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