2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from CURLOPT_SOCKS5_AUTH.md
|
2024-06-01 14:49:19 -06:00
|
|
|
.TH CURLOPT_SOCKS5_AUTH 3 "2024-06-01" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH NAME
|
|
|
|
|
CURLOPT_SOCKS5_AUTH \- methods for SOCKS5 proxy authentication
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKS5_AUTH, long bitmask);
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
Pass a long as parameter, which is set to a bitmask, to tell libcurl which
|
|
|
|
|
authentication method(s) are allowed for SOCKS5 proxy authentication. The only
|
|
|
|
|
supported flags are \fICURLAUTH_BASIC\fP, which allows username/password
|
|
|
|
|
authentication, \fICURLAUTH_GSSAPI\fP, which allows GSS\-API authentication, and
|
2024-03-30 12:28:04 -06:00
|
|
|
\fICURLAUTH_NONE\fP, which allows no authentication. Set the actual username and
|
2024-03-15 20:55:33 -06:00
|
|
|
password with the \fICURLOPT_PROXYUSERPWD(3)\fP option.
|
|
|
|
|
.SH DEFAULT
|
|
|
|
|
CURLAUTH_BASIC|CURLAUTH_GSSAPI
|
|
|
|
|
.SH PROTOCOLS
|
|
|
|
|
All
|
|
|
|
|
.SH EXAMPLE
|
|
|
|
|
.nf
|
|
|
|
|
int main(void)
|
|
|
|
|
{
|
|
|
|
|
CURL *curl = curl_easy_init();
|
|
|
|
|
if(curl) {
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
|
|
|
|
|
|
|
|
|
/* request to use a SOCKS5 proxy */
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_PROXY, "socks5://user:pass@myproxy.com");
|
|
|
|
|
|
|
|
|
|
/* enable username/password authentication only */
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_SOCKS5_AUTH, (long)CURLAUTH_BASIC);
|
|
|
|
|
|
|
|
|
|
/* Perform the request */
|
|
|
|
|
curl_easy_perform(curl);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
.fi
|
|
|
|
|
.SH AVAILABILITY
|
|
|
|
|
Added in 7.55.0
|
|
|
|
|
.SH RETURN VALUE
|
|
|
|
|
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
|
|
|
|
|
CURLE_NOT_BUILT_IN if the bitmask contains unsupported flags.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR CURLOPT_PROXY (3),
|
|
|
|
|
.BR CURLOPT_PROXYTYPE (3)
|
