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