Skip to content

Latest commit

 

History

History
73 lines (56 loc) · 1.49 KB

CURLOPT_PROXY_KEYPASSWD.md

File metadata and controls

73 lines (56 loc) · 1.49 KB
c SPDX-License-Identifier Title Section Source See-also Protocol TLS-backend
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
curl
CURLOPT_PROXY_KEYPASSWD
3
libcurl
CURLOPT_KEYPASSWD (3)
CURLOPT_PROXY_SSLKEY (3)
CURLOPT_SSH_PRIVATE_KEYFILE (3)
CURLOPT_SSLKEY (3)
TLS
OpenSSL
mbedTLS
Schannel
wolfSSL

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(3) 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

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.