d91afc293316321d3c12e589f6ca08a233c0aa36
[openssl.git] / doc / man3 / SSL_get_ciphers.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_get1_supported_ciphers, SSL_get_client_ciphers,
6 SSL_get_ciphers, SSL_CTX_get_ciphers,
7 SSL_bytes_to_cipher_list, SSL_get_cipher_list
8 - get list of available SSL_CIPHERs
9
10 =head1 SYNOPSIS
11
12  #include <openssl/ssl.h>
13
14  STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *ssl);
15  STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx);
16  STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s);
17  STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *ssl);
18  int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
19                               int isv2format, STACK_OF(SSL_CIPHER) **sk,
20                               STACK_OF(SSL_CIPHER) **scsvs);
21  const char *SSL_get_cipher_list(const SSL *ssl, int priority);
22
23 =head1 DESCRIPTION
24
25 SSL_get_ciphers() returns the stack of available SSL_CIPHERs for B<ssl>,
26 sorted by preference. If B<ssl> is NULL or no ciphers are available, NULL
27 is returned.
28
29 SSL_CTX_get_ciphers() returns the stack of available SSL_CIPHERs for B<ctx>.
30
31 SSL_get1_supported_ciphers() returns the stack of enabled SSL_CIPHERs for
32 B<ssl> as would be sent in a ClientHello (that is, sorted by preference).
33 The list depends on settings like the cipher list, the supported protocol
34 versions, the security level, and the enabled signature algorithms.
35 SRP and PSK ciphers are only enabled if the appropriate callbacks or settings
36 have been applied.
37 The list of ciphers that would be sent in a ClientHello can differ from
38 the list of ciphers that would be acceptable when acting as a server.
39 For example, additional ciphers may be usable by a server if there is
40 a gap in the list of supported protocols, and some ciphers may not be
41 usable by a server if there is not a suitable certificate configured.
42 If B<ssl> is NULL or no ciphers are available, NULL is returned.
43
44 SSL_get_client_ciphers() returns the stack of available SSL_CIPHERs matching the
45 list received from the client on B<ssl>. If B<ssl> is NULL, no ciphers are
46 available, or B<ssl> is not operating in server mode, NULL is returned.
47
48 SSL_bytes_to_cipher_list() treats the supplied B<len> octets in B<bytes>
49 as a wire-protocol cipher suite specification (in the three-octet-per-cipher
50 SSLv2 wire format if B<isv2format> is nonzero; otherwise the two-octet
51 SSLv3/TLS wire format), and parses the cipher suites supported by the library
52 into the returned stacks of SSL_CIPHER objects sk and Signalling Cipher-Suite
53 Values scsvs.  Unsupported cipher suites are ignored.  Returns 1 on success
54 and 0 on failure.
55
56 SSL_get_cipher_list() returns a pointer to the name of the SSL_CIPHER
57 listed for B<ssl> with B<priority>. If B<ssl> is NULL, no ciphers are
58 available, or there are less ciphers than B<priority> available, NULL
59 is returned.
60
61 =head1 NOTES
62
63 The details of the ciphers obtained by SSL_get_ciphers(), SSL_CTX_get_ciphers()
64 SSL_get1_supported_ciphers() and SSL_get_client_ciphers() can be obtained using
65 the L<SSL_CIPHER_get_name(3)> family of functions.
66
67 Call SSL_get_cipher_list() with B<priority> starting from 0 to obtain the
68 sorted list of available ciphers, until NULL is returned.
69
70 Note: SSL_get_ciphers(), SSL_CTX_get_ciphers() and SSL_get_client_ciphers()
71 return a pointer to an internal cipher stack, which will be freed later on when
72 the SSL or SSL_SESSION object is freed.  Therefore, the calling code B<MUST NOT>
73 free the return value itself.
74
75 The stack returned by SSL_get1_supported_ciphers() should be freed using
76 sk_SSL_CIPHER_free().
77
78 The stacks returned by SSL_bytes_to_cipher_list() should be freed using
79 sk_SSL_CIPHER_free().
80
81 =head1 RETURN VALUES
82
83 See DESCRIPTION
84
85 =head1 SEE ALSO
86
87 L<ssl(7)>, L<SSL_CTX_set_cipher_list(3)>,
88 L<SSL_CIPHER_get_name(3)>
89
90 =head1 COPYRIGHT
91
92 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
93
94 Licensed under the OpenSSL license (the "License").  You may not use
95 this file except in compliance with the License.  You can obtain a copy
96 in the file LICENSE in the source distribution or at
97 L<https://www.openssl.org/source/license.html>.
98
99 =cut