Blame doc/man3/SSL_CONF_cmd.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
SSL_CONF_cmd_value_type,
Packit c4476c
SSL_CONF_cmd - send configuration command
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 #include <openssl/ssl.h>
Packit c4476c
Packit c4476c
 int SSL_CONF_cmd(SSL_CONF_CTX *cctx, const char *cmd, const char *value);
Packit c4476c
 int SSL_CONF_cmd_value_type(SSL_CONF_CTX *cctx, const char *cmd);
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
The function SSL_CONF_cmd() performs configuration operation B<cmd> with
Packit c4476c
optional parameter B<value> on B<ctx>. Its purpose is to simplify application
Packit c4476c
configuration of B<SSL_CTX> or B<SSL> structures by providing a common
Packit c4476c
framework for command line options or configuration files.
Packit c4476c
Packit c4476c
SSL_CONF_cmd_value_type() returns the type of value that B<cmd> refers to.
Packit c4476c
Packit c4476c
=head1 SUPPORTED COMMAND LINE COMMANDS
Packit c4476c
Packit c4476c
Currently supported B<cmd> names for command lines (i.e. when the
Packit c4476c
flag B<SSL_CONF_CMDLINE> is set) are listed below. Note: all B<cmd> names
Packit c4476c
are case sensitive. Unless otherwise stated commands can be used by
Packit c4476c
both clients and servers and the B<value> parameter is not used. The default
Packit c4476c
prefix for command line commands is B<-> and that is reflected below.
Packit c4476c
Packit c4476c
=over 4
Packit c4476c
Packit c4476c
=item B<-sigalgs>
Packit c4476c
Packit c4476c
This sets the supported signature algorithms for TLSv1.2 and TLSv1.3.
Packit c4476c
For clients this
Packit c4476c
value is used directly for the supported signature algorithms extension. For
Packit c4476c
servers it is used to determine which signature algorithms to support.
Packit c4476c
Packit c4476c
The B<value> argument should be a colon separated list of signature algorithms
Packit c4476c
in order of decreasing preference of the form B<algorithm+hash> or
Packit c4476c
B<signature_scheme>. B<algorithm>
Packit c4476c
is one of B<RSA>, B<DSA> or B<ECDSA> and B<hash> is a supported algorithm
Packit c4476c
OID short name such as B<SHA1>, B<SHA224>, B<SHA256>, B<SHA384> of B<SHA512>.
Packit c4476c
Note: algorithm and hash names are case sensitive.
Packit c4476c
B<signature_scheme> is one of the signature schemes defined in TLSv1.3,
Packit c4476c
specified using the IETF name, e.g., B<ecdsa_secp256r1_sha256>, B<ed25519>,
Packit c4476c
or B<rsa_pss_pss_sha256>.
Packit c4476c
Packit c4476c
If this option is not set then all signature algorithms supported by the
Packit c4476c
OpenSSL library are permissible.
Packit c4476c
Packit c4476c
Note: algorithms which specify a PKCS#1 v1.5 signature scheme (either by
Packit c4476c
using B<RSA> as the B<algorithm> or by using one of the B<rsa_pkcs1_*>
Packit c4476c
identifiers) are ignored in TLSv1.3 and will not be negotiated.
Packit c4476c
Packit c4476c
=item B<-client_sigalgs>
Packit c4476c
Packit c4476c
This sets the supported signature algorithms associated with client
Packit c4476c
authentication for TLSv1.2 and TLSv1.3.
Packit c4476c
For servers the value is used in the
Packit c4476c
B<signature_algorithms> field of a B<CertificateRequest> message.
Packit c4476c
For clients it is
Packit c4476c
used to determine which signature algorithm to use with the client certificate.
Packit c4476c
If a server does not request a certificate this option has no effect.
Packit c4476c
Packit c4476c
The syntax of B<value> is identical to B<-sigalgs>. If not set then
Packit c4476c
the value set for B<-sigalgs> will be used instead.
Packit c4476c
Packit c4476c
=item B<-groups>
Packit c4476c
Packit c4476c
This sets the supported groups. For clients, the groups are
Packit c4476c
sent using the supported groups extension. For servers, it is used
Packit c4476c
to determine which group to use. This setting affects groups used for
Packit c4476c
signatures (in TLSv1.2 and earlier) and key exchange. The first group listed
Packit c4476c
will also be used for the B<key_share> sent by a client in a TLSv1.3
Packit c4476c
B<ClientHello>.
Packit c4476c
Packit c4476c
The B<value> argument is a colon separated list of groups. The group can be
Packit c4476c
either the B<NIST> name (e.g. B<P-256>), some other commonly used name where
Packit c4476c
applicable (e.g. B<X25519>) or an OpenSSL OID name (e.g B<prime256v1>). Group
Packit c4476c
names are case sensitive. The list should be in order of preference with the
Packit c4476c
most preferred group first.
Packit c4476c
Packit c4476c
=item B<-curves>
Packit c4476c
Packit c4476c
This is a synonym for the "-groups" command.
Packit c4476c
Packit c4476c
=item B<-named_curve>
Packit c4476c
Packit c4476c
This sets the temporary curve used for ephemeral ECDH modes. Only used by
Packit c4476c
servers
Packit c4476c
Packit c4476c
The B<value> argument is a curve name or the special value B<auto> which
Packit c4476c
picks an appropriate curve based on client and server preferences. The curve
Packit c4476c
can be either the B<NIST> name (e.g. B<P-256>) or an OpenSSL OID name
Packit c4476c
(e.g B<prime256v1>). Curve names are case sensitive.
Packit c4476c
Packit c4476c
=item B<-cipher>
Packit c4476c
Packit c4476c
Sets the TLSv1.2 and below ciphersuite list to B<value>. This list will be
Packit c4476c
combined with any configured TLSv1.3 ciphersuites. Note: syntax checking
Packit c4476c
of B<value> is currently not performed unless a B<SSL> or B<SSL_CTX> structure is
Packit c4476c
associated with B<cctx>.
Packit c4476c
Packit c4476c
=item B<-ciphersuites>
Packit c4476c
Packit c4476c
Sets the available ciphersuites for TLSv1.3 to value. This is a simple colon
Packit c4476c
(":") separated list of TLSv1.3 ciphersuite names in order of preference. This
Packit c4476c
list will be combined any configured TLSv1.2 and below ciphersuites.
Packit c4476c
See L<ciphers(1)> for more information.
Packit c4476c
Packit c4476c
Packit c4476c
=item B<-cert>
Packit c4476c
Packit c4476c
Attempts to use the file B<value> as the certificate for the appropriate
Packit c4476c
context. It currently uses SSL_CTX_use_certificate_chain_file() if an B<SSL_CTX>
Packit c4476c
structure is set or SSL_use_certificate_file() with filetype PEM if an B<SSL>
Packit c4476c
structure is set. This option is only supported if certificate operations
Packit c4476c
are permitted.
Packit c4476c
Packit c4476c
=item B<-key>
Packit c4476c
Packit c4476c
Attempts to use the file B<value> as the private key for the appropriate
Packit c4476c
context. This option is only supported if certificate operations
Packit c4476c
are permitted. Note: if no B<-key> option is set then a private key is
Packit c4476c
not loaded unless the flag B<SSL_CONF_FLAG_REQUIRE_PRIVATE> is set.
Packit c4476c
Packit c4476c
=item B<-dhparam>
Packit c4476c
Packit c4476c
Attempts to use the file B<value> as the set of temporary DH parameters for
Packit c4476c
the appropriate context. This option is only supported if certificate
Packit c4476c
operations are permitted.
Packit c4476c
Packit c4476c
=item B<-record_padding>
Packit c4476c
Packit c4476c
Attempts to pad TLSv1.3 records so that they are a multiple of B<value> in
Packit c4476c
length on send. A B<value> of 0 or 1 turns off padding. Otherwise, the
Packit c4476c
B<value> must be >1 or <=16384.
Packit c4476c
Packit c4476c
=item B<-no_renegotiation>
Packit c4476c
Packit c4476c
Disables all attempts at renegotiation in TLSv1.2 and earlier, same as setting
Packit c4476c
B<SSL_OP_NO_RENEGOTIATION>.
Packit c4476c
Packit c4476c
=item B<-min_protocol>, B<-max_protocol>
Packit c4476c
Packit c4476c
Sets the minimum and maximum supported protocol.
Packit c4476c
Currently supported protocol values are B<SSLv3>, B<TLSv1>,
Packit c4476c
B<TLSv1.1>, B<TLSv1.2>, B<TLSv1.3> for TLS and B<DTLSv1>, B<DTLSv1.2> for DTLS,
Packit c4476c
and B<None> for no limit.
Packit c4476c
If either bound is not specified then only the other bound applies,
Packit c4476c
if specified.
Packit c4476c
To restrict the supported protocol versions use these commands rather
Packit c4476c
than the deprecated alternative commands below.
Packit c4476c
Packit c4476c
=item B<-no_ssl3>, B<-no_tls1>, B<-no_tls1_1>, B<-no_tls1_2>, B<-no_tls1_3>
Packit c4476c
Packit c4476c
Disables protocol support for SSLv3, TLSv1.0, TLSv1.1, TLSv1.2 or TLSv1.3 by
Packit c4476c
setting the corresponding options B<SSL_OP_NO_SSLv3>, B<SSL_OP_NO_TLSv1>,
Packit c4476c
B<SSL_OP_NO_TLSv1_1>, B<SSL_OP_NO_TLSv1_2> and B<SSL_OP_NO_TLSv1_3>
Packit c4476c
respectively. These options are deprecated, instead use B<-min_protocol> and
Packit c4476c
B<-max_protocol>.
Packit c4476c
Packit c4476c
=item B<-bugs>
Packit c4476c
Packit c4476c
Various bug workarounds are set, same as setting B<SSL_OP_ALL>.
Packit c4476c
Packit c4476c
=item B<-comp>
Packit c4476c
Packit c4476c
Enables support for SSL/TLS compression, same as clearing
Packit c4476c
B<SSL_OP_NO_COMPRESSION>.
Packit c4476c
This command was introduced in OpenSSL 1.1.0.
Packit c4476c
As of OpenSSL 1.1.0, compression is off by default.
Packit c4476c
Packit c4476c
=item B<-no_comp>
Packit c4476c
Packit c4476c
Disables support for SSL/TLS compression, same as setting
Packit c4476c
B<SSL_OP_NO_COMPRESSION>.
Packit c4476c
As of OpenSSL 1.1.0, compression is off by default.
Packit c4476c
Packit c4476c
=item B<-no_ticket>
Packit c4476c
Packit c4476c
Disables support for session tickets, same as setting B<SSL_OP_NO_TICKET>.
Packit c4476c
Packit c4476c
=item B<-serverpref>
Packit c4476c
Packit c4476c
Use server and not client preference order when determining which cipher suite,
Packit c4476c
signature algorithm or elliptic curve to use for an incoming connection.
Packit c4476c
Equivalent to B<SSL_OP_CIPHER_SERVER_PREFERENCE>. Only used by servers.
Packit c4476c
Packit c4476c
=item B<-prioritize_chacha>
Packit c4476c
Packit c4476c
Prioritize ChaCha ciphers when the client has a ChaCha20 cipher at the top of
Packit c4476c
its preference list. This usually indicates a client without AES hardware
Packit c4476c
acceleration (e.g. mobile) is in use. Equivalent to B<SSL_OP_PRIORITIZE_CHACHA>.
Packit c4476c
Only used by servers. Requires B<-serverpref>.
Packit c4476c
Packit c4476c
=item B<-no_resumption_on_reneg>
Packit c4476c
Packit c4476c
set SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION flag. Only used by servers.
Packit c4476c
Packit c4476c
=item B<-legacyrenegotiation>
Packit c4476c
Packit c4476c
permits the use of unsafe legacy renegotiation. Equivalent to setting
Packit c4476c
B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION>.
Packit c4476c
Packit c4476c
=item B<-legacy_server_connect>, B<-no_legacy_server_connect>
Packit c4476c
Packit c4476c
permits or prohibits the use of unsafe legacy renegotiation for OpenSSL
Packit c4476c
clients only. Equivalent to setting or clearing B<SSL_OP_LEGACY_SERVER_CONNECT>.
Packit c4476c
Set by default.
Packit c4476c
Packit c4476c
=item B<-allow_no_dhe_kex>
Packit c4476c
Packit c4476c
In TLSv1.3 allow a non-(ec)dhe based key exchange mode on resumption. This means
Packit c4476c
that there will be no forward secrecy for the resumed session.
Packit c4476c
Packit c4476c
=item B<-strict>
Packit c4476c
Packit c4476c
enables strict mode protocol handling. Equivalent to setting
Packit c4476c
B<SSL_CERT_FLAG_TLS_STRICT>.
Packit c4476c
Packit c4476c
=item B<-anti_replay>, B<-no_anti_replay>
Packit c4476c
Packit c4476c
Switches replay protection, on or off respectively. With replay protection on,
Packit c4476c
OpenSSL will automatically detect if a session ticket has been used more than
Packit c4476c
once, TLSv1.3 has been negotiated, and early data is enabled on the server. A
Packit c4476c
full handshake is forced if a session ticket is used a second or subsequent
Packit c4476c
time. Anti-Replay is on by default unless overridden by a configuration file and
Packit c4476c
is only used by servers. Anti-replay measures are required for compliance with
Packit c4476c
the TLSv1.3 specification. Some applications may be able to mitigate the replay
Packit c4476c
risks in other ways and in such cases the built-in OpenSSL functionality is not
Packit c4476c
required. Switching off anti-replay is equivalent to B<SSL_OP_NO_ANTI_REPLAY>.
Packit c4476c
Packit c4476c
=back
Packit c4476c
Packit c4476c
=head1 SUPPORTED CONFIGURATION FILE COMMANDS
Packit c4476c
Packit c4476c
Currently supported B<cmd> names for configuration files (i.e. when the
Packit c4476c
flag B<SSL_CONF_FLAG_FILE> is set) are listed below. All configuration file
Packit c4476c
B<cmd> names are case insensitive so B<signaturealgorithms> is recognised
Packit c4476c
as well as B<SignatureAlgorithms>. Unless otherwise stated the B<value> names
Packit c4476c
are also case insensitive.
Packit c4476c
Packit c4476c
Note: the command prefix (if set) alters the recognised B<cmd> values.
Packit c4476c
Packit c4476c
=over 4
Packit c4476c
Packit c4476c
=item B<CipherString>
Packit c4476c
Packit c4476c
Sets the ciphersuite list for TLSv1.2 and below to B<value>. This list will be
Packit c4476c
combined with any configured TLSv1.3 ciphersuites. Note: syntax
Packit c4476c
checking of B<value> is currently not performed unless an B<SSL> or B<SSL_CTX>
Packit c4476c
structure is associated with B<cctx>.
Packit c4476c
Packit c4476c
=item B<Ciphersuites>
Packit c4476c
Packit c4476c
Sets the available ciphersuites for TLSv1.3 to B<value>. This is a simple colon
Packit c4476c
(":") separated list of TLSv1.3 ciphersuite names in order of preference. This
Packit c4476c
list will be combined any configured TLSv1.2 and below ciphersuites.
Packit c4476c
See L<ciphers(1)> for more information.
Packit c4476c
Packit c4476c
=item B<Certificate>
Packit c4476c
Packit c4476c
Attempts to use the file B<value> as the certificate for the appropriate
Packit c4476c
context. It currently uses SSL_CTX_use_certificate_chain_file() if an B<SSL_CTX>
Packit c4476c
structure is set or SSL_use_certificate_file() with filetype PEM if an B<SSL>
Packit c4476c
structure is set. This option is only supported if certificate operations
Packit c4476c
are permitted.
Packit c4476c
Packit c4476c
=item B<PrivateKey>
Packit c4476c
Packit c4476c
Attempts to use the file B<value> as the private key for the appropriate
Packit c4476c
context. This option is only supported if certificate operations
Packit c4476c
are permitted. Note: if no B<PrivateKey> option is set then a private key is
Packit c4476c
not loaded unless the B<SSL_CONF_FLAG_REQUIRE_PRIVATE> is set.
Packit c4476c
Packit c4476c
=item B<ChainCAFile>, B<ChainCAPath>, B<VerifyCAFile>, B<VerifyCAPath>
Packit c4476c
Packit c4476c
These options indicate a file or directory used for building certificate
Packit c4476c
chains or verifying certificate chains. These options are only supported
Packit c4476c
if certificate operations are permitted.
Packit c4476c
Packit c4476c
=item B<RequestCAFile>
Packit c4476c
Packit c4476c
This option indicates a file containing a set of certificates in PEM form.
Packit c4476c
The subject names of the certificates are sent to the peer in the
Packit c4476c
B<certificate_authorities> extension for TLS 1.3 (in ClientHello or
Packit c4476c
CertificateRequest) or in a certificate request for previous versions or
Packit c4476c
TLS.
Packit c4476c
Packit c4476c
=item B<ServerInfoFile>
Packit c4476c
Packit c4476c
Attempts to use the file B<value> in the "serverinfo" extension using the
Packit c4476c
function SSL_CTX_use_serverinfo_file.
Packit c4476c
Packit c4476c
=item B<DHParameters>
Packit c4476c
Packit c4476c
Attempts to use the file B<value> as the set of temporary DH parameters for
Packit c4476c
the appropriate context. This option is only supported if certificate
Packit c4476c
operations are permitted.
Packit c4476c
Packit c4476c
=item B<RecordPadding>
Packit c4476c
Packit c4476c
Attempts to pad TLSv1.3 records so that they are a multiple of B<value> in
Packit c4476c
length on send. A B<value> of 0 or 1 turns off padding. Otherwise, the
Packit c4476c
B<value> must be >1 or <=16384.
Packit c4476c
Packit c4476c
=item B<SignatureAlgorithms>
Packit c4476c
Packit c4476c
This sets the supported signature algorithms for TLSv1.2 and TLSv1.3.
Packit c4476c
For clients this
Packit c4476c
value is used directly for the supported signature algorithms extension. For
Packit c4476c
servers it is used to determine which signature algorithms to support.
Packit c4476c
Packit c4476c
The B<value> argument should be a colon separated list of signature algorithms
Packit c4476c
in order of decreasing preference of the form B<algorithm+hash> or
Packit c4476c
B<signature_scheme>. B<algorithm>
Packit c4476c
is one of B<RSA>, B<DSA> or B<ECDSA> and B<hash> is a supported algorithm
Packit c4476c
OID short name such as B<SHA1>, B<SHA224>, B<SHA256>, B<SHA384> of B<SHA512>.
Packit c4476c
Note: algorithm and hash names are case sensitive.
Packit c4476c
B<signature_scheme> is one of the signature schemes defined in TLSv1.3,
Packit c4476c
specified using the IETF name, e.g., B<ecdsa_secp256r1_sha256>, B<ed25519>,
Packit c4476c
or B<rsa_pss_pss_sha256>.
Packit c4476c
Packit c4476c
If this option is not set then all signature algorithms supported by the
Packit c4476c
OpenSSL library are permissible.
Packit c4476c
Packit c4476c
Note: algorithms which specify a PKCS#1 v1.5 signature scheme (either by
Packit c4476c
using B<RSA> as the B<algorithm> or by using one of the B<rsa_pkcs1_*>
Packit c4476c
identifiers) are ignored in TLSv1.3 and will not be negotiated.
Packit c4476c
Packit c4476c
=item B<ClientSignatureAlgorithms>
Packit c4476c
Packit c4476c
This sets the supported signature algorithms associated with client
Packit c4476c
authentication for TLSv1.2 and TLSv1.3.
Packit c4476c
For servers the value is used in the
Packit c4476c
B<signature_algorithms> field of a B<CertificateRequest> message.
Packit c4476c
For clients it is
Packit c4476c
used to determine which signature algorithm to use with the client certificate.
Packit c4476c
If a server does not request a certificate this option has no effect.
Packit c4476c
Packit c4476c
The syntax of B<value> is identical to B<SignatureAlgorithms>. If not set then
Packit c4476c
the value set for B<SignatureAlgorithms> will be used instead.
Packit c4476c
Packit c4476c
=item B<Groups>
Packit c4476c
Packit c4476c
This sets the supported groups. For clients, the groups are
Packit c4476c
sent using the supported groups extension. For servers, it is used
Packit c4476c
to determine which group to use. This setting affects groups used for
Packit c4476c
signatures (in TLSv1.2 and earlier) and key exchange. The first group listed
Packit c4476c
will also be used for the B<key_share> sent by a client in a TLSv1.3
Packit c4476c
B<ClientHello>.
Packit c4476c
Packit c4476c
The B<value> argument is a colon separated list of groups. The group can be
Packit c4476c
either the B<NIST> name (e.g. B<P-256>), some other commonly used name where
Packit c4476c
applicable (e.g. B<X25519>) or an OpenSSL OID name (e.g B<prime256v1>). Group
Packit c4476c
names are case sensitive. The list should be in order of preference with the
Packit c4476c
most preferred group first.
Packit c4476c
Packit c4476c
=item B<Curves>
Packit c4476c
Packit c4476c
This is a synonym for the "Groups" command.
Packit c4476c
Packit c4476c
=item B<MinProtocol>
Packit c4476c
Packit c4476c
This sets the minimum supported SSL, TLS or DTLS version.
Packit c4476c
Packit c4476c
Currently supported protocol values are B<SSLv3>, B<TLSv1>, B<TLSv1.1>,
Packit c4476c
B<TLSv1.2>, B<TLSv1.3>, B<DTLSv1> and B<DTLSv1.2>.
Packit c4476c
The value B<None> will disable the limit.
Packit c4476c
Packit c4476c
=item B<MaxProtocol>
Packit c4476c
Packit c4476c
This sets the maximum supported SSL, TLS or DTLS version.
Packit c4476c
Packit c4476c
Currently supported protocol values are B<SSLv3>, B<TLSv1>, B<TLSv1.1>,
Packit c4476c
B<TLSv1.2>, B<TLSv1.3>, B<DTLSv1> and B<DTLSv1.2>.
Packit c4476c
The value B<None> will disable the limit.
Packit c4476c
Packit c4476c
=item B<Protocol>
Packit c4476c
Packit c4476c
This can be used to enable or disable certain versions of the SSL,
Packit c4476c
TLS or DTLS protocol.
Packit c4476c
Packit c4476c
The B<value> argument is a comma separated list of supported protocols
Packit c4476c
to enable or disable.
Packit c4476c
If a protocol is preceded by B<-> that version is disabled.
Packit c4476c
Packit c4476c
All protocol versions are enabled by default.
Packit c4476c
You need to disable at least one protocol version for this setting have any
Packit c4476c
effect.
Packit c4476c
Only enabling some protocol versions does not disable the other protocol
Packit c4476c
versions.
Packit c4476c
Packit c4476c
Currently supported protocol values are B<SSLv3>, B<TLSv1>, B<TLSv1.1>,
Packit c4476c
B<TLSv1.2>, B<TLSv1.3>, B<DTLSv1> and B<DTLSv1.2>.
Packit c4476c
The special value B<ALL> refers to all supported versions.
Packit c4476c
Packit c4476c
This can't enable protocols that are disabled using B<MinProtocol>
Packit c4476c
or B<MaxProtocol>, but can disable protocols that are still allowed
Packit c4476c
by them.
Packit c4476c
Packit c4476c
The B<Protocol> command is fragile and deprecated; do not use it.
Packit c4476c
Use B<MinProtocol> and B<MaxProtocol> instead.
Packit c4476c
If you do use B<Protocol>, make sure that the resulting range of enabled
Packit c4476c
protocols has no "holes", e.g. if TLS 1.0 and TLS 1.2 are both enabled, make
Packit c4476c
sure to also leave TLS 1.1 enabled.
Packit c4476c
Packit c4476c
=item B<Options>
Packit c4476c
Packit c4476c
The B<value> argument is a comma separated list of various flags to set.
Packit c4476c
If a flag string is preceded B<-> it is disabled.
Packit c4476c
See the L<SSL_CTX_set_options(3)> function for more details of
Packit c4476c
individual options.
Packit c4476c
Packit c4476c
Each option is listed below. Where an operation is enabled by default
Packit c4476c
the B<-flag> syntax is needed to disable it.
Packit c4476c
Packit c4476c
B<SessionTicket>: session ticket support, enabled by default. Inverse of
Packit c4476c
B<SSL_OP_NO_TICKET>: that is B<-SessionTicket> is the same as setting
Packit c4476c
B<SSL_OP_NO_TICKET>.
Packit c4476c
Packit c4476c
B<Compression>: SSL/TLS compression support, enabled by default. Inverse
Packit c4476c
of B<SSL_OP_NO_COMPRESSION>.
Packit c4476c
Packit c4476c
B<EmptyFragments>: use empty fragments as a countermeasure against a
Packit c4476c
SSL 3.0/TLS 1.0 protocol vulnerability affecting CBC ciphers. It
Packit c4476c
is set by default. Inverse of B<SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS>.
Packit c4476c
Packit c4476c
B<Bugs>: enable various bug workarounds. Same as B<SSL_OP_ALL>.
Packit c4476c
Packit c4476c
B<DHSingle>: enable single use DH keys, set by default. Inverse of
Packit c4476c
B<SSL_OP_DH_SINGLE>. Only used by servers.
Packit c4476c
Packit c4476c
B<ECDHSingle>: enable single use ECDH keys, set by default. Inverse of
Packit c4476c
B<SSL_OP_ECDH_SINGLE>. Only used by servers.
Packit c4476c
Packit c4476c
B<ServerPreference>: use server and not client preference order when
Packit c4476c
determining which cipher suite, signature algorithm or elliptic curve
Packit c4476c
to use for an incoming connection.  Equivalent to
Packit c4476c
B<SSL_OP_CIPHER_SERVER_PREFERENCE>. Only used by servers.
Packit c4476c
Packit c4476c
B<PrioritizeChaCha>: prioritizes ChaCha ciphers when the client has a
Packit c4476c
ChaCha20 cipher at the top of its preference list. This usually indicates
Packit c4476c
a mobile client is in use. Equivalent to B<SSL_OP_PRIORITIZE_CHACHA>.
Packit c4476c
Only used by servers.
Packit c4476c
Packit c4476c
B<NoResumptionOnRenegotiation>: set
Packit c4476c
B<SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION> flag. Only used by servers.
Packit c4476c
Packit c4476c
B<NoRenegotiation>: disables all attempts at renegotiation in TLSv1.2 and
Packit c4476c
earlier, same as setting B<SSL_OP_NO_RENEGOTIATION>.
Packit c4476c
Packit c4476c
B<UnsafeLegacyRenegotiation>: permits the use of unsafe legacy renegotiation.
Packit c4476c
Equivalent to B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION>.
Packit c4476c
Packit c4476c
B<UnsafeLegacyServerConnect>: permits the use of unsafe legacy renegotiation
Packit c4476c
for OpenSSL clients only. Equivalent to B<SSL_OP_LEGACY_SERVER_CONNECT>.
Packit c4476c
Set by default.
Packit c4476c
Packit c4476c
B<EncryptThenMac>: use encrypt-then-mac extension, enabled by
Packit c4476c
default. Inverse of B<SSL_OP_NO_ENCRYPT_THEN_MAC>: that is,
Packit c4476c
B<-EncryptThenMac> is the same as setting B<SSL_OP_NO_ENCRYPT_THEN_MAC>.
Packit c4476c
Packit c4476c
B<AllowNoDHEKEX>: In TLSv1.3 allow a non-(ec)dhe based key exchange mode on
Packit c4476c
resumption. This means that there will be no forward secrecy for the resumed
Packit c4476c
session. Equivalent to B<SSL_OP_ALLOW_NO_DHE_KEX>.
Packit c4476c
Packit c4476c
B<MiddleboxCompat>: If set then dummy Change Cipher Spec (CCS) messages are sent
Packit c4476c
in TLSv1.3. This has the effect of making TLSv1.3 look more like TLSv1.2 so that
Packit c4476c
middleboxes that do not understand TLSv1.3 will not drop the connection. This
Packit c4476c
option is set by default. A future version of OpenSSL may not set this by
Packit c4476c
default. Equivalent to B<SSL_OP_ENABLE_MIDDLEBOX_COMPAT>.
Packit c4476c
Packit c4476c
B<AntiReplay>: If set then OpenSSL will automatically detect if a session ticket
Packit c4476c
has been used more than once, TLSv1.3 has been negotiated, and early data is
Packit c4476c
enabled on the server. A full handshake is forced if a session ticket is used a
Packit c4476c
second or subsequent time. This option is set by default and is only used by
Packit c4476c
servers. Anti-replay measures are required to comply with the TLSv1.3
Packit c4476c
specification. Some applications may be able to mitigate the replay risks in
Packit c4476c
other ways and in such cases the built-in OpenSSL functionality is not required.
Packit c4476c
Disabling anti-replay is equivalent to setting B<SSL_OP_NO_ANTI_REPLAY>.
Packit c4476c
Packit c4476c
=item B<VerifyMode>
Packit c4476c
Packit c4476c
The B<value> argument is a comma separated list of flags to set.
Packit c4476c
Packit c4476c
B<Peer> enables peer verification: for clients only.
Packit c4476c
Packit c4476c
B<Request> requests but does not require a certificate from the client.
Packit c4476c
Servers only.
Packit c4476c
Packit c4476c
B<Require> requests and requires a certificate from the client: an error
Packit c4476c
occurs if the client does not present a certificate. Servers only.
Packit c4476c
Packit c4476c
B<Once> requests a certificate from a client only on the initial connection:
Packit c4476c
not when renegotiating. Servers only.
Packit c4476c
Packit c4476c
B<RequestPostHandshake> configures the connection to support requests but does
Packit c4476c
not require a certificate from the client post-handshake. A certificate will
Packit c4476c
not be requested during the initial handshake. The server application must
Packit c4476c
provide a mechanism to request a certificate post-handshake. Servers only.
Packit c4476c
TLSv1.3 only.
Packit c4476c
Packit c4476c
B<RequiresPostHandshake> configures the connection to support requests and
Packit c4476c
requires a certificate from the client post-handshake: an error occurs if the
Packit c4476c
client does not present a certificate. A certificate will not be requested
Packit c4476c
during the initial handshake. The server application must provide a mechanism
Packit c4476c
to request a certificate post-handshake. Servers only. TLSv1.3 only.
Packit c4476c
Packit c4476c
=item B<ClientCAFile>, B<ClientCAPath>
Packit c4476c
Packit c4476c
A file or directory of certificates in PEM format whose names are used as the
Packit c4476c
set of acceptable names for client CAs. Servers only. This option is only
Packit c4476c
supported if certificate operations are permitted.
Packit c4476c
Packit c4476c
=back
Packit c4476c
Packit c4476c
=head1 SUPPORTED COMMAND TYPES
Packit c4476c
Packit c4476c
The function SSL_CONF_cmd_value_type() currently returns one of the following
Packit c4476c
types:
Packit c4476c
Packit c4476c
=over 4
Packit c4476c
Packit c4476c
=item B<SSL_CONF_TYPE_UNKNOWN>
Packit c4476c
Packit c4476c
The B<cmd> string is unrecognised, this return value can be use to flag
Packit c4476c
syntax errors.
Packit c4476c
Packit c4476c
=item B<SSL_CONF_TYPE_STRING>
Packit c4476c
Packit c4476c
The value is a string without any specific structure.
Packit c4476c
Packit c4476c
=item B<SSL_CONF_TYPE_FILE>
Packit c4476c
Packit c4476c
The value is a file name.
Packit c4476c
Packit c4476c
=item B<SSL_CONF_TYPE_DIR>
Packit c4476c
Packit c4476c
The value is a directory name.
Packit c4476c
Packit c4476c
=item B<SSL_CONF_TYPE_NONE>
Packit c4476c
Packit c4476c
The value string is not used e.g. a command line option which doesn't take an
Packit c4476c
argument.
Packit c4476c
Packit c4476c
=back
Packit c4476c
Packit c4476c
=head1 NOTES
Packit c4476c
Packit c4476c
The order of operations is significant. This can be used to set either defaults
Packit c4476c
or values which cannot be overridden. For example if an application calls:
Packit c4476c
Packit c4476c
 SSL_CONF_cmd(ctx, "Protocol", "-SSLv3");
