oracular (3) CURLOPT_SSLKEYTYPE.3.gz

Provided by: libcurl4-doc_8.9.1-2ubuntu2.2_all bug

NAME

       CURLOPT_SSLKEYTYPE - type of the private key file

SYNOPSIS

       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLKEYTYPE, char *type);

DESCRIPTION

       Pass  a pointer to a null-terminated string as parameter. The string should be the format of your private
       key. Supported formats are "PEM", "DER" and "ENG".

       The format "ENG" enables you to load the private key from a crypto engine. In this case CURLOPT_SSLKEY(3)
       is   used   as   an   identifier  passed  to  the  engine.  You  have  to  set  the  crypto  engine  with
       CURLOPT_SSLENGINE(3). "DER" format key file currently does not work because of a bug in OpenSSL.

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

DEFAULT

       "PEM"

PROTOCOLS

       This functionality affects all TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.

       This option works only with the following TLS backends: BearSSL, OpenSSL and wolfSSL

EXAMPLE

       int main(void)
       {
         CURL *curl = curl_easy_init();
         if(curl) {
           CURLcode res;
           curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
           curl_easy_setopt(curl, CURLOPT_SSLCERT, "client.pem");
           curl_easy_setopt(curl, CURLOPT_SSLKEY, "key.pem");
           curl_easy_setopt(curl, CURLOPT_SSLKEYTYPE, "PEM");
           curl_easy_setopt(curl, CURLOPT_KEYPASSWD, "s3cret");
           res = curl_easy_perform(curl);
           curl_easy_cleanup(curl);
         }
       }

AVAILABILITY

       Added in curl 7.9.3

RETURN VALUE

       Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or CURLE_OUT_OF_MEMORY  if  there  was
       insufficient heap space.

SEE ALSO

       CURLOPT_PROXY_SSLKEYTYPE(3), CURLOPT_SSLCERT(3), CURLOPT_SSLKEY(3)