Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_PROXY_SSLKEY (3)

Name

CURLOPT_PROXY_SSLKEY - private keyfile for HTTPS proxy client cert

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLKEY, char *keyfile);

Description

CURLOPT_PROXY_SSLKEY(3)    curl_easy_setopt options    CURLOPT_PROXY_SSLKEY(3)



NAME
       CURLOPT_PROXY_SSLKEY - private keyfile for HTTPS proxy client cert

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLKEY, char *keyfile);

DESCRIPTION
       Pass  a  pointer  to  a null-terminated string as parameter. The string
       should be the file name of your private key used for connecting to  the
       HTTPS  proxy.  The default format is "PEM" and can be changed with CUR-
       LOPT_PROXY_SSLKEYTYPE(3).

       (Windows, iOS and Mac OS X) This option is ignored by Secure  Transport
       and  Schannel  SSL  backends  because they expect the private key to be
       already present in the keychain or PKCS#12 file containing the certifi-
       cate.

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

DEFAULT
       NULL

PROTOCOLS
       All

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
         curl_easy_setopt(curl, CURLOPT_PROXY, "https://proxy");
         curl_easy_setopt(curl, CURLOPT_PROXY_SSLCERT, "client.pem");
         curl_easy_setopt(curl, CURLOPT_PROXY_SSLKEY, "key.pem");
         curl_easy_setopt(curl, CURLOPT_PROXY_KEYPASSWD, "s3cret");
         ret = curl_easy_perform(curl);
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in 7.52.0

       If built TLS enabled.

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.


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


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       CURLOPT_PROXY_SSLKEYTYPE(3),  CURLOPT_PROXY_SSLCERT(3), CURLOPT_SSLKEY-
       TYPE(3), CURLOPT_SSLCERT(3),



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source      was      downloaded       from        https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

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



libcurl 7.83.1                  March 12, 2022         CURLOPT_PROXY_SSLKEY(3)