Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_SSLENGINE (3)

Name

CURLOPT_SSLENGINE - set SSL engine identifier

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLENGINE, char *id);

Description

CURLOPT_SSLENGINE(3)       curl_easy_setopt options       CURLOPT_SSLENGINE(3)



NAME
       CURLOPT_SSLENGINE - set SSL engine identifier

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLENGINE, char *id);

DESCRIPTION
       Pass  a  pointer  to  a zero terminated string as parameter. It will be
       used as the identifier for the crypto engine you want to use  for  your
       private key.

       The  application  does not have to keep the string around after setting
       this option.

DEFAULT
       NULL

PROTOCOLS
       All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
         curl_easy_setopt(curl, CURLOPT_SSLENGINE, "dynamic");
         ret = curl_easy_perform(curl);
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Only if the SSL backend is OpenSSL built with engine support.

RETURN VALUE
       CURLE_OK - Engine found.

       CURLE_SSL_ENGINE_NOTFOUND - Engine not found, or OpenSSL was not  built
       with engine support.

       CURLE_SSL_ENGINE_INITFAILED - Engine found but initialization failed.

       CURLE_NOT_BUILT_IN  - Option not built in, OpenSSL is not the SSL back-
       end.

       CURLE_UNKNOWN_OPTION - Option not recognized.

       CURLE_OUT_OF_MEMORY - Insufficient heap space.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_SSLENGINE_DEFAULT(3), CURLOPT_SSLKEY(3),



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was    downloaded    from     https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.37.0                    17 Jun 2014             CURLOPT_SSLENGINE(3)