docs/libcurl/opts/CURLOPT_SOCKS5_AUTH.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, 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 "April 27, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_SOCKS5_AUTH \- set allowed methods for SOCKS5 proxy authentication
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKS5_AUTH, long bitmask);
  31 .SH DESCRIPTION
  32 Pass a long as parameter, which is set to a bitmask, to tell libcurl which
  33 authentication method(s) are allowed for SOCKS5 proxy authentication.  The only
  34 supported flags are \fICURLAUTH_BASIC\fP, which allows username/password
  35 authentication, \fICURLAUTH_GSSAPI\fP, which allows GSS-API authentication, and
  36 \fICURLAUTH_NONE\fP, which allows no authentication.  Set the actual user name
  37 and password with the \fICURLOPT_PROXYUSERPWD(3)\fP option.
  38 .SH DEFAULT
  39 CURLAUTH_BASIC|CURLAUTH_GSSAPI
  40 .SH PROTOCOLS
  41 All
  42 .SH EXAMPLE
  43 .nf
  44 CURL *curl = curl_easy_init();
  45 if(curl) {
  46   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  47
  48   /* request to use a SOCKS5 proxy */
  49   curl_easy_setopt(curl, CURLOPT_PROXY, "socks5://user:pass@myproxy.com");
  50
  51   /* enable username/password authentication only */
  52   curl_easy_setopt(curl, CURLOPT_SOCKS5_AUTH, CURLAUTH_BASIC);
  53
  54   /* Perform the request */
  55   curl_easy_perform(curl);
  56 }
  57 .fi
  58 .SH AVAILABILITY
  59 Added in 7.55.0
  60 .SH RETURN VALUE
  61 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  62 CURLE_NOT_BUILT_IN if the bitmask contains unsupported flags.
  63 .SH "SEE ALSO"
  64 .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3)"