Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_TLS13_CIPHERS.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2019, 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_TLS13_CIPHERS 3 "October 31, 2019" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_TLS13_CIPHERS \- specify ciphers suites to use for TLS 1.3
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TLS13_CIPHERS, char *list);
31: .SH DESCRIPTION
32: Pass a char *, pointing to a zero terminated string holding the list of cipher
33: suites to use for the TLS 1.3 connection. The list must be syntactically
34: correct, it consists of one or more cipher suite strings separated by colons.
35:
36: You'll find more details about cipher lists on this URL:
37:
38: https://curl.haxx.se/docs/ssl-ciphers.html
39:
40: This option is currently used only when curl is built to use OpenSSL 1.1.1 or
41: later. If you are using a different SSL backend you can try setting TLS 1.3
42: cipher suites by using the CURLOPT_SSL_CIPHER_LIST option.
43:
44: The application does not have to keep the string around after setting this
45: option.
46: .SH DEFAULT
47: NULL, use internal default
48: .SH PROTOCOLS
49: All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
50: .SH EXAMPLE
51: .nf
52: CURL *curl = curl_easy_init();
53: if(curl) {
54: curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
55: curl_easy_setopt(curl, CURLOPT_TLS13_CIPHERS,
56: "TLS13-CHACHA20-POLY1305-SHA256");
57: ret = curl_easy_perform(curl);
58: curl_easy_cleanup(curl);
59: }
60: .fi
61: .SH AVAILABILITY
62: Added in 7.61.0.
63: Available when built with OpenSSL >= 1.1.1.
64: .SH RETURN VALUE
65: Returns CURLE_OK if supported, CURLE_NOT_BUILT_IN otherwise.
66: .SH "SEE ALSO"
67: .BR CURLOPT_SSL_CIPHER_LIST "(3), " CURLOPT_SSLVERSION "(3), "
68: .BR CURLOPT_PROXY_SSL_CIPHER_LIST "(3), " CURLOPT_PROXY_TLS13_CIPHERS "(3), "
69: .BR CURLOPT_PROXY_SSLVERSION "(3), " CURLOPT_USE_SSL "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>