curl / libcurl / API / curl_easy_setopt / CURLOPT_PROXY_KEYPASSWD

CURLOPT_PROXY_KEYPASSWD explained

Name

CURLOPT_PROXY_KEYPASSWD - passphrase for the 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 null-terminated string as parameter. It is used as the password required to use the CURLOPT_PROXY_SSLKEY private key. You never need 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

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
    curl_easy_setopt(curl, CURLOPT_PROXY, "https://proxy:443");
    curl_easy_setopt(curl, CURLOPT_PROXY_KEYPASSWD, "superman");
    res = 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_KEYPASSWD(3), CURLOPT_PROXY_SSLKEY(3), CURLOPT_SSH_PRIVATE_KEYFILE(3), CURLOPT_SSLKEY(3)

This HTML page was made with roffit.