$NetBSD: SSL_get_ciphers.3,v 1.17 2018/02/08 21:57:27 christos Exp $

Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)

Standard preamble:
========================================================================
..

..

.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\}
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "SSL_get_ciphers 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
SSL_get1_supported_ciphers, SSL_get_client_ciphers, SSL_get_ciphers, SSL_CTX_get_ciphers, SSL_get_cipher_list \- get list of available SSL_CIPHERs libcrypto, -lcrypto Header "SYNOPSIS" .Vb 1 #include <openssl/ssl.h> \& STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *ssl); STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx); STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s); STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *ssl); const char *SSL_get_cipher_list(const SSL *ssl, int priority); .Ve Header "DESCRIPTION" \fISSL_get_ciphers() returns the stack of available SSL_CIPHERs for ssl, sorted by preference. If ssl is \s-1NULL\s0 or no ciphers are available, \s-1NULL\s0 is returned.

\fISSL_CTX_get_ciphers() returns the stack of available SSL_CIPHERs for ctx.

\fISSL_get1_supported_ciphers() returns the stack of enabled SSL_CIPHERs for \fBssl, sorted by preference. The list depends on settings like the cipher list, the supported protocol versions, the security level, and the enabled signature algorithms. \s-1SRP\s0 and \s-1PSK\s0 ciphers are only enabled if the appropriate callbacks or settings have been applied. This is the list that will be sent by the client to the server. The list supported by the server might include more ciphers in case there is a hole in the list of supported protocols. The server will also not use ciphers from this list depending on the configured certificates and \s-1DH\s0 parameters. If ssl is \s-1NULL\s0 or no ciphers are available, \s-1NULL\s0 is returned.

\fISSL_get_client_ciphers() returns the stack of available SSL_CIPHERs matching the list received from the client on ssl. If ssl is \s-1NULL,\s0 no ciphers are available, or ssl is not operating in server mode, \s-1NULL\s0 is returned.

\fISSL_get_cipher_list() returns a pointer to the name of the \s-1SSL_CIPHER\s0 listed for ssl with priority. If ssl is \s-1NULL,\s0 no ciphers are available, or there are less ciphers than priority available, \s-1NULL\s0 is returned.

Header "NOTES" The details of the ciphers obtained by SSL_get_ciphers(), SSL_CTX_get_ciphers() \fISSL_get1_supported_ciphers() and SSL_get_client_ciphers() can be obtained using the SSL_CIPHER_get_name\|(3) family of functions.

Call SSL_get_cipher_list() with priority starting from 0 to obtain the sorted list of available ciphers, until \s-1NULL\s0 is returned.

Note: SSL_get_ciphers(), SSL_CTX_get_ciphers() and SSL_get_client_ciphers() return a pointer to an internal cipher stack, which will be freed later on when the \s-1SSL\s0 or \s-1SSL_SESSION\s0 object is freed. Therefore, the calling code \s-1MUST NOT\s0 free the return value itself.

The stack returned by SSL_get1_supported_ciphers() should be freed using \fIsk_SSL_CIPHER_free().

Header "RETURN VALUES" See \s-1DESCRIPTION\s0 Header "SEE ALSO" \fIssl\|(3), SSL_CTX_set_cipher_list\|(3), \fISSL_CIPHER_get_name\|(3) Header "COPYRIGHT" Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.