xref: /onnv-gate/usr/src/common/openssl/doc/ssl/SSL_get_ciphers.pod (revision 2175:b0b2f052a486)
1*2175Sjp161948=pod
2*2175Sjp161948
3*2175Sjp161948=head1 NAME
4*2175Sjp161948
5*2175Sjp161948SSL_get_ciphers, SSL_get_cipher_list - get list of available SSL_CIPHERs
6*2175Sjp161948
7*2175Sjp161948=head1 SYNOPSIS
8*2175Sjp161948
9*2175Sjp161948 #include <openssl/ssl.h>
10*2175Sjp161948
11*2175Sjp161948 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *ssl);
12*2175Sjp161948 const char *SSL_get_cipher_list(const SSL *ssl, int priority);
13*2175Sjp161948
14*2175Sjp161948=head1 DESCRIPTION
15*2175Sjp161948
16*2175Sjp161948SSL_get_ciphers() returns the stack of available SSL_CIPHERs for B<ssl>,
17*2175Sjp161948sorted by preference. If B<ssl> is NULL or no ciphers are available, NULL
18*2175Sjp161948is returned.
19*2175Sjp161948
20*2175Sjp161948SSL_get_cipher_list() returns a pointer to the name of the SSL_CIPHER
21*2175Sjp161948listed for B<ssl> with B<priority>. If B<ssl> is NULL, no ciphers are
22*2175Sjp161948available, or there are less ciphers than B<priority> available, NULL
23*2175Sjp161948is returned.
24*2175Sjp161948
25*2175Sjp161948=head1 NOTES
26*2175Sjp161948
27*2175Sjp161948The details of the ciphers obtained by SSL_get_ciphers() can be obtained using
28*2175Sjp161948the L<SSL_CIPHER_get_name(3)|SSL_CIPHER_get_name(3)> family of functions.
29*2175Sjp161948
30*2175Sjp161948Call SSL_get_cipher_list() with B<priority> starting from 0 to obtain the
31*2175Sjp161948sorted list of available ciphers, until NULL is returned.
32*2175Sjp161948
33*2175Sjp161948=head1 RETURN VALUES
34*2175Sjp161948
35*2175Sjp161948See DESCRIPTION
36*2175Sjp161948
37*2175Sjp161948=head1 SEE ALSO
38*2175Sjp161948
39*2175Sjp161948L<ssl(3)|ssl(3)>, L<SSL_CTX_set_cipher_list(3)|SSL_CTX_set_cipher_list(3)>,
40*2175Sjp161948L<SSL_CIPHER_get_name(3)|SSL_CIPHER_get_name(3)>
41*2175Sjp161948
42*2175Sjp161948=cut
43