Revert "Imported Upstream version 7.44.0"
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_SSL_OPTIONS.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_SSL_OPTIONS 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_SSL_OPTIONS \- set SSL behavior options
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_OPTIONS, long bitmask);
30 .SH DESCRIPTION
31 Pass a long with a bitmask to tell libcurl about specific SSL behaviors.
32
33 \fICURLSSLOPT_ALLOW_BEAST\fP is the only supported bit and by setting this the
34 user will tell libcurl to not attempt to use any workarounds for a security
35 flaw in the SSL3 and TLS1.0 protocols.  If this option isn't used or this bit
36 is set to 0, the SSL layer libcurl uses may use a work-around for this flaw
37 although it might cause interoperability problems with some (older) SSL
38 implementations. WARNING: avoiding this work-around lessens the security, and
39 by setting this option to 1 you ask for exactly that.
40 .SH DEFAULT
41 0
42 .SH PROTOCOLS
43 All TLS-based protocols
44 .SH EXAMPLE
45 TODO
46 .SH AVAILABILITY
47 Added in 7.25.0
48 .SH RETURN VALUE
49 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
50 .SH "SEE ALSO"
51 .BR CURLOPT_SSLVERSION "(3), " CURLOPT_SSL_CIPHER_LIST "(3), "