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_DONT_INSERT_EMPTY_FRAGMENTS
  98
  99 Disables a countermeasure against a SSL 3.0/TLS 1.0 protocol
 100 vulnerability affecting CBC ciphers, which cannot be handled by some
 101 broken SSL implementations.  This option has no effect for connections
 102 using other ciphers.
 103
 104 =item SSL_OP_TLSEXT_PADDING
 105
 106 Adds a padding extension to ensure the ClientHello size is never between
 107 256 and 511 bytes in length. This is needed as a workaround for some
 108 implementations.
 109
 110 =item SSL_OP_ALL
 111
 112 All of the above bug workarounds.
 113
 114 =back
 115
 116 It is usually safe to use B<SSL_OP_ALL> to enable the bug workaround
 117 options if compatibility with somewhat broken implementations is
 118 desired.
 119
 120 The following B<modifying> options are available:
 121
 122 =over 4
 123
 124 =item SSL_OP_TLS_ROLLBACK_BUG
 125
 126 Disable version rollback attack detection.
 127
 128 During the client key exchange, the client must send the same information
 129 about acceptable SSL/TLS protocol levels as during the first hello. Some
 130 clients violate this rule by adapting to the server's answer. (Example:
 131 the client sends a SSLv2 hello and accepts up to SSLv3.1=TLSv1, the server
 132 only understands up to SSLv3. In this case the client must still use the
 133 same SSLv3.1=TLSv1 announcement. Some clients step down to SSLv3 with respect
 134 to the server's answer and violate the version rollback protection.)
 135
 136 =item SSL_OP_SINGLE_DH_USE
 137
 138 Always create a new key when using temporary/ephemeral DH parameters
 139 (see L<SSL_CTX_set_tmp_dh_callback(3)|SSL_CTX_set_tmp_dh_callback(3)>).
 140 This option must be used to prevent small subgroup attacks, when
 141 the DH parameters were not generated using "strong" primes
 142 (e.g. when using DSA-parameters, see L<dhparam(1)|dhparam(1)>).
 143 If "strong" primes were used, it is not strictly necessary to generate
 144 a new DH key during each handshake but it is also recommended.
 145 B<SSL_OP_SINGLE_DH_USE> should therefore be enabled whenever
 146 temporary/ephemeral DH parameters are used.
 147
 148 =item SSL_OP_EPHEMERAL_RSA
 149
 150 This option is no longer implemented and is treated as no op.
 151
 152 =item SSL_OP_CIPHER_SERVER_PREFERENCE
 153
 154 When choosing a cipher, use the server's preferences instead of the client
 155 preferences. When not set, the SSL server will always follow the clients
 156 preferences. When set, the SSLv3/TLSv1 server will choose following its
 157 own preferences. Because of the different protocol, for SSLv2 the server
 158 will send its list of preferences to the client and the client chooses.
 159
 160 =item SSL_OP_PKCS1_CHECK_1
 161
 162 ...
 163
 164 =item SSL_OP_PKCS1_CHECK_2
 165
 166 ...
 167
 168
 169
 170 =item SSL_OP_NO_SSLv2
 171
 172 Do not use the SSLv2 protocol.
 173
 174 =item SSL_OP_NO_SSLv3
 175
 176 Do not use the SSLv3 protocol.
 177
 178 =item SSL_OP_NO_TLSv1
 179
 180 Do not use the TLSv1 protocol.
 181
 182 =item SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION
 183
 184 When performing renegotiation as a server, always start a new session
 185 (i.e., session resumption requests are only accepted in the initial
 186 handshake). This option is not needed for clients.
 187
 188 =item SSL_OP_NO_TICKET
 189
 190 Normally clients and servers will, where possible, transparently make use
 191 of RFC4507bis tickets for stateless session resumption.
 192
 193 If this option is set this functionality is disabled and tickets will
 194 not be used by clients or servers.
 195
 196 =item SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION
 197
 198 Allow legacy insecure renegotiation between OpenSSL and unpatched clients or
 199 servers. See the B<SECURE RENEGOTIATION> section for more details.
 200
 201 =item SSL_OP_LEGACY_SERVER_CONNECT
 202
 203 Allow legacy insecure renegotiation between OpenSSL and unpatched servers
 204 B<only>: this option is currently set by default. See the
 205 B<SECURE RENEGOTIATION> section for more details.
 206
 207 =back
 208
 209 =head1 SECURE RENEGOTIATION
 210
 211 OpenSSL 0.9.8m and later always attempts to use secure renegotiation as
 212 described in RFC5746. This counters the prefix attack described in
 213 CVE-2009-3555 and elsewhere.
 214
 215 The deprecated and highly broken SSLv2 protocol does not support
 216 renegotiation at all: its use is B<strongly> discouraged.
 217
 218 This attack has far reaching consequences which application writers should be
 219 aware of. In the description below an implementation supporting secure
 220 renegotiation is referred to as I<patched>. A server not supporting secure
 221 renegotiation is referred to as I<unpatched>.
 222
 223 The following sections describe the operations permitted by OpenSSL's secure
 224 renegotiation implementation.
 225
 226 =head2 Patched client and server
 227
 228 Connections and renegotiation are always permitted by OpenSSL implementations.
 229
 230 =head2 Unpatched client and patched OpenSSL server
 231
 232 The initial connection succeeds but client renegotiation is denied by the
 233 server with a B<no_renegotiation> warning alert if TLS v1.0 is used or a fatal
 234 B<handshake_failure> alert in SSL v3.0.
 235
 236 If the patched OpenSSL server attempts to renegotiate a fatal
 237 B<handshake_failure> alert is sent. This is because the server code may be
 238 unaware of the unpatched nature of the client.
 239
 240 If the option B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION> is set then
 241 renegotiation B<always> succeeds.
 242
 243 B<NB:> a bug in OpenSSL clients earlier than 0.9.8m (all of which are
 244 unpatched) will result in the connection hanging if it receives a
 245 B<no_renegotiation> alert. OpenSSL versions 0.9.8m and later will regard
 246 a B<no_renegotiation> alert as fatal and respond with a fatal
 247 B<handshake_failure> alert. This is because the OpenSSL API currently has
 248 no provision to indicate to an application that a renegotiation attempt
 249 was refused.
 250
 251 =head2 Patched OpenSSL client and unpatched server.
 252
 253 If the option B<SSL_OP_LEGACY_SERVER_CONNECT> or
 254 B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION> is set then initial connections
 255 and renegotiation between patched OpenSSL clients and unpatched servers
 256 succeeds. If neither option is set then initial connections to unpatched
 257 servers will fail.
 258
 259 The option B<SSL_OP_LEGACY_SERVER_CONNECT> is currently set by default even
 260 though it has security implications: otherwise it would be impossible to
 261 connect to unpatched servers (i.e. all of them initially) and this is clearly
 262 not acceptable. Renegotiation is permitted because this does not add any
 263 additional security issues: during an attack clients do not see any
 264 renegotiations anyway.
 265
 266 As more servers become patched the option B<SSL_OP_LEGACY_SERVER_CONNECT> will
 267 B<not> be set by default in a future version of OpenSSL.
 268
 269 OpenSSL client applications wishing to ensure they can connect to unpatched
 270 servers should always B<set> B<SSL_OP_LEGACY_SERVER_CONNECT>
 271
 272 OpenSSL client applications that want to ensure they can B<not> connect to
 273 unpatched servers (and thus avoid any security issues) should always B<clear>
 274 B<SSL_OP_LEGACY_SERVER_CONNECT> using SSL_CTX_clear_options() or
 275 SSL_clear_options().
 276
 277 The difference between the B<SSL_OP_LEGACY_SERVER_CONNECT> and
 278 B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION> options is that
 279 B<SSL_OP_LEGACY_SERVER_CONNECT> enables initial connections and secure
 280 renegotiation between OpenSSL clients and unpatched servers B<only>, while
 281 B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION> allows initial connections
 282 and renegotiation between OpenSSL and unpatched clients or servers.
 283
 284 =head1 RETURN VALUES
 285
 286 SSL_CTX_set_options() and SSL_set_options() return the new options bitmask
 287 after adding B<options>.
 288
 289 SSL_CTX_clear_options() and SSL_clear_options() return the new options bitmask
 290 after clearing B<options>.
 291
 292 SSL_CTX_get_options() and SSL_get_options() return the current bitmask.
 293
 294 SSL_get_secure_renegotiation_support() returns 1 is the peer supports
 295 secure renegotiation and 0 if it does not.
 296
 297 =head1 SEE ALSO
 298
 299 L<ssl(3)|ssl(3)>, L<SSL_new(3)|SSL_new(3)>, L<SSL_clear(3)|SSL_clear(3)>,
 300 L<SSL_CTX_set_tmp_dh_callback(3)|SSL_CTX_set_tmp_dh_callback(3)>,
 301 L<SSL_CTX_set_tmp_rsa_callback(3)|SSL_CTX_set_tmp_rsa_callback(3)>,
 302 L<dhparam(1)|dhparam(1)>
 303
 304 =head1 HISTORY
 305
 306 B<SSL_OP_CIPHER_SERVER_PREFERENCE> and
 307 B<SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION> have been added in
 308 OpenSSL 0.9.7.
 309
 310 B<SSL_OP_TLS_ROLLBACK_BUG> has been added in OpenSSL 0.9.6 and was automatically
 311 enabled with B<SSL_OP_ALL>. As of 0.9.7, it is no longer included in B<SSL_OP_ALL>
 312 and must be explicitly set.
 313
 314 B<SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS> has been added in OpenSSL 0.9.6e.
 315 Versions up to OpenSSL 0.9.6c do not include the countermeasure that
 316 can be disabled with this option (in OpenSSL 0.9.6d, it was always
 317 enabled).
 318
 319 SSL_CTX_clear_options() and SSL_clear_options() were first added in OpenSSL
 320 0.9.8m.
 321
 322 B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION>, B<SSL_OP_LEGACY_SERVER_CONNECT>
 323 and the function SSL_get_secure_renegotiation_support() were first added in
 324 OpenSSL 0.9.8m.
 325
 326 =cut