Daniel Stenberg 5a488251f7

- make DEFAULT sections less repetitive

- make historic mentions use HISTORY

- generate the protocols section on `# %PROTOCOLS%` instead of guessing
  where to put it

- generate the availability section on `# %AVAILABILITY%` instead of
  guessing where to put it

- make the protocols section more verbose

Closes #14227

2024-07-19 17:03:25 +02:00

1.8 KiB

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

See-also

Protocol

TLS-backend

Added-in

curl

CURLOPT_PROXY_SSLKEY

libcurl

CURLOPT_PROXY_SSLCERT (3)

CURLOPT_PROXY_SSLKEYTYPE (3)

CURLOPT_SSLCERT (3)

CURLOPT_SSLKEY (3)

CURLOPT_SSLKEYTYPE (3)

TLS

OpenSSL

mbedTLS

Schannel

wolfSSL

7.52.0

NAME

CURLOPT_PROXY_SSLKEY - private key file for HTTPS 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 null-terminated string as parameter. The string should be the filename of your private key used for connecting to the HTTPS proxy. The default format is "PEM" and can be changed with CURLOPT_PROXY_SSLKEYTYPE(3).

(Windows, iOS and Mac OS X) This option is ignored by Secure Transport and Schannel SSL backends because they expect the private key to be already present in the key chain or PKCS#12 file containing the certificate.

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

DEFAULT

NULL

%PROTOCOLS%

EXAMPLE

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    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");
    res = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

%AVAILABILITY%

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.

1.8 KiB Raw Blame History