Packit c4476c
 SSL_CONF_cmd(ctx, userparam, uservalue);
Packit c4476c
Packit c4476c
it will disable SSLv3 support by default but the user can override it. If
Packit c4476c
however the call sequence is:
Packit c4476c
Packit c4476c
 SSL_CONF_cmd(ctx, userparam, uservalue);
Packit c4476c
 SSL_CONF_cmd(ctx, "Protocol", "-SSLv3");
Packit c4476c
Packit c4476c
SSLv3 is B<always> disabled and attempt to override this by the user are
Packit c4476c
ignored.
Packit c4476c
Packit c4476c
By checking the return code of SSL_CONF_cmd() it is possible to query if a
Packit c4476c
given B<cmd> is recognised, this is useful if SSL_CONF_cmd() values are
Packit c4476c
mixed with additional application specific operations.
Packit c4476c
Packit c4476c
For example an application might call SSL_CONF_cmd() and if it returns
Packit c4476c
-2 (unrecognised command) continue with processing of application specific
Packit c4476c
commands.
Packit c4476c
Packit c4476c
Applications can also use SSL_CONF_cmd() to process command lines though the
Packit c4476c
utility function SSL_CONF_cmd_argv() is normally used instead. One way
Packit c4476c
to do this is to set the prefix to an appropriate value using
Packit c4476c
SSL_CONF_CTX_set1_prefix(), pass the current argument to B<cmd> and the
Packit c4476c
following argument to B<value> (which may be NULL).
Packit c4476c
Packit c4476c
In this case if the return value is positive then it is used to skip that
Packit c4476c
number of arguments as they have been processed by SSL_CONF_cmd(). If -2 is
Packit c4476c
returned then B<cmd> is not recognised and application specific arguments
Packit c4476c
can be checked instead. If -3 is returned a required argument is missing
Packit c4476c
and an error is indicated. If 0 is returned some other error occurred and
Packit c4476c
this can be reported back to the user.
Packit c4476c
Packit c4476c
The function SSL_CONF_cmd_value_type() can be used by applications to
Packit c4476c
check for the existence of a command or to perform additional syntax
Packit c4476c
checking or translation of the command value. For example if the return
Packit c4476c
value is B<SSL_CONF_TYPE_FILE> an application could translate a relative
Packit c4476c
pathname to an absolute pathname.
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
SSL_CONF_cmd() returns 1 if the value of B<cmd> is recognised and B<value> is
Packit c4476c
B<NOT> used and 2 if both B<cmd> and B<value> are used. In other words it
Packit c4476c
returns the number of arguments processed. This is useful when processing
Packit c4476c
command lines.
Packit c4476c
Packit c4476c
A return value of -2 means B<cmd> is not recognised.
Packit c4476c
Packit c4476c
A return value of -3 means B<cmd> is recognised and the command requires a
Packit c4476c
value but B<value> is NULL.
Packit c4476c
Packit c4476c
A return code of 0 indicates that both B<cmd> and B<value> are valid but an
Packit c4476c
error occurred attempting to perform the operation: for example due to an
Packit c4476c
error in the syntax of B<value> in this case the error queue may provide
Packit c4476c
additional information.
Packit c4476c
Packit c4476c
=head1 EXAMPLES
Packit c4476c
Packit c4476c
Set supported signature algorithms:
Packit c4476c
Packit c4476c
 SSL_CONF_cmd(ctx, "SignatureAlgorithms", "ECDSA+SHA256:RSA+SHA256:DSA+SHA256");
