docs/libcurl/opts/CURLOPT_PROXY_SSL_CIPHER_LIST.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2016, 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 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_PROXY_SSL_CIPHER_LIST \- specify ciphers to use for proxy TLS
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_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 connection to the HTTPS proxy. The list must be
  33 syntactically correct, it consists of one or more cipher strings separated by
  34 colons. Commas or spaces are also acceptable separators but colons are
  35 normally used, \&!, \&- 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  https://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
  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
  60 .SH EXAMPLE
  61 TODO
  62 .SH AVAILABILITY
  63 Added in 7.52.0
  64
  65 If built TLS enabled.
  66 .SH RETURN VALUE
  67 Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
  68 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  69 .SH "SEE ALSO"
  70 .BR CURLOPT_PROXY_SSLVERSION "(3), " CURLOPT_USE_SSL "(3), "
  71 .BR CURLOPT_SSLVERSION "(3), "