docs/libcurl/opts/CURLOPT_SSLENGINE.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.
   9 .\" *
  10 .\" * This software is licensed as described in the file COPYING, which
  11 .\" * you should have received as part of this distribution. The terms
  12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
  13 .\" *
  14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15 .\" * copies of the Software, and permit persons to whom the Software is
  16 .\" * furnished to do so, under the terms of the COPYING file.
  17 .\" *
  18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19 .\" * KIND, either express or implied.
  20 .\" *
  21 .\" **************************************************************************
  22 .\"
  23 .TH CURLOPT_SSLENGINE 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_SSLENGINE \- set SSL engine identifier
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLENGINE, char *id);
  30 .SH DESCRIPTION
  31 Pass a pointer to a zero terminated string as parameter. It will be used as
  32 the identifier for the crypto engine you want to use for your private key.
  33
  34 The application does not have to keep the string around after setting this
  35 option.
  36 .SH DEFAULT
  37 NULL
  38 .SH PROTOCOLS
  39 All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  40 .SH EXAMPLE
  41 TODO
  42 .SH AVAILABILITY
  43 Only if the SSL backend is OpenSSL built with engine support.
  44 .SH RETURN VALUE
  45 CURLE_OK - Engine found.
  46
  47 CURLE_SSL_ENGINE_NOTFOUND - Engine not found, or OpenSSL was not built with
  48 engine support.
  49
  50 CURLE_SSL_ENGINE_INITFAILED - Engine found but initialization failed.
  51
  52 CURLE_NOT_BUILT_IN - Option not built in, OpenSSL is not the SSL backend.
  53
  54 CURLE_UNKNOWN_OPTION - Option not recognized.
  55
  56 CURLE_OUT_OF_MEMORY - Insufficient heap space.
  57 .SH "SEE ALSO"
  58 .BR CURLOPT_SSLENGINE_DEFAULT "(3), " CURLOPT_SSLKEY "(3), "