1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLOPT_PROXY_TLSAUTH_PASSWORD
5Section: 3
6Source: libcurl
7See-also:
8  - CURLOPT_PROXY_TLSAUTH_TYPE (3)
9  - CURLOPT_PROXY_TLSAUTH_USERNAME (3)
10  - CURLOPT_TLSAUTH_TYPE (3)
11  - CURLOPT_TLSAUTH_USERNAME (3)
12Protocol:
13  - TLS
14TLS-backend:
15  - OpenSSL
16  - GnuTLS
17---
18
19# NAME
20
21CURLOPT_PROXY_TLSAUTH_PASSWORD - password to use for proxy TLS authentication
22
23# SYNOPSIS
24
25~~~c
26#include <curl/curl.h>
27
28CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_TLSAUTH_PASSWORD,
29                          char *pwd);
30~~~
31
32# DESCRIPTION
33
34Pass a char pointer as parameter, which should point to the null-terminated
35password to use for the TLS authentication method specified with the
36CURLOPT_PROXY_TLSAUTH_TYPE(3) option. Requires that the
37CURLOPT_PROXY_TLSAUTH_USERNAME(3) option also be set.
38
39The application does not have to keep the string around after setting this
40option.
41
42# DEFAULT
43
44NULL
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/");
55    curl_easy_setopt(curl, CURLOPT_PROXY, "https://proxy");
56    curl_easy_setopt(curl, CURLOPT_PROXY_TLSAUTH_TYPE, "SRP");
57    curl_easy_setopt(curl, CURLOPT_PROXY_TLSAUTH_USERNAME, "user");
58    curl_easy_setopt(curl, CURLOPT_PROXY_TLSAUTH_PASSWORD, "secret");
59    res = curl_easy_perform(curl);
60    curl_easy_cleanup(curl);
61  }
62}
63~~~
64
65# AVAILABILITY
66
67Added in 7.52.0.
68
69# RETURN VALUE
70
71Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
72CURLE_OUT_OF_MEMORY if there was insufficient heap space.
73