docs/libcurl/opts/CURLOPT_SSL_OPTIONS.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, 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_SSL_OPTIONS 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_SSL_OPTIONS \- set SSL behavior options
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_OPTIONS, long bitmask);
  31 .SH DESCRIPTION
  32 Pass a long with a bitmask to tell libcurl about specific SSL behaviors.
  33
  34 \fICURLSSLOPT_ALLOW_BEAST\fP tells libcurl to not attempt to use any
  35 workarounds for a security flaw in the SSL3 and TLS1.0 protocols.  If this
  36 option isn't used or this bit is set to 0, the SSL layer libcurl uses may use a
  37 work-around for this flaw although it might cause interoperability problems
  38 with some (older) SSL implementations. WARNING: avoiding this work-around
  39 lessens the security, and by setting this option to 1 you ask for exactly that.
  40 This option is only supported for DarwinSSL, NSS and OpenSSL.
  41
  42 Added in 7.44.0:
  43
  44 \fICURLSSLOPT_NO_REVOKE\fP tells libcurl to disable certificate revocation
  45 checks for those SSL backends where such behavior is present. \fBCurrently this
  46 option is only supported for WinSSL (the native Windows SSL library), with an
  47 exception in the case of Windows' Untrusted Publishers blacklist which it seems
  48 can't be bypassed.\fP This option may have broader support to accommodate other
  49 SSL backends in the future.
  50 https://curl.haxx.se/docs/ssl-compared.html
  51 .SH DEFAULT
  52 0
  53 .SH PROTOCOLS
  54 All TLS-based protocols
  55 .SH EXAMPLE
  56 .nf
  57 CURL *curl = curl_easy_init();
  58 if(curl) {
  59   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  60   /* weaken TLS only for use with silly servers */
  61   curl_easy_setopt(curl, CURLOPT_SSL_OPTIONS, CURLSSLOPT_ALLOW_BEAST |
  62                    CURLSSLOPT_NO_REVOKE);
  63   ret = curl_easy_perform(curl);
  64   curl_easy_cleanup(curl);
  65 }
  66 .fi
  67 .SH AVAILABILITY
  68 Added in 7.25.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_SSLVERSION "(3), " CURLOPT_SSL_CIPHER_LIST "(3), "