docs/libcurl/opts/CURLOPT_SSLVERSION.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2015, 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_SSLVERSION 3 "January 10, 2018" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_SSLVERSION \- set preferred TLS/SSL version
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLVERSION, long version);
  31 .SH DESCRIPTION
  32 Pass a long as parameter to control which version of SSL/TLS to attempt to
  33 use.
  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_SSLv2
  43 SSLv2
  44 .IP CURL_SSLVERSION_SSLv3
  45 SSLv3
  46 .IP CURL_SSLVERSION_TLSv1_0
  47 TLSv1.0 (Added in 7.34.0)
  48 .IP CURL_SSLVERSION_TLSv1_1
  49 TLSv1.1 (Added in 7.34.0)
  50 .IP CURL_SSLVERSION_TLSv1_2
  51 TLSv1.2 (Added in 7.34.0)
  52 .IP CURL_SSLVERSION_TLSv1_3
  53 TLSv1.3 (Added in 7.52.0)
  54 .RE
  55 The maximum TLS version can be set by using \fIone\fP of the
  56 CURL_SSLVERSION_MAX_ macros below. It is also possible to OR \fIone\fP of the
  57 CURL_SSLVERSION_ macros with \fIone\fP of the CURL_SSLVERSION_MAX_ macros.
  58 The MAX macros are not supported for SSL backends axTLS or wolfSSL.
  59 .RS
  60 .IP CURL_SSLVERSION_MAX_DEFAULT
  61 The flag defines the maximum supported TLS version as TLSv1.2, or the default
  62 value from the SSL library.
  63 (Added in 7.54.0)
  64 .IP CURL_SSLVERSION_MAX_TLSv1_0
  65 The flag defines maximum supported TLS version as TLSv1.0.
  66 (Added in 7.54.0)
  67 .IP CURL_SSLVERSION_MAX_TLSv1_1
  68 The flag defines maximum supported TLS version as TLSv1.1.
  69 (Added in 7.54.0)
  70 .IP CURL_SSLVERSION_MAX_TLSv1_2
  71 The flag defines maximum supported TLS version as TLSv1.2.
  72 (Added in 7.54.0)
  73 .IP CURL_SSLVERSION_MAX_TLSv1_3
  74 The flag defines maximum supported TLS version as TLSv1.3.
  75 (Added in 7.54.0)
  76 .RE
  77 .SH DEFAULT
  78 CURL_SSLVERSION_DEFAULT
  79 .SH PROTOCOLS
  80 All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  81 .SH EXAMPLE
  82 .nf
  83 CURL *curl = curl_easy_init();
  84 if(curl) {
  85   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  86
  87   /* ask libcurl to use TLS version 1.0 or later */
  88   curl_easy_setopt(curl, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
  89
  90   /* Perform the request */
  91   curl_easy_perform(curl);
  92 }
  93 .fi
  94 .SH AVAILABILITY
  95 SSLv2 is disabled by default since 7.18.1. Other SSL versions availability may
  96 vary depending on which backend libcurl has been built to use.
  97
  98 SSLv3 is disabled by default since 7.39.0.
  99 .SH RETURN VALUE
 100 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
 101 .SH "SEE ALSO"
 102 .BR CURLOPT_USE_SSL "(3), " CURLOPT_HTTP_VERSION "(3), "
 103 .BR CURLOPT_IPRESOLVE "(3) "