Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_PROXY_SSLVERSION.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2019, 2018, 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 "October 31, 2019" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_PROXY_SSLVERSION \- set preferred proxy TLS/SSL version
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLVERSION, long version);
31: .SH DESCRIPTION
32: Pass a long as parameter to control which version of SSL/TLS to attempt to use
33: when connecting to an HTTPS proxy.
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_TLSv1_0
43: TLSv1.0
44: .IP CURL_SSLVERSION_TLSv1_1
45: TLSv1.1
46: .IP CURL_SSLVERSION_TLSv1_2
47: TLSv1.2
48: .IP CURL_SSLVERSION_TLSv1_3
49: TLSv1.3
50: .RE
51: The maximum TLS version can be set by using \fIone\fP of the
52: CURL_SSLVERSION_MAX_ macros below. It is also possible to OR \fIone\fP of the
53: CURL_SSLVERSION_ macros with \fIone\fP of the CURL_SSLVERSION_MAX_ macros.
54: The MAX macros are not supported for WolfSSL.
55: .RS
56: .IP CURL_SSLVERSION_MAX_DEFAULT
57: The flag defines the maximum supported TLS version as TLSv1.2, or the default
58: value from the SSL library.
59: (Added in 7.54.0)
60: .IP CURL_SSLVERSION_MAX_TLSv1_0
61: The flag defines maximum supported TLS version as TLSv1.0.
62: (Added in 7.54.0)
63: .IP CURL_SSLVERSION_MAX_TLSv1_1
64: The flag defines maximum supported TLS version as TLSv1.1.
65: (Added in 7.54.0)
66: .IP CURL_SSLVERSION_MAX_TLSv1_2
67: The flag defines maximum supported TLS version as TLSv1.2.
68: (Added in 7.54.0)
69: .IP CURL_SSLVERSION_MAX_TLSv1_3
70: The flag defines maximum supported TLS version as TLSv1.3.
71: (Added in 7.54.0)
72: .RE
73:
74: In versions of curl prior to 7.54 the CURL_SSLVERSION_TLS options were
75: documented to allow \fIonly\fP the specified TLS version, but behavior was
76: inconsistent depending on the TLS library.
77:
78: .SH DEFAULT
79: CURL_SSLVERSION_DEFAULT
80: .SH PROTOCOLS
81: All
82: .SH EXAMPLE
83: .nf
84: CURL *curl = curl_easy_init();
85: if(curl) {
86: curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
87:
88: /* ask libcurl to use TLS version 1.0 or later */
89: curl_easy_setopt(curl, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
90:
91: /* Perform the request */
92: curl_easy_perform(curl);
93: }
94: .fi
95: .SH AVAILABILITY
96: Added in 7.52.0
97: .SH RETURN VALUE
98: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
99: .SH "SEE ALSO"
100: .BR CURLOPT_USE_SSL "(3), " CURLOPT_HTTP_VERSION "(3), "
101: .BR CURLOPT_IPRESOLVE "(3) " CURLOPT_SSLVERSION "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>