240 lines
9.1 KiB
Groff
Executable File
240 lines
9.1 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" 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 C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. 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\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, 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.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" 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
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. 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
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. 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
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "SSL_GET_CIPHERS 3"
|
|
.TH SSL_GET_CIPHERS 3 "2020-03-02" "3.0.0-dev" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
SSL_get1_supported_ciphers,
|
|
SSL_get_client_ciphers,
|
|
SSL_get_ciphers,
|
|
SSL_CTX_get_ciphers,
|
|
SSL_bytes_to_cipher_list,
|
|
SSL_get_cipher_list,
|
|
SSL_get_shared_ciphers
|
|
\&\- get list of available SSL_CIPHERs
|
|
.SH "SYNOPSIS"
|
|
.IX 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);
|
|
\& int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
|
|
\& int isv2format, STACK_OF(SSL_CIPHER) **sk,
|
|
\& STACK_OF(SSL_CIPHER) **scsvs);
|
|
\& const char *SSL_get_cipher_list(const SSL *ssl, int priority);
|
|
\& char *SSL_get_shared_ciphers(const SSL *s, char *buf, int size);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
\&\fISSL_get_ciphers()\fR returns the stack of available SSL_CIPHERs for \fBssl\fR,
|
|
sorted by preference. If \fBssl\fR is \s-1NULL\s0 or no ciphers are available, \s-1NULL\s0
|
|
is returned.
|
|
.PP
|
|
\&\fISSL_CTX_get_ciphers()\fR returns the stack of available SSL_CIPHERs for \fBctx\fR.
|
|
.PP
|
|
\&\fISSL_get1_supported_ciphers()\fR returns the stack of enabled SSL_CIPHERs for
|
|
\&\fBssl\fR as would be sent in a ClientHello (that is, 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.
|
|
The list of ciphers that would be sent in a ClientHello can differ from
|
|
the list of ciphers that would be acceptable when acting as a server.
|
|
For example, additional ciphers may be usable by a server if there is
|
|
a gap in the list of supported protocols, and some ciphers may not be
|
|
usable by a server if there is not a suitable certificate configured.
|
|
If \fBssl\fR is \s-1NULL\s0 or no ciphers are available, \s-1NULL\s0 is returned.
|
|
.PP
|
|
\&\fISSL_get_client_ciphers()\fR returns the stack of available SSL_CIPHERs matching the
|
|
list received from the client on \fBssl\fR. If \fBssl\fR is \s-1NULL\s0, no ciphers are
|
|
available, or \fBssl\fR is not operating in server mode, \s-1NULL\s0 is returned.
|
|
.PP
|
|
\&\fISSL_bytes_to_cipher_list()\fR treats the supplied \fBlen\fR octets in \fBbytes\fR
|
|
as a wire-protocol cipher suite specification (in the three-octet-per-cipher
|
|
SSLv2 wire format if \fBisv2format\fR is nonzero; otherwise the two-octet
|
|
SSLv3/TLS wire format), and parses the cipher suites supported by the library
|
|
into the returned stacks of \s-1SSL_CIPHER\s0 objects sk and Signalling Cipher-Suite
|
|
Values scsvs. Unsupported cipher suites are ignored. Returns 1 on success
|
|
and 0 on failure.
|
|
.PP
|
|
\&\fISSL_get_cipher_list()\fR returns a pointer to the name of the \s-1SSL_CIPHER\s0
|
|
listed for \fBssl\fR with \fBpriority\fR. If \fBssl\fR is \s-1NULL\s0, no ciphers are
|
|
available, or there are less ciphers than \fBpriority\fR available, \s-1NULL\s0
|
|
is returned.
|
|
.PP
|
|
\&\fISSL_get_shared_ciphers()\fR creates a colon separated and \s-1NUL\s0 terminated list of
|
|
\&\s-1SSL_CIPHER\s0 names that are available in both the client and the server. \fBbuf\fR is
|
|
the buffer that should be populated with the list of names and \fBsize\fR is the
|
|
size of that buffer. A pointer to \fBbuf\fR is returned on success or \s-1NULL\s0 on
|
|
error. If the supplied buffer is not large enough to contain the complete list
|
|
of names then a truncated list of names will be returned. Note that just because
|
|
a ciphersuite is available (i.e. it is configured in the cipher list) and shared
|
|
by both the client and the server it does not mean that it is enabled (see the
|
|
description of \fISSL_get1_supported_ciphers()\fR above). This function will return
|
|
available shared ciphersuites whether or not they are enabled. This is a server
|
|
side function only and must only be called after the completion of the initial
|
|
handshake.
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
The details of the ciphers obtained by \fISSL_get_ciphers()\fR, \fISSL_CTX_get_ciphers()\fR
|
|
\&\fISSL_get1_supported_ciphers()\fR and \fISSL_get_client_ciphers()\fR can be obtained using
|
|
the \fISSL_CIPHER_get_name\fR\|(3) family of functions.
|
|
.PP
|
|
Call \fISSL_get_cipher_list()\fR with \fBpriority\fR starting from 0 to obtain the
|
|
sorted list of available ciphers, until \s-1NULL\s0 is returned.
|
|
.PP
|
|
Note: \fISSL_get_ciphers()\fR, \fISSL_CTX_get_ciphers()\fR and \fISSL_get_client_ciphers()\fR
|
|
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 \fB\s-1MUST\s0 \s-1NOT\s0\fR
|
|
free the return value itself.
|
|
.PP
|
|
The stack returned by \fISSL_get1_supported_ciphers()\fR should be freed using
|
|
\&\fIsk_SSL_CIPHER_free()\fR.
|
|
.PP
|
|
The stacks returned by \fISSL_bytes_to_cipher_list()\fR should be freed using
|
|
\&\fIsk_SSL_CIPHER_free()\fR.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
See \s-1DESCRIPTION\s0
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIssl\fR\|(7), \fISSL_CTX_set_cipher_list\fR\|(3),
|
|
\&\fISSL_CIPHER_get_name\fR\|(3)
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
Licensed under the Apache License 2.0 (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>.
|