docs/libcurl/opts/CURLOPT_SSL_CIPHER_LIST.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 http://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 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_SSL_CIPHER_LIST \- specify ciphers to use for TLS
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_CIPHER_LIST, char *list);
  30 .SH DESCRIPTION
  31 Pass a char *, pointing to a zero terminated string holding the list of
  32 ciphers to use for the SSL connection. The list must be syntactically correct,
  33 it consists of one or more cipher strings separated by colons. Commas or
  34 spaces are also acceptable separators but colons are normally used, \&!, \&-
  35 and \&+ can be used as operators.
  36
  37 For OpenSSL and GnuTLS valid examples of cipher lists include 'RC4-SHA',
  38 \'SHA1+DES\', 'TLSv1' and 'DEFAULT'. The default list is normally set when you
  39 compile OpenSSL.
  40
  41 You'll find more details about cipher lists on this URL:
  42
  43  http://www.openssl.org/docs/apps/ciphers.html
  44
  45 For NSS, valid examples of cipher lists include 'rsa_rc4_128_md5',
  46 \'rsa_aes_128_sha\', etc. With NSS you don't add/remove ciphers. If one uses
  47 this option then all known ciphers are disabled and only those passed in are
  48 enabled.
  49
  50 You'll find more details about the NSS cipher lists on this URL:
  51
  52  http://git.fedorahosted.org/cgit/mod_nss.git/plain/docs/mod_nss.html#Directives
  53 .SH DEFAULT
  54 NULL, use internal default
  55 .SH PROTOCOLS
  56 All TLS based protocols: HTTPS, FTPS, IMAPS, POP3, SMTPS etc.
  57 .SH EXAMPLE
  58 TODO
  59 .SH AVAILABILITY
  60 If built TLS enabled.
  61 .SH RETURN VALUE
  62 Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
  63 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  64 .SH "SEE ALSO"
  65 .BR CURLOPT_SSLVERSION "(3), " CURLOPT_USE_SSL "(3), "