docs/libcurl/opts/CURLOPT_SSLVERSION.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 http://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 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_SSLVERSION \- set preferred TLS/SSL version
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLVERSION, long version);
  30 .SH DESCRIPTION
  31 Pass a long as parameter to control which version of SSL/TLS to attempt to
  32 use.
  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, i.e. either SSLv3 or TLSv1
  39 .IP CURL_SSLVERSION_TLSv1
  40 TLSv1.x
  41 .IP CURL_SSLVERSION_SSLv2
  42 SSLv2
  43 .IP CURL_SSLVERSION_SSLv3
  44 SSLv3
  45 .IP CURL_SSLVERSION_TLSv1_0
  46 TLSv1.0 (Added in 7.34.0)
  47 .IP CURL_SSLVERSION_TLSv1_1
  48 TLSv1.1 (Added in 7.34.0)
  49 .IP CURL_SSLVERSION_TLSv1_2
  50 TLSv1.2 (Added in 7.34.0)
  51 .RE
  52 .SH DEFAULT
  53 CURL_SSLVERSION_DEFAULT
  54 .SH PROTOCOLS
  55 All TLS based protocols: HTTPS, FTPS, IMAPS, POP3, SMTPS etc.
  56 .SH EXAMPLE
  57 TODO
  58 .SH AVAILABILITY
  59 SSLv2 is disabled by default since 7.18.1
  60 .SH RETURN VALUE
  61 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  62 .SH "SEE ALSO"
  63 .BR CURLOPT_USE_SSL "(3), " CURLOPT_HTTP_VERSION "(3), "