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