Packit c4476c
Packit c4476c
There are various ways to select the supported protocols.
Packit c4476c
Packit c4476c
This set the minimum protocol version to TLSv1, and so disables SSLv3.
Packit c4476c
This is the recommended way to disable protocols.
Packit c4476c
Packit c4476c
 SSL_CONF_cmd(ctx, "MinProtocol", "TLSv1");
Packit c4476c
Packit c4476c
The following also disables SSLv3:
Packit c4476c
Packit c4476c
 SSL_CONF_cmd(ctx, "Protocol", "-SSLv3");
Packit c4476c
Packit c4476c
The following will first enable all protocols, and then disable
Packit c4476c
SSLv3.
Packit c4476c
If no protocol versions were disabled before this has the same effect as
Packit c4476c
"-SSLv3", but if some versions were disables this will re-enable them before
Packit c4476c
disabling SSLv3.
Packit c4476c
Packit c4476c
 SSL_CONF_cmd(ctx, "Protocol", "ALL,-SSLv3");
Packit c4476c
Packit c4476c
Only enable TLSv1.2:
Packit c4476c
Packit c4476c
 SSL_CONF_cmd(ctx, "MinProtocol", "TLSv1.2");
Packit c4476c
 SSL_CONF_cmd(ctx, "MaxProtocol", "TLSv1.2");
