doc/ssl/SSL_CTX_set_options.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_CTX_set_options, SSL_set_options, SSL_CTX_clear_options, SSL_clear_options, SSL_CTX_get_options, SSL_get_options, SSL_get_secure_renegotiation_support - manipulate SSL options
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/ssl.h>
  10
  11  long SSL_CTX_set_options(SSL_CTX *ctx, long options);
  12  long SSL_set_options(SSL *ssl, long options);
  13
  14  long SSL_CTX_clear_options(SSL_CTX *ctx, long options);
  15  long SSL_clear_options(SSL *ssl, long options);
  16
  17  long SSL_CTX_get_options(SSL_CTX *ctx);
  18  long SSL_get_options(SSL *ssl);
  19
  20  long SSL_get_secure_renegotiation_support(SSL *ssl);
  21
  22 =head1 DESCRIPTION
  23
  24 Note: all these functions are implemented using macros.
  25
  26 SSL_CTX_set_options() adds the options set via bitmask in B<options> to B<ctx>.
  27 Options already set before are not cleared!
  28
  29 SSL_set_options() adds the options set via bitmask 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 bitmask in B<options>
  33 to B<ctx>.
  34
  35 SSL_clear_options() clears the options set via bitmask 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
  44 =head1 NOTES
  45
  46 The behaviour of the SSL library can be changed by setting several options.
  47 The options are coded as bitmasks and can be combined by a bitwise B<or>
  48 operation (|).
  49
  50 SSL_CTX_set_options() and SSL_set_options() affect the (external)
  51 protocol behaviour of the SSL library. The (internal) behaviour of
  52 the API can be changed by using the similar
  53 L<SSL_CTX_set_mode(3)|SSL_CTX_set_mode(3)> and SSL_set_mode() functions.
  54
  55 During a handshake, the option settings of the SSL object are used. When
  56 a new SSL object is created from a context using SSL_new(), the current
  57 option setting is copied. Changes to B<ctx> do not affect already created
  58 SSL objects. SSL_clear() does not affect the settings.
  59
  60 The following B<bug workaround> options are available:
  61
  62 =over 4
  63
  64 =item SSL_OP_MICROSOFT_SESS_ID_BUG
  65
  66 As of OpenSSL 1.0.0 this option has no effect.
  67
  68 =item SSL_OP_NETSCAPE_CHALLENGE_BUG
  69
  70 As of OpenSSL 1.0.0 this option has no effect.
  71
  72 =item SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG
  73
  74 As of OpenSSL 0.9.8q and 1.0.0c, this option has no effect.
  75
  76 =item SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG
  77
  78 ...
  79
  80 =item SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER
  81
  82 ...
  83
  84 =item SSL_OP_SAFARI_ECDHE_ECDSA_BUG
  85
  86 Don't prefer ECDHE-ECDSA ciphers when the client appears to be Safari on OS X.
  87 OS X 10.8..10.8.3 has broken support for ECDHE-ECDSA ciphers.
  88
  89 =item SSL_OP_SSLEAY_080_CLIENT_DH_BUG
  90
  91 ...
  92
  93 =item SSL_OP_TLS_D5_BUG
  94
  95 ...
  96
  97 =item SSL_OP_TLS_BLOCK_PADDING_BUG
  98
  99 ...
 100
 101 =item SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS
 102
 103 Disables a countermeasure against a SSL 3.0/TLS 1.0 protocol
 104 vulnerability affecting CBC ciphers, which cannot be handled by some
 105 broken SSL implementations.  This option has no effect for connections
 106 using other ciphers.
 107
 108 =item SSL_OP_TLSEXT_PADDING
 109
 110 Adds a padding extension to ensure the ClientHello size is never between
 111 256 and 511 bytes in length. This is needed as a workaround for some
 112 implementations.
 113
 114 =item SSL_OP_ALL
 115
 116 All of the above bug workarounds.
 117
 118 =back
 119
 120 It is usually safe to use B<SSL_OP_ALL> to enable the bug workaround
 121 options if compatibility with somewhat broken implementations is
 122 desired.
 123
 124 The following B<modifying> options are available:
 125
 126 =over 4
 127
 128 =item SSL_OP_TLS_ROLLBACK_BUG
 129
 130 Disable version rollback attack detection.
 131
 132 During the client key exchange, the client must send the same information
 133 about acceptable SSL/TLS protocol levels as during the first hello. Some
 134 clients violate this rule by adapting to the server's answer. (Example:
 135 the client sends a SSLv2 hello and accepts up to SSLv3.1=TLSv1, the server
 136 only understands up to SSLv3. In this case the client must still use the
 137 same SSLv3.1=TLSv1 announcement. Some clients step down to SSLv3 with respect
 138 to the server's answer and violate the version rollback protection.)
 139
 140 =item SSL_OP_SINGLE_DH_USE
 141
 142 Always create a new key when using temporary/ephemeral DH parameters
 143 (see L<SSL_CTX_set_tmp_dh_callback(3)|SSL_CTX_set_tmp_dh_callback(3)>).
 144 This option must be used to prevent small subgroup attacks, when
 145 the DH parameters were not generated using "strong" primes
 146 (e.g. when using DSA-parameters, see L<dhparam(1)|dhparam(1)>).
 147 If "strong" primes were used, it is not strictly necessary to generate
 148 a new DH key during each handshake but it is also recommended.
 149 B<SSL_OP_SINGLE_DH_USE> should therefore be enabled whenever
 150 temporary/ephemeral DH parameters are used.
 151
 152 =item SSL_OP_EPHEMERAL_RSA
 153
 154 This option is no longer implemented and is treated as no op.
 155
 156 =item SSL_OP_CIPHER_SERVER_PREFERENCE
 157
 158 When choosing a cipher, use the server's preferences instead of the client
 159 preferences. When not set, the SSL server will always follow the clients
 160 preferences. When set, the SSLv3/TLSv1 server will choose following its
 161 own preferences. Because of the different protocol, for SSLv2 the server
 162 will send its list of preferences to the client and the client chooses.
 163
 164 =item SSL_OP_PKCS1_CHECK_1
 165
 166 ...
 167
 168 =item SSL_OP_PKCS1_CHECK_2
 169
 170 ...
 171
 172
 173
 174 =item SSL_OP_NO_SSLv2
 175
 176 Do not use the SSLv2 protocol.
 177
 178 =item SSL_OP_NO_SSLv3
 179
 180 Do not use the SSLv3 protocol.
 181
 182 =item SSL_OP_NO_TLSv1
 183
 184 Do not use the TLSv1 protocol.
 185
 186 =item SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION
 187
 188 When performing renegotiation as a server, always start a new session
 189 (i.e., session resumption requests are only accepted in the initial
 190 handshake). This option is not needed for clients.
 191
 192 =item SSL_OP_NO_TICKET
 193
 194 Normally clients and servers will, where possible, transparently make use
 195 of RFC4507bis tickets for stateless session resumption.
 196
 197 If this option is set this functionality is disabled and tickets will
 198 not be used by clients or servers.
 199
 200 =item SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION
 201
 202 Allow legacy insecure renegotiation between OpenSSL and unpatched clients or
 203 servers. See the B<SECURE RENEGOTIATION> section for more details.
 204
 205 =item SSL_OP_LEGACY_SERVER_CONNECT
 206
 207 Allow legacy insecure renegotiation between OpenSSL and unpatched servers
 208 B<only>: this option is currently set by default. See the
 209 B<SECURE RENEGOTIATION> section for more details.
 210
 211 =back
 212
 213 =head1 SECURE RENEGOTIATION
 214
 215 OpenSSL 0.9.8m and later always attempts to use secure renegotiation as
 216 described in RFC5746. This counters the prefix attack described in
 217 CVE-2009-3555 and elsewhere.
 218
 219 The deprecated and highly broken SSLv2 protocol does not support
 220 renegotiation at all: its use is B<strongly> discouraged.
 221
 222 This attack has far reaching consequences which application writers should be
 223 aware of. In the description below an implementation supporting secure
 224 renegotiation is referred to as I<patched>. A server not supporting secure
 225 renegotiation is referred to as I<unpatched>.
 226
 227 The following sections describe the operations permitted by OpenSSL's secure
 228 renegotiation implementation.
 229
 230 =head2 Patched client and server
 231
 232 Connections and renegotiation are always permitted by OpenSSL implementations.
 233
 234 =head2 Unpatched client and patched OpenSSL server
 235
 236 The initial connection succeeds but client renegotiation is denied by the
 237 server with a B<no_renegotiation> warning alert if TLS v1.0 is used or a fatal
 238 B<handshake_failure> alert in SSL v3.0.
 239
 240 If the patched OpenSSL server attempts to renegotiate a fatal
 241 B<handshake_failure> alert is sent. This is because the server code may be
 242 unaware of the unpatched nature of the client.
 243
 244 If the option B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION> is set then
 245 renegotiation B<always> succeeds.
 246
 247 B<NB:> a bug in OpenSSL clients earlier than 0.9.8m (all of which are
 248 unpatched) will result in the connection hanging if it receives a
 249 B<no_renegotiation> alert. OpenSSL versions 0.9.8m and later will regard
 250 a B<no_renegotiation> alert as fatal and respond with a fatal
 251 B<handshake_failure> alert. This is because the OpenSSL API currently has
 252 no provision to indicate to an application that a renegotiation attempt
 253 was refused.
 254
 255 =head2 Patched OpenSSL client and unpatched server.
 256
 257 If the option B<SSL_OP_LEGACY_SERVER_CONNECT> or
 258 B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION> is set then initial connections
 259 and renegotiation between patched OpenSSL clients and unpatched servers
 260 succeeds. If neither option is set then initial connections to unpatched
 261 servers will fail.
 262
 263 The option B<SSL_OP_LEGACY_SERVER_CONNECT> is currently set by default even
 264 though it has security implications: otherwise it would be impossible to
 265 connect to unpatched servers (i.e. all of them initially) and this is clearly
 266 not acceptable. Renegotiation is permitted because this does not add any
 267 additional security issues: during an attack clients do not see any
 268 renegotiations anyway.
 269
 270 As more servers become patched the option B<SSL_OP_LEGACY_SERVER_CONNECT> will
 271 B<not> be set by default in a future version of OpenSSL.
 272
 273 OpenSSL client applications wishing to ensure they can connect to unpatched
 274 servers should always B<set> B<SSL_OP_LEGACY_SERVER_CONNECT>
 275
 276 OpenSSL client applications that want to ensure they can B<not> connect to
 277 unpatched servers (and thus avoid any security issues) should always B<clear>
 278 B<SSL_OP_LEGACY_SERVER_CONNECT> using SSL_CTX_clear_options() or
 279 SSL_clear_options().
 280
 281 The difference between the B<SSL_OP_LEGACY_SERVER_CONNECT> and
 282 B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION> options is that
 283 B<SSL_OP_LEGACY_SERVER_CONNECT> enables initial connections and secure
 284 renegotiation between OpenSSL clients and unpatched servers B<only>, while
 285 B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION> allows initial connections
 286 and renegotiation between OpenSSL and unpatched clients or servers.
 287
 288 =head1 RETURN VALUES
 289
 290 SSL_CTX_set_options() and SSL_set_options() return the new options bitmask
 291 after adding B<options>.
 292
 293 SSL_CTX_clear_options() and SSL_clear_options() return the new options bitmask
 294 after clearing B<options>.
 295
 296 SSL_CTX_get_options() and SSL_get_options() return the current bitmask.
 297
 298 SSL_get_secure_renegotiation_support() returns 1 is the peer supports
 299 secure renegotiation and 0 if it does not.
 300
 301 =head1 SEE ALSO
 302
 303 L<ssl(3)|ssl(3)>, L<SSL_new(3)|SSL_new(3)>, L<SSL_clear(3)|SSL_clear(3)>,
 304 L<SSL_CTX_set_tmp_dh_callback(3)|SSL_CTX_set_tmp_dh_callback(3)>,
 305 L<SSL_CTX_set_tmp_rsa_callback(3)|SSL_CTX_set_tmp_rsa_callback(3)>,
 306 L<dhparam(1)|dhparam(1)>
 307
 308 =head1 HISTORY
 309
 310 B<SSL_OP_CIPHER_SERVER_PREFERENCE> and
 311 B<SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION> have been added in
 312 OpenSSL 0.9.7.
 313
 314 B<SSL_OP_TLS_ROLLBACK_BUG> has been added in OpenSSL 0.9.6 and was automatically
 315 enabled with B<SSL_OP_ALL>. As of 0.9.7, it is no longer included in B<SSL_OP_ALL>
 316 and must be explicitly set.
 317
 318 B<SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS> has been added in OpenSSL 0.9.6e.
 319 Versions up to OpenSSL 0.9.6c do not include the countermeasure that
 320 can be disabled with this option (in OpenSSL 0.9.6d, it was always
 321 enabled).
 322
 323 SSL_CTX_clear_options() and SSL_clear_options() were first added in OpenSSL
 324 0.9.8m.
 325
 326 B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION>, B<SSL_OP_LEGACY_SERVER_CONNECT>
 327 and the function SSL_get_secure_renegotiation_support() were first added in
 328 OpenSSL 0.9.8m.
 329
 330 =cut