bionic (3) CURLOPT_PROXY_SSLCERT.3.gz

Provided by: libcurl4-doc_7.58.0-2ubuntu3.24_all bug

NAME

       CURLOPT_PROXY_SSLCERT - set SSL proxy client certificate

SYNOPSIS

       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLCERT, char *cert);

DESCRIPTION

       This option is for connecting to a HTTPS proxy, not a HTTPS server.

       Pass  a  pointer  to  a  zero  terminated string as parameter. The string should be the file name of your
       client certificate used to connect to the HTTPS proxy.  The default format is "P12" on  Secure  Transport
       and "PEM" on other engines, and can be changed with CURLOPT_PROXY_SSLCERTTYPE(3).

       With  NSS  or Secure Transport, this can also be the nickname of the certificate you wish to authenticate
       with as it is named in the security database. If you want to use  a  file  from  the  current  directory,
       please precede it with "./" prefix, in order to avoid confusion with a nickname.

       When   using   a  client  certificate,  you  most  likely  also  need  to  provide  a  private  key  with
       CURLOPT_PROXY_SSLKEY(3).

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

DEFAULT

       NULL

PROTOCOLS

       Used with HTTPS proxy

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

RETURN VALUE

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

SEE ALSO

       CURLOPT_PROXY_SSLCERTTYPE(3), CURLOPT_PROXY_SSLKEY(3), CURLOPT_SSLCERT(3),