Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_SOCKS5_AUTH (3)

Name

CURLOPT_SOCKS5_AUTH - tion

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKS5_AUTH, long  bit-
mask);

Description

CURLOPT_SOCKS5_AUTH(3)     curl_easy_setopt options     CURLOPT_SOCKS5_AUTH(3)



NAME
       CURLOPT_SOCKS5_AUTH  - set allowed methods for SOCKS5 proxy authentica-
       tion

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKS5_AUTH, long  bit-
       mask);

DESCRIPTION
       Pass  a  long  as parameter, which is set to a bitmask, to tell libcurl
       which authentication method(s) are allowed for SOCKS5 proxy authentica-
       tion.   The only supported flags are CURLAUTH_BASIC, which allows user-
       name/password authentication,  CURLAUTH_GSSAPI,  which  allows  GSS-API
       authentication, and CURLAUTH_NONE, which allows no authentication.  Set
       the actual user name  and  password  with  the  CURLOPT_PROXYUSERPWD(3)
       option.

DEFAULT
       CURLAUTH_BASIC|CURLAUTH_GSSAPI

PROTOCOLS
       All

EXAMPLE
       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);
       }

AVAILABILITY
       Added in 7.55.0

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.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_PROXY(3), CURLOPT_PROXYTYPE(3)



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was    downloaded    from     https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.55.0                   27 April 2017          CURLOPT_SOCKS5_AUTH(3)