Automatically generated by Pod::Man 2.28 (Pod::Simple 3.30) Standard preamble: ========================================================================..
..
..
Set up some character translations and predefined strings. \*(-- will give an unbreakable dash, \*(PI will give pi, \*(L" will give a left double quote, and \*(R" will give a right double quote. \*(C+ will give a nicer C++. Capital omega is used to do unbreakable dashes and therefore won't be available. \*(C` and \*(C' expand to `' in nroff, nothing in troff, for use with C<>..tr \(*W-
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
Escape single quotes in literal strings from groff's Unicode transform. If the F register is turned on, we'll generate index entries on stderr for titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index entries marked with X<> in POD. Of course, you'll have to process the output yourself in some meaningful fashion. Avoid warning from groff about undefined register 'F'...
.nr rF 0
. if \nF \{
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). Fear. Run. Save yourself. No user-serviceable parts.. \" fudge factors for nroff and troff
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #]
.\}
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
. \" corrections for vroff
. \" for low resolution devices (crt and lpr)
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
======================================================================== Title "SSL_CTX_set_options 3" SSL_CTX_set_options 3 "2015-07-09" "1.0.1p" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes way too many mistakes in technical documents. "NAME"
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
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1
#include <
openssl/
ssl.h>
\&
long SSL_CTX_set_options(SSL_CTX *ctx, long options);
long SSL_set_options(SSL *ssl, long options);
\&
long SSL_CTX_clear_options(SSL_CTX *ctx, long options);
long SSL_clear_options(SSL *ssl, long options);
\&
long SSL_CTX_get_options(SSL_CTX *ctx);
long SSL_get_options(SSL *ssl);
\&
long SSL_get_secure_renegotiation_support(SSL *ssl);
.Ve
"DESCRIPTION"
Header "DESCRIPTION" Note: all these functions are implemented using macros.
\fISSL_CTX_set_options() adds the options set via bitmask in options to ctx.
Options already set before are not cleared!
\fISSL_set_options() adds the options set via bitmask in options to ssl.
Options already set before are not cleared!
\fISSL_CTX_clear_options() clears the options set via bitmask in options
to ctx.
\fISSL_clear_options() clears the options set via bitmask in options to ssl.
\fISSL_CTX_get_options() returns the options set for ctx.
\fISSL_get_options() returns the options set for ssl.
\fISSL_get_secure_renegotiation_support() indicates whether the peer supports
secure renegotiation.
"NOTES"
Header "NOTES" The behaviour of the \s-1SSL\s0 library can be changed by setting several options.
The options are coded as bitmasks and can be combined by a logical
or
operation (|).
\fISSL_CTX_set_options() and SSL_set_options() affect the (external)
protocol behaviour of the \s-1SSL\s0 library. The (internal) behaviour of
the \s-1API\s0 can be changed by using the similar
\fISSL_CTX_set_mode\|(3) and SSL_set_mode() functions.
During a handshake, the option settings of the \s-1SSL\s0 object are used. When
a new \s-1SSL\s0 object is created from a context using SSL_new(), the current
option setting is copied. Changes to ctx do not affect already created
\s-1SSL\s0 objects. SSL_clear() does not affect the settings.
The following bug workaround options are available:
"\s-1SSL_OP_MICROSOFT_SESS_ID_BUG\s0" 4
Item "SSL_OP_MICROSOFT_SESS_ID_BUG" www.microsoft.com - when talking SSLv2, if session-id reuse is
performed, the session-id passed back in the server-finished message
is different from the one decided upon.
"\s-1SSL_OP_NETSCAPE_CHALLENGE_BUG\s0" 4
Item "SSL_OP_NETSCAPE_CHALLENGE_BUG" Netscape-Commerce/1.12, when talking SSLv2, accepts a 32 byte
challenge but then appears to only use 16 bytes when generating the
encryption keys. Using 16 bytes is ok but it should be ok to use 32.
According to the SSLv3 spec, one should use 32 bytes for the challenge
when operating in
SSLv2/
v3 compatibility mode, but as mentioned above,
this breaks this server so 16 bytes is the way to go.
"\s-1SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG\s0" 4
Item "SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG" As of OpenSSL 0.9.8q and 1.0.0c, this option has no effect.
"\s-1SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG\s0" 4
Item "SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG" ...
"\s-1SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER\s0" 4
Item "SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER" ...
"\s-1SSL_OP_SAFARI_ECDHE_ECDSA_BUG\s0" 4
Item "SSL_OP_SAFARI_ECDHE_ECDSA_BUG" Don't prefer ECDHE-ECDSA ciphers when the client appears to be Safari on \s-1OS X.
OS X 10.8..10.8.3\s0 has broken support for ECDHE-ECDSA ciphers.
"\s-1SSL_OP_SSLEAY_080_CLIENT_DH_BUG\s0" 4
Item "SSL_OP_SSLEAY_080_CLIENT_DH_BUG" ...
"\s-1SSL_OP_TLS_D5_BUG\s0" 4
Item "SSL_OP_TLS_D5_BUG" ...
"\s-1SSL_OP_TLS_BLOCK_PADDING_BUG\s0" 4
Item "SSL_OP_TLS_BLOCK_PADDING_BUG" ...
"\s-1SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS\s0" 4
Item "SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS" Disables a countermeasure against a \s-1SSL 3.0/TLS 1.0\s0 protocol
vulnerability affecting \s-1CBC\s0 ciphers, which cannot be handled by some
broken \s-1SSL\s0 implementations. This option has no effect for connections
using other ciphers.
"\s-1SSL_OP_TLSEXT_PADDING\s0" 4
Item "SSL_OP_TLSEXT_PADDING" Adds a padding extension to ensure the ClientHello size is never between
256 and 511 bytes in length. This is needed as a workaround for some
implementations.
"\s-1SSL_OP_ALL\s0" 4
Item "SSL_OP_ALL" All of the above bug workarounds.
It is usually safe to use \s-1SSL_OP_ALL\s0 to enable the bug workaround
options if compatibility with somewhat broken implementations is
desired.
The following modifying options are available:
"\s-1SSL_OP_TLS_ROLLBACK_BUG\s0" 4
Item "SSL_OP_TLS_ROLLBACK_BUG" Disable version rollback attack detection.
.Sp
During the client key exchange, the client must send the same information
about acceptable \
s-1SSL/
TLS\s0 protocol levels as during the first hello. Some
clients violate this rule by adapting to the server's answer. (Example:
the client sends a SSLv2 hello and accepts up to SSLv3.1=TLSv1, the server
only understands up to SSLv3. In this case the client must still use the
same SSLv3.1=TLSv1 announcement. Some clients step down to SSLv3 with respect
to the server's answer and violate the version rollback protection.)
"\s-1SSL_OP_SINGLE_DH_USE\s0" 4
Item "SSL_OP_SINGLE_DH_USE" Always create a new key when using
temporary/
ephemeral \s-1DH\s0 parameters
(see
SSL_CTX_set_tmp_dh_callback\|(3)).
This option must be used to prevent small subgroup attacks, when
the \s-1DH\s0 parameters were not generated using \*(L"strong\*(R" primes
(e.g. when using DSA-parameters, see
dhparam\|(1)).
If \*(L"strong\*(R" primes were used, it is not strictly necessary to generate
a new \s-1DH\s0 key during each handshake but it is also recommended.
\fB\s-1SSL_OP_SINGLE_DH_USE\s0 should therefore be enabled whenever
temporary/
ephemeral \s-1DH\s0 parameters are used.
"\s-1SSL_OP_EPHEMERAL_RSA\s0" 4
Item "SSL_OP_EPHEMERAL_RSA" This option is no longer implemented and is treated as no op.
"\s-1SSL_OP_CIPHER_SERVER_PREFERENCE\s0" 4
Item "SSL_OP_CIPHER_SERVER_PREFERENCE" When choosing a cipher, use the server's preferences instead of the client
preferences. When not set, the \s-1SSL\s0 server will always follow the clients
preferences. When set, the
SSLv3/
TLSv1 server will choose following its
own preferences. Because of the different protocol, for SSLv2 the server
will send its list of preferences to the client and the client chooses.
"\s-1SSL_OP_PKCS1_CHECK_1\s0" 4
Item "SSL_OP_PKCS1_CHECK_1" ...
"\s-1SSL_OP_PKCS1_CHECK_2\s0" 4
Item "SSL_OP_PKCS1_CHECK_2" ...
"\s-1SSL_OP_NETSCAPE_CA_DN_BUG\s0" 4
Item "SSL_OP_NETSCAPE_CA_DN_BUG" If we accept a netscape connection, demand a client cert, have a
non-self-signed \s-1CA\s0 which does not have its \s-1CA\s0 in netscape, and the
browser has a cert, it will
crash/
hang. Works for 3.x and 4.xbeta
"\s-1SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG\s0" 4
Item "SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG" ...
"SSL_OP_NO_SSLv2" 4
Item "SSL_OP_NO_SSLv2" Do not use the SSLv2 protocol.
"SSL_OP_NO_SSLv3" 4
Item "SSL_OP_NO_SSLv3" Do not use the SSLv3 protocol.
"SSL_OP_NO_TLSv1" 4
Item "SSL_OP_NO_TLSv1" Do not use the TLSv1 protocol.
"\s-1SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION\s0" 4
Item "SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION" When performing renegotiation as a server, always start a new session
(i.e., session resumption requests are only accepted in the initial
handshake). This option is not needed for clients.
"\s-1SSL_OP_NO_TICKET\s0" 4
Item "SSL_OP_NO_TICKET" Normally clients and servers will, where possible, transparently make use
of RFC4507bis tickets for stateless session resumption.
.Sp
If this option is set this functionality is disabled and tickets will
not be used by clients or servers.
"\s-1SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION\s0" 4
Item "SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION" Allow legacy insecure renegotiation between OpenSSL and unpatched clients or
servers. See the
\s-1SECURE RENEGOTIATION\s0 section for more details.
"\s-1SSL_OP_LEGACY_SERVER_CONNECT\s0" 4
Item "SSL_OP_LEGACY_SERVER_CONNECT" Allow legacy insecure renegotiation between OpenSSL and unpatched servers
\fBonly: this option is currently set by default. See the
\fB\s-1SECURE RENEGOTIATION\s0 section for more details.
"SECURE RENEGOTIATION"
Header "SECURE RENEGOTIATION" OpenSSL 0.9.8m and later always attempts to use secure renegotiation as
described in \s-1RFC5746.\s0 This counters the prefix attack described in
\s-1CVE-2009-3555\s0 and elsewhere.
The deprecated and highly broken SSLv2 protocol does not support
renegotiation at all: its use is strongly discouraged.
This attack has far reaching consequences which application writers should be
aware of. In the description below an implementation supporting secure
renegotiation is referred to as patched. A server not supporting secure
renegotiation is referred to as unpatched.
The following sections describe the operations permitted by OpenSSL's secure
renegotiation implementation.
"Patched client and server"
Subsection "Patched client and server" Connections and renegotiation are always permitted by OpenSSL implementations.
"Unpatched client and patched OpenSSL server"
Subsection "Unpatched client and patched OpenSSL server" The initial connection succeeds but client renegotiation is denied by the
server with a
no_renegotiation warning alert if \s-1TLS\s0 v1.0 is used or a fatal
\fBhandshake_failure alert in \s-1SSL\s0 v3.0.
If the patched OpenSSL server attempts to renegotiate a fatal
\fBhandshake_failure alert is sent. This is because the server code may be
unaware of the unpatched nature of the client.
If the option \s-1SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION\s0 is set then
renegotiation always succeeds.
\fB\s-1NB:\s0 a bug in OpenSSL clients earlier than 0.9.8m (all of which are
unpatched) will result in the connection hanging if it receives a
\fBno_renegotiation alert. OpenSSL versions 0.9.8m and later will regard
a no_renegotiation alert as fatal and respond with a fatal
\fBhandshake_failure alert. This is because the OpenSSL \s-1API\s0 currently has
no provision to indicate to an application that a renegotiation attempt
was refused.
"Patched OpenSSL client and unpatched server."
Subsection "Patched OpenSSL client and unpatched server." If the option
\s-1SSL_OP_LEGACY_SERVER_CONNECT\s0 or
\fB\s-1SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION\s0 is set then initial connections
and renegotiation between patched OpenSSL clients and unpatched servers
succeeds. If neither option is set then initial connections to unpatched
servers will fail.
The option \s-1SSL_OP_LEGACY_SERVER_CONNECT\s0 is currently set by default even
though it has security implications: otherwise it would be impossible to
connect to unpatched servers (i.e. all of them initially) and this is clearly
not acceptable. Renegotiation is permitted because this does not add any
additional security issues: during an attack clients do not see any
renegotiations anyway.
As more servers become patched the option \s-1SSL_OP_LEGACY_SERVER_CONNECT\s0 will
\fBnot be set by default in a future version of OpenSSL.
OpenSSL client applications wishing to ensure they can connect to unpatched
servers should always set \s-1SSL_OP_LEGACY_SERVER_CONNECT\s0
OpenSSL client applications that want to ensure they can not connect to
unpatched servers (and thus avoid any security issues) should always clear
\fB\s-1SSL_OP_LEGACY_SERVER_CONNECT\s0 using SSL_CTX_clear_options() or
\fISSL_clear_options().
The difference between the \s-1SSL_OP_LEGACY_SERVER_CONNECT\s0 and
\fB\s-1SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION\s0 options is that
\fB\s-1SSL_OP_LEGACY_SERVER_CONNECT\s0 enables initial connections and secure
renegotiation between OpenSSL clients and unpatched servers only, while
\fB\s-1SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION\s0 allows initial connections
and renegotiation between OpenSSL and unpatched clients or servers.
"RETURN VALUES"
Header "RETURN VALUES" \fISSL_CTX_set_options() and
SSL_set_options() return the new options bitmask
after adding
options.
\fISSL_CTX_clear_options() and SSL_clear_options() return the new options bitmask
after clearing options.
\fISSL_CTX_get_options() and SSL_get_options() return the current bitmask.
\fISSL_get_secure_renegotiation_support() returns 1 is the peer supports
secure renegotiation and 0 if it does not.
"SEE ALSO"
Header "SEE ALSO" \fIssl\|(3),
SSL_new\|(3),
SSL_clear\|(3),
\fISSL_CTX_set_tmp_dh_callback\|(3),
\fISSL_CTX_set_tmp_rsa_callback\|(3),
\fIdhparam\|(1)
"HISTORY"
Header "HISTORY" \fB\s-1SSL_OP_CIPHER_SERVER_PREFERENCE\s0 and
\fB\s-1SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION\s0 have been added in
OpenSSL 0.9.7.
\fB\s-1SSL_OP_TLS_ROLLBACK_BUG\s0 has been added in OpenSSL 0.9.6 and was automatically
enabled with \s-1SSL_OP_ALL\s0. As of 0.9.7, it is no longer included in \s-1SSL_OP_ALL\s0
and must be explicitly set.
\fB\s-1SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS\s0 has been added in OpenSSL 0.9.6e.
Versions up to OpenSSL 0.9.6c do not include the countermeasure that
can be disabled with this option (in OpenSSL 0.9.6d, it was always
enabled).
\fISSL_CTX_clear_options() and SSL_clear_options() were first added in OpenSSL
0.9.8m.
\fB\s-1SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION\s0, \s-1SSL_OP_LEGACY_SERVER_CONNECT\s0
and the function SSL_get_secure_renegotiation_support() were first added in
OpenSSL 0.9.8m.