Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_PROXY_KEYPASSWD (3)

Name

CURLOPT_PROXY_KEYPASSWD - set passphrase to proxy private key

Synopsis

#include <curl/curl.h>

CURLcode  curl_easy_setopt(CURL  *handle, CURLOPT_PROXY_KEYPASSWD, char
*pwd);

Description

curl_easy_setopt options                            CURLOPT_PROXY_KEYPASSWD(3)



NAME
       CURLOPT_PROXY_KEYPASSWD - set passphrase to proxy private key

SYNOPSIS
       #include <curl/curl.h>

       CURLcode  curl_easy_setopt(CURL  *handle, CURLOPT_PROXY_KEYPASSWD, char
       *pwd);

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

       Pass a pointer to a zero terminated string as  parameter.  It  will  be
       used  as  the password required to use the CURLOPT_PROXY_SSLKEY(3) pri-
       vate key.  You never needed a pass phrase to load a certificate but you
       need one to load your private key.

       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, "http://example.com/foo.bin");
         curl_easy_setopt(curl, CURLOPT_PROXY, "https://proxy:443");
         curl_easy_setopt(curl, CURLOPT_PROXY_KEYPASSWD, "superman");
         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.


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


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_PROXY_SSLKEY(3),      CURLOPT_SSH_PRIVATE_KEYFILE(3),      CUR-
       LOPT_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.52.0                    16 Nov 2016
                                                    CURLOPT_PROXY_KEYPASSWD(3)