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 "January 10, 2018" "libcurl 7.59.0" "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 .RE
  51 The maximum TLS version can be set by using \fIone\fP of the
  52 CURL_SSLVERSION_MAX_ macros below. It is also possible to OR \fIone\fP of the
  53 CURL_SSLVERSION_ macros with \fIone\fP of the CURL_SSLVERSION_MAX_ macros.
  54 The MAX macros are not supported for SSL backends axTLS or wolfSSL.
  55 .RS
  56 .IP CURL_SSLVERSION_MAX_DEFAULT
  57 The flag defines the maximum supported TLS version as TLSv1.2, or the default
  58 value from the SSL library.
  59 (Added in 7.54.0)
  60 .IP CURL_SSLVERSION_MAX_TLSv1_0
  61 The flag defines maximum supported TLS version as TLSv1.0.
  62 (Added in 7.54.0)
  63 .IP CURL_SSLVERSION_MAX_TLSv1_1
  64 The flag defines maximum supported TLS version as TLSv1.1.
  65 (Added in 7.54.0)
  66 .IP CURL_SSLVERSION_MAX_TLSv1_2
  67 The flag defines maximum supported TLS version as TLSv1.2.
  68 (Added in 7.54.0)
  69 .IP CURL_SSLVERSION_MAX_TLSv1_3
  70 The flag defines maximum supported TLS version as TLSv1.3.
  71 (Added in 7.54.0)
  72 .RE
  73 .SH DEFAULT
  74 CURL_SSLVERSION_DEFAULT
  75 .SH PROTOCOLS
  76 All
  77 .SH EXAMPLE
  78 .nf
  79 CURL *curl = curl_easy_init();
  80 if(curl) {
  81   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  82
  83   /* ask libcurl to use TLS version 1.0 or later */
  84   curl_easy_setopt(curl, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
  85
  86   /* Perform the request */
  87   curl_easy_perform(curl);
  88 }
  89 .fi
  90 .SH AVAILABILITY
  91 Added in 7.52.0
  92 .SH RETURN VALUE
  93 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  94 .SH "SEE ALSO"
  95 .BR CURLOPT_USE_SSL "(3), " CURLOPT_HTTP_VERSION "(3), "
  96 .BR CURLOPT_IPRESOLVE "(3) " CURLOPT_SSLVERSION "(3), "
  97