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 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_PROXY_SSLVERSION \- set preferred proxy TLS/SSL version
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLVERSION, long version);
  30 .SH DESCRIPTION
  31 Pass a long as parameter to control which version of SSL/TLS to attempt to use
  32 when connecting to an HTTPS proxy.
  33
  34 Use one of the available defines for this purpose. The available options are:
  35 .RS
  36 .IP CURL_SSLVERSION_DEFAULT
  37 The default action. This will attempt to figure out the remote SSL protocol
  38 version.
  39 .IP CURL_SSLVERSION_TLSv1
  40 TLSv1.x
  41 .IP CURL_SSLVERSION_TLSv1_0
  42 TLSv1.0
  43 .IP CURL_SSLVERSION_TLSv1_1
  44 TLSv1.1
  45 .IP CURL_SSLVERSION_TLSv1_2
  46 TLSv1.2
  47 .IP CURL_SSLVERSION_TLSv1_3
  48 TLSv1.3
  49 .RE
  50 .SH DEFAULT
  51 CURL_SSLVERSION_DEFAULT
  52 .SH PROTOCOLS
  53 All
  54 .SH EXAMPLE
  55 .nf
  56 CURL *curl = curl_easy_init();
  57 if(curl) {
  58   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  59
  60   /* ask libcurl to use TLS version 1.0 or later */
  61   curl_easy_setopt(curl, CURLOPT_PROXY_SSLVERSION, CURL_SSLVERSION_TLSv1);
  62
  63   /* Perform the request */
  64   curl_easy_perform(curl);
  65 }
  66 .fi
  67 .SH AVAILABILITY
  68 Added in 7.52.0
  69 .SH RETURN VALUE
  70 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  71 .SH "SEE ALSO"
  72 .BR CURLOPT_USE_SSL "(3), " CURLOPT_HTTP_VERSION "(3), "
  73 .BR CURLOPT_IPRESOLVE "(3) " CURLOPT_SSLVERSION "(3), "
  74