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,
   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 Note: all these functions are implemented using macros.
  27
  28 SSL_CTX_set_options() adds the options set via bitmask in B<options> to B<ctx>.
  29 Options already set before are not cleared!
  30
  31 SSL_set_options() adds the options set via bitmask in B<options> to B<ssl>.
  32 Options already set before are not cleared!
  33
  34 SSL_CTX_clear_options() clears the options set via bitmask in B<options>
  35 to B<ctx>.
  36
  37 SSL_clear_options() clears the options set via bitmask in B<options> to B<ssl>.
  38
  39 SSL_CTX_get_options() returns the options set for B<ctx>.
  40
  41 SSL_get_options() returns the options set for B<ssl>.
  42
  43 SSL_get_secure_renegotiation_support() indicates whether the peer supports
  44 secure renegotiation.
  45
  46 =head1 NOTES
  47
  48 The behaviour of the SSL library can be changed by setting several options.
  49 The options are coded as bitmasks and can be combined by a bitwise B<or>
  50 operation (|).
  51
  52 SSL_CTX_set_options() and SSL_set_options() affect the (external)
  53 protocol behaviour of the SSL library. The (internal) behaviour of
  54 the API can be changed by using the similar
  55 L<SSL_CTX_set_mode(3)> and SSL_set_mode() functions.
  56
  57 During a handshake, the option settings of the SSL object are used. When
  58 a new SSL object is created from a context using SSL_new(), the current
  59 option setting is copied. Changes to B<ctx> do not affect already created
  60 SSL objects. SSL_clear() does not affect the settings.
  61
  62 The following B<bug workaround> options are available:
  63
  64 =over 4
  65
  66 =item SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG
  67
  68 ...
  69
  70 =item SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER
  71
  72 ...
  73
  74 =item SSL_OP_SAFARI_ECDHE_ECDSA_BUG
  75
  76 Don't prefer ECDHE-ECDSA ciphers when the client appears to be Safari on OS X.
  77 OS X 10.8..10.8.3 has broken support for ECDHE-ECDSA ciphers.
  78
  79 =item SSL_OP_SSLEAY_080_CLIENT_DH_BUG
  80
  81 ...
  82
  83 =item SSL_OP_TLS_D5_BUG
  84
  85 ...
  86
  87 =item SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS
  88
  89 Disables a countermeasure against a SSL 3.0/TLS 1.0 protocol
  90 vulnerability affecting CBC ciphers, which cannot be handled by some
  91 broken SSL implementations.  This option has no effect for connections
  92 using other ciphers.
  93
  94 =item SSL_OP_TLSEXT_PADDING
  95
  96 Adds a padding extension to ensure the ClientHello size is never between
  97 256 and 511 bytes in length. This is needed as a workaround for some
  98 implementations.
  99
 100 =item SSL_OP_ALL
 101
 102 All of the above bug workarounds.
 103
 104 =back
 105
 106 It is usually safe to use B<SSL_OP_ALL> to enable the bug workaround
 107 options if compatibility with somewhat broken implementations is
 108 desired.
 109
 110 The following B<modifying> options are available:
 111
 112 =over 4
 113
 114 =item SSL_OP_TLS_ROLLBACK_BUG
 115
 116 Disable version rollback attack detection.
 117
 118 During the client key exchange, the client must send the same information
 119 about acceptable SSL/TLS protocol levels as during the first hello. Some
 120 clients violate this rule by adapting to the server's answer. (Example:
 121 the client sends a SSLv2 hello and accepts up to SSLv3.1=TLSv1, the server
 122 only understands up to SSLv3. In this case the client must still use the
 123 same SSLv3.1=TLSv1 announcement. Some clients step down to SSLv3 with respect
 124 to the server's answer and violate the version rollback protection.)
 125
 126 =item SSL_OP_SINGLE_DH_USE
 127
 128 Always create a new key when using temporary/ephemeral DH parameters
 129 (see L<SSL_CTX_set_tmp_dh_callback(3)>).
 130 This option must be used to prevent small subgroup attacks, when
 131 the DH parameters were not generated using "strong" primes
 132 (e.g. when using DSA-parameters, see L<dhparam(1)>).
 133 If "strong" primes were used, it is not strictly necessary to generate
 134 a new DH key during each handshake but it is also recommended.
 135 B<SSL_OP_SINGLE_DH_USE> should therefore be enabled whenever
 136 temporary/ephemeral DH parameters are used.
 137
 138 =item SSL_OP_EPHEMERAL_RSA
 139
 140 This option is no longer implemented and is treated as no op.
 141
 142 =item SSL_OP_CIPHER_SERVER_PREFERENCE
 143
 144 When choosing a cipher, use the server's preferences instead of the client
 145 preferences. When not set, the SSL server will always follow the clients
 146 preferences. When set, the SSL/TLS server will choose following its
 147 own preferences.
 148
 149 =item SSL_OP_PKCS1_CHECK_1
 150
 151 ...
 152
 153 =item SSL_OP_PKCS1_CHECK_2
 154
 155 ...
 156
 157
 158 =item SSL_OP_NO_SSLv3, SSL_OP_NO_TLSv1, SSL_OP_NO_TLSv1_1,
 159 SSL_OP_NO_TLSv1_2, SSL_OP_NO_DTLSv1, SSL_OP_NO_DTLSv1_2
 160
 161 These options turn off the SSLv3, TLSv1, TLSv1.1 or TLSv1.2 protocol
 162 versions with TLS or the DTLSv1, DTLSv1.2 versions with DTLS,
 163 respectively.
 164 As of OpenSSL 1.1.0, these options are deprecated, use
 165 L<SSL_CTX_set_min_proto_version(3)> and
 166 L<SSL_CTX_set_max_proto_version(3)> instead.
 167
 168 =item SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION
 169
 170 When performing renegotiation as a server, always start a new session
 171 (i.e., session resumption requests are only accepted in the initial
 172 handshake). This option is not needed for clients.
 173
 174 =item SSL_OP_NO_TICKET
 175
 176 Normally clients and servers will, where possible, transparently make use
 177 of RFC4507bis tickets for stateless session resumption.
 178
 179 If this option is set this functionality is disabled and tickets will
 180 not be used by clients or servers.
 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 =back
 194
 195 =head1 SECURE RENEGOTIATION
 196
 197 OpenSSL always attempts to use secure renegotiation as
 198 described in RFC5746. This counters the prefix attack described in
 199 CVE-2009-3555 and elsewhere.
 200
 201 This attack has far reaching consequences which application writers should be
 202 aware of. In the description below an implementation supporting secure
 203 renegotiation is referred to as I<patched>. A server not supporting secure
 204 renegotiation is referred to as I<unpatched>.
 205
 206 The following sections describe the operations permitted by OpenSSL's secure
 207 renegotiation implementation.
 208
 209 =head2 Patched client and server
 210
 211 Connections and renegotiation are always permitted by OpenSSL implementations.
 212
 213 =head2 Unpatched client and patched OpenSSL server
 214
 215 The initial connection succeeds but client renegotiation is denied by the
 216 server with a B<no_renegotiation> warning alert if TLS v1.0 is used or a fatal
 217 B<handshake_failure> alert in SSL v3.0.
 218
 219 If the patched OpenSSL server attempts to renegotiate a fatal
 220 B<handshake_failure> alert is sent. This is because the server code may be
 221 unaware of the unpatched nature of the client.
 222
 223 If the option B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION> is set then
 224 renegotiation B<always> succeeds.
 225
 226 =head2 Patched OpenSSL client and unpatched server.
 227
 228 If the option B<SSL_OP_LEGACY_SERVER_CONNECT> or
 229 B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION> is set then initial connections
 230 and renegotiation between patched OpenSSL clients and unpatched servers
 231 succeeds. If neither option is set then initial connections to unpatched
 232 servers will fail.
 233
 234 The option B<SSL_OP_LEGACY_SERVER_CONNECT> is currently set by default even
 235 though it has security implications: otherwise it would be impossible to
 236 connect to unpatched servers (i.e. all of them initially) and this is clearly
 237 not acceptable. Renegotiation is permitted because this does not add any
 238 additional security issues: during an attack clients do not see any
 239 renegotiations anyway.
 240
 241 As more servers become patched the option B<SSL_OP_LEGACY_SERVER_CONNECT> will
 242 B<not> be set by default in a future version of OpenSSL.
 243
 244 OpenSSL client applications wishing to ensure they can connect to unpatched
 245 servers should always B<set> B<SSL_OP_LEGACY_SERVER_CONNECT>
 246
 247 OpenSSL client applications that want to ensure they can B<not> connect to
 248 unpatched servers (and thus avoid any security issues) should always B<clear>
 249 B<SSL_OP_LEGACY_SERVER_CONNECT> using SSL_CTX_clear_options() or
 250 SSL_clear_options().
 251
 252 The difference between the B<SSL_OP_LEGACY_SERVER_CONNECT> and
 253 B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION> options is that
 254 B<SSL_OP_LEGACY_SERVER_CONNECT> enables initial connections and secure
 255 renegotiation between OpenSSL clients and unpatched servers B<only>, while
 256 B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION> allows initial connections
 257 and renegotiation between OpenSSL and unpatched clients or servers.
 258
 259 =head1 RETURN VALUES
 260
 261 SSL_CTX_set_options() and SSL_set_options() return the new options bitmask
 262 after adding B<options>.
 263
 264 SSL_CTX_clear_options() and SSL_clear_options() return the new options bitmask
 265 after clearing B<options>.
 266
 267 SSL_CTX_get_options() and SSL_get_options() return the current bitmask.
 268
 269 SSL_get_secure_renegotiation_support() returns 1 is the peer supports
 270 secure renegotiation and 0 if it does not.
 271
 272 =head1 SEE ALSO
 273
 274 L<ssl(3)>, L<SSL_new(3)>, L<SSL_clear(3)>,
 275 L<SSL_CTX_set_tmp_dh_callback(3)>,
 276 L<SSL_CTX_set_min_proto_version(3)>,
 277 L<dhparam(1)>
 278
 279 =head1 HISTORY
 280
 281 The attempt to always try to use secure renegotiation was added in
 282 Openssl 0.9.8m.
 283
 284 =cut