Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_PROXY_SSL_CIPHER_LIST.3, revision 1.1
1.1 ! misho 1: .\" **************************************************************************
! 2: .\" * _ _ ____ _
! 3: .\" * Project ___| | | | _ \| |
! 4: .\" * / __| | | | |_) | |
! 5: .\" * | (__| |_| | _ <| |___
! 6: .\" * \___|\___/|_| \_\_____|
! 7: .\" *
! 8: .\" * Copyright (C) 1998 - 2020, 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_SSL_CIPHER_LIST 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
! 24:
! 25: .SH NAME
! 26: CURLOPT_PROXY_SSL_CIPHER_LIST \- specify ciphers to use for proxy TLS
! 27: .SH SYNOPSIS
! 28: #include <curl/curl.h>
! 29:
! 30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSL_CIPHER_LIST, char *list);
! 31: .SH DESCRIPTION
! 32: Pass a char *, pointing to a zero terminated string holding the list of
! 33: ciphers to use for the connection to the HTTPS proxy. The list must be
! 34: syntactically correct, it consists of one or more cipher strings separated by
! 35: colons. Commas or spaces are also acceptable separators but colons are
! 36: normally used, \&!, \&- and \&+ can be used as operators.
! 37:
! 38: For OpenSSL and GnuTLS valid examples of cipher lists include 'RC4-SHA',
! 39: \'SHA1+DES\', 'TLSv1' and 'DEFAULT'. The default list is normally set when you
! 40: compile OpenSSL.
! 41:
! 42: You'll find more details about cipher lists on this URL:
! 43:
! 44: https://www.openssl.org/docs/apps/ciphers.html
! 45:
! 46: For NSS, valid examples of cipher lists include 'rsa_rc4_128_md5',
! 47: \'rsa_aes_128_sha\', etc. With NSS you don't add/remove ciphers. If one uses
! 48: this option then all known ciphers are disabled and only those passed in are
! 49: enabled.
! 50:
! 51: You'll find more details about the NSS cipher lists on this URL:
! 52:
! 53: http://git.fedorahosted.org/cgit/mod_nss.git/plain/docs/mod_nss.html#Directives
! 54:
! 55: The application does not have to keep the string around after setting this
! 56: option.
! 57: .SH DEFAULT
! 58: NULL, use internal default
! 59: .SH PROTOCOLS
! 60: All
! 61: .SH EXAMPLE
! 62: .nf
! 63: CURL *curl = curl_easy_init();
! 64: if(curl) {
! 65: curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
! 66: curl_easy_setopt(curl, CURLOPT_PROXY, "https://localhost");
! 67: curl_easy_setopt(curl, CURLOPT_PROXY_SSL_CIPHER_LIST, "TLSv1");
! 68: ret = curl_easy_perform(curl);
! 69: curl_easy_cleanup(curl);
! 70: }
! 71: .fi
! 72: .SH AVAILABILITY
! 73: Added in 7.52.0
! 74:
! 75: If built TLS enabled.
! 76: .SH RETURN VALUE
! 77: Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
! 78: CURLE_OUT_OF_MEMORY if there was insufficient heap space.
! 79: .SH "SEE ALSO"
! 80: .BR CURLOPT_PROXY_TLS13_CIPHERS "(3), " CURLOPT_PROXY_SSLVERSION "(3), "
! 81: .BR CURLOPT_SSL_CIPHER_LIST "(3), " CURLOPT_TLS13_CIPHERS "(3), "
! 82: .BR CURLOPT_SSLVERSION "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>