Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_PROXY_SSLKEY (3)

Name

CURLOPT_PROXY_SSLKEY - specify private keyfile for TLS and SSL 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  -  specify  private keyfile for TLS and SSL 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 zero 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).

       (iOS and Mac OS X only) This  option  is  ignored  if  curl  was  built
       against  Secure  Transport. Secure Transport expects the private key to
       be already present in the keychain or PKCS#12 file containing the  cer-
       tificate.

       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
       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.52.0                    16 Nov 2016          CURLOPT_PROXY_SSLKEY(3)