5933bf584973bc8065177d879617507e1de765c5
[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  STACK_OF(SSL_CIPHER) *SSL_bytes_to_cipher_list(SSL *s,
19                                                 const unsigned char *bytes,
20                                                 size_t len, int isv2format)
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>, 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 This is the list that will be sent by the client to the server.
38 The list supported by the server might include more ciphers in case there is a
39 hole in the list of supported protocols.
40 The server will also not use ciphers from this list depending on the
41 configured certificates and DH parameters.
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 stack of SSL_CIPHER objects.  Unsupported cipher suites
53 are ignored, and NULL is returned on error.
54
55 SSL_get_cipher_list() returns a pointer to the name of the SSL_CIPHER
56 listed for B<ssl> with B<priority>. If B<ssl> is NULL, no ciphers are
57 available, or there are less ciphers than B<priority> available, NULL
58 is returned.
59
60 =head1 NOTES
61
62 The details of the ciphers obtained by SSL_get_ciphers(), SSL_CTX_get_ciphers()
63 SSL_get1_supported_ciphers() and SSL_get_client_ciphers() can be obtained using
64 the L<SSL_CIPHER_get_name(3)> family of functions.
65
66 Call SSL_get_cipher_list() with B<priority> starting from 0 to obtain the
67 sorted list of available ciphers, until NULL is returned.
68
69 Note: SSL_get_ciphers(), SSL_CTX_get_ciphers() and SSL_get_client_ciphers()
70 return a pointer to an internal cipher stack, which will be freed later on when
71 the SSL or SSL_SESSION object is freed.  Therefore, the calling code B<MUST NOT>
72 free the return value itself.
73
74 The stack returned by SSL_get1_supported_ciphers() should be freed using
75 sk_SSL_CIPHER_free().
76
77 The stack returned by SSL_bytes_to_cipher_list() should be freed using
78 sk_SSL_CIPHER_free().
79
80 =head1 RETURN VALUES
81
82 See DESCRIPTION
83
84 =head1 BUGS
85
86 The implementation of SSL_bytes_to_cipher_list() mutates state in the
87 supplied SSL object B<s>; SSL_bytes_to_cipher_list() should not be called
88 on a server SSL object after that server has processed the received ClientHello.
89
90 =head1 SEE ALSO
91
92 L<ssl(7)>, L<SSL_CTX_set_cipher_list(3)>,
93 L<SSL_CIPHER_get_name(3)>
94
95 =head1 COPYRIGHT
96
97 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
98
99 Licensed under the OpenSSL license (the "License").  You may not use
100 this file except in compliance with the License.  You can obtain a copy
101 in the file LICENSE in the source distribution or at
102 L<https://www.openssl.org/source/license.html>.
103
104 =cut