docs/libcurl/opts/CURLOPT_PROXY_SSLVERSION.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2016, 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_PROXY_SSLVERSION 3 "August 12, 2017" "libcurl 7.56.1" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_PROXY_SSLVERSION \- set preferred proxy TLS/SSL version
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLVERSION, long version);
  31 .SH DESCRIPTION
  32 Pass a long as parameter to control which version of SSL/TLS to attempt to use
  33 when connecting to an HTTPS proxy.
  34
  35 Use one of the available defines for this purpose. The available options are:
  36 .RS
  37 .IP CURL_SSLVERSION_DEFAULT
  38 The default action. This will attempt to figure out the remote SSL protocol
  39 version.
  40 .IP CURL_SSLVERSION_TLSv1
  41 TLSv1.x
  42 .IP CURL_SSLVERSION_TLSv1_0
  43 TLSv1.0
  44 .IP CURL_SSLVERSION_TLSv1_1
  45 TLSv1.1
  46 .IP CURL_SSLVERSION_TLSv1_2
  47 TLSv1.2
  48 .IP CURL_SSLVERSION_TLSv1_3
  49 TLSv1.3
  50 .IP CURL_SSLVERSION_MAX_DEFAULT
  51 The flag defines the maximum supported TLS version as TLSv1.2, or the default
  52 value from the SSL library. Only the NSS library currently allows one to get
  53 the maximum supported TLS version.
  54 (Added in 7.54.0)
  55 .IP CURL_SSLVERSION_MAX_TLSv1_0
  56 The flag defines maximum supported TLS version as TLSv1.0.
  57 (Added in 7.54.0)
  58 .IP CURL_SSLVERSION_MAX_TLSv1_1
  59 The flag defines maximum supported TLS version as TLSv1.1.
  60 (Added in 7.54.0)
  61 .IP CURL_SSLVERSION_MAX_TLSv1_2
  62 The flag defines maximum supported TLS version as TLSv1.2.
  63 (Added in 7.54.0)
  64 .IP CURL_SSLVERSION_MAX_TLSv1_3
  65 The flag defines maximum supported TLS version as TLSv1.3.
  66 (Added in 7.54.0)
  67 .RE
  68 .SH DEFAULT
  69 CURL_SSLVERSION_DEFAULT
  70 .SH PROTOCOLS
  71 All
  72 .SH EXAMPLE
  73 .nf
  74 CURL *curl = curl_easy_init();
  75 if(curl) {
  76   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  77
  78   /* ask libcurl to use TLS version 1.0 or later */
  79   curl_easy_setopt(curl, CURLOPT_PROXY_SSLVERSION, CURL_SSLVERSION_TLSv1_1 |
  80                    CURL_SSLVERSION_MAX_DEFAULT);
  81
  82   /* Perform the request */
  83   curl_easy_perform(curl);
  84 }
  85 .fi
  86 .SH AVAILABILITY
  87 Added in 7.52.0
  88 .SH RETURN VALUE
  89 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  90 .SH "SEE ALSO"
  91 .BR CURLOPT_USE_SSL "(3), " CURLOPT_HTTP_VERSION "(3), "
  92 .BR CURLOPT_IPRESOLVE "(3) " CURLOPT_SSLVERSION "(3), "
  93