1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLOPT_PROXY_KEYPASSWD
5Section: 3
6Source: libcurl
7See-also:
8  - CURLOPT_KEYPASSWD (3)
9  - CURLOPT_PROXY_SSLKEY (3)
10  - CURLOPT_SSH_PRIVATE_KEYFILE (3)
11  - CURLOPT_SSLKEY (3)
12Protocol:
13  - TLS
14TLS-backend:
15  - OpenSSL
16  - mbedTLS
17  - Schannel
18  - wolfSSL
19---
20
21# NAME
22
23CURLOPT_PROXY_KEYPASSWD - passphrase for the proxy private key
24
25# SYNOPSIS
26
27~~~c
28#include <curl/curl.h>
29
30CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_KEYPASSWD, char *pwd);
31~~~
32
33# DESCRIPTION
34
35This option is for connecting to an HTTPS proxy, not an HTTPS server.
36
37Pass a pointer to a null-terminated string as parameter. It is used as the
38password required to use the CURLOPT_PROXY_SSLKEY(3) private key. You
39never need a pass phrase to load a certificate but you need one to load your
40private key.
41
42The application does not have to keep the string around after setting this
43option.
44
45# DEFAULT
46
47NULL
48
49# EXAMPLE
50
51~~~c
52int main(void)
53{
54  CURL *curl = curl_easy_init();
55  if(curl) {
56    CURLcode res;
57    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
58    curl_easy_setopt(curl, CURLOPT_PROXY, "https://proxy:443");
59    curl_easy_setopt(curl, CURLOPT_PROXY_KEYPASSWD, "superman");
60    res = curl_easy_perform(curl);
61    curl_easy_cleanup(curl);
62  }
63}
64~~~
65
66# AVAILABILITY
67
68Added in 7.52.0
69
70# RETURN VALUE
71
72Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
73CURLE_OUT_OF_MEMORY if there was insufficient heap space.
74