Deleted Added
full compact
SSL_CTX_set_options.pod (76866) SSL_CTX_set_options.pod (89837)
1=pod
2
3=head1 NAME
4
5SSL_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
19SSL_CTX_set_options() adds the options set via bitmask in B<options> to B<ctx>.
1=pod
2
3=head1 NAME
4
5SSL_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
19SSL_CTX_set_options() adds the options set via bitmask in B<options> to B<ctx>.
20Options already set before are not cleared.
20Options already set before are not cleared!
21
22SSL_set_options() adds the options set via bitmask in B<options> to B<ssl>.
21
22SSL_set_options() adds the options set via bitmask in B<options> to B<ssl>.
23Options already set before are not cleared.
23Options already set before are not cleared!
24
25SSL_CTX_get_options() returns the options set for B<ctx>.
26
27SSL_get_options() returns the options set for B<ssl>.
28
29=head1 NOTES
30
31The behaviour of the SSL library can be changed by setting several options.
32The options are coded as bitmasks and can be combined by a logical B<or>
33operation (|). Options can only be added but can never be reset.
34
24
25SSL_CTX_get_options() returns the options set for B<ctx>.
26
27SSL_get_options() returns the options set for B<ssl>.
28
29=head1 NOTES
30
31The behaviour of the SSL library can be changed by setting several options.
32The options are coded as bitmasks and can be combined by a logical B<or>
33operation (|). Options can only be added but can never be reset.
34
35During a handshake, the option settings of the SSL object used. When
35SSL_CTX_set_options() and SSL_set_options() affect the (external)
36protocol behaviour of the SSL library. The (internal) behaviour of
37the API can be changed by using the similar
38L<SSL_CTX_set_modes(3)|SSL_CTX_set_modes(3)> and SSL_set_modes() functions.
39
40During a handshake, the option settings of the SSL object are used. When
36a new SSL object is created from a context using SSL_new(), the current
37option setting is copied. Changes to B<ctx> do not affect already created
38SSL objects. SSL_clear() does not affect the settings.
39
40The following B<bug workaround> options are available:
41
42=over 4
43

--- 73 unchanged lines hidden (view full) ---

117options.
118
119The following B<modifying> options are available:
120
121=over 4
122
123=item SSL_OP_SINGLE_DH_USE
124
41a new SSL object is created from a context using SSL_new(), the current
42option setting is copied. Changes to B<ctx> do not affect already created
43SSL objects. SSL_clear() does not affect the settings.
44
45The following B<bug workaround> options are available:
46
47=over 4
48

--- 73 unchanged lines hidden (view full) ---

122options.
123
124The following B<modifying> options are available:
125
126=over 4
127
128=item SSL_OP_SINGLE_DH_USE
129
125Always create a new key when using temporary DH parameters.
130Always create a new key when using temporary/ephemeral DH parameters
131(see L<SSL_CTX_set_tmp_dh_callback(3)|SSL_CTX_set_tmp_dh_callback(3)>).
132This option must be used to prevent small subgroup attacks, when
133the DH parameters were not generated using "strong" primes
134(e.g. when using DSA-parameters, see L<dhparam(1)|dhparam(1)>).
135If "strong" primes were used, it is not strictly necessary to generate
136a new DH key during each handshake but it is also recommended.
137SSL_OP_SINGLE_DH_USE should therefore be enabled whenever
138temporary/ephemeral DH parameters are used.
126
127=item SSL_OP_EPHEMERAL_RSA
128
139
140=item SSL_OP_EPHEMERAL_RSA
141
129Also use the temporary RSA key when doing RSA operations.
142Always use ephemeral (temporary) RSA key when doing RSA operations
143(see L<SSL_CTX_set_tmp_rsa_callback(3)|SSL_CTX_set_tmp_rsa_callback(3)>).
144According to the specifications this is only done, when a RSA key
145can only be used for signature operations (namely under export ciphers
146with restricted RSA keylength). By setting this option, ephemeral
147RSA keys are always used. This option breaks compatibility with the
148SSL/TLS specifications and may lead to interoperability problems with
149clients and should therefore never be used. Ciphers with EDH (ephemeral
150Diffie-Hellman) key exchange should be used instead.
130
131=item SSL_OP_PKCS1_CHECK_1
132
133...
134
135=item SSL_OP_PKCS1_CHECK_2
136
137...
138
139=item SSL_OP_NETSCAPE_CA_DN_BUG
140
141If we accept a netscape connection, demand a client cert, have a
142non-self-sighed CA which does not have it's CA in netscape, and the
143browser has a cert, it will crash/hang. Works for 3.x and 4.xbeta
144
151
152=item SSL_OP_PKCS1_CHECK_1
153
154...
155
156=item SSL_OP_PKCS1_CHECK_2
157
158...
159
160=item SSL_OP_NETSCAPE_CA_DN_BUG
161
162If we accept a netscape connection, demand a client cert, have a
163non-self-sighed CA which does not have it's CA in netscape, and the
164browser has a cert, it will crash/hang. Works for 3.x and 4.xbeta
165
145=item SSL_OP_NON_EXPORT_FIRST
146
147On servers try to use non-export (stronger) ciphers first. This option does
148not work under all circumstances (in the code it is declared "broken").
149
150=item SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG
151
152...
153
154=item SSL_OP_NO_SSLv2
155
156Do not use the SSLv2 protocol.
157

--- 11 unchanged lines hidden (view full) ---

169
170SSL_CTX_set_options() and SSL_set_options() return the new options bitmask
171after adding B<options>.
172
173SSL_CTX_get_options() and SSL_get_options() return the current bitmask.
174
175=head1 SEE ALSO
176
166=item SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG
167
168...
169
170=item SSL_OP_NO_SSLv2
171
172Do not use the SSLv2 protocol.
173

--- 11 unchanged lines hidden (view full) ---

185
186SSL_CTX_set_options() and SSL_set_options() return the new options bitmask
187after adding B<options>.
188
189SSL_CTX_get_options() and SSL_get_options() return the current bitmask.
190
191=head1 SEE ALSO
192
177L, L, L
193L<ssl(3)|ssl(3)>, L<SSL_new(3)|SSL_new(3)>, L<SSL_clear(3)|SSL_clear(3)>,
194L<SSL_CTX_set_tmp_dh_callback(3)|SSL_CTX_set_tmp_dh_callback(3)>,
195L<SSL_CTX_set_tmp_rsa_callback(3)|SSL_CTX_set_tmp_rsa_callback(3)>,
196L<dhparam(1)|dhparam(1)>
178
179=head1 HISTORY
180
181SSL_OP_TLS_ROLLBACK_BUG has been added in OpenSSL 0.9.6.
182
183=cut
197
198=head1 HISTORY
199
200SSL_OP_TLS_ROLLBACK_BUG has been added in OpenSSL 0.9.6.
201
202=cut