docs/libcurl/opts/CURLOPT_SSL_CIPHER_LIST.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, 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_SSL_CIPHER_LIST 3 "May 31, 2017" "libcurl 7.56.1" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_SSL_CIPHER_LIST \- specify ciphers to use for TLS
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_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 SSL connection. The list must be syntactically correct,
  34 it consists of one or more cipher strings separated by colons. Commas or
  35 spaces are also acceptable separators but colons are normally used, \&!, \&-
  36 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://curl.haxx.se/docs/ssl-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 For WolfSSL, valid examples of cipher lists include
  52 \'ECDHE-RSA-RC4-SHA\', 'AES256-SHA:AES256-SHA256', etc.
  53
  54 The application does not have to keep the string around after setting this
  55 option.
  56 .SH DEFAULT
  57 NULL, use internal default
  58 .SH PROTOCOLS
  59 All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  60 .SH EXAMPLE
  61 .nf
  62 CURL *curl = curl_easy_init();
  63 if(curl) {
  64   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  65   curl_easy_setopt(curl, CURLOPT_SSL_CIPHER_LIST, "TLSv1");
  66   ret = curl_easy_perform(curl);
  67   curl_easy_cleanup(curl);
  68 }
  69 .fi
  70 .SH AVAILABILITY
  71 If built TLS enabled.
  72 .SH RETURN VALUE
  73 Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
  74 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  75 .SH "SEE ALSO"
  76 .BR CURLOPT_SSLVERSION "(3), " CURLOPT_USE_SSL "(3), "