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