f2a81037c04ae46f57347384ddccb6732ddf5b66
[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  STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *ssl);
13  const char *SSL_get_cipher_list(const SSL *ssl, int priority);
14
15 =head1 DESCRIPTION
16
17 SSL_get_ciphers() returns the stack of available SSL_CIPHERs for B<ssl>,
18 sorted by preference. If B<ssl> is NULL or no ciphers are available, NULL
19 is returned.
20
21 SSL_get_client_ciphers() returns the stack of available SSL_CIPHERS matching the
22 list sent by the client for B<ssl>. If B<ssl> is NULL, no ciphers are
23 available, or B<ssl> is not operating in server mode, NULL is returned.
24
25 SSL_get_cipher_list() returns a pointer to the name of the SSL_CIPHER
26 listed for B<ssl> with B<priority>. If B<ssl> is NULL, no ciphers are
27 available, or there are less ciphers than B<priority> available, NULL
28 is returned.
29
30 =head1 NOTES
31
32 The details of the ciphers obtained by SSL_get_ciphers() can be obtained using
33 the L<SSL_CIPHER_get_name(3)|SSL_CIPHER_get_name(3)> family of functions.
34
35 Call SSL_get_cipher_list() with B<priority> starting from 0 to obtain the
36 sorted list of available ciphers, until NULL is returned.
37
38 =head1 RETURN VALUES
39
40 See DESCRIPTION
41
42 =head1 SEE ALSO
43
44 L<ssl(3)|ssl(3)>, L<SSL_CTX_set_cipher_list(3)|SSL_CTX_set_cipher_list(3)>,
45 L<SSL_CIPHER_get_name(3)|SSL_CIPHER_get_name(3)>
46
47 =cut