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