Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_PROXY_SSLVERSION (3)

Name

CURLOPT_PROXY_SSLVERSION - preferred HTTPS proxy TLS version

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLVERSION,
long version);

Description

curl_easy_setopt options                           CURLOPT_PROXY_SSLVERSION(3)



NAME
       CURLOPT_PROXY_SSLVERSION - preferred HTTPS proxy TLS version

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLVERSION,
                                 long version);

DESCRIPTION
       Pass a long as parameter to control which version of SSL/TLS to attempt
       to use when connecting to an HTTPS proxy.

       Use one of the  available  defines  for  this  purpose.  The  available
       options are:

              CURL_SSLVERSION_DEFAULT
                     The  default  action. This will attempt to figure out the
                     remote SSL protocol version.

              CURL_SSLVERSION_TLSv1
                     TLSv1.x

              CURL_SSLVERSION_TLSv1_0
                     TLSv1.0

              CURL_SSLVERSION_TLSv1_1
                     TLSv1.1

              CURL_SSLVERSION_TLSv1_2
                     TLSv1.2

              CURL_SSLVERSION_TLSv1_3
                     TLSv1.3
       The maximum TLS version can be set by using  one  of  the  CURL_SSLVER-
       SION_MAX_  macros  below.  It  is  also  possible  to  OR  one  of  the
       CURL_SSLVERSION_ macros with one of  the  CURL_SSLVERSION_MAX_  macros.
       The MAX macros are not supported for WolfSSL.

              CURL_SSLVERSION_MAX_DEFAULT
                     The  flag  defines  the  maximum supported TLS version as
                     TLSv1.2, or the  default  value  from  the  SSL  library.
                     (Added in 7.54.0)

              CURL_SSLVERSION_MAX_TLSv1_0
                     The   flag  defines  maximum  supported  TLS  version  as
                     TLSv1.0.  (Added in 7.54.0)

              CURL_SSLVERSION_MAX_TLSv1_1
                     The  flag  defines  maximum  supported  TLS  version   as
                     TLSv1.1.  (Added in 7.54.0)

              CURL_SSLVERSION_MAX_TLSv1_2
                     The   flag  defines  maximum  supported  TLS  version  as
                     TLSv1.2.  (Added in 7.54.0)

              CURL_SSLVERSION_MAX_TLSv1_3
                     The  flag  defines  maximum  supported  TLS  version   as
                     TLSv1.3.  (Added in 7.54.0)

       In  versions of curl prior to 7.54 the CURL_SSLVERSION_TLS options were
       documented to allow only the specified TLS version,  but  behavior  was
       inconsistent depending on the TLS library.


DEFAULT
       CURL_SSLVERSION_DEFAULT

PROTOCOLS
       All

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");

         /* ask libcurl to use TLS version 1.0 or later */
         curl_easy_setopt(curl, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);

         /* Perform the request */
         curl_easy_perform(curl);
       }

AVAILABILITY
       Added in 7.52.0

RETURN VALUE
       Returns  CURLE_OK  if the option is supported, and CURLE_UNKNOWN_OPTION
       if not.


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


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       CURLOPT_USE_SSL(3), CURLOPT_HTTP_VERSION(3), CURLOPT_IPRESOLVE(3)  CUR-
       LOPT_SSLVERSION(3),



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source       was       downloaded      from       https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

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



libcurl 7.83.1                 November 26, 2021
                                                   CURLOPT_PROXY_SSLVERSION(3)