Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_SSL_CIPHER_LIST (3)

Name

CURLOPT_SSL_CIPHER_LIST - ciphers to use for TLS

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_CIPHER_LIST, char *list);

Description

curl_easy_setopt options                            CURLOPT_SSL_CIPHER_LIST(3)



NAME
       CURLOPT_SSL_CIPHER_LIST - ciphers to use for TLS

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_CIPHER_LIST, char *list);

DESCRIPTION
       Pass a char *, pointing to a null-terminated string holding the list of
       ciphers to use for the SSL connection. The list must  be  syntactically
       correct, it consists of one or more cipher strings separated by colons.
       Commas or spaces are also acceptable separators but colons are normally
       used, !, - and + can be used as operators.

       For  OpenSSL and GnuTLS valid examples of cipher lists include RC4-SHA,
       SHA1+DES, TLSv1 and DEFAULT. The default list is normally set when  you
       compile OpenSSL.

       For  NSS,  valid  examples  of  cipher  lists  include rsa_rc4_128_md5,
       rsa_aes_128_sha, etc. With NSS you do not add/remove  ciphers.  If  one
       uses  this  option  then  all known ciphers are disabled and only those
       passed in are enabled.

       For WolfSSL, valid examples of cipher lists include  ECDHE-RSA-RC4-SHA,
       AES256-SHA:AES256-SHA256, etc.

       For   BearSSL,  valid  examples  of  cipher  lists  include  ECDHE-RSA-
       CHACHA20-POLY1305:ECDHE-RSA-AES128-GCM-SHA256, or when using IANA names
       TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256:TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,
       etc.  With BearSSL you do not add/remove  ciphers.  If  one  uses  this
       option then all known ciphers are disabled and only those passed in are
       enabled.

       you will find more details about cipher lists on this URL:

        https://curl.se/docs/ssl-ciphers.html

       The application does not have to keep the string around  after  setting
       this option.

DEFAULT
       NULL, use internal default

PROTOCOLS
       All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
         curl_easy_setopt(curl, CURLOPT_SSL_CIPHER_LIST, "TLSv1");
         ret = curl_easy_perform(curl);
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in 7.9, in 7.83.0 for BearSSL

       If built TLS enabled.

RETURN VALUE
       Returns  CURLE_OK  if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
       CURLE_OUT_OF_MEMORY if there was insufficient heap space.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       CURLOPT_TLS13_CIPHERS(3),          CURLOPT_SSLVERSION(3),          CUR-
       LOPT_PROXY_SSL_CIPHER_LIST(3),   CURLOPT_PROXY_TLS13_CIPHERS(3),   CUR-
       LOPT_USE_SSL(3),



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source      was      downloaded       from        https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                 December 06, 2021
                                                    CURLOPT_SSL_CIPHER_LIST(3)