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

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>