secure/lib/libcrypto/man/man3/SSL_CTX_set_cipher_list.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
   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 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "SSL_CTX_SET_CIPHER_LIST 3"
 136 .TH SSL_CTX_SET_CIPHER_LIST 3 "2022-05-03" "1.1.1o" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 SSL_CTX_set_cipher_list, SSL_set_cipher_list, SSL_CTX_set_ciphersuites, SSL_set_ciphersuites \&\- choose list of available SSL_CIPHERs
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ssl.h>
 147 \&
 148 \& int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str);
 149 \& int SSL_set_cipher_list(SSL *ssl, const char *str);
 150 \&
 151 \& int SSL_CTX_set_ciphersuites(SSL_CTX *ctx, const char *str);
 152 \& int SSL_set_ciphersuites(SSL *s, const char *str);
 153 .Ve
 154 .SH "DESCRIPTION"
 155 .IX Header "DESCRIPTION"
 156 \&\fBSSL_CTX_set_cipher_list()\fR sets the list of available ciphers (TLSv1.2 and below)
 157 for \fBctx\fR using the control string \fBstr\fR. The format of the string is described
 158 in \fBciphers\fR\|(1). The list of ciphers is inherited by all
 159 \&\fBssl\fR objects created from \fBctx\fR. This function does not impact TLSv1.3
 160 ciphersuites. Use \fBSSL_CTX_set_ciphersuites()\fR to configure those.
 161 .PP
 162 \&\fBSSL_set_cipher_list()\fR sets the list of ciphers (TLSv1.2 and below) only for
 163 \&\fBssl\fR.
 164 .PP
 165 \&\fBSSL_CTX_set_ciphersuites()\fR is used to configure the available TLSv1.3
 166 ciphersuites for \fBctx\fR. This is a simple colon (\*(L":\*(R") separated list of TLSv1.3
 167 ciphersuite names in order of preference. Valid TLSv1.3 ciphersuite names are:
 168 .IP "\s-1TLS_AES_128_GCM_SHA256\s0" 4
 169 .IX Item "TLS_AES_128_GCM_SHA256"
 170 .PD 0
 171 .IP "\s-1TLS_AES_256_GCM_SHA384\s0" 4
 172 .IX Item "TLS_AES_256_GCM_SHA384"
 173 .IP "\s-1TLS_CHACHA20_POLY1305_SHA256\s0" 4
 174 .IX Item "TLS_CHACHA20_POLY1305_SHA256"
 175 .IP "\s-1TLS_AES_128_CCM_SHA256\s0" 4
 176 .IX Item "TLS_AES_128_CCM_SHA256"
 177 .IP "\s-1TLS_AES_128_CCM_8_SHA256\s0" 4
 178 .IX Item "TLS_AES_128_CCM_8_SHA256"
 179 .PD
 180 .PP
 181 An empty list is permissible. The default value for the this setting is:
 182 .PP
 183 \&\*(L"\s-1TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256\*(R"\s0
 184 .PP
 185 \&\fBSSL_set_ciphersuites()\fR is the same as \fBSSL_CTX_set_ciphersuites()\fR except it
 186 configures the ciphersuites for \fBssl\fR.
 187 .SH "NOTES"
 188 .IX Header "NOTES"
 189 The control string \fBstr\fR for \fBSSL_CTX_set_cipher_list()\fR and
 190 \&\fBSSL_set_cipher_list()\fR should be universally usable and not depend
 191 on details of the library configuration (ciphers compiled in). Thus no
 192 syntax checking takes place. Items that are not recognized, because the
 193 corresponding ciphers are not compiled in or because they are mistyped,
 194 are simply ignored. Failure is only flagged if no ciphers could be collected
 195 at all.
 196 .PP
 197 It should be noted, that inclusion of a cipher to be used into the list is
 198 a necessary condition. On the client side, the inclusion into the list is
 199 also sufficient unless the security level excludes it. On the server side,
 200 additional restrictions apply. All ciphers have additional requirements.
 201 \&\s-1ADH\s0 ciphers don't need a certificate, but DH-parameters must have been set.
 202 All other ciphers need a corresponding certificate and key.
 203 .PP
 204 A \s-1RSA\s0 cipher can only be chosen, when a \s-1RSA\s0 certificate is available.
 205 \&\s-1RSA\s0 ciphers using \s-1DHE\s0 need a certificate and key and additional DH-parameters
 206 (see \fBSSL_CTX_set_tmp_dh_callback\fR\|(3)).
 207 .PP
 208 A \s-1DSA\s0 cipher can only be chosen, when a \s-1DSA\s0 certificate is available.
 209 \&\s-1DSA\s0 ciphers always use \s-1DH\s0 key exchange and therefore need DH-parameters
 210 (see \fBSSL_CTX_set_tmp_dh_callback\fR\|(3)).
 211 .PP
 212 When these conditions are not met for any cipher in the list (e.g. a
 213 client only supports export \s-1RSA\s0 ciphers with an asymmetric key length
 214 of 512 bits and the server is not configured to use temporary \s-1RSA\s0
 215 keys), the \*(L"no shared cipher\*(R" (\s-1SSL_R_NO_SHARED_CIPHER\s0) error is generated
 216 and the handshake will fail.
 217 .SH "RETURN VALUES"
 218 .IX Header "RETURN VALUES"
 219 \&\fBSSL_CTX_set_cipher_list()\fR and \fBSSL_set_cipher_list()\fR return 1 if any cipher
 220 could be selected and 0 on complete failure.
 221 .PP
 222 \&\fBSSL_CTX_set_ciphersuites()\fR and \fBSSL_set_ciphersuites()\fR return 1 if the requested
 223 ciphersuite list was configured, and 0 otherwise.
 224 .SH "SEE ALSO"
 225 .IX Header "SEE ALSO"
 226 \&\fBssl\fR\|(7), \fBSSL_get_ciphers\fR\|(3),
 227 \&\fBSSL_CTX_use_certificate\fR\|(3),
 228 \&\fBSSL_CTX_set_tmp_dh_callback\fR\|(3),
 229 \&\fBciphers\fR\|(1)
 230 .SH "COPYRIGHT"
 231 .IX Header "COPYRIGHT"
 232 Copyright 2000\-2019 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>.