CURLOPT_PROXYAUTH
Section: curl_easy_setopt options (3)
Updated: November 04, 2020
Page Index
NAME
CURLOPT_PROXYAUTH - set HTTP proxy authentication methods to try
SYNOPSIS
#include <
curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYAUTH, long bitmask);
DESCRIPTION
Pass a long as parameter, which is set to a bitmask, to tell libcurl which
HTTP authentication method(s) you want it to use for your proxy
authentication. If more than one bit is set, libcurl will first query the
site to see what authentication methods it supports and then pick the best one
you allow it to use. For some methods, this will induce an extra network
round-trip. Set the actual name and password with the
CURLOPT_PROXYUSERPWD(3) option.
The bitmask can be constructed by or'ing together the bits fully listed and
described in the CURLOPT_HTTPAUTH(3) man page.
DEFAULT
CURLAUTH_BASIC
PROTOCOLS
HTTP
EXAMPLE
CURL *curl = curl_easy_init();
if(curl) {
CURLcode ret;
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
/* use this proxy */
curl_easy_setopt(curl, CURLOPT_PROXY, "http://local.example.com:1080");
/* allow whatever auth the proxy speaks */
curl_easy_setopt(curl, CURLOPT_PROXYAUTH, CURLAUTH_ANY);
/* set the proxy credentials */
curl_easy_setopt(curl, CURLOPT_PROXYUSERPWD, "james:007");
ret = curl_easy_perform(curl);
curl_easy_cleanup(curl);
}
AVAILABILITY
Added in 7.10.7
RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_NOT_BUILT_IN if the bitmask specified no supported authentication
methods.
SEE ALSO
CURLOPT_PROXY(3),
CURLOPT_PROXYTYPE(3),
CURLOPT_PROXYUSERPWD(3),
CURLOPT_PROXYPORT(3),