SSL_CTX_set_cipher_list.pod revision 68651
168651Skris=pod
268651Skris
368651Skris=head1 NAME
468651Skris
568651SkrisSSL_CTX_set_cipher_list, SSL_set_cipher_list 
668651Skris- choose list of available SSL_CIPHERs
768651Skris
868651Skris=head1 SYNOPSIS
968651Skris
1068651Skris #include <openssl/ssl.h>
1168651Skris
1268651Skris int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str);
1368651Skris int SSL_set_cipher_list(SSL *ssl, const char *str);
1468651Skris
1568651Skris=head1 DESCRIPTION
1668651Skris
1768651SkrisSSL_CTX_set_cipher_list() sets the list of available ciphers for B<ctx>
1868651Skrisusing the control string B<str>. The format of the string is described
1968651Skrisin L<ciphers(1)|ciphers(1)>. The list of ciphers is inherited by all
2068651SkrisB<ssl> objects created from B<ctx>.
2168651Skris
2268651SkrisSSL_set_cipher_list() sets the list of ciphers only for B<ssl>.
2368651Skris
2468651Skris=head1 NOTES
2568651Skris
2668651SkrisThe control string B<str> should be universally usable and not depend
2768651Skrison details of the library configuration (ciphers compiled in). Thus no
2868651Skrissyntax checking takes place. Items that are not recognized, because the
2968651Skriscorresponding ciphers are not compiled in or because they are mistyped,
3068651Skrisare simply ignored. Failure is only flagged if no ciphers could be collected
3168651Skrisat all.
3268651Skris
3368651SkrisIt should be noted, that inclusion of a cipher to be used into the list is
3468651Skrisa necessary condition. On the client side, the inclusion into the list is
3568651Skrisalso sufficient. On the server side, additional restrictions apply. All ciphers
3668651Skrishave additional requirements. ADH ciphers don't need a certificate, but
3768651SkrisDH-parameters must have been set. All other ciphers need a corresponding
3868651Skriscertificate and key. A RSA cipher can only be chosen, when a RSA certificate is
3968651Skrisavailable, the respective is valid for DSA ciphers. Ciphers using EDH need
4068651Skrisa certificate and key and DH-parameters.
4168651Skris
4268651Skris=head1 RETURN VALUES
4368651Skris
4468651SkrisSSL_CTX_set_cipher_list() and SSL_set_cipher_list() return 1 if any cipher
4568651Skriscould be selected and 0 on complete failure.
4668651Skris
4768651Skris=head1 SEE ALSO
4868651Skris
4968651SkrisL<ssl(3)|ssl(3)>, L<SSL_get_ciphers(3)|SSL_get_ciphers(3)>,
5068651SkrisL<ciphers(1)|ciphers(1)>
5168651Skris
5268651Skris=cut
53