Packit c4476c
Packit c4476c
This also only enables TLSv1.2:
Packit c4476c
Packit c4476c
 SSL_CONF_cmd(ctx, "Protocol", "-ALL,TLSv1.2");
Packit c4476c
Packit c4476c
Disable TLS session tickets:
Packit c4476c
Packit c4476c
 SSL_CONF_cmd(ctx, "Options", "-SessionTicket");
Packit c4476c
Packit c4476c
Enable compression:
Packit c4476c
Packit c4476c
 SSL_CONF_cmd(ctx, "Options", "Compression");
Packit c4476c
Packit c4476c
Set supported curves to P-256, P-384:
Packit c4476c
Packit c4476c
 SSL_CONF_cmd(ctx, "Curves", "P-256:P-384");
Packit c4476c
Packit c4476c
=head1 SEE ALSO
Packit c4476c
Packit c4476c
L<SSL_CONF_CTX_new(3)>,
Packit c4476c
L<SSL_CONF_CTX_set_flags(3)>,
Packit c4476c
L<SSL_CONF_CTX_set1_prefix(3)>,
Packit c4476c
L<SSL_CONF_CTX_set_ssl_ctx(3)>,
Packit c4476c
L<SSL_CONF_cmd_argv(3)>,
Packit c4476c
L<SSL_CTX_set_options(3)>
Packit c4476c
Packit c4476c
=head1 HISTORY
Packit c4476c
Packit c4476c
The SSL_CONF_cmd() function was added in OpenSSL 1.0.2.
Packit c4476c
Packit c4476c
The B<SSL_OP_NO_SSL2> option doesn't have effect since 1.1.0, but the macro
Packit c4476c
is retained for backwards compatibility.
Packit c4476c
Packit c4476c
The B<SSL_CONF_TYPE_NONE> was added in OpenSSL 1.1.0. In earlier versions of
Packit c4476c
OpenSSL passing a command which didn't take an argument would return
Packit c4476c
B<SSL_CONF_TYPE_UNKNOWN>.
Packit c4476c
Packit c4476c
B<MinProtocol> and B<MaxProtocol> where added in OpenSSL 1.1.0.
Packit c4476c
Packit c4476c
B<AllowNoDHEKEX> and B<PrioritizeChaCha> were added in OpenSSL 1.1.1.
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2012-2019 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
Packit c4476c
Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
this file except in compliance with the License.  You can obtain a copy
Packit c4476c
in the file LICENSE in the source distribution or at
Packit c4476c
L<https://www.openssl.org/source/license.html>.
Packit c4476c
Packit c4476c
=cut