mirror of
https://github.com/moparisthebest/curl
synced 2024-11-16 14:35:03 -05:00
032e838b73
Updated terminology in docs, comments and phrases to refer to C strings as "null-terminated". Done to unify with how most other C oriented docs refer of them and what users in general seem to prefer (based on a single highly unscientific poll on twitter). Reported-by: coinhubs on github Fixes #5598 Closes #5608
69 lines
2.7 KiB
Groff
69 lines
2.7 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
.\" *
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
.\" * you should have received as part of this distribution. The terms
|
|
.\" * are also available at https://curl.haxx.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH CURLOPT_TLS13_CIPHERS 3 "25 May 2018" "libcurl 7.61.0" "curl_easy_setopt options"
|
|
.SH NAME
|
|
CURLOPT_TLS13_CIPHERS \- specify ciphers suites to use for TLS 1.3
|
|
.SH SYNOPSIS
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TLS13_CIPHERS, char *list);
|
|
.SH DESCRIPTION
|
|
Pass a char *, pointing to a null-terminated string holding the list of cipher
|
|
suites to use for the TLS 1.3 connection. The list must be syntactically
|
|
correct, it consists of one or more cipher suite strings separated by colons.
|
|
|
|
You'll find more details about cipher lists on this URL:
|
|
|
|
https://curl.haxx.se/docs/ssl-ciphers.html
|
|
|
|
This option is currently used only when curl is built to use OpenSSL 1.1.1 or
|
|
later. If you are using a different SSL backend you can try setting TLS 1.3
|
|
cipher suites by using the CURLOPT_SSL_CIPHER_LIST option.
|
|
|
|
The application does not have to keep the string around after setting this
|
|
option.
|
|
.SH DEFAULT
|
|
NULL, use internal default
|
|
.SH PROTOCOLS
|
|
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
|
|
.SH EXAMPLE
|
|
.nf
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
|
|
curl_easy_setopt(curl, CURLOPT_TLS13_CIPHERS,
|
|
"TLS13-CHACHA20-POLY1305-SHA256");
|
|
ret = curl_easy_perform(curl);
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in 7.61.0.
|
|
Available when built with OpenSSL >= 1.1.1.
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if supported, CURLE_NOT_BUILT_IN otherwise.
|
|
.SH "SEE ALSO"
|
|
.BR CURLOPT_SSL_CIPHER_LIST "(3), " CURLOPT_SSLVERSION "(3), "
|
|
.BR CURLOPT_PROXY_SSL_CIPHER_LIST "(3), " CURLOPT_PROXY_TLS13_CIPHERS "(3), "
|
|
.BR CURLOPT_PROXY_SSLVERSION "(3), " CURLOPT_USE_SSL "(3), "
|