secure/lib/libcrypto/man/SSL_get_ciphers.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "SSL_GET_CIPHERS 3"
 132 .TH SSL_GET_CIPHERS 3 "2018-09-11" "1.1.1" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 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
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *ssl);
 145 \& STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx);
 146 \& STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s);
 147 \& STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *ssl);
 148 \& int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
 149 \&                              int isv2format, STACK_OF(SSL_CIPHER) **sk,
 150 \&                              STACK_OF(SSL_CIPHER) **scsvs);
 151 \& const char *SSL_get_cipher_list(const SSL *ssl, int priority);
 152 \& char *SSL_get_shared_ciphers(const SSL *s, char *buf, int size);
 153 .Ve
 154 .SH "DESCRIPTION"
 155 .IX Header "DESCRIPTION"
 156 \&\fISSL_get_ciphers()\fR returns the stack of available SSL_CIPHERs for \fBssl\fR,
 157 sorted by preference. If \fBssl\fR is \s-1NULL\s0 or no ciphers are available, \s-1NULL\s0
 158 is returned.
 159 .PP
 160 \&\fISSL_CTX_get_ciphers()\fR returns the stack of available SSL_CIPHERs for \fBctx\fR.
 161 .PP
 162 \&\fISSL_get1_supported_ciphers()\fR returns the stack of enabled SSL_CIPHERs for
 163 \&\fBssl\fR as would be sent in a ClientHello (that is, sorted by preference).
 164 The list depends on settings like the cipher list, the supported protocol
 165 versions, the security level, and the enabled signature algorithms.
 166 \&\s-1SRP\s0 and \s-1PSK\s0 ciphers are only enabled if the appropriate callbacks or settings
 167 have been applied.
 168 The list of ciphers that would be sent in a ClientHello can differ from
 169 the list of ciphers that would be acceptable when acting as a server.
 170 For example, additional ciphers may be usable by a server if there is
 171 a gap in the list of supported protocols, and some ciphers may not be
 172 usable by a server if there is not a suitable certificate configured.
 173 If \fBssl\fR is \s-1NULL\s0 or no ciphers are available, \s-1NULL\s0 is returned.
 174 .PP
 175 \&\fISSL_get_client_ciphers()\fR returns the stack of available SSL_CIPHERs matching the
 176 list received from the client on \fBssl\fR. If \fBssl\fR is \s-1NULL,\s0 no ciphers are
 177 available, or \fBssl\fR is not operating in server mode, \s-1NULL\s0 is returned.
 178 .PP
 179 \&\fISSL_bytes_to_cipher_list()\fR treats the supplied \fBlen\fR octets in \fBbytes\fR
 180 as a wire-protocol cipher suite specification (in the three-octet-per-cipher
 181 SSLv2 wire format if \fBisv2format\fR is nonzero; otherwise the two-octet
 182 SSLv3/TLS wire format), and parses the cipher suites supported by the library
 183 into the returned stacks of \s-1SSL_CIPHER\s0 objects sk and Signalling Cipher-Suite
 184 Values scsvs.  Unsupported cipher suites are ignored.  Returns 1 on success
 185 and 0 on failure.
 186 .PP
 187 \&\fISSL_get_cipher_list()\fR returns a pointer to the name of the \s-1SSL_CIPHER\s0
 188 listed for \fBssl\fR with \fBpriority\fR. If \fBssl\fR is \s-1NULL,\s0 no ciphers are
 189 available, or there are less ciphers than \fBpriority\fR available, \s-1NULL\s0
 190 is returned.
 191 .PP
 192 \&\fISSL_get_shared_ciphers()\fR creates a colon separated and \s-1NUL\s0 terminated list of
 193 \&\s-1SSL_CIPHER\s0 names that are available in both the client and the server. \fBbuf\fR is
 194 the buffer that should be populated with the list of names and \fBsize\fR is the
 195 size of that buffer. A pointer to \fBbuf\fR is returned on success or \s-1NULL\s0 on
 196 error. If the supplied buffer is not large enough to contain the complete list
 197 of names then a truncated list of names will be returned. Note that just because
 198 a ciphersuite is available (i.e. it is configured in the cipher list) and shared
 199 by both the client and the server it does not mean that it is enabled (see the
 200 description of \fISSL_get1_supported_ciphers()\fR above). This function will return
 201 available shared ciphersuites whether or not they are enabled. This is a server
 202 side function only and must only be called after the completion of the initial
 203 handshake.
 204 .SH "NOTES"
 205 .IX Header "NOTES"
 206 The details of the ciphers obtained by \fISSL_get_ciphers()\fR, \fISSL_CTX_get_ciphers()\fR
 207 \&\fISSL_get1_supported_ciphers()\fR and \fISSL_get_client_ciphers()\fR can be obtained using
 208 the \fISSL_CIPHER_get_name\fR\|(3) family of functions.
 209 .PP
 210 Call \fISSL_get_cipher_list()\fR with \fBpriority\fR starting from 0 to obtain the
 211 sorted list of available ciphers, until \s-1NULL\s0 is returned.
 212 .PP
 213 Note: \fISSL_get_ciphers()\fR, \fISSL_CTX_get_ciphers()\fR and \fISSL_get_client_ciphers()\fR
 214 return a pointer to an internal cipher stack, which will be freed later on when
 215 the \s-1SSL\s0 or \s-1SSL_SESSION\s0 object is freed.  Therefore, the calling code \fB\s-1MUST NOT\s0\fR
 216 free the return value itself.
 217 .PP
 218 The stack returned by \fISSL_get1_supported_ciphers()\fR should be freed using
 219 \&\fIsk_SSL_CIPHER_free()\fR.
 220 .PP
 221 The stacks returned by \fISSL_bytes_to_cipher_list()\fR should be freed using
 222 \&\fIsk_SSL_CIPHER_free()\fR.
 223 .SH "RETURN VALUES"
 224 .IX Header "RETURN VALUES"
 225 See \s-1DESCRIPTION\s0
 226 .SH "SEE ALSO"
 227 .IX Header "SEE ALSO"
 228 \&\fIssl\fR\|(7), \fISSL_CTX_set_cipher_list\fR\|(3),
 229 \&\fISSL_CIPHER_get_name\fR\|(3)
 230 .SH "COPYRIGHT"
 231 .IX Header "COPYRIGHT"
 232 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 233 .PP
 234 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 235 this file except in compliance with the License.  You can obtain a copy
 236 in the file \s-1LICENSE\s0 in the source distribution or at
 237 <https://www.openssl.org/source/license.html>.