RT1941: c_rehash.pod is missing
[openssl.git] / doc / ssl / SSL_get_ciphers.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_get_ciphers, SSL_get_cipher_list - get list of available SSL_CIPHERs
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *ssl);
12  const char *SSL_get_cipher_list(const SSL *ssl, int priority);
13
14 =head1 DESCRIPTION
15
16 SSL_get_ciphers() returns the stack of available SSL_CIPHERs for B<ssl>,
17 sorted by preference. If B<ssl> is NULL or no ciphers are available, NULL
18 is returned.
19
20 SSL_get_cipher_list() returns a pointer to the name of the SSL_CIPHER
21 listed for B<ssl> with B<priority>. If B<ssl> is NULL, no ciphers are
22 available, or there are less ciphers than B<priority> available, NULL
23 is returned.
24
25 =head1 NOTES
26
27 The details of the ciphers obtained by SSL_get_ciphers() can be obtained using
28 the L<SSL_CIPHER_get_name(3)|SSL_CIPHER_get_name(3)> family of functions.
29
30 Call SSL_get_cipher_list() with B<priority> starting from 0 to obtain the
31 sorted list of available ciphers, until NULL is returned.
32
33 =head1 RETURN VALUES
34
35 See DESCRIPTION
36
37 =head1 SEE ALSO
38
39 L<ssl(3)|ssl(3)>, L<SSL_CTX_set_cipher_list(3)|SSL_CTX_set_cipher_list(3)>,
40 L<SSL_CIPHER_get_name(3)|SSL_CIPHER_get_name(3)>
41
42 =cut