1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
---
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
SPDX-License-Identifier: curl
Title: CURLOPT_PROXYUSERPWD
Section: 3
Source: libcurl
See-also:
- CURLOPT_PROXY (3)
- CURLOPT_PROXYPASSWORD (3)
- CURLOPT_PROXYTYPE (3)
- CURLOPT_PROXYUSERNAME (3)
---
# NAME
CURLOPT_PROXYUSERPWD - user name and password to use for proxy authentication
# SYNOPSIS
~~~c
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYUSERPWD, char *userpwd);
~~~
# DESCRIPTION
Pass a char pointer as parameter, which should be [user name]:[password] to
use for the connection to the HTTP proxy. Both the name and the password are
URL decoded before used, so to include for example a colon in the user name
you should encode it as %3A. (This is different to how CURLOPT_USERPWD(3) is
used - beware.)
Use CURLOPT_PROXYAUTH(3) to specify the authentication method.
The application does not have to keep the string around after setting this
option.
# DEFAULT
This is NULL by default.
# PROTOCOLS
Used with all protocols that can use a proxy
# EXAMPLE
~~~c
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, "http://localhost:8080");
curl_easy_setopt(curl, CURLOPT_PROXYUSERPWD, "clark%20kent:superman");
res = curl_easy_perform(curl);
curl_easy_cleanup(curl);
}
}
~~~
# AVAILABILITY
Always
# RETURN VALUE
Returns CURLE_OK if proxies are supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
