| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884 |
- .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
- .\"
- .\" Standard preamble:
- .\" ========================================================================
- .de Sp \" Vertical space (when we can't use .PP)
- .if t .sp .5v
- .if n .sp
- ..
- .de Vb \" Begin verbatim text
- .ft CW
- .nf
- .ne \\$1
- ..
- .de Ve \" End verbatim text
- .ft R
- .fi
- ..
- .\" 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 C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
- .ie n \{\
- . 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\}
- .el\{\
- . 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.
- .ie \n(.g .ds Aq \(aq
- .el .ds Aq '
- .\"
- .\" If the F register is >0, 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'.
- .de IX
- ..
- .nr rF 0
- .if \n(.g .if rF .nr rF 1
- .if (\n(rF:(\n(.g==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
- .if n \{\
- . ds #H 0
- . ds #V .8m
- . ds #F .3m
- . ds #[ \f1
- . ds #] \fP
- .\}
- .if t \{\
- . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
- . ds #V .6m
- . ds #F 0
- . ds #[ \&
- . ds #] \&
- .\}
- . \" simple accents for nroff and troff
- .if n \{\
- . ds ' \&
- . ds ` \&
- . ds ^ \&
- . ds , \&
- . ds ~ ~
- . ds /
- .\}
- .if t \{\
- . 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
- .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
- .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
- .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
- .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
- .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
- .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
- .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
- .ds ae a\h'-(\w'a'u*4/10)'e
- .ds Ae A\h'-(\w'A'u*4/10)'E
- . \" corrections for vroff
- .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
- .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
- . \" for low resolution devices (crt and lpr)
- .if \n(.H>23 .if \n(.V>19 \
- \{\
- . 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
- .\}
- .rm #[ #] #H #V #F C
- .\" ========================================================================
- .\"
- .IX Title "SSL_CONF_CMD 3ossl"
- .TH SSL_CONF_CMD 3ossl "2024-09-03" "3.3.2" "OpenSSL"
- .\" For nroff, turn off justification. Always turn off hyphenation; it makes
- .\" way too many mistakes in technical documents.
- .if n .ad l
- .nh
- .SH "NAME"
- SSL_CONF_cmd_value_type,
- SSL_CONF_cmd \- send configuration command
- .SH "SYNOPSIS"
- .IX Header "SYNOPSIS"
- .Vb 1
- \& #include <openssl/ssl.h>
- \&
- \& int SSL_CONF_cmd(SSL_CONF_CTX *ctx, const char *option, const char *value);
- \& int SSL_CONF_cmd_value_type(SSL_CONF_CTX *ctx, const char *option);
- .Ve
- .SH "DESCRIPTION"
- .IX Header "DESCRIPTION"
- The function \fBSSL_CONF_cmd()\fR performs configuration operation \fBoption\fR with
- optional parameter \fBvalue\fR on \fBctx\fR. Its purpose is to simplify application
- configuration of \fB\s-1SSL_CTX\s0\fR or \fB\s-1SSL\s0\fR structures by providing a common
- framework for command line options or configuration files.
- .PP
- \&\fBSSL_CONF_cmd_value_type()\fR returns the type of value that \fBoption\fR refers to.
- .SH "SUPPORTED COMMAND LINE COMMANDS"
- .IX Header "SUPPORTED COMMAND LINE COMMANDS"
- Currently supported \fBoption\fR names for command lines (i.e. when the
- flag \fB\s-1SSL_CONF_FLAG_CMDLINE\s0\fR is set) are listed below. Note: all \fBoption\fR
- names are case sensitive. Unless otherwise stated commands can be used by
- both clients and servers and the \fBvalue\fR parameter is not used. The default
- prefix for command line commands is \fB\-\fR and that is reflected below.
- .IP "\fB\-bugs\fR" 4
- .IX Item "-bugs"
- Various bug workarounds are set, same as setting \fB\s-1SSL_OP_ALL\s0\fR.
- .IP "\fB\-no_comp\fR" 4
- .IX Item "-no_comp"
- Disables support for \s-1SSL/TLS\s0 compression, same as setting
- \&\fB\s-1SSL_OP_NO_COMPRESSION\s0\fR.
- As of OpenSSL 1.1.0, compression is off by default.
- .IP "\fB\-comp\fR" 4
- .IX Item "-comp"
- Enables support for \s-1SSL/TLS\s0 compression, same as clearing
- \&\fB\s-1SSL_OP_NO_COMPRESSION\s0\fR.
- This command was introduced in OpenSSL 1.1.0.
- As of OpenSSL 1.1.0, compression is off by default. \s-1TLS\s0 compression can only be
- used in security level 1 or lower. From OpenSSL 3.2.0 and above the default
- security level is 2, so this option will have no effect without also changing
- the security level. See \fBSSL_CTX_set_security_level\fR\|(3).
- .IP "\fB\-no_ticket\fR" 4
- .IX Item "-no_ticket"
- Disables support for session tickets, same as setting \fB\s-1SSL_OP_NO_TICKET\s0\fR.
- .IP "\fB\-serverpref\fR" 4
- .IX Item "-serverpref"
- Use server and not client preference order when determining which cipher suite,
- signature algorithm or elliptic curve to use for an incoming connection.
- Equivalent to \fB\s-1SSL_OP_CIPHER_SERVER_PREFERENCE\s0\fR. Only used by servers.
- .IP "\fB\-client_renegotiation\fR" 4
- .IX Item "-client_renegotiation"
- Allows servers to accept client-initiated renegotiation. Equivalent to
- setting \fB\s-1SSL_OP_ALLOW_CLIENT_RENEGOTIATION\s0\fR.
- Only used by servers.
- .IP "\fB\-legacy_renegotiation\fR" 4
- .IX Item "-legacy_renegotiation"
- Permits the use of unsafe legacy renegotiation. Equivalent to setting
- \&\fB\s-1SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION\s0\fR.
- .IP "\fB\-no_renegotiation\fR" 4
- .IX Item "-no_renegotiation"
- Disables all attempts at renegotiation in TLSv1.2 and earlier, same as setting
- \&\fB\s-1SSL_OP_NO_RENEGOTIATION\s0\fR.
- .IP "\fB\-no_resumption_on_reneg\fR" 4
- .IX Item "-no_resumption_on_reneg"
- Sets \fB\s-1SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION\s0\fR. Only used by servers.
- .IP "\fB\-legacy_server_connect\fR, \fB\-no_legacy_server_connect\fR" 4
- .IX Item "-legacy_server_connect, -no_legacy_server_connect"
- Permits or prohibits the use of unsafe legacy renegotiation for OpenSSL
- clients only. Equivalent to setting or clearing \fB\s-1SSL_OP_LEGACY_SERVER_CONNECT\s0\fR.
- .IP "\fB\-prioritize_chacha\fR" 4
- .IX Item "-prioritize_chacha"
- Prioritize ChaCha ciphers when the client has a ChaCha20 cipher at the top of
- its preference list. This usually indicates a client without \s-1AES\s0 hardware
- acceleration (e.g. mobile) is in use. Equivalent to \fB\s-1SSL_OP_PRIORITIZE_CHACHA\s0\fR.
- Only used by servers. Requires \fB\-serverpref\fR.
- .IP "\fB\-allow_no_dhe_kex\fR" 4
- .IX Item "-allow_no_dhe_kex"
- In TLSv1.3 allow a non\-(ec)dhe based key exchange mode on resumption. This means
- that there will be no forward secrecy for the resumed session.
- .IP "\fB\-prefer_no_dhe_kex\fR" 4
- .IX Item "-prefer_no_dhe_kex"
- In TLSv1.3, on resumption let the server prefer a non\-(ec)dhe based key
- exchange mode over an (ec)dhe based one. Requires \fB\-allow_no_dhe_kex\fR.
- Equivalent to \fB\s-1SSL_OP_PREFER_NO_DHE_KEX\s0\fR. Only used by servers.
- .IP "\fB\-strict\fR" 4
- .IX Item "-strict"
- Enables strict mode protocol handling. Equivalent to setting
- \&\fB\s-1SSL_CERT_FLAG_TLS_STRICT\s0\fR.
- .IP "\fB\-sigalgs\fR \fIalgs\fR" 4
- .IX Item "-sigalgs algs"
- This sets the supported signature algorithms for TLSv1.2 and TLSv1.3.
- For clients this value is used directly for the supported signature
- algorithms extension. For servers it is used to determine which signature
- algorithms to support.
- .Sp
- The \fBalgs\fR argument should be a colon separated list of signature
- algorithms in order of decreasing preference of the form \fBalgorithm+hash\fR
- or \fBsignature_scheme\fR. For the default providers shipped with OpenSSL,
- \&\fBalgorithm\fR is one of \fB\s-1RSA\s0\fR, \fB\s-1DSA\s0\fR or \fB\s-1ECDSA\s0\fR and
- \&\fBhash\fR is a supported algorithm \s-1OID\s0 short name such as \fB\s-1SHA1\s0\fR, \fB\s-1SHA224\s0\fR,
- \&\fB\s-1SHA256\s0\fR, \fB\s-1SHA384\s0\fR or \fB\s-1SHA512\s0\fR. Note: algorithm and hash names are case
- sensitive. \fBsignature_scheme\fR is one of the signature schemes defined in
- TLSv1.3, specified using the \s-1IETF\s0 name, e.g., \fBecdsa_secp256r1_sha256\fR,
- \&\fBed25519\fR, or \fBrsa_pss_pss_sha256\fR. Additional providers may make available
- further algorithms via the \s-1TLS_SIGALG\s0 capability.
- See \*(L"\s-1CAPABILITIES\*(R"\s0 in \fBprovider\-base\fR\|(7).
- .Sp
- If this option is not set then all signature algorithms supported by all
- activated providers are permissible.
- .Sp
- Note: algorithms which specify a PKCS#1 v1.5 signature scheme (either by
- using \fB\s-1RSA\s0\fR as the \fBalgorithm\fR or by using one of the \fBrsa_pkcs1_*\fR
- identifiers) are ignored in TLSv1.3 and will not be negotiated.
- .IP "\fB\-client_sigalgs\fR \fIalgs\fR" 4
- .IX Item "-client_sigalgs algs"
- This sets the supported signature algorithms associated with client
- authentication for TLSv1.2 and TLSv1.3. For servers the \fBalgs\fR is used
- in the \fBsignature_algorithms\fR field of a \fBCertificateRequest\fR message.
- For clients it is used to determine which signature algorithm to use with
- the client certificate. If a server does not request a certificate this
- option has no effect.
- .Sp
- The syntax of \fBalgs\fR is identical to \fB\-sigalgs\fR. If not set, then the
- value set for \fB\-sigalgs\fR will be used instead.
- .IP "\fB\-groups\fR \fIgroups\fR" 4
- .IX Item "-groups groups"
- This sets the supported groups. For clients, the groups are sent using
- the supported groups extension. For servers, it is used to determine which
- group to use. This setting affects groups used for signatures (in TLSv1.2
- and earlier) and key exchange. The first group listed will also be used
- for the \fBkey_share\fR sent by a client in a TLSv1.3 \fBClientHello\fR.
- .Sp
- The \fBgroups\fR argument is a colon separated list of groups. The group can
- be either the \fB\s-1NIST\s0\fR name (e.g. \fBP\-256\fR), some other commonly used name
- where applicable (e.g. \fBX25519\fR, \fBffdhe2048\fR) or an OpenSSL \s-1OID\s0 name
- (e.g. \fBprime256v1\fR). Group names are case sensitive. The list should be
- in order of preference with the most preferred group first.
- .Sp
- Currently supported groups for \fBTLSv1.3\fR are \fBP\-256\fR, \fBP\-384\fR, \fBP\-521\fR,
- \&\fBX25519\fR, \fBX448\fR, \fBffdhe2048\fR, \fBffdhe3072\fR, \fBffdhe4096\fR, \fBffdhe6144\fR,
- \&\fBffdhe8192\fR.
- .IP "\fB\-curves\fR \fIgroups\fR" 4
- .IX Item "-curves groups"
- This is a synonym for the \fB\-groups\fR command.
- .IP "\fB\-named_curve\fR \fIcurve\fR" 4
- .IX Item "-named_curve curve"
- This sets the temporary curve used for ephemeral \s-1ECDH\s0 modes. Only used
- by servers.
- .IP "\fB\-tx_cert_comp\fR" 4
- .IX Item "-tx_cert_comp"
- Enables support for sending TLSv1.3 compressed certificates.
- .IP "\fB\-no_tx_cert_comp\fR" 4
- .IX Item "-no_tx_cert_comp"
- Disables support for sending TLSv1.3 compressed certificates.
- .IP "\fB\-rx_cert_comp\fR" 4
- .IX Item "-rx_cert_comp"
- Enables support for receiving TLSv1.3 compressed certificates.
- .IP "\fB\-no_rx_cert_comp\fR" 4
- .IX Item "-no_rx_cert_comp"
- Disables support for receiving TLSv1.3 compressed certificates.
- .IP "\fB\-comp\fR" 4
- .IX Item "-comp"
- The \fBgroups\fR argument is a curve name or the special value \fBauto\fR which
- picks an appropriate curve based on client and server preferences. The
- curve can be either the \fB\s-1NIST\s0\fR name (e.g. \fBP\-256\fR) or an OpenSSL \s-1OID\s0 name
- (e.g. \fBprime256v1\fR). Curve names are case sensitive.
- .IP "\fB\-cipher\fR \fIciphers\fR" 4
- .IX Item "-cipher ciphers"
- Sets the TLSv1.2 and below ciphersuite list to \fBciphers\fR. This list will be
- combined with any configured TLSv1.3 ciphersuites. Note: syntax checking
- of \fBciphers\fR is currently not performed unless a \fB\s-1SSL\s0\fR or \fB\s-1SSL_CTX\s0\fR
- structure is associated with \fBctx\fR.
- .IP "\fB\-ciphersuites\fR \fI1.3ciphers\fR" 4
- .IX Item "-ciphersuites 1.3ciphers"
- Sets the available ciphersuites for TLSv1.3 to value. This is a
- colon-separated list of TLSv1.3 ciphersuite names in order of preference. This
- list will be combined any configured TLSv1.2 and below ciphersuites.
- See \fBopenssl\-ciphers\fR\|(1) for more information.
- .IP "\fB\-min_protocol\fR \fIminprot\fR, \fB\-max_protocol\fR \fImaxprot\fR" 4
- .IX Item "-min_protocol minprot, -max_protocol maxprot"
- Sets the minimum and maximum supported protocol.
- Currently supported protocol values are \fBSSLv3\fR, \fBTLSv1\fR, \fBTLSv1.1\fR,
- \&\fBTLSv1.2\fR, \fBTLSv1.3\fR for \s-1TLS\s0; \fBDTLSv1\fR, \fBDTLSv1.2\fR for \s-1DTLS,\s0 and \fBNone\fR
- for no limit.
- If either the lower or upper bound is not specified then only the other bound
- applies, if specified.
- If your application supports both \s-1TLS\s0 and \s-1DTLS\s0 you can specify any of these
- options twice, once with a bound for \s-1TLS\s0 and again with an appropriate bound
- for \s-1DTLS.\s0
- To restrict the supported protocol versions use these commands rather than the
- deprecated alternative commands below.
- .IP "\fB\-record_padding\fR \fIpadding\fR" 4
- .IX Item "-record_padding padding"
- Attempts to pad TLSv1.3 records so that they are a multiple of \fBpadding\fR
- in length on send. A \fBpadding\fR of 0 or 1 turns off padding. Otherwise,
- the \fBpadding\fR must be >1 or <=16384.
- .IP "\fB\-debug_broken_protocol\fR" 4
- .IX Item "-debug_broken_protocol"
- Ignored.
- .IP "\fB\-no_middlebox\fR" 4
- .IX Item "-no_middlebox"
- Turn off \*(L"middlebox compatibility\*(R", as described below.
- .SS "Additional Options"
- .IX Subsection "Additional Options"
- The following options are accepted by \fBSSL_CONF_cmd()\fR, but are not
- processed by the OpenSSL commands.
- .IP "\fB\-cert\fR \fIfile\fR" 4
- .IX Item "-cert file"
- Attempts to use \fBfile\fR as the certificate for the appropriate context. It
- currently uses \fBSSL_CTX_use_certificate_chain_file()\fR if an \fB\s-1SSL_CTX\s0\fR
- structure is set or \fBSSL_use_certificate_file()\fR with filetype \s-1PEM\s0 if an
- \&\fB\s-1SSL\s0\fR structure is set. This option is only supported if certificate
- operations are permitted.
- .IP "\fB\-key\fR \fIfile\fR" 4
- .IX Item "-key file"
- Attempts to use \fBfile\fR as the private key for the appropriate context. This
- option is only supported if certificate operations are permitted. Note:
- if no \fB\-key\fR option is set then a private key is not loaded unless the
- flag \fB\s-1SSL_CONF_FLAG_REQUIRE_PRIVATE\s0\fR is set.
- .IP "\fB\-dhparam\fR \fIfile\fR" 4
- .IX Item "-dhparam file"
- Attempts to use \fBfile\fR as the set of temporary \s-1DH\s0 parameters for
- the appropriate context. This option is only supported if certificate
- operations are permitted.
- .IP "\fB\-no_ssl3\fR, \fB\-no_tls1\fR, \fB\-no_tls1_1\fR, \fB\-no_tls1_2\fR, \fB\-no_tls1_3\fR" 4
- .IX Item "-no_ssl3, -no_tls1, -no_tls1_1, -no_tls1_2, -no_tls1_3"
- Disables protocol support for SSLv3, TLSv1.0, TLSv1.1, TLSv1.2 or TLSv1.3 by
- setting the corresponding options \fBSSL_OP_NO_SSLv3\fR, \fBSSL_OP_NO_TLSv1\fR,
- \&\fBSSL_OP_NO_TLSv1_1\fR, \fBSSL_OP_NO_TLSv1_2\fR and \fBSSL_OP_NO_TLSv1_3\fR
- respectively. These options are deprecated, use \fB\-min_protocol\fR and
- \&\fB\-max_protocol\fR instead.
- .IP "\fB\-anti_replay\fR, \fB\-no_anti_replay\fR" 4
- .IX Item "-anti_replay, -no_anti_replay"
- Switches replay protection, on or off respectively. With replay protection on,
- OpenSSL will automatically detect if a session ticket has been used more than
- once, TLSv1.3 has been negotiated, and early data is enabled on the server. A
- full handshake is forced if a session ticket is used a second or subsequent
- time. Anti-Replay is on by default unless overridden by a configuration file and
- is only used by servers. Anti-replay measures are required for compliance with
- the TLSv1.3 specification. Some applications may be able to mitigate the replay
- risks in other ways and in such cases the built-in OpenSSL functionality is not
- required. Switching off anti-replay is equivalent to \fB\s-1SSL_OP_NO_ANTI_REPLAY\s0\fR.
- .SH "SUPPORTED CONFIGURATION FILE COMMANDS"
- .IX Header "SUPPORTED CONFIGURATION FILE COMMANDS"
- Currently supported \fBoption\fR names for configuration files (i.e., when the
- flag \fB\s-1SSL_CONF_FLAG_FILE\s0\fR is set) are listed below. All configuration file
- \&\fBoption\fR names are case insensitive so \fBsignaturealgorithms\fR is recognised
- as well as \fBSignatureAlgorithms\fR. Unless otherwise stated the \fBvalue\fR names
- are also case insensitive.
- .PP
- Note: the command prefix (if set) alters the recognised \fBoption\fR values.
- .IP "\fBCipherString\fR" 4
- .IX Item "CipherString"
- Sets the ciphersuite list for TLSv1.2 and below to \fBvalue\fR. This list will be
- combined with any configured TLSv1.3 ciphersuites. Note: syntax
- checking of \fBvalue\fR is currently not performed unless an \fB\s-1SSL\s0\fR or \fB\s-1SSL_CTX\s0\fR
- structure is associated with \fBctx\fR.
- .IP "\fBCiphersuites\fR" 4
- .IX Item "Ciphersuites"
- Sets the available ciphersuites for TLSv1.3 to \fBvalue\fR. This is a
- colon-separated list of TLSv1.3 ciphersuite names in order of preference. This
- list will be combined any configured TLSv1.2 and below ciphersuites.
- See \fBopenssl\-ciphers\fR\|(1) for more information.
- .IP "\fBCertificate\fR" 4
- .IX Item "Certificate"
- Attempts to use the file \fBvalue\fR as the certificate for the appropriate
- context. It currently uses \fBSSL_CTX_use_certificate_chain_file()\fR if an \fB\s-1SSL_CTX\s0\fR
- structure is set or \fBSSL_use_certificate_file()\fR with filetype \s-1PEM\s0 if an \fB\s-1SSL\s0\fR
- structure is set. This option is only supported if certificate operations
- are permitted.
- .IP "\fBPrivateKey\fR" 4
- .IX Item "PrivateKey"
- Attempts to use the file \fBvalue\fR as the private key for the appropriate
- context. This option is only supported if certificate operations
- are permitted. Note: if no \fBPrivateKey\fR option is set then a private key is
- not loaded unless the \fB\s-1SSL_CONF_FLAG_REQUIRE_PRIVATE\s0\fR is set.
- .IP "\fBChainCAFile\fR, \fBChainCAPath\fR, \fBVerifyCAFile\fR, \fBVerifyCAPath\fR" 4
- .IX Item "ChainCAFile, ChainCAPath, VerifyCAFile, VerifyCAPath"
- These options indicate a file or directory used for building certificate
- chains or verifying certificate chains. These options are only supported
- if certificate operations are permitted.
- .IP "\fBRequestCAFile\fR" 4
- .IX Item "RequestCAFile"
- This option indicates a file containing a set of certificates in \s-1PEM\s0 form.
- The subject names of the certificates are sent to the peer in the
- \&\fBcertificate_authorities\fR extension for \s-1TLS 1.3\s0 (in ClientHello or
- CertificateRequest) or in a certificate request for previous versions or
- \&\s-1TLS.\s0
- .IP "\fBServerInfoFile\fR" 4
- .IX Item "ServerInfoFile"
- Attempts to use the file \fBvalue\fR in the \*(L"serverinfo\*(R" extension using the
- function SSL_CTX_use_serverinfo_file.
- .IP "\fBDHParameters\fR" 4
- .IX Item "DHParameters"
- Attempts to use the file \fBvalue\fR as the set of temporary \s-1DH\s0 parameters for
- the appropriate context. This option is only supported if certificate
- operations are permitted.
- .IP "\fBRecordPadding\fR" 4
- .IX Item "RecordPadding"
- Attempts to pad TLSv1.3 records so that they are a multiple of \fBvalue\fR in
- length on send. A \fBvalue\fR of 0 or 1 turns off padding. Otherwise, the
- \&\fBvalue\fR must be >1 or <=16384.
- .IP "\fBSignatureAlgorithms\fR" 4
- .IX Item "SignatureAlgorithms"
- This sets the supported signature algorithms for TLSv1.2 and TLSv1.3.
- For clients this
- value is used directly for the supported signature algorithms extension. For
- servers it is used to determine which signature algorithms to support.
- .Sp
- The \fBvalue\fR argument should be a colon separated list of signature algorithms
- in order of decreasing preference of the form \fBalgorithm+hash\fR or
- \&\fBsignature_scheme\fR. For the default providers shipped with OpenSSL,
- \&\fBalgorithm\fR is one of \fB\s-1RSA\s0\fR, \fB\s-1DSA\s0\fR or \fB\s-1ECDSA\s0\fR and \fBhash\fR is a supported
- algorithm \s-1OID\s0 short name such as \fB\s-1SHA1\s0\fR, \fB\s-1SHA224\s0\fR, \fB\s-1SHA256\s0\fR, \fB\s-1SHA384\s0\fR
- or \fB\s-1SHA512\s0\fR.
- Note: algorithm and hash names are case sensitive.
- \&\fBsignature_scheme\fR is one of the signature schemes defined in TLSv1.3,
- specified using the \s-1IETF\s0 name, e.g., \fBecdsa_secp256r1_sha256\fR, \fBed25519\fR,
- or \fBrsa_pss_pss_sha256\fR.
- Additional providers may make available further algorithms via the \s-1TLS_SIGALG\s0
- capability. See \*(L"\s-1CAPABILITIES\*(R"\s0 in \fBprovider\-base\fR\|(7).
- .Sp
- If this option is not set then all signature algorithms supported by all
- activated providers are permissible.
- .Sp
- Note: algorithms which specify a PKCS#1 v1.5 signature scheme (either by
- using \fB\s-1RSA\s0\fR as the \fBalgorithm\fR or by using one of the \fBrsa_pkcs1_*\fR
- identifiers) are ignored in TLSv1.3 and will not be negotiated.
- .IP "\fBClientSignatureAlgorithms\fR" 4
- .IX Item "ClientSignatureAlgorithms"
- This sets the supported signature algorithms associated with client
- authentication for TLSv1.2 and TLSv1.3.
- For servers the value is used in the
- \&\fBsignature_algorithms\fR field of a \fBCertificateRequest\fR message.
- For clients it is
- used to determine which signature algorithm to use with the client certificate.
- If a server does not request a certificate this option has no effect.
- .Sp
- The syntax of \fBvalue\fR is identical to \fBSignatureAlgorithms\fR. If not set then
- the value set for \fBSignatureAlgorithms\fR will be used instead.
- .IP "\fBGroups\fR" 4
- .IX Item "Groups"
- This sets the supported groups. For clients, the groups are
- sent using the supported groups extension. For servers, it is used
- to determine which group to use. This setting affects groups used for
- signatures (in TLSv1.2 and earlier) and key exchange. The first group listed
- will also be used for the \fBkey_share\fR sent by a client in a TLSv1.3
- \&\fBClientHello\fR.
- .Sp
- The \fBvalue\fR argument is a colon separated list of groups. The group can be
- either the \fB\s-1NIST\s0\fR name (e.g. \fBP\-256\fR), some other commonly used name where
- applicable (e.g. \fBX25519\fR, \fBffdhe2048\fR) or an OpenSSL \s-1OID\s0 name
- (e.g. \fBprime256v1\fR). Group names are case sensitive. The list should be in
- order of preference with the most preferred group first.
- .Sp
- Currently supported groups for \fBTLSv1.3\fR are \fBP\-256\fR, \fBP\-384\fR, \fBP\-521\fR,
- \&\fBX25519\fR, \fBX448\fR, \fBffdhe2048\fR, \fBffdhe3072\fR, \fBffdhe4096\fR, \fBffdhe6144\fR,
- \&\fBffdhe8192\fR.
- .IP "\fBCurves\fR" 4
- .IX Item "Curves"
- This is a synonym for the \*(L"Groups\*(R" command.
- .IP "\fBMinProtocol\fR" 4
- .IX Item "MinProtocol"
- This sets the minimum supported \s-1SSL, TLS\s0 or \s-1DTLS\s0 version.
- .Sp
- Currently supported protocol values are \fBSSLv3\fR, \fBTLSv1\fR, \fBTLSv1.1\fR,
- \&\fBTLSv1.2\fR, \fBTLSv1.3\fR, \fBDTLSv1\fR and \fBDTLSv1.2\fR.
- The \s-1SSL\s0 and \s-1TLS\s0 bounds apply only to TLS-based contexts, while the \s-1DTLS\s0 bounds
- apply only to DTLS-based contexts.
- The command can be repeated with one instance setting a \s-1TLS\s0 bound, and the
- other setting a \s-1DTLS\s0 bound.
- The value \fBNone\fR applies to both types of contexts and disables the limits.
- .IP "\fBMaxProtocol\fR" 4
- .IX Item "MaxProtocol"
- This sets the maximum supported \s-1SSL, TLS\s0 or \s-1DTLS\s0 version.
- .Sp
- Currently supported protocol values are \fBSSLv3\fR, \fBTLSv1\fR, \fBTLSv1.1\fR,
- \&\fBTLSv1.2\fR, \fBTLSv1.3\fR, \fBDTLSv1\fR and \fBDTLSv1.2\fR.
- The \s-1SSL\s0 and \s-1TLS\s0 bounds apply only to TLS-based contexts, while the \s-1DTLS\s0 bounds
- apply only to DTLS-based contexts.
- The command can be repeated with one instance setting a \s-1TLS\s0 bound, and the
- other setting a \s-1DTLS\s0 bound.
- The value \fBNone\fR applies to both types of contexts and disables the limits.
- .IP "\fBProtocol\fR" 4
- .IX Item "Protocol"
- This can be used to enable or disable certain versions of the \s-1SSL,
- TLS\s0 or \s-1DTLS\s0 protocol.
- .Sp
- The \fBvalue\fR argument is a comma separated list of supported protocols
- to enable or disable.
- If a protocol is preceded by \fB\-\fR that version is disabled.
- .Sp
- All protocol versions are enabled by default.
- You need to disable at least one protocol version for this setting have any
- effect.
- Only enabling some protocol versions does not disable the other protocol
- versions.
- .Sp
- Currently supported protocol values are \fBSSLv3\fR, \fBTLSv1\fR, \fBTLSv1.1\fR,
- \&\fBTLSv1.2\fR, \fBTLSv1.3\fR, \fBDTLSv1\fR and \fBDTLSv1.2\fR.
- The special value \fB\s-1ALL\s0\fR refers to all supported versions.
- .Sp
- This can't enable protocols that are disabled using \fBMinProtocol\fR
- or \fBMaxProtocol\fR, but can disable protocols that are still allowed
- by them.
- .Sp
- The \fBProtocol\fR command is fragile and deprecated; do not use it.
- Use \fBMinProtocol\fR and \fBMaxProtocol\fR instead.
- If you do use \fBProtocol\fR, make sure that the resulting range of enabled
- protocols has no \*(L"holes\*(R", e.g. if \s-1TLS 1.0\s0 and \s-1TLS 1.2\s0 are both enabled, make
- sure to also leave \s-1TLS 1.1\s0 enabled.
- .IP "\fBOptions\fR" 4
- .IX Item "Options"
- The \fBvalue\fR argument is a comma separated list of various flags to set.
- If a flag string is preceded \fB\-\fR it is disabled.
- See the \fBSSL_CTX_set_options\fR\|(3) function for more details of
- individual options.
- .Sp
- Each option is listed below. Where an operation is enabled by default
- the \fB\-flag\fR syntax is needed to disable it.
- .Sp
- \&\fBSessionTicket\fR: session ticket support, enabled by default. Inverse of
- \&\fB\s-1SSL_OP_NO_TICKET\s0\fR: that is \fB\-SessionTicket\fR is the same as setting
- \&\fB\s-1SSL_OP_NO_TICKET\s0\fR.
- .Sp
- \&\fBCompression\fR: \s-1SSL/TLS\s0 compression support, disabled by default. Inverse
- of \fB\s-1SSL_OP_NO_COMPRESSION\s0\fR.
- .Sp
- \&\fBEmptyFragments\fR: use empty fragments as a countermeasure against a
- \&\s-1SSL 3.0/TLS 1.0\s0 protocol vulnerability affecting \s-1CBC\s0 ciphers. It
- is set by default. Inverse of \fB\s-1SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS\s0\fR.
- .Sp
- \&\fBBugs\fR: enable various bug workarounds. Same as \fB\s-1SSL_OP_ALL\s0\fR.
- .Sp
- \&\fBDHSingle\fR: enable single use \s-1DH\s0 keys, set by default. Inverse of
- \&\fB\s-1SSL_OP_DH_SINGLE\s0\fR. Only used by servers.
- .Sp
- \&\fBECDHSingle\fR: enable single use \s-1ECDH\s0 keys, set by default. Inverse of
- \&\fB\s-1SSL_OP_ECDH_SINGLE\s0\fR. Only used by servers.
- .Sp
- \&\fBServerPreference\fR: use server and not client preference order when
- determining which cipher suite, signature algorithm or elliptic curve
- to use for an incoming connection. Equivalent to
- \&\fB\s-1SSL_OP_CIPHER_SERVER_PREFERENCE\s0\fR. Only used by servers.
- .Sp
- \&\fBPrioritizeChaCha\fR: prioritizes ChaCha ciphers when the client has a
- ChaCha20 cipher at the top of its preference list. This usually indicates
- a mobile client is in use. Equivalent to \fB\s-1SSL_OP_PRIORITIZE_CHACHA\s0\fR.
- Only used by servers.
- .Sp
- \&\fBNoResumptionOnRenegotiation\fR: set
- \&\fB\s-1SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION\s0\fR flag. Only used by servers.
- .Sp
- \&\fBNoRenegotiation\fR: disables all attempts at renegotiation in TLSv1.2 and
- earlier, same as setting \fB\s-1SSL_OP_NO_RENEGOTIATION\s0\fR.
- .Sp
- \&\fBUnsafeLegacyRenegotiation\fR: permits the use of unsafe legacy renegotiation.
- Equivalent to \fB\s-1SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION\s0\fR.
- .Sp
- \&\fBUnsafeLegacyServerConnect\fR: permits the use of unsafe legacy renegotiation
- for OpenSSL clients only. Equivalent to \fB\s-1SSL_OP_LEGACY_SERVER_CONNECT\s0\fR.
- .Sp
- \&\fBEncryptThenMac\fR: use encrypt-then-mac extension, enabled by
- default. Inverse of \fB\s-1SSL_OP_NO_ENCRYPT_THEN_MAC\s0\fR: that is,
- \&\fB\-EncryptThenMac\fR is the same as setting \fB\s-1SSL_OP_NO_ENCRYPT_THEN_MAC\s0\fR.
- .Sp
- \&\fBAllowNoDHEKEX\fR: In TLSv1.3 allow a non\-(ec)dhe based key exchange mode on
- resumption. This means that there will be no forward secrecy for the resumed
- session. Equivalent to \fB\s-1SSL_OP_ALLOW_NO_DHE_KEX\s0\fR.
- .Sp
- \&\fBPreferNoDHEKEX\fR: In TLSv1.3, on resumption let the server prefer a
- non\-(ec)dhe based key exchange mode over an (ec)dhe based one. Requires
- \&\fBAllowNoDHEKEX\fR. Equivalent to \fB\s-1SSL_OP_PREFER_NO_DHE_KEX\s0\fR. Only used by
- servers.
- .Sp
- \&\fBMiddleboxCompat\fR: If set then dummy Change Cipher Spec (\s-1CCS\s0) messages are sent
- in TLSv1.3. This has the effect of making TLSv1.3 look more like TLSv1.2 so that
- middleboxes that do not understand TLSv1.3 will not drop the connection. This
- option is set by default. A future version of OpenSSL may not set this by
- default. Equivalent to \fB\s-1SSL_OP_ENABLE_MIDDLEBOX_COMPAT\s0\fR.
- .Sp
- \&\fBAntiReplay\fR: If set then OpenSSL will automatically detect if a session ticket
- has been used more than once, TLSv1.3 has been negotiated, and early data is
- enabled on the server. A full handshake is forced if a session ticket is used a
- second or subsequent time. This option is set by default and is only used by
- servers. Anti-replay measures are required to comply with the TLSv1.3
- specification. Some applications may be able to mitigate the replay risks in
- other ways and in such cases the built-in OpenSSL functionality is not required.
- Disabling anti-replay is equivalent to setting \fB\s-1SSL_OP_NO_ANTI_REPLAY\s0\fR.
- .Sp
- \&\fBExtendedMasterSecret\fR: use extended master secret extension, enabled by
- default. Inverse of \fB\s-1SSL_OP_NO_EXTENDED_MASTER_SECRET\s0\fR: that is,
- \&\fB\-ExtendedMasterSecret\fR is the same as setting \fB\s-1SSL_OP_NO_EXTENDED_MASTER_SECRET\s0\fR.
- .Sp
- \&\fBCANames\fR: use \s-1CA\s0 names extension, enabled by
- default. Inverse of \fB\s-1SSL_OP_DISABLE_TLSEXT_CA_NAMES\s0\fR: that is,
- \&\fB\-CANames\fR is the same as setting \fB\s-1SSL_OP_DISABLE_TLSEXT_CA_NAMES\s0\fR.
- .Sp
- \&\fB\s-1KTLS\s0\fR: Enables kernel \s-1TLS\s0 if support has been compiled in, and it is supported
- by the negotiated ciphersuites and extensions. Equivalent to
- \&\fB\s-1SSL_OP_ENABLE_KTLS\s0\fR.
- .Sp
- \&\fBStrictCertCheck\fR: Enable strict certificate checking. Equivalent to
- setting \fB\s-1SSL_CERT_FLAG_TLS_STRICT\s0\fR with \fBSSL_CTX_set_cert_flags()\fR.
- .Sp
- \&\fBTxCertificateCompression\fR: support sending compressed certificates, enabled by
- default. Inverse of \fB\s-1SSL_OP_NO_TX_CERTIFICATE_COMPRESSION\s0\fR: that is,
- \&\fB\-TxCertificateCompression\fR is the same as setting \fB\s-1SSL_OP_NO_TX_CERTIFICATE_COMPRESSION\s0\fR.
- .Sp
- \&\fBRxCertificateCompression\fR: support receiving compressed certificates, enabled by
- default. Inverse of \fB\s-1SSL_OP_NO_RX_CERTIFICATE_COMPRESSION\s0\fR: that is,
- \&\fB\-RxCertificateCompression\fR is the same as setting \fB\s-1SSL_OP_NO_RX_CERTIFICATE_COMPRESSION\s0\fR.
- .Sp
- \&\fBKTLSTxZerocopySendfile\fR: use the zerocopy \s-1TX\s0 mode of \fBsendfile()\fR, which gives
- a performance boost when used with \s-1KTLS\s0 hardware offload. Note that invalid \s-1TLS\s0
- records might be transmitted if the file is changed while being sent. This
- option has no effect if \fB\s-1KTLS\s0\fR is not enabled. Equivalent to
- \&\fB\s-1SSL_OP_ENABLE_KTLS_TX_ZEROCOPY_SENDFILE\s0\fR. This option only applies to Linux.
- \&\s-1KTLS\s0 sendfile on FreeBSD doesn't offer an option to disable zerocopy and
- always runs in this mode.
- .Sp
- \&\fBIgnoreUnexpectedEOF\fR: Equivalent to \fB\s-1SSL_OP_IGNORE_UNEXPECTED_EOF\s0\fR.
- You should only enable this option if the protocol running over \s-1TLS\s0 can detect
- a truncation attack itself, and that the application is checking for that
- truncation attack.
- .IP "\fBVerifyMode\fR" 4
- .IX Item "VerifyMode"
- The \fBvalue\fR argument is a comma separated list of flags to set.
- .Sp
- \&\fBPeer\fR enables peer verification: for clients only.
- .Sp
- \&\fBRequest\fR requests but does not require a certificate from the client.
- Servers only.
- .Sp
- \&\fBRequire\fR requests and requires a certificate from the client: an error
- occurs if the client does not present a certificate. Servers only.
- .Sp
- \&\fBOnce\fR requests a certificate from a client only on the initial connection:
- not when renegotiating. Servers only.
- .Sp
- \&\fBRequestPostHandshake\fR configures the connection to support requests but does
- not require a certificate from the client post-handshake. A certificate will
- not be requested during the initial handshake. The server application must
- provide a mechanism to request a certificate post-handshake. Servers only.
- TLSv1.3 only.
- .Sp
- \&\fBRequiresPostHandshake\fR configures the connection to support requests and
- requires a certificate from the client post-handshake: an error occurs if the
- client does not present a certificate. A certificate will not be requested
- during the initial handshake. The server application must provide a mechanism
- to request a certificate post-handshake. Servers only. TLSv1.3 only.
- .IP "\fBClientCAFile\fR, \fBClientCAPath\fR" 4
- .IX Item "ClientCAFile, ClientCAPath"
- A file or directory of certificates in \s-1PEM\s0 format whose names are used as the
- set of acceptable names for client CAs. Servers only. This option is only
- supported if certificate operations are permitted.
- .SH "SUPPORTED COMMAND TYPES"
- .IX Header "SUPPORTED COMMAND TYPES"
- The function \fBSSL_CONF_cmd_value_type()\fR currently returns one of the following
- types:
- .IP "\fB\s-1SSL_CONF_TYPE_UNKNOWN\s0\fR" 4
- .IX Item "SSL_CONF_TYPE_UNKNOWN"
- The \fBoption\fR string is unrecognised, this return value can be use to flag
- syntax errors.
- .IP "\fB\s-1SSL_CONF_TYPE_STRING\s0\fR" 4
- .IX Item "SSL_CONF_TYPE_STRING"
- The value is a string without any specific structure.
- .IP "\fB\s-1SSL_CONF_TYPE_FILE\s0\fR" 4
- .IX Item "SSL_CONF_TYPE_FILE"
- The value is a filename.
- .IP "\fB\s-1SSL_CONF_TYPE_DIR\s0\fR" 4
- .IX Item "SSL_CONF_TYPE_DIR"
- The value is a directory name.
- .IP "\fB\s-1SSL_CONF_TYPE_NONE\s0\fR" 4
- .IX Item "SSL_CONF_TYPE_NONE"
- The value string is not used e.g. a command line option which doesn't take an
- argument.
- .SH "NOTES"
- .IX Header "NOTES"
- The order of operations is significant. This can be used to set either defaults
- or values which cannot be overridden. For example if an application calls:
- .PP
- .Vb 2
- \& SSL_CONF_cmd(ctx, "Protocol", "\-SSLv3");
- \& SSL_CONF_cmd(ctx, userparam, uservalue);
- .Ve
- .PP
- it will disable SSLv3 support by default but the user can override it. If
- however the call sequence is:
- .PP
- .Vb 2
- \& SSL_CONF_cmd(ctx, userparam, uservalue);
- \& SSL_CONF_cmd(ctx, "Protocol", "\-SSLv3");
- .Ve
- .PP
- SSLv3 is \fBalways\fR disabled and attempt to override this by the user are
- ignored.
- .PP
- By checking the return code of \fBSSL_CONF_cmd()\fR it is possible to query if a
- given \fBoption\fR is recognised, this is useful if \fBSSL_CONF_cmd()\fR values are
- mixed with additional application specific operations.
- .PP
- For example an application might call \fBSSL_CONF_cmd()\fR and if it returns
- \&\-2 (unrecognised command) continue with processing of application specific
- commands.
- .PP
- Applications can also use \fBSSL_CONF_cmd()\fR to process command lines though the
- utility function \fBSSL_CONF_cmd_argv()\fR is normally used instead. One way
- to do this is to set the prefix to an appropriate value using
- \&\fBSSL_CONF_CTX_set1_prefix()\fR, pass the current argument to \fBoption\fR and the
- following argument to \fBvalue\fR (which may be \s-1NULL\s0).
- .PP
- In this case if the return value is positive then it is used to skip that
- number of arguments as they have been processed by \fBSSL_CONF_cmd()\fR. If \-2 is
- returned then \fBoption\fR is not recognised and application specific arguments
- can be checked instead. If \-3 is returned a required argument is missing
- and an error is indicated. If 0 is returned some other error occurred and
- this can be reported back to the user.
- .PP
- The function \fBSSL_CONF_cmd_value_type()\fR can be used by applications to
- check for the existence of a command or to perform additional syntax
- checking or translation of the command value. For example if the return
- value is \fB\s-1SSL_CONF_TYPE_FILE\s0\fR an application could translate a relative
- pathname to an absolute pathname.
- .SH "RETURN VALUES"
- .IX Header "RETURN VALUES"
- \&\fBSSL_CONF_cmd()\fR returns 1 if the value of \fBoption\fR is recognised and \fBvalue\fR is
- \&\fB\s-1NOT\s0\fR used and 2 if both \fBoption\fR and \fBvalue\fR are used. In other words it
- returns the number of arguments processed. This is useful when processing
- command lines.
- .PP
- A return value of \-2 means \fBoption\fR is not recognised.
- .PP
- A return value of \-3 means \fBoption\fR is recognised and the command requires a
- value but \fBvalue\fR is \s-1NULL.\s0
- .PP
- A return code of 0 indicates that both \fBoption\fR and \fBvalue\fR are valid but an
- error occurred attempting to perform the operation: for example due to an
- error in the syntax of \fBvalue\fR in this case the error queue may provide
- additional information.
- .SH "EXAMPLES"
- .IX Header "EXAMPLES"
- Set supported signature algorithms:
- .PP
- .Vb 1
- \& SSL_CONF_cmd(ctx, "SignatureAlgorithms", "ECDSA+SHA256:RSA+SHA256:DSA+SHA256");
- .Ve
- .PP
- There are various ways to select the supported protocols.
- .PP
- This set the minimum protocol version to TLSv1, and so disables SSLv3.
- This is the recommended way to disable protocols.
- .PP
- .Vb 1
- \& SSL_CONF_cmd(ctx, "MinProtocol", "TLSv1");
- .Ve
- .PP
- The following also disables SSLv3:
- .PP
- .Vb 1
- \& SSL_CONF_cmd(ctx, "Protocol", "\-SSLv3");
- .Ve
- .PP
- The following will first enable all protocols, and then disable
- SSLv3.
- If no protocol versions were disabled before this has the same effect as
- \&\*(L"\-SSLv3\*(R", but if some versions were disables this will re-enable them before
- disabling SSLv3.
- .PP
- .Vb 1
- \& SSL_CONF_cmd(ctx, "Protocol", "ALL,\-SSLv3");
- .Ve
- .PP
- Only enable TLSv1.2:
- .PP
- .Vb 2
- \& SSL_CONF_cmd(ctx, "MinProtocol", "TLSv1.2");
- \& SSL_CONF_cmd(ctx, "MaxProtocol", "TLSv1.2");
- .Ve
- .PP
- This also only enables TLSv1.2:
- .PP
- .Vb 1
- \& SSL_CONF_cmd(ctx, "Protocol", "\-ALL,TLSv1.2");
- .Ve
- .PP
- Disable \s-1TLS\s0 session tickets:
- .PP
- .Vb 1
- \& SSL_CONF_cmd(ctx, "Options", "\-SessionTicket");
- .Ve
- .PP
- Enable compression:
- .PP
- .Vb 1
- \& SSL_CONF_cmd(ctx, "Options", "Compression");
- .Ve
- .PP
- Set supported curves to P\-256, P\-384:
- .PP
- .Vb 1
- \& SSL_CONF_cmd(ctx, "Curves", "P\-256:P\-384");
- .Ve
- .SH "SEE ALSO"
- .IX Header "SEE ALSO"
- \&\fBssl\fR\|(7),
- \&\fBSSL_CONF_CTX_new\fR\|(3),
- \&\fBSSL_CONF_CTX_set_flags\fR\|(3),
- \&\fBSSL_CONF_CTX_set1_prefix\fR\|(3),
- \&\fBSSL_CONF_CTX_set_ssl_ctx\fR\|(3),
- \&\fBSSL_CONF_cmd_argv\fR\|(3),
- \&\fBSSL_CTX_set_options\fR\|(3)
- .SH "HISTORY"
- .IX Header "HISTORY"
- The \fBSSL_CONF_cmd()\fR function was added in OpenSSL 1.0.2.
- .PP
- The \fB\s-1SSL_OP_NO_SSL2\s0\fR option doesn't have effect since 1.1.0, but the macro
- is retained for backwards compatibility.
- .PP
- The \fB\s-1SSL_CONF_TYPE_NONE\s0\fR was added in OpenSSL 1.1.0. In earlier versions of
- OpenSSL passing a command which didn't take an argument would return
- \&\fB\s-1SSL_CONF_TYPE_UNKNOWN\s0\fR.
- .PP
- \&\fBMinProtocol\fR and \fBMaxProtocol\fR where added in OpenSSL 1.1.0.
- .PP
- \&\fBAllowNoDHEKEX\fR and \fBPrioritizeChaCha\fR were added in OpenSSL 1.1.1.
- .PP
- The \fBUnsafeLegacyServerConnect\fR option is no longer set by default from
- OpenSSL 3.0.
- .PP
- The \fBTxCertificateCompression\fR and \fBRxCertificateCompression\fR options were
- added in OpenSSL 3.2.
- .PP
- \&\fBPreferNoDHEKEX\fR was added in OpenSSL 3.3.
- .SH "COPYRIGHT"
- .IX Header "COPYRIGHT"
- Copyright 2012\-2024 The OpenSSL Project Authors. All Rights Reserved.
- .PP
- Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
- this file except in compliance with the License. You can obtain a copy
- in the file \s-1LICENSE\s0 in the source distribution or at
- <https://www.openssl.org/source/license.html>.
|