Fix errors found by new find-doc-nits
[openssl.git] / doc / man3 / SSL_CTX_set_options.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_CTX_set_options, SSL_set_options, SSL_CTX_clear_options,
6 SSL_clear_options, SSL_CTX_get_options, SSL_get_options,
7 SSL_get_secure_renegotiation_support - manipulate SSL options
8
9 =head1 SYNOPSIS
10
11  #include <openssl/ssl.h>
12
13  long SSL_CTX_set_options(SSL_CTX *ctx, long options);
14  long SSL_set_options(SSL *ssl, long options);
15
16  long SSL_CTX_clear_options(SSL_CTX *ctx, long options);
17  long SSL_clear_options(SSL *ssl, long options);
18
19  long SSL_CTX_get_options(SSL_CTX *ctx);
20  long SSL_get_options(SSL *ssl);
21
22  long SSL_get_secure_renegotiation_support(SSL *ssl);
23
24 =head1 DESCRIPTION
25
26 SSL_CTX_set_options() adds the options set via bit-mask in B<options> to B<ctx>.
27 Options already set before are not cleared!
28
29 SSL_set_options() adds the options set via bit-mask in B<options> to B<ssl>.
30 Options already set before are not cleared!
31
32 SSL_CTX_clear_options() clears the options set via bit-mask in B<options>
33 to B<ctx>.
34
35 SSL_clear_options() clears the options set via bit-mask in B<options> to B<ssl>.
36
37 SSL_CTX_get_options() returns the options set for B<ctx>.
38
39 SSL_get_options() returns the options set for B<ssl>.
40
41 SSL_get_secure_renegotiation_support() indicates whether the peer supports
42 secure renegotiation.
43 Note, this is implemented via a macro.
44
45 =head1 NOTES
46
47 The behaviour of the SSL library can be changed by setting several options.
48 The options are coded as bit-masks and can be combined by a bitwise B<or>
49 operation (|).
50
51 SSL_CTX_set_options() and SSL_set_options() affect the (external)
52 protocol behaviour of the SSL library. The (internal) behaviour of
53 the API can be changed by using the similar
54 L<SSL_CTX_set_mode(3)> and SSL_set_mode() functions.
55
56 During a handshake, the option settings of the SSL object are used. When
57 a new SSL object is created from a context using SSL_new(), the current
58 option setting is copied. Changes to B<ctx> do not affect already created
59 SSL objects. SSL_clear() does not affect the settings.
60
61 The following B<bug workaround> options are available:
62
63 =over 4
64
65 =item SSL_OP_SAFARI_ECDHE_ECDSA_BUG
66
67 Don't prefer ECDHE-ECDSA ciphers when the client appears to be Safari on OS X.
68 OS X 10.8..10.8.3 has broken support for ECDHE-ECDSA ciphers.
69
70 =item SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS
71
72 Disables a countermeasure against a SSL 3.0/TLS 1.0 protocol
73 vulnerability affecting CBC ciphers, which cannot be handled by some
74 broken SSL implementations.  This option has no effect for connections
75 using other ciphers.
76
77 =item SSL_OP_TLSEXT_PADDING
78
79 Adds a padding extension to ensure the ClientHello size is never between
80 256 and 511 bytes in length. This is needed as a workaround for some
81 implementations.
82
83 =item SSL_OP_ALL
84
85 All of the above bug workarounds plus B<SSL_OP_LEGACY_SERVER_CONNECT> as
86 mentioned below.
87
88 =back
89
90 It is usually safe to use B<SSL_OP_ALL> to enable the bug workaround
91 options if compatibility with somewhat broken implementations is
92 desired.
93
94 The following B<modifying> options are available:
95
96 =over 4
97
98 =item SSL_OP_TLS_ROLLBACK_BUG
99
100 Disable version rollback attack detection.
101
102 During the client key exchange, the client must send the same information
103 about acceptable SSL/TLS protocol levels as during the first hello. Some
104 clients violate this rule by adapting to the server's answer. (Example:
105 the client sends a SSLv2 hello and accepts up to SSLv3.1=TLSv1, the server
106 only understands up to SSLv3. In this case the client must still use the
107 same SSLv3.1=TLSv1 announcement. Some clients step down to SSLv3 with respect
108 to the server's answer and violate the version rollback protection.)
109
110 =item SSL_OP_CIPHER_SERVER_PREFERENCE
111
112 When choosing a cipher, use the server's preferences instead of the client
113 preferences. When not set, the SSL server will always follow the clients
114 preferences. When set, the SSL/TLS server will choose following its
115 own preferences.
116
117 =item SSL_OP_NO_SSLv3, SSL_OP_NO_TLSv1, SSL_OP_NO_TLSv1_1,
118 SSL_OP_NO_TLSv1_2, SSL_OP_NO_TLSv1_3, SSL_OP_NO_DTLSv1, SSL_OP_NO_DTLSv1_2
119
120 These options turn off the SSLv3, TLSv1, TLSv1.1, TLSv1.2 or TLSv1.3 protocol
121 versions with TLS or the DTLSv1, DTLSv1.2 versions with DTLS,
122 respectively.
123 As of OpenSSL 1.1.0, these options are deprecated, use
124 L<SSL_CTX_set_min_proto_version(3)> and
125 L<SSL_CTX_set_max_proto_version(3)> instead.
126
127 =item SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION
128
129 When performing renegotiation as a server, always start a new session
130 (i.e., session resumption requests are only accepted in the initial
131 handshake). This option is not needed for clients.
132
133 =item SSL_OP_NO_COMPRESSION
134
135 Do not use compression even if it is supported.
136
137 =item SSL_OP_NO_QUERY_MTU
138
139 Do not query the MTU. Only affects DTLS connections.
140
141 =item SSL_OP_COOKIE_EXCHANGE
142
143 Turn on Cookie Exchange as described in RFC4347 Section 4.2.1. Only affects
144 DTLS connections.
145
146 =item SSL_OP_NO_TICKET
147
148 SSL/TLS supports two mechanisms for resuming sessions: session ids and stateless
149 session tickets.
150
151 When using session ids a copy of the session information is
152 cached on the server and a unique id is sent to the client. When the client
153 wishes to resume it provides the unique id so that the server can retrieve the
154 session information from its cache.
155
156 When using stateless session tickets the server uses a session ticket encryption
157 key to encrypt the session information. This encrypted data is sent to the
158 client as a "ticket". When the client wishes to resume it sends the encrypted
159 data back to the server. The server uses its key to decrypt the data and resume
160 the session. In this way the server can operate statelessly - no session
161 information needs to be cached locally.
162
163 The TLSv1.3 protocol only supports tickets and does not directly support session
164 ids. However OpenSSL allows two modes of ticket operation in TLSv1.3: stateful
165 and stateless. Stateless tickets work the same way as in TLSv1.2 and below.
166 Stateful tickets mimic the session id behaviour available in TLSv1.2 and below.
167 The session information is cached on the server and the session id is wrapped up
168 in a ticket and sent back to the client. When the client wishes to resume, it
169 presents a ticket in the same way as for stateless tickets. The server can then
170 extract the session id from the ticket and retrieve the session information from
171 its cache.
172
173 By default OpenSSL will use stateless tickets. The SSL_OP_NO_TICKET option will
174 cause stateless tickets to not be issued. In TLSv1.2 and below this means no
175 ticket gets sent to the client at all. In TLSv1.3 a stateful ticket will be
176 sent. This is a server-side option only.
177
178 In TLSv1.3 it is possible to suppress all tickets (stateful and stateless) from
179 being sent by calling L<SSL_CTX_set_num_tickets(3)> or
180 L<SSL_set_num_tickets(3)>.
181
182 =item SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION
183
184 Allow legacy insecure renegotiation between OpenSSL and unpatched clients or
185 servers. See the B<SECURE RENEGOTIATION> section for more details.
186
187 =item SSL_OP_LEGACY_SERVER_CONNECT
188
189 Allow legacy insecure renegotiation between OpenSSL and unpatched servers
190 B<only>: this option is currently set by default. See the
191 B<SECURE RENEGOTIATION> section for more details.
192
193 =item SSL_OP_NO_ENCRYPT_THEN_MAC
194
195 Normally clients and servers will transparently attempt to negotiate the
196 RFC7366 Encrypt-then-MAC option on TLS and DTLS connection.
197
198 If this option is set, Encrypt-then-MAC is disabled. Clients will not
199 propose, and servers will not accept the extension.
200
201 =item SSL_OP_NO_EXTENDED_MASTER_SECRET
202
203 Normally clients and servers will transparently attempt to negotiate the
204 RFC7627 Extended Master Secret option on TLS and DTLS connection.
205
206 If this option is set, Extended Master Secret is disabled. Clients will
207 not propose, and servers will not accept the extension.
208
209 =item SSL_OP_NO_RENEGOTIATION
210
211 Disable all renegotiation in TLSv1.2 and earlier. Do not send HelloRequest
212 messages, and ignore renegotiation requests via ClientHello.
213
214 =item SSL_OP_ALLOW_NO_DHE_KEX
215
216 In TLSv1.3 allow a non-(ec)dhe based key exchange mode on resumption. This means
217 that there will be no forward secrecy for the resumed session.
218
219 =item SSL_OP_PRIORITIZE_CHACHA
220
221 When SSL_OP_CIPHER_SERVER_PREFERENCE is set, temporarily reprioritize
222 ChaCha20-Poly1305 ciphers to the top of the server cipher list if a
223 ChaCha20-Poly1305 cipher is at the top of the client cipher list. This helps
224 those clients (e.g. mobile) use ChaCha20-Poly1305 if that cipher is anywhere
225 in the server cipher list; but still allows other clients to use AES and other
226 ciphers. Requires B<SSL_OP_CIPHER_SERVER_PREFERENCE>.
227
228 =item SSL_OP_ENABLE_MIDDLEBOX_COMPAT
229
230 If set then dummy Change Cipher Spec (CCS) messages are sent in TLSv1.3. This
231 has the effect of making TLSv1.3 look more like TLSv1.2 so that middleboxes that
232 do not understand TLSv1.3 will not drop the connection. Regardless of whether
233 this option is set or not CCS messages received from the peer will always be
234 ignored in TLSv1.3. This option is set by default. To switch it off use
235 SSL_clear_options(). A future version of OpenSSL may not set this by default.
236
237 =item SSL_OP_NO_ANTI_REPLAY
238
239 By default, when a server is configured for early data (i.e., max_early_data > 0),
240 OpenSSL will switch on replay protection. See L<SSL_read_early_data(3)> for a
241 description of the replay protection feature. Anti-replay measures are required
242 to comply with the TLSv1.3 specification. Some applications may be able to
243 mitigate the replay risks in other ways and in such cases the built in OpenSSL
244 functionality is not required. Those applications can turn this feature off by
245 setting this option. This is a server-side opton only. It is ignored by
246 clients.
247
248 =back
249
250 The following options no longer have any effect but their identifiers are
251 retained for compatibility purposes:
252
253 =over 4
254
255 =item SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG
256
257 =item SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER
258
259 =item SSL_OP_SSLEAY_080_CLIENT_DH_BUG
260
261 =item SSL_OP_TLS_D5_BUG
262
263 =item SSL_OP_TLS_BLOCK_PADDING_BUG
264
265 =item SSL_OP_MSIE_SSLV2_RSA_PADDING
266
267 =item SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG
268
269 =item SSL_OP_MICROSOFT_SESS_ID_BUG
270
271 =item SSL_OP_NETSCAPE_CHALLENGE_BUG
272
273 =item SSL_OP_PKCS1_CHECK_1
274
275 =item SSL_OP_PKCS1_CHECK_2
276
277 =item SSL_OP_SINGLE_DH_USE
278
279 =item SSL_OP_SINGLE_ECDH_USE
280
281 =item SSL_OP_EPHEMERAL_RSA
282
283 =back
284
285 =head1 SECURE RENEGOTIATION
286
287 OpenSSL always attempts to use secure renegotiation as
288 described in RFC5746. This counters the prefix attack described in
289 CVE-2009-3555 and elsewhere.
290
291 This attack has far reaching consequences which application writers should be
292 aware of. In the description below an implementation supporting secure
293 renegotiation is referred to as I<patched>. A server not supporting secure
294 renegotiation is referred to as I<unpatched>.
295
296 The following sections describe the operations permitted by OpenSSL's secure
297 renegotiation implementation.
298
299 =head2 Patched client and server
300
301 Connections and renegotiation are always permitted by OpenSSL implementations.
302
303 =head2 Unpatched client and patched OpenSSL server
304
305 The initial connection succeeds but client renegotiation is denied by the
306 server with a B<no_renegotiation> warning alert if TLS v1.0 is used or a fatal
307 B<handshake_failure> alert in SSL v3.0.
308
309 If the patched OpenSSL server attempts to renegotiate a fatal
310 B<handshake_failure> alert is sent. This is because the server code may be
311 unaware of the unpatched nature of the client.
312
313 If the option B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION> is set then
314 renegotiation B<always> succeeds.
315
316 =head2 Patched OpenSSL client and unpatched server
317
318 If the option B<SSL_OP_LEGACY_SERVER_CONNECT> or
319 B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION> is set then initial connections
320 and renegotiation between patched OpenSSL clients and unpatched servers
321 succeeds. If neither option is set then initial connections to unpatched
322 servers will fail.
323
324 The option B<SSL_OP_LEGACY_SERVER_CONNECT> is currently set by default even
325 though it has security implications: otherwise it would be impossible to
326 connect to unpatched servers (i.e. all of them initially) and this is clearly
327 not acceptable. Renegotiation is permitted because this does not add any
328 additional security issues: during an attack clients do not see any
329 renegotiations anyway.
330
331 As more servers become patched the option B<SSL_OP_LEGACY_SERVER_CONNECT> will
332 B<not> be set by default in a future version of OpenSSL.
333
334 OpenSSL client applications wishing to ensure they can connect to unpatched
335 servers should always B<set> B<SSL_OP_LEGACY_SERVER_CONNECT>
336
337 OpenSSL client applications that want to ensure they can B<not> connect to
338 unpatched servers (and thus avoid any security issues) should always B<clear>
339 B<SSL_OP_LEGACY_SERVER_CONNECT> using SSL_CTX_clear_options() or
340 SSL_clear_options().
341
342 The difference between the B<SSL_OP_LEGACY_SERVER_CONNECT> and
343 B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION> options is that
344 B<SSL_OP_LEGACY_SERVER_CONNECT> enables initial connections and secure
345 renegotiation between OpenSSL clients and unpatched servers B<only>, while
346 B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION> allows initial connections
347 and renegotiation between OpenSSL and unpatched clients or servers.
348
349 =head1 RETURN VALUES
350
351 SSL_CTX_set_options() and SSL_set_options() return the new options bit-mask
352 after adding B<options>.
353
354 SSL_CTX_clear_options() and SSL_clear_options() return the new options bit-mask
355 after clearing B<options>.
356
357 SSL_CTX_get_options() and SSL_get_options() return the current bit-mask.
358
359 SSL_get_secure_renegotiation_support() returns 1 is the peer supports
360 secure renegotiation and 0 if it does not.
361
362 =head1 SEE ALSO
363
364 L<ssl(7)>, L<SSL_new(3)>, L<SSL_clear(3)>,
365 L<SSL_CTX_set_tmp_dh_callback(3)>,
366 L<SSL_CTX_set_min_proto_version(3)>,
367 L<dhparam(1)>
368
369 =head1 HISTORY
370
371 The attempt to always try to use secure renegotiation was added in
372 OpenSSL 0.9.8m.
373
374 The B<SSL_OP_PRIORITIZE_CHACHA> and B<SSL_OP_NO_RENEGOTIATION> options
375 were added in OpenSSL 1.1.1.
376
377 The B<SSL_OP_NO_EXTENDED_MASTER_SECRET> option was added in OpenSSL 3.0.
378
379 =head1 COPYRIGHT
380
381 Copyright 2001-2019 The OpenSSL Project Authors. All Rights Reserved.
382
383 Licensed under the Apache License 2.0 (the "License").  You may not use
384 this file except in compliance with the License.  You can obtain a copy
385 in the file LICENSE in the source distribution or at
386 L<https://www.openssl.org/source/license.html>.
387
388 =cut