| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <[email protected]>, et al. |
| 9 |
.\" * |
| 10 |
.\" * This software is licensed as described in the file COPYING, which |
| 11 |
.\" * you should have received as part of this distribution. The terms |
| 12 |
.\" * are also available at https://curl.haxx.se/docs/copyright.html. |
| 13 |
.\" * |
| 14 |
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| 15 |
.\" * copies of the Software, and permit persons to whom the Software is |
| 16 |
.\" * furnished to do so, under the terms of the COPYING file. |
| 17 |
.\" * |
| 18 |
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| 19 |
.\" * KIND, either express or implied. |
| 20 |
.\" * |
| 21 |
.\" ************************************************************************** |
| 22 |
.\" |
| 23 |
.TH CURLOPT_SOCKS5_AUTH 3 "27 April 2017" "libcurl 7.55.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_SOCKS5_AUTH \- set allowed methods for SOCKS5 proxy authentication |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKS5_AUTH, long bitmask); |
| 30 |
.SH DESCRIPTION |
| 31 |
Pass a long as parameter, which is set to a bitmask, to tell libcurl which |
| 32 |
authentication method(s) are allowed for SOCKS5 proxy authentication. The only |
| 33 |
supported flags are \fICURLAUTH_BASIC\fP, which allows username/password |
| 34 |
authentication, \fICURLAUTH_GSSAPI\fP, which allows GSS-API authentication, and |
| 35 |
\fICURLAUTH_NONE\fP, which allows no authentication. Set the actual user name |
| 36 |
and password with the \fICURLOPT_PROXYUSERPWD(3)\fP option. |
| 37 |
.SH DEFAULT |
| 38 |
CURLAUTH_BASIC|CURLAUTH_GSSAPI |
| 39 |
.SH PROTOCOLS |
| 40 |
All |
| 41 |
.SH EXAMPLE |
| 42 |
.nf |
| 43 |
CURL *curl = curl_easy_init(); |
| 44 |
if(curl) { |
| 45 |
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com"); |
| 46 |
|
| 47 |
/* request to use a SOCKS5 proxy */ |
| 48 |
curl_easy_setopt(curl, CURLOPT_PROXY, "socks5://user:[email protected]"); |
| 49 |
|
| 50 |
/* enable username/password authentication only */ |
| 51 |
curl_easy_setopt(curl, CURLOPT_SOCKS5_AUTH, CURLAUTH_BASIC); |
| 52 |
|
| 53 |
/* Perform the request */ |
| 54 |
curl_easy_perform(curl); |
| 55 |
} |
| 56 |
.fi |
| 57 |
.SH AVAILABILITY |
| 58 |
Added in 7.55.0 |
| 59 |
.SH RETURN VALUE |
| 60 |
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
| 61 |
CURLE_NOT_BUILT_IN if the bitmask contains unsupported flags. |
| 62 |
.SH "SEE ALSO" |
| 63 |
.BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3)" |