doc/ssl/SSL_CTX_set_options.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_CTX_set_options, SSL_set_options, SSL_CTX_get_options, SSL_get_options - manipulate SSL engine 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_get_options(SSL_CTX *ctx);
  15  long SSL_get_options(SSL *ssl);
  16
  17 =head1 DESCRIPTION
  18
  19 SSL_CTX_set_options() adds the options set via bitmask in B<options> to B<ctx>.
  20 Options already set before are not cleared.
  21
  22 SSL_set_options() adds the options set via bitmask in B<options> to B<ssl>.
  23 Options already set before are not cleared.
  24
  25 SSL_CTX_get_options() returns the options set for B<ctx>.
  26
  27 SSL_get_options() returns the options set for B<ssl>.
  28
  29 =head1 NOTES
  30
  31 The behaviour of the SSL library can be changed by setting several options.
  32 The options are coded as bitmasks and can be combined by a logical B<or>
  33 operation (|). Options can only be added but can never be reset.
  34
  35 During a handshake, the option settings of the SSL object used. When
  36 a new SSL object is created from a context using SSL_new(), the current
  37 option setting is copied. Changes to B<ctx> do not affect already created
  38 SSL objects. SSL_clear() does not affect the settings.
  39
  40 The following B<bug workaround> options are available:
  41
  42 =over 4
  43
  44 =item SSL_OP_MICROSOFT_SESS_ID_BUG
  45
  46 www.microsoft.com - when talking SSLv2, if session-id reuse is
  47 performed, the session-id passed back in the server-finished message
  48 is different from the one decided upon.
  49
  50 =item SSL_OP_NETSCAPE_CHALLENGE_BUG
  51
  52 Netscape-Commerce/1.12, when talking SSLv2, accepts a 32 byte
  53 challenge but then appears to only use 16 bytes when generating the
  54 encryption keys.  Using 16 bytes is ok but it should be ok to use 32.
  55 According to the SSLv3 spec, one should use 32 bytes for the challenge
  56 when operating in SSLv2/v3 compatibility mode, but as mentioned above,
  57 this breaks this server so 16 bytes is the way to go.
  58
  59 =item SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG
  60
  61 ssl3.netscape.com:443, first a connection is established with RC4-MD5.
  62 If it is then resumed, we end up using DES-CBC3-SHA.  It should be
  63 RC4-MD5 according to 7.6.1.3, 'cipher_suite'.
  64
  65 Netscape-Enterprise/2.01 (https://merchant.netscape.com) has this bug.
  66 It only really shows up when connecting via SSLv2/v3 then reconnecting
  67 via SSLv3. The cipher list changes....
  68
  69 NEW INFORMATION.  Try connecting with a cipher list of just
  70 DES-CBC-SHA:RC4-MD5.  For some weird reason, each new connection uses
  71 RC4-MD5, but a re-connect tries to use DES-CBC-SHA.  So netscape, when
  72 doing a re-connect, always takes the first cipher in the cipher list.
  73
  74 =item SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG
  75
  76 ...
  77
  78 =item SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER
  79
  80 ...
  81
  82 =item SSL_OP_MSIE_SSLV2_RSA_PADDING
  83
  84 ...
  85
  86 =item SSL_OP_SSLEAY_080_CLIENT_DH_BUG
  87
  88 ...
  89
  90 =item SSL_OP_TLS_D5_BUG
  91
  92 ...
  93
  94 =item SSL_OP_TLS_BLOCK_PADDING_BUG
  95
  96 ...
  97
  98 =item SSL_OP_TLS_ROLLBACK_BUG
  99
 100 Disable version rollback attack detection.
 101
 102 During the client key exchange, the client must send the same information
 103 about acceptable SSL/TLS protocol levels as during the first hello. Some
 104 clients violate this rule by adapting to the server's answer. (Example:
 105 the client sends a SSLv2 hello and accepts up to SSLv3.1=TLSv1, the server
 106 only understands up to SSLv3. In this case the client must still use the
 107 same SSLv3.1=TLSv1 announcement. Some clients step down to SSLv3 with respect
 108 to the server's answer and violate the version rollback protection.)
 109
 110 =item SSL_OP_ALL
 111
 112 All of the above bug workarounds.
 113
 114 =back
 115
 116 It is save and recommended to use SSL_OP_ALL to enable the bug workaround
 117 options.
 118
 119 The following B<modifying> options are available:
 120
 121 =over 4
 122
 123 =item SSL_OP_SINGLE_DH_USE
 124
 125 Always create a new key when using temporary DH parameters.
 126
 127 =item SSL_OP_EPHEMERAL_RSA
 128
 129 Also use the temporary RSA key when doing RSA operations.
 130
 131 =item SSL_OP_CIPHER_SERVER_PREFERENCE
 132
 133 When choosing a cipher, use the server's preferences instead of the client
 134 preferences. When not set, the SSL server will always follow the clients
 135 preferences. When set, the SSLv3/TLSv1 server will choose following its
 136 own preferences. Because of the different protocol, for SSLv2 the server
 137 will send his list of preferences to the client and the client chooses.
 138
 139 =item SSL_OP_PKCS1_CHECK_1
 140
 141 ...
 142
 143 =item SSL_OP_PKCS1_CHECK_2
 144
 145 ...
 146
 147 =item SSL_OP_NETSCAPE_CA_DN_BUG
 148
 149 If we accept a netscape connection, demand a client cert, have a
 150 non-self-sighed CA which does not have it's CA in netscape, and the
 151 browser has a cert, it will crash/hang.  Works for 3.x and 4.xbeta
 152
 153 =item SSL_OP_NON_EXPORT_FIRST
 154
 155 On servers try to use non-export (stronger) ciphers first. This option does
 156 not work under all circumstances (in the code it is declared "broken").
 157
 158 =item SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG
 159
 160 ...
 161
 162 =item SSL_OP_NO_SSLv2
 163
 164 Do not use the SSLv2 protocol.
 165
 166 =item SSL_OP_NO_SSLv3
 167
 168 Do not use the SSLv3 protocol.
 169
 170 =item SSL_OP_NO_TLSv1
 171
 172 Do not use the TLSv1 protocol.
 173
 174 =back
 175
 176 =head1 RETURN VALUES
 177
 178 SSL_CTX_set_options() and SSL_set_options() return the new options bitmask
 179 after adding B<options>.
 180
 181 SSL_CTX_get_options() and SSL_get_options() return the current bitmask.
 182
 183 =head1 SEE ALSO
 184
 185 L<ssl(3)|ssl(3)>, L<SSL_new(3)|SSL_new(3)>, L<SSL_clear(3)|SSL_clear(3)>
 186
 187 =head1 HISTORY
 188
 189 SSL_OP_CIPHER_SERVER_PREFERENCE has been added in OpenSSL 0.9.7.
 190
 191 SSL_OP_TLS_ROLLBACK_BUG has been added in OpenSSL 0.9.6.
 192
 193 =cut