Blame view

3rdparty/curl/share/man/man3/CURLOPT_SOCKS5_AUTH.3 2.5 KB
a86c63ca   Hu Chunming   提交三方库文件
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
  .\" **************************************************************************
  .\" *                                  _   _ ____  _
  .\" *  Project                     ___| | | |  _ \| |
  .\" *                             / __| | | | |_) | |
  .\" *                            | (__| |_| |  _ <| |___
  .\" *                             \___|\___/|_| \_\_____|
  .\" *
  .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
  .\" *
  .\" * This software is licensed as described in the file COPYING, which
  .\" * you should have received as part of this distribution. The terms
  .\" * are also available at https://curl.se/docs/copyright.html.
  .\" *
  .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  .\" * copies of the Software, and permit persons to whom the Software is
  .\" * furnished to do so, under the terms of the COPYING file.
  .\" *
  .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  .\" * KIND, either express or implied.
  .\" *
  .\" **************************************************************************
  .\"
  .TH CURLOPT_SOCKS5_AUTH 3 "November 04, 2020" "libcurl 7.77.0" "curl_easy_setopt options"
  
  .SH NAME
  CURLOPT_SOCKS5_AUTH \- set allowed methods for SOCKS5 proxy authentication
  .SH SYNOPSIS
  #include <curl/curl.h>
  
  CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKS5_AUTH, long bitmask);
  .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
  \fICURLAUTH_NONE\fP, which allows no authentication.  Set the actual user name
  and password with the \fICURLOPT_PROXYUSERPWD(3)\fP option.
  .SH DEFAULT
  CURLAUTH_BASIC|CURLAUTH_GSSAPI
  .SH PROTOCOLS
  All
  .SH EXAMPLE
  .nf
  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, 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), " CURLOPT_PROXYTYPE "(3)"