doc/ssl/SSL_CTX_set_cipher_list.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_CTX_set_cipher_list, SSL_set_cipher_list
   6 - choose list of available SSL_CIPHERs
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/ssl.h>
  11
  12  int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str);
  13  int SSL_set_cipher_list(SSL *ssl, const char *str);
  14
  15 =head1 DESCRIPTION
  16
  17 SSL_CTX_set_cipher_list() sets the list of available ciphers for B<ctx>
  18 using the control string B<str>. The format of the string is described
  19 in L<ciphers(1)|ciphers(1)>. The list of ciphers is inherited by all
  20 B<ssl> objects created from B<ctx>.
  21
  22 SSL_set_cipher_list() sets the list of ciphers only for B<ssl>.
  23
  24 =head1 NOTES
  25
  26 The control string B<str> should be universally usable and not depend
  27 on details of the library configuration (ciphers compiled in). Thus no
  28 syntax checking takes place. Items that are not recognized, because the
  29 corresponding ciphers are not compiled in or because they are mistyped,
  30 are simply ignored. Failure is only flagged if no ciphers could be collected
  31 at all.
  32
  33 It should be noted, that inclusion of a cipher to be used into the list is
  34 a necessary condition. On the client side, the inclusion into the list is
  35 also sufficient. On the server side, additional restrictions apply. All ciphers
  36 have additional requirements. ADH ciphers don't need a certificate, but
  37 DH-parameters must have been set. All other ciphers need a corresponding
  38 certificate and key. A RSA cipher can only be chosen, when a RSA certificate is
  39 available, the respective is valid for DSA ciphers. Ciphers using EDH need
  40 a certificate and key and DH-parameters.
  41
  42 =head1 RETURN VALUES
  43
  44 SSL_CTX_set_cipher_list() and SSL_set_cipher_list() return 1 if any cipher
  45 could be selected and 0 on complete failure.
  46
  47 =head1 SEE ALSO
  48
  49 L<ssl(3)|ssl(3)>, L<SSL_get_ciphers(3)|SSL_get_ciphers(3)>,
  50 L<ciphers(1)|ciphers(1)>
  51
  52 =cut