CURLOPT_PROXY_SSL_CIPHER_LIST(3)

1CURLOPT_PROXY_SSL_CIPHER_LIScTu(r3l)_easy_setopt optCiUoRnLsOPT_PROXY_SSL_CIPHER_LIST(3)
2
3
4

NAME

6       CURLOPT_PROXY_SSL_CIPHER_LIST - ciphers to use for HTTPS proxy
7

SYNOPSIS

9       #include <curl/curl.h>
10
11       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSL_CIPHER_LIST,
12                                 char *list);
13

DESCRIPTION

15       Pass a char *, pointing to a null-terminated string holding the list of
16       ciphers to use for the connection to the HTTPS proxy. The list must  be
17       syntactically  correct, it consists of one or more cipher strings sepa‐
18       rated by colons. Commas or spaces are also  acceptable  separators  but
19       colons are normally used, !, - and + can be used as operators.
20
21       For  OpenSSL and GnuTLS valid examples of cipher lists include RC4-SHA,
22       SHA1+DES, TLSv1 and DEFAULT. The default list is normally set when  you
23       compile OpenSSL.
24
25       For  NSS,  valid  examples  of  cipher  lists  include rsa_rc4_128_md5,
26       rsa_aes_128_sha, etc. With NSS you do not add/remove  ciphers.  If  one
27       uses  this  option  then  all known ciphers are disabled and only those
28       passed in are enabled.
29
30       For WolfSSL, valid examples of cipher lists include  ECDHE-RSA-RC4-SHA,
31       AES256-SHA:AES256-SHA256, etc.
32
33       For   BearSSL,  valid  examples  of  cipher  lists  include  ECDHE-RSA-
34       CHACHA20-POLY1305:ECDHE-RSA-AES128-GCM-SHA256, or when using IANA names
35       TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256:TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,
36       etc.  With BearSSL you do not add/remove ciphers. If one uses this  op‐
37       tion  then  all known ciphers are disabled and only those passed in are
38       enabled.
39
40       you will find more details about cipher lists on this URL:
41
42        https://curl.se/docs/ssl-ciphers.html
43
44       The application does not have to keep the string around  after  setting
45       this option.
46

DEFAULT

48       NULL, use internal default
49

PROTOCOLS

51       All
52

EXAMPLE

54       CURL *curl = curl_easy_init();
55       if(curl) {
56         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
57         curl_easy_setopt(curl, CURLOPT_PROXY, "https://localhost");
58         curl_easy_setopt(curl, CURLOPT_PROXY_SSL_CIPHER_LIST, "TLSv1");
59         ret = curl_easy_perform(curl);
60         curl_easy_cleanup(curl);
61       }
62

AVAILABILITY

64       Added in 7.52.0, in 7.83.0 for BearSSL
65
66       If built TLS enabled.
67

RETURN VALUE

69       Returns  CURLE_OK  if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
70       CURLE_OUT_OF_MEMORY if there was insufficient heap space.
71