doc/man3/SSL_CTX_set_cipher_list.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_CTX_set_cipher_list, SSL_set_cipher_list - choose list of available SSL_CIPHERs
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/ssl.h>
  10
  11  int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str);
  12  int SSL_set_cipher_list(SSL *ssl, const char *str);
  13
  14 =head1 DESCRIPTION
  15
  16 SSL_CTX_set_cipher_list() sets the list of available ciphers for B<ctx>
  17 using the control string B<str>. The format of the string is described
  18 in L<ciphers(1)>. The list of ciphers is inherited by all
  19 B<ssl> objects created from B<ctx>.
  20
  21 SSL_set_cipher_list() sets the list of ciphers only for B<ssl>.
  22
  23 =head1 NOTES
  24
  25 The control string B<str> should be universally usable and not depend
  26 on details of the library configuration (ciphers compiled in). Thus no
  27 syntax checking takes place. Items that are not recognized, because the
  28 corresponding ciphers are not compiled in or because they are mistyped,
  29 are simply ignored. Failure is only flagged if no ciphers could be collected
  30 at all.
  31
  32 It should be noted, that inclusion of a cipher to be used into the list is
  33 a necessary condition. On the client side, the inclusion into the list is
  34 also sufficient unless the security level excludes it. On the server side,
  35 additional restrictions apply. All ciphers have additional requirements.
  36 ADH ciphers don't need a certificate, but DH-parameters must have been set.
  37 All other ciphers need a corresponding certificate and key.
  38
  39 A RSA cipher can only be chosen, when a RSA certificate is available.
  40 RSA ciphers using DHE need a certificate and key and additional DH-parameters
  41 (see L<SSL_CTX_set_tmp_dh_callback(3)>).
  42
  43 A DSA cipher can only be chosen, when a DSA certificate is available.
  44 DSA ciphers always use DH key exchange and therefore need DH-parameters
  45 (see L<SSL_CTX_set_tmp_dh_callback(3)>).
  46
  47 When these conditions are not met for any cipher in the list (e.g. a
  48 client only supports export RSA ciphers with an asymmetric key length
  49 of 512 bits and the server is not configured to use temporary RSA
  50 keys), the "no shared cipher" (SSL_R_NO_SHARED_CIPHER) error is generated
  51 and the handshake will fail.
  52
  53 =head1 RETURN VALUES
  54
  55 SSL_CTX_set_cipher_list() and SSL_set_cipher_list() return 1 if any cipher
  56 could be selected and 0 on complete failure.
  57
  58 =head1 SEE ALSO
  59
  60 L<ssl(7)>, L<SSL_get_ciphers(3)>,
  61 L<SSL_CTX_use_certificate(3)>,
  62 L<SSL_CTX_set_tmp_dh_callback(3)>,
  63 L<ciphers(1)>
  64
  65 =head1 COPYRIGHT
  66
  67 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
  68
  69 Licensed under the OpenSSL license (the "License").  You may not use
  70 this file except in compliance with the License.  You can obtain a copy
  71 in the file LICENSE in the source distribution or at
  72 L<https://www.openssl.org/source/license.html>.
  73
  74 =cut