xref: /minix3/crypto/external/bsd/openssl/dist/doc/ssl/SSL_get_ciphers.pod (revision ebfedea0ce5bbe81e252ddf32d732e40fb633fae)
1*ebfedea0SLionel Sambuc=pod
2*ebfedea0SLionel Sambuc
3*ebfedea0SLionel Sambuc=head1 NAME
4*ebfedea0SLionel Sambuc
5*ebfedea0SLionel SambucSSL_get_ciphers, SSL_get_cipher_list - get list of available SSL_CIPHERs
6*ebfedea0SLionel Sambuc
7*ebfedea0SLionel Sambuc=head1 SYNOPSIS
8*ebfedea0SLionel Sambuc
9*ebfedea0SLionel Sambuc #include <openssl/ssl.h>
10*ebfedea0SLionel Sambuc
11*ebfedea0SLionel Sambuc STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *ssl);
12*ebfedea0SLionel Sambuc const char *SSL_get_cipher_list(const SSL *ssl, int priority);
13*ebfedea0SLionel Sambuc
14*ebfedea0SLionel Sambuc=head1 DESCRIPTION
15*ebfedea0SLionel Sambuc
16*ebfedea0SLionel SambucSSL_get_ciphers() returns the stack of available SSL_CIPHERs for B<ssl>,
17*ebfedea0SLionel Sambucsorted by preference. If B<ssl> is NULL or no ciphers are available, NULL
18*ebfedea0SLionel Sambucis returned.
19*ebfedea0SLionel Sambuc
20*ebfedea0SLionel SambucSSL_get_cipher_list() returns a pointer to the name of the SSL_CIPHER
21*ebfedea0SLionel Sambuclisted for B<ssl> with B<priority>. If B<ssl> is NULL, no ciphers are
22*ebfedea0SLionel Sambucavailable, or there are less ciphers than B<priority> available, NULL
23*ebfedea0SLionel Sambucis returned.
24*ebfedea0SLionel Sambuc
25*ebfedea0SLionel Sambuc=head1 NOTES
26*ebfedea0SLionel Sambuc
27*ebfedea0SLionel SambucThe details of the ciphers obtained by SSL_get_ciphers() can be obtained using
28*ebfedea0SLionel Sambucthe L<SSL_CIPHER_get_name(3)|SSL_CIPHER_get_name(3)> family of functions.
29*ebfedea0SLionel Sambuc
30*ebfedea0SLionel SambucCall SSL_get_cipher_list() with B<priority> starting from 0 to obtain the
31*ebfedea0SLionel Sambucsorted list of available ciphers, until NULL is returned.
32*ebfedea0SLionel Sambuc
33*ebfedea0SLionel Sambuc=head1 RETURN VALUES
34*ebfedea0SLionel Sambuc
35*ebfedea0SLionel SambucSee DESCRIPTION
36*ebfedea0SLionel Sambuc
37*ebfedea0SLionel Sambuc=head1 SEE ALSO
38*ebfedea0SLionel Sambuc
39*ebfedea0SLionel SambucL<ssl(3)|ssl(3)>, L<SSL_CTX_set_cipher_list(3)|SSL_CTX_set_cipher_list(3)>,
40*ebfedea0SLionel SambucL<SSL_CIPHER_get_name(3)|SSL_CIPHER_get_name(3)>
41*ebfedea0SLionel Sambuc
42*ebfedea0SLionel Sambuc=cut
43