Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) 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 >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'...
.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 "OPENSSL-S_SERVER 1" OPENSSL-S_SERVER 1 "2023-08-02" "3.0.10" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes way too many mistakes in technical documents. "NAME"
openssl-s_server -
SSL/
TLS server program
"SYNOPSIS"
Header "SYNOPSIS" \fBopenssl
s_server
[
-help]
[
-port +int]
[
-accept val]
[
-unix val]
[
-4]
[
-6]
[
-unlink]
[
-context val]
[
-verify int]
[
-Verify int]
[
-cert infile]
[
-cert2 infile]
[
-certform \s-1DER\s0|
\s-1PEM\s0|
P12]
[
-cert_chain infile]
[
-build_chain]
[
-serverinfo val]
[
-key filename|
uri]
[
-key2 filename|
uri]
[
-keyform \s-1DER\s0|
\s-1PEM\s0|
P12|
\s-1ENGINE\s0]
[
-pass val]
[
-dcert infile]
[
-dcertform \s-1DER\s0|
\s-1PEM\s0|
P12]
[
-dcert_chain infile]
[
-dkey filename|
uri]
[
-dkeyform \s-1DER\s0|
\s-1PEM\s0|
P12|
\s-1ENGINE\s0]
[
-dpass val]
[
-nbio_test]
[
-crlf]
[
-debug]
[
-msg]
[
-msgfile outfile]
[
-state]
[
-nocert]
[
-quiet]
[
-no_resume_ephemeral]
[
-www]
[
-WWW]
[
-http_server_binmode]
[
-no_ca_names]
[
-ignore_unexpected_eof]
[
-servername]
[
-servername_fatal]
[
-tlsextdebug]
[
-HTTP]
[
-id_prefix val]
[
-keymatexport val]
[
-keymatexportlen +int]
[
-CRL infile]
[
-CRLform \s-1DER\s0|
\s-1PEM\s0]
[
-crl_download]
[
-chainCAfile infile]
[
-chainCApath dir]
[
-chainCAstore uri]
[
-verifyCAfile infile]
[
-verifyCApath dir]
[
-verifyCAstore uri]
[
-no_cache]
[
-ext_cache]
[
-verify_return_error]
[
-verify_quiet]
[
-ign_eof]
[
-no_ign_eof]
[
-no_etm]
[
-status]
[
-status_verbose]
[
-status_timeout int]
[
-proxy [http[s]://][userinfo@]host[:port][/path]]
[
-no_proxy addresses]
[
-status_url val]
[
-status_file infile]
[
-ssl_config val]
[
-trace]
[
-security_debug]
[
-security_debug_verbose]
[
-brief]
[
-rev]
[
-async]
[
-max_send_frag +int]
[
-split_send_frag +int]
[
-max_pipelines +int]
[
-naccept +int]
[
-read_buf +int]
[
-bugs]
[
-no_comp]
[
-comp]
[
-no_ticket]
[
-serverpref]
[
-legacy_renegotiation]
[
-no_renegotiation]
[
-no_resumption_on_reneg]
[
-allow_no_dhe_kex]
[
-prioritize_chacha]
[
-strict]
[
-sigalgs val]
[
-client_sigalgs val]
[
-groups val]
[
-curves val]
[
-named_curve val]
[
-cipher val]
[
-ciphersuites val]
[
-dhparam infile]
[
-record_padding val]
[
-debug_broken_protocol]
[
-nbio]
[
-psk_identity val]
[
-psk_hint val]
[
-psk val]
[
-psk_session file]
[
-srpvfile infile]
[
-srpuserseed val]
[
-timeout]
[
-mtu +int]
[
-listen]
[
-sctp]
[
-sctp_label_bug]
[
-use_srtp val]
[
-no_dhe]
[
-nextprotoneg val]
[
-alpn val]
[
-sendfile]
[
-keylogfile outfile]
[
-recv_max_early_data int]
[
-max_early_data int]
[
-early_data]
[
-stateless]
[
-anti_replay]
[
-no_anti_replay]
[
-num_tickets]
[
-nameopt option]
[
-no_ssl3]
[
-no_tls1]
[
-no_tls1_1]
[
-no_tls1_2]
[
-no_tls1_3]
[
-ssl3]
[
-tls1]
[
-tls1_1]
[
-tls1_2]
[
-tls1_3]
[
-dtls]
[
-dtls1]
[
-dtls1_2]
[
-allow_proxy_certs]
[
-attime timestamp]
[
-no_check_time]
[
-check_ss_sig]
[
-crl_check]
[
-crl_check_all]
[
-explicit_policy]
[
-extended_crl]
[
-ignore_critical]
[
-inhibit_any]
[
-inhibit_map]
[
-partial_chain]
[
-policy arg]
[
-policy_check]
[
-policy_print]
[
-purpose purpose]
[
-suiteB_128]
[
-suiteB_128_only]
[
-suiteB_192]
[
-trusted_first]
[
-no_alt_chains]
[
-use_deltas]
[
-auth_level num]
[
-verify_depth num]
[
-verify_email email]
[
-verify_hostname hostname]
[
-verify_ip ip]
[
-verify_name name]
[
-x509_strict]
[
-issuer_checks]
[
-bugs]
[
-no_comp]
[
-comp]
[
-no_ticket]
[
-serverpref]
[
-client_renegotiation]
[
-legacy_renegotiation]
[
-no_renegotiation]
[
-no_resumption_on_reneg]
[
-legacy_server_connect]
[
-no_legacy_server_connect]
[
-no_etm]
[
-allow_no_dhe_kex]
[
-prioritize_chacha]
[
-strict]
[
-sigalgs algs]
[
-client_sigalgs algs]
[
-groups groups]
[
-curves curves]
[
-named_curve curve]
[
-cipher ciphers]
[
-ciphersuites 1.3ciphers]
[
-min_protocol minprot]
[
-max_protocol maxprot]
[
-record_padding padding]
[
-debug_broken_protocol]
[
-no_middlebox]
[
-xkey infile]
[
-xcert file]
[
-xchain file]
[
-xchain_build file]
[
-xcertform \s-1DER\s0|
\s-1PEM\s0]>
[
-xkeyform \s-1DER\s0|
\s-1PEM\s0]>
[
-CAfile file]
[
-no-CAfile]
[
-CApath dir]
[
-no-CApath]
[
-CAstore uri]
[
-no-CAstore]
[
-rand files]
[
-writerand file]
[
-engine id]
[
-provider name]
[
-provider-path path]
[
-propquery propq]
"DESCRIPTION"
Header "DESCRIPTION" This command implements a generic \
s-1SSL/
TLS\s0 server which
listens for connections on a given port using \
s-1SSL/
TLS.\s0
"OPTIONS"
Header "OPTIONS" In addition to the options below, this command also supports
the common and server only options documented
\*(L"Supported Command Line Commands\*(R" in
SSL_CONF_cmd\|(3)
"-help" 4
Item "-help" Print out a usage message.
"-port +int" 4
Item "-port +int" The \s-1TCP\s0 port to listen on for connections. If not specified 4433 is used.
"-accept val" 4
Item "-accept val" The optional \s-1TCP\s0 host and port to listen on for connections. If not specified, *:4433 is used.
"-unix val" 4
Item "-unix val" Unix domain socket to accept on.
"-4" 4
Item "-4" Use IPv4 only.
"-6" 4
Item "-6" Use IPv6 only.
"-unlink" 4
Item "-unlink" For -unix, unlink any existing socket first.
"-context val" 4
Item "-context val" Sets the \s-1SSL\s0 context id. It can be given any string value. If this option
is not present a default value will be used.
"-verify int, -Verify int" 4
Item "-verify int, -Verify int" The verify depth to use. This specifies the maximum length of the
client certificate chain and makes the server request a certificate from
the client. With the
-verify option a certificate is requested but the
client does not have to send one, with the
-Verify option the client
must supply a certificate or an error occurs.
.Sp
If the cipher suite cannot request a client certificate (for example an
anonymous cipher suite or \s-1PSK\s0) this option has no effect.
"-cert infile" 4
Item "-cert infile" The certificate to use, most servers cipher suites require the use of a
certificate and some require a certificate with a certain public key type:
for example the \s-1DSS\s0 cipher suites require a certificate containing a \s-1DSS\s0
(\s-1DSA\s0) key. If not specified then the filename
server.pem will be used.
"-cert2 infile" 4
Item "-cert2 infile" The certificate file to use for servername; default is
\*(C`server2.pem\*(C'.
"-certform \s-1DER\s0|\s-1PEM\s0|P12" 4
Item "-certform DER|PEM|P12" The server certificate file format; unspecified by default.
See
openssl-format-options\|(1) for details.
"-cert_chain" 4
Item "-cert_chain" A file or \s-1URI\s0 of untrusted certificates to use when attempting to build the
certificate chain related to the certificate specified via the
-cert option.
The input can be in \s-1PEM, DER,\s0 or PKCS#12 format.
"-build_chain" 4
Item "-build_chain" Specify whether the application should build the server certificate chain to be
provided to the client.
"-serverinfo val" 4
Item "-serverinfo val" A file containing one or more blocks of \s-1PEM\s0 data. Each \s-1PEM\s0 block
must encode a \s-1TLS\s0 ServerHello extension (2 bytes type, 2 bytes length,
followed by \*(L"length\*(R" bytes of extension data). If the client sends
an empty \s-1TLS\s0 ClientHello extension matching the type, the corresponding
ServerHello extension will be returned.
"-key filename|uri" 4
Item "-key filename|uri" The private key to use. If not specified then the certificate file will
be used.
"-key2 filename|uri" 4
Item "-key2 filename|uri" The private Key file to use for servername if not given via
-cert2.
"-keyform \s-1DER\s0|\s-1PEM\s0|P12|\s-1ENGINE\s0" 4
Item "-keyform DER|PEM|P12|ENGINE" The key format; unspecified by default.
See
openssl-format-options\|(1) for details.
"-pass val" 4
Item "-pass val" The private key and certificate file password source.
For more information about the format of
val,
see
openssl-passphrase-options\|(1).
"-dcert infile, -dkey filename|uri" 4
Item "-dcert infile, -dkey filename|uri" Specify an additional certificate and private key, these behave in the
same manner as the
-cert and
-key options except there is no default
if they are not specified (no additional certificate and key is used). As
noted above some cipher suites require a certificate containing a key of
a certain type. Some cipher suites need a certificate carrying an \s-1RSA\s0 key
and some a \s-1DSS\s0 (\s-1DSA\s0) key. By using \s-1RSA\s0 and \s-1DSS\s0 certificates and keys
a server can support clients which only support \s-1RSA\s0 or \s-1DSS\s0 cipher suites
by using an appropriate certificate.
"-dcert_chain" 4
Item "-dcert_chain" A file or \s-1URI\s0 of untrusted certificates to use when attempting to build the
server certificate chain when a certificate specified via the
-dcert option
is in use.
The input can be in \s-1PEM, DER,\s0 or PKCS#12 format.
"-dcertform \s-1DER\s0|\s-1PEM\s0|P12" 4
Item "-dcertform DER|PEM|P12" The format of the additional certificate file; unspecified by default.
See
openssl-format-options\|(1) for details.
"-dkeyform \s-1DER\s0|\s-1PEM\s0|P12|\s-1ENGINE\s0" 4
Item "-dkeyform DER|PEM|P12|ENGINE" The format of the additional private key; unspecified by default.
See
openssl-format-options\|(1) for details.
"-dpass val" 4
Item "-dpass val" The passphrase for the additional private key and certificate.
For more information about the format of
val,
see
openssl-passphrase-options\|(1).
"-nbio_test" 4
Item "-nbio_test" Tests non blocking I/O.
"-crlf" 4
Item "-crlf" This option translated a line feed from the terminal into \s-1CR+LF.\s0
"-debug" 4
Item "-debug" Print extensive debugging information including a hex dump of all traffic.
"-security_debug" 4
Item "-security_debug" Print output from \
s-1SSL/
TLS\s0 security framework.
"-security_debug_verbose" 4
Item "-security_debug_verbose" Print more output from \
s-1SSL/
TLS\s0 security framework
"-msg" 4
Item "-msg" Show all protocol messages with hex dump.
"-msgfile outfile" 4
Item "-msgfile outfile" File to send output of
-msg or
-trace to, default standard output.
"-state" 4
Item "-state" Prints the \s-1SSL\s0 session states.
"-CRL infile" 4
Item "-CRL infile" The \s-1CRL\s0 file to use.
"-CRLform \s-1DER\s0|\s-1PEM\s0" 4
Item "-CRLform DER|PEM" The \s-1CRL\s0 file format; unspecified by default.
See
openssl-format-options\|(1) for details.
"-crl_download" 4
Item "-crl_download" Download CRLs from distribution points given in \s-1CDP\s0 extensions of certificates
"-verifyCAfile filename" 4
Item "-verifyCAfile filename" A file in \s-1PEM\s0 format \s-1CA\s0 containing trusted certificates to use
for verifying client certificates.
"-verifyCApath dir" 4
Item "-verifyCApath dir" A directory containing trusted certificates to use
for verifying client certificates.
This directory must be in \*(L"hash format\*(R",
see
openssl-verify\|(1) for more information.
"-verifyCAstore uri" 4
Item "-verifyCAstore uri" The \s-1URI\s0 of a store containing trusted certificates to use
for verifying client certificates.
"-chainCAfile file" 4
Item "-chainCAfile file" A file in \s-1PEM\s0 format containing trusted certificates to use
when attempting to build the server certificate chain.
"-chainCApath dir" 4
Item "-chainCApath dir" A directory containing trusted certificates to use
for building the server certificate chain provided to the client.
This directory must be in \*(L"hash format\*(R",
see
openssl-verify\|(1) for more information.
"-chainCAstore uri" 4
Item "-chainCAstore uri" The \s-1URI\s0 of a store containing trusted certificates to use
for building the server certificate chain provided to the client.
The \s-1URI\s0 may indicate a single certificate, as well as a collection of them.
With URIs in the
\*(C`file:\*(C' scheme, this acts as
-chainCAfile or
\fB-chainCApath, depending on if the \s-1URI\s0 indicates a directory or a
single file.
See
ossl_store-file\|(7) for more information on the
\*(C`file:\*(C' scheme.
"-nocert" 4
Item "-nocert" If this option is set then no certificate is used. This restricts the
cipher suites available to the anonymous ones (currently just anonymous
\s-1DH\s0).
"-quiet" 4
Item "-quiet" Inhibit printing of session and certificate information.
"-no_resume_ephemeral" 4
Item "-no_resume_ephemeral" Disable caching and tickets if ephemeral (\s-1EC\s0)DH is used.
"-tlsextdebug" 4
Item "-tlsextdebug" Print a hex dump of any \s-1TLS\s0 extensions received from the server.
"-www" 4
Item "-www" Sends a status message back to the client when it connects. This includes
information about the ciphers used and various session parameters.
The output is in \s-1HTML\s0 format so this option can be used with a web browser.
The special \s-1URL\s0
\*(C`/renegcert\*(C' turns on client cert validation, and
\*(C`/reneg\*(C'
tells the server to request renegotiation.
The
-early_data option cannot be used with this option.
"-WWW, -HTTP" 4
Item "-WWW, -HTTP" Emulates a simple web server. Pages will be resolved relative to the
current directory, for example if the \s-1URL\s0
\*(C`https://myhost/page.html\*(C' is
requested the file
./page.html will be sent.
If the
-HTTP flag is used, the files are sent directly, and should contain
any \s-1HTTP\s0 response headers (including status response line).
If the
-WWW option is used,
the response headers are generated by the server, and the file extension is
examined to determine the
Content-Type header.
Extensions of
\*(C`html\*(C',
\*(C`htm\*(C', and
\*(C`php\*(C' are
\*(C`text/html\*(C' and all others are
\f(CW\*(C`
text/
plain\*(C'.
In addition, the special \s-1URL\s0
\*(C`/stats\*(C' will return status
information like the
-www option.
Neither of these options can be used in conjunction with
-early_data.
"-http_server_binmode" 4
Item "-http_server_binmode" When acting as web-server (using option
-WWW or
-HTTP) open files requested
by the client in binary mode.
"-no_ca_names" 4
Item "-no_ca_names" Disable \s-1TLS\s0 Extension \s-1CA\s0 Names. You may want to disable it for security reasons
or for compatibility with some Windows \s-1TLS\s0 implementations crashing when this
extension is larger than 1024 bytes.
"-ignore_unexpected_eof" 4
Item "-ignore_unexpected_eof" Some \s-1TLS\s0 implementations do not send the mandatory close_notify alert on
shutdown. If the application tries to wait for the close_notify alert but the
peer closes the connection without sending it, an error is generated. When this
option is enabled the peer does not need to send the close_notify alert and a
closed connection will be treated as if the close_notify alert was received.
For more information on shutting down a connection, see
SSL_shutdown\|(3).
"-servername" 4
Item "-servername" Servername for HostName \s-1TLS\s0 extension.
"-servername_fatal" 4
Item "-servername_fatal" On servername mismatch send fatal alert (default: warning alert).
"-id_prefix val" 4
Item "-id_prefix val" Generate \
s-1SSL/
TLS\s0 session IDs prefixed by
val. This is mostly useful
for testing any \
s-1SSL/
TLS\s0 code (e.g. proxies) that wish to deal with multiple
servers, when each of which might be generating a unique range of session
IDs (e.g. with a certain prefix).
"-keymatexport" 4
Item "-keymatexport" Export keying material using label.
"-keymatexportlen" 4
Item "-keymatexportlen" Export the given number of bytes of keying material; default 20.
"-no_cache" 4
Item "-no_cache" Disable session cache.
"-ext_cache." 4
Item "-ext_cache." Disable internal cache, set up and use external cache.
"-verify_return_error" 4
Item "-verify_return_error" Verification errors normally just print a message but allow the
connection to continue, for debugging purposes.
If this option is used, then verification errors close the connection.
"-verify_quiet" 4
Item "-verify_quiet" No verify output except verify errors.
"-ign_eof" 4
Item "-ign_eof" Ignore input \s-1EOF\s0 (default: when
-quiet).
"-no_ign_eof" 4
Item "-no_ign_eof" Do not ignore input \s-1EOF.\s0
"-no_etm" 4
Item "-no_etm" Disable Encrypt-then-MAC negotiation.
"-status" 4
Item "-status" Enables certificate status request support (aka \s-1OCSP\s0 stapling).
"-status_verbose" 4
Item "-status_verbose" Enables certificate status request support (aka \s-1OCSP\s0 stapling) and gives
a verbose printout of the \s-1OCSP\s0 response.
"-status_timeout int" 4
Item "-status_timeout int" Sets the timeout for \s-1OCSP\s0 response to
int seconds.
"-proxy [http[s]://][userinfo@]host[:port][/path]" 4
Item "-proxy [http[s]://][userinfo@]host[:port][/path]" The \s-1HTTP\s0(S) proxy server to use for reaching the \s-1OCSP\s0 server unless
-no_proxy
applies, see below.
The proxy port defaults to 80 or 443 if the scheme is
\*(C`https\*(C'; apart from that
the optional
\*(C`http://\*(C' or
\*(C`https://\*(C' prefix is ignored,
as well as any userinfo and path components.
Defaults to the environment variable
\*(C`http_proxy\*(C' if set, else
\*(C`HTTP_PROXY\*(C'
in case no \s-1TLS\s0 is used, otherwise
\*(C`https_proxy\*(C' if set, else
\*(C`HTTPS_PROXY\*(C'.
"-no_proxy addresses" 4
Item "-no_proxy addresses" List of \s-1IP\s0 addresses
and/
or \s-1DNS\s0 names of servers
not to use an \s-1HTTP\s0(S) proxy for, separated by commas
and/
or whitespace
(where in the latter case the whole argument must be enclosed in \*(L"...\*(R").
Default is from the environment variable
\*(C`no_proxy\*(C' if set, else
\*(C`NO_PROXY\*(C'.
"-status_url val" 4
Item "-status_url val" Sets a fallback responder \s-1URL\s0 to use if no responder \s-1URL\s0 is present in the
server certificate. Without this option an error is returned if the server
certificate does not contain a responder address.
The optional userinfo and fragment \s-1URL\s0 components are ignored.
Any given query component is handled as part of the path component.
"-status_file infile" 4
Item "-status_file infile" Overrides any \s-1OCSP\s0 responder URLs from the certificate and always provides the
\s-1OCSP\s0 Response stored in the file. The file must be in \s-1DER\s0 format.
"-ssl_config val" 4
Item "-ssl_config val" Configure \s-1SSL_CTX\s0 using the given configuration value.
"-trace" 4
Item "-trace" Show verbose trace output of protocol messages.
"-brief" 4
Item "-brief" Provide a brief summary of connection parameters instead of the normal verbose
output.
"-rev" 4
Item "-rev" Simple echo server that sends back received text reversed. Also sets
-brief.
Cannot be used in conjunction with
-early_data.
"-async" 4
Item "-async" Switch on asynchronous mode. Cryptographic operations will be performed
asynchronously. This will only have an effect if an asynchronous capable engine
is also used via the
-engine option. For test purposes the dummy async engine
(dasync) can be used (if available).
"-max_send_frag +int" 4
Item "-max_send_frag +int" The maximum size of data fragment to send.
See
SSL_CTX_set_max_send_fragment\|(3) for further information.
"-split_send_frag +int" 4
Item "-split_send_frag +int" The size used to split data for encrypt pipelines. If more data is written in
one go than this value then it will be split into multiple pipelines, up to the
maximum number of pipelines defined by max_pipelines. This only has an effect if
a suitable cipher suite has been negotiated, an engine that supports pipelining
has been loaded, and max_pipelines is greater than 1. See
\fBSSL_CTX_set_split_send_fragment\|(3) for further information.
"-max_pipelines +int" 4
Item "-max_pipelines +int" The maximum number of
encrypt/
decrypt pipelines to be used. This will only have
an effect if an engine has been loaded that supports pipelining (e.g. the dasync
engine) and a suitable cipher suite has been negotiated. The default value is 1.
See
SSL_CTX_set_max_pipelines\|(3) for further information.
"-naccept +int" 4
Item "-naccept +int" The server will exit after receiving the specified number of connections,
default unlimited.
"-read_buf +int" 4
Item "-read_buf +int" The default read buffer size to be used for connections. This will only have an
effect if the buffer size is larger than the size that would otherwise be used
and pipelining is in use (see
SSL_CTX_set_default_read_buffer_len\|(3) for
further information).
"-bugs" 4
Item "-bugs" There are several known bugs in \s-1SSL\s0 and \s-1TLS\s0 implementations. Adding this
option enables various workarounds.
"-no_comp" 4
Item "-no_comp" Disable negotiation of \s-1TLS\s0 compression.
\s-1TLS\s0 compression is not recommended and is off by default as of
OpenSSL 1.1.0.
"-comp" 4
Item "-comp" Enable negotiation of \s-1TLS\s0 compression.
This option was introduced in OpenSSL 1.1.0.
\s-1TLS\s0 compression is not recommended and is off by default as of
OpenSSL 1.1.0.
"-no_ticket" 4
Item "-no_ticket" Disable RFC4507bis session ticket support. This option has no effect if TLSv1.3
is negotiated. See
-num_tickets.
"-num_tickets" 4
Item "-num_tickets" Control the number of tickets that will be sent to the client after a full
handshake in TLSv1.3. The default number of tickets is 2. This option does not
affect the number of tickets sent after a resumption handshake.
"-serverpref" 4
Item "-serverpref" Use the server's cipher preferences, rather than the client's preferences.
"-prioritize_chacha" 4
Item "-prioritize_chacha" Prioritize ChaCha ciphers when preferred by clients. Requires
-serverpref.
"-no_resumption_on_reneg" 4
Item "-no_resumption_on_reneg" Set the
\s-1SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION\s0 option.
"-client_sigalgs val" 4
Item "-client_sigalgs val" Signature algorithms to support for client certificate authentication
(colon-separated list).
"-named_curve val" 4
Item "-named_curve val" Specifies the elliptic curve to use. \s-1NOTE:\s0 this is single curve, not a list.
For a list of all possible curves, use:
.Sp
.Vb 1
$ openssl ecparam -list_curves
.Ve
"-cipher val" 4
Item "-cipher val" This allows the list of TLSv1.2 and below ciphersuites used by the server to be
modified. This list is combined with any TLSv1.3 ciphersuites that have been
configured. When the client sends a list of supported ciphers the first client
cipher also included in the server list is used. Because the client specifies
the preference order, the order of the server cipherlist is irrelevant. See
\fBopenssl-ciphers\|(1) for more information.
"-ciphersuites val" 4
Item "-ciphersuites val" This allows the list of TLSv1.3 ciphersuites used by the server to be modified.
This list is combined with any TLSv1.2 and below ciphersuites that have been
configured. When the client sends a list of supported ciphers the first client
cipher also included in the server list is used. Because the client specifies
the preference order, the order of the server cipherlist is irrelevant. See
\fBopenssl-ciphers\|(1) command for more information. The format for this list is
a simple colon (\*(L":\*(R") separated list of TLSv1.3 ciphersuite names.
"-dhparam infile" 4
Item "-dhparam infile" The \s-1DH\s0 parameter file to use. The ephemeral \s-1DH\s0 cipher suites generate keys
using a set of \s-1DH\s0 parameters. If not specified then an attempt is made to
load the parameters from the server certificate file.
If this fails then a static set of parameters hard coded into this command
will be used.
"-nbio" 4
Item "-nbio" Turns on non blocking I/O.
"-timeout" 4
Item "-timeout" Enable timeouts.
"-mtu" 4
Item "-mtu" Set link-layer \s-1MTU.\s0
"-psk_identity val" 4
Item "-psk_identity val" Expect the client to send \s-1PSK\s0 identity
val when using a \s-1PSK\s0
cipher suite, and warn if they do not. By default, the expected \s-1PSK\s0
identity is the string \*(L"Client_identity\*(R".
"-psk_hint val" 4
Item "-psk_hint val" Use the \s-1PSK\s0 identity hint
val when using a \s-1PSK\s0 cipher suite.
"-psk val" 4
Item "-psk val" Use the \s-1PSK\s0 key
val when using a \s-1PSK\s0 cipher suite. The key is
given as a hexadecimal number without leading 0x, for example -psk
1a2b3c4d.
This option must be provided in order to use a \s-1PSK\s0 cipher.
"-psk_session file" 4
Item "-psk_session file" Use the pem encoded \s-1SSL_SESSION\s0 data stored in
file as the basis of a \s-1PSK.\s0
Note that this will only work if TLSv1.3 is negotiated.
"-srpvfile" 4
Item "-srpvfile" The verifier file for \s-1SRP.\s0
This option is deprecated.
"-srpuserseed" 4
Item "-srpuserseed" A seed string for a default user salt.
This option is deprecated.
"-listen" 4
Item "-listen" This option can only be used in conjunction with one of the \s-1DTLS\s0 options above.
With this option, this command will listen on a \s-1UDP\s0 port for incoming
connections.
Any ClientHellos that arrive will be checked to see if they have a cookie in
them or not.
Any without a cookie will be responded to with a HelloVerifyRequest.
If a ClientHello with a cookie is received then this command will
connect to that peer and complete the handshake.
"-sctp" 4
Item "-sctp" Use \s-1SCTP\s0 for the transport protocol instead of \s-1UDP\s0 in \s-1DTLS.\s0 Must be used in
conjunction with
-dtls,
-dtls1 or
-dtls1_2. This option is only
available where OpenSSL has support for \s-1SCTP\s0 enabled.
"-sctp_label_bug" 4
Item "-sctp_label_bug" Use the incorrect behaviour of older OpenSSL implementations when computing
endpoint-pair shared secrets for \
s-1DTLS/
SCTP.\s0 This allows communication with
older broken implementations but breaks interoperability with correct
implementations. Must be used in conjunction with
-sctp. This option is only
available where OpenSSL has support for \s-1SCTP\s0 enabled.
"-use_srtp" 4
Item "-use_srtp" Offer \s-1SRTP\s0 key management with a colon-separated profile list.
"-no_dhe" 4
Item "-no_dhe" If this option is set then no \s-1DH\s0 parameters will be loaded effectively
disabling the ephemeral \s-1DH\s0 cipher suites.
"-alpn val, -nextprotoneg val" 4
Item "-alpn val, -nextprotoneg val" These flags enable the Application-Layer Protocol Negotiation
or Next Protocol Negotiation (\s-1NPN\s0) extension, respectively. \s-1ALPN\s0 is the
\s-1IETF\s0 standard and replaces \s-1NPN.\s0
The
val list is a comma-separated list of supported protocol
names. The list should contain the most desirable protocols first.
Protocol names are printable \s-1ASCII\s0 strings, for example \*(L"http/1.1\*(R" or
\*(L"spdy/3\*(R".
The flag
-nextprotoneg cannot be specified if
-tls1_3 is used.
"-sendfile" 4
Item "-sendfile" If this option is set and \s-1KTLS\s0 is enabled,
SSL_sendfile() will be used
instead of
BIO_write() to send the \s-1HTTP\s0 response requested by a client.
This option is only valid if
-WWW or
-HTTP is specified.
"-keylogfile outfile" 4
Item "-keylogfile outfile" Appends \s-1TLS\s0 secrets to the specified keylog file such that external programs
(like Wireshark) can decrypt \s-1TLS\s0 connections.
"-max_early_data int" 4
Item "-max_early_data int" Change the default maximum early data bytes that are specified for new sessions
and any incoming early data (when used in conjunction with the
-early_data
flag). The default value is approximately 16k. The argument must be an integer
greater than or equal to 0.
"-recv_max_early_data int" 4
Item "-recv_max_early_data int" Specify the hard limit on the maximum number of early data bytes that will
be accepted.
"-early_data" 4
Item "-early_data" Accept early data where possible. Cannot be used in conjunction with
-www,
\fB-WWW,
-HTTP or
-rev.
"-stateless" 4
Item "-stateless" Require TLSv1.3 cookies.
"-anti_replay, -no_anti_replay" 4
Item "-anti_replay, -no_anti_replay" Switches replay protection on or off, respectively. Replay protection is on by
default unless overridden by a configuration file. When it is 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. Any early
data that was sent will be rejected.
"-nameopt option" 4
Item "-nameopt option" This specifies how the subject or issuer names are displayed.
See
openssl-namedisplay-options\|(1) for details.
"-no_ssl3, -no_tls1, -no_tls1_1, -no_tls1_2, -no_tls1_3, -ssl3, -tls1, -tls1_1, -tls1_2, -tls1_3" 4
Item "-no_ssl3, -no_tls1, -no_tls1_1, -no_tls1_2, -no_tls1_3, -ssl3, -tls1, -tls1_1, -tls1_2, -tls1_3" See \*(L"\s-1TLS\s0 Version Options\*(R" in
openssl\|(1).
"-dtls, -dtls1, -dtls1_2" 4
Item "-dtls, -dtls1, -dtls1_2" These specify the use of \s-1DTLS\s0 instead of \s-1TLS.\s0
See \*(L"\s-1TLS\s0 Version Options\*(R" in
openssl\|(1).
"-bugs, -comp, -no_comp, -no_ticket, -serverpref, -client_renegotiation, -legacy_renegotiation, -no_renegotiation, -no_resumption_on_reneg, -legacy_server_connect, -no_legacy_server_connect, -no_etm -allow_no_dhe_kex, -prioritize_chacha, -strict, -sigalgs algs, -client_sigalgs algs, -groups groups, -curves curves, -named_curve curve, -cipher ciphers, -ciphersuites 1.3ciphers, -min_protocol minprot, -max_protocol maxprot, -record_padding padding, -debug_broken_protocol, -no_middlebox" 4
Item "-bugs, -comp, -no_comp, -no_ticket, -serverpref, -client_renegotiation, -legacy_renegotiation, -no_renegotiation, -no_resumption_on_reneg, -legacy_server_connect, -no_legacy_server_connect, -no_etm -allow_no_dhe_kex, -prioritize_chacha, -strict, -sigalgs algs, -client_sigalgs algs, -groups groups, -curves curves, -named_curve curve, -cipher ciphers, -ciphersuites 1.3ciphers, -min_protocol minprot, -max_protocol maxprot, -record_padding padding, -debug_broken_protocol, -no_middlebox" See \*(L"\s-1SUPPORTED COMMAND LINE COMMANDS\*(R"\s0 in
SSL_CONF_cmd\|(3) for details.
"-xkey infile, -xcert file, -xchain file, -xchain_build file, -xcertform \s-1DER\s0|\s-1PEM\s0, -xkeyform \s-1DER\s0|\s-1PEM\s0" 4
Item "-xkey infile, -xcert file, -xchain file, -xchain_build file, -xcertform DER|PEM, -xkeyform DER|PEM" Set extended certificate verification options.
See \*(L"Extended Verification Options\*(R" in
openssl-verification-options\|(1) for details.
"-CAfile file, -no-CAfile, -CApath dir, -no-CApath, -CAstore uri, -no-CAstore" 4
Item "-CAfile file, -no-CAfile, -CApath dir, -no-CApath, -CAstore uri, -no-CAstore" See \*(L"Trusted Certificate Options\*(R" in
openssl-verification-options\|(1) for details.
"-rand files, -writerand file" 4
Item "-rand files, -writerand file" See \*(L"Random State Options\*(R" in
openssl\|(1) for details.
"-engine id" 4
Item "-engine id" See \*(L"Engine Options\*(R" in
openssl\|(1).
This option is deprecated.
"-provider name" 4
Item "-provider name" 0
"-provider-path path" 4
Item "-provider-path path" "-propquery propq" 4
Item "-propquery propq"
See \*(L"Provider Options\*(R" in openssl\|(1), provider\|(7), and property\|(7).
"-allow_proxy_certs, -attime, -no_check_time, -check_ss_sig, -crl_check, -crl_check_all, -explicit_policy, -extended_crl, -ignore_critical, -inhibit_any, -inhibit_map, -no_alt_chains, -partial_chain, -policy, -policy_check, -policy_print, -purpose, -suiteB_128, -suiteB_128_only, -suiteB_192, -trusted_first, -use_deltas, -auth_level, -verify_depth, -verify_email, -verify_hostname, -verify_ip, -verify_name, -x509_strict -issuer_checks" 4
Item "-allow_proxy_certs, -attime, -no_check_time, -check_ss_sig, -crl_check, -crl_check_all, -explicit_policy, -extended_crl, -ignore_critical, -inhibit_any, -inhibit_map, -no_alt_chains, -partial_chain, -policy, -policy_check, -policy_print, -purpose, -suiteB_128, -suiteB_128_only, -suiteB_192, -trusted_first, -use_deltas, -auth_level, -verify_depth, -verify_email, -verify_hostname, -verify_ip, -verify_name, -x509_strict -issuer_checks" Set various options of certificate chain verification.
See \*(L"Verification Options\*(R" in
openssl-verification-options\|(1) for details.
.Sp
If the server requests a client certificate, then
verification errors are displayed, for debugging, but the command will
proceed unless the
-verify_return_error option is used.
"CONNECTED COMMANDS"
Header "CONNECTED COMMANDS" If a connection request is established with an \s-1SSL\s0 client and neither the
\fB-www nor the
-WWW option has been used then normally any data received
from the client is displayed and any key presses will be sent to the client.
Certain commands are also recognized which perform special operations. These
commands are a letter which must appear at the start of a line. They are listed
below.
"q" 4
Item "q" End the current \s-1SSL\s0 connection but still accept new connections.
"Q" 4
Item "Q" End the current \s-1SSL\s0 connection and exit.
"r" 4
Item "r" Renegotiate the \s-1SSL\s0 session (TLSv1.2 and below only).
"R" 4
Item "R" Renegotiate the \s-1SSL\s0 session and request a client certificate (TLSv1.2 and below
only).
"P" 4
Item "P" Send some plain text down the underlying \s-1TCP\s0 connection: this should
cause the client to disconnect due to a protocol violation.
"S" 4
Item "S" Print out some session cache status information.
"k" 4
Item "k" Send a key update message to the client (TLSv1.3 only)
"K" 4
Item "K" Send a key update message to the client and request one back (TLSv1.3 only)
"c" 4
Item "c" Send a certificate request to the client (TLSv1.3 only)
"NOTES"
Header "NOTES" This command can be used to debug \s-1SSL\s0 clients. To accept connections
from a web browser the command:
.Vb 1
openssl s_server -accept 443 -www
.Ve
can be used for example.
Although specifying an empty list of CAs when requesting a client certificate
is strictly speaking a protocol violation, some \s-1SSL\s0 clients interpret this to
mean any \s-1CA\s0 is acceptable. This is useful for debugging purposes.
The session parameters can printed out using the openssl-sess_id\|(1) command.
"BUGS"
Header "BUGS" Because this program has a lot of options and also because some of the
techniques used are rather old, the C source for this command is rather
hard to read and not a model of how things should be done.
A typical \s-1SSL\s0 server program would be much simpler.
The output of common ciphers is wrong: it just gives the list of ciphers that
OpenSSL recognizes and the client supports.
There should be a way for this command to print out details
of any unknown cipher suites a client says it supports.
"SEE ALSO"
Header "SEE ALSO" \fBopenssl\|(1),
\fBopenssl-sess_id\|(1),
\fBopenssl-s_client\|(1),
\fBopenssl-ciphers\|(1),
\fBSSL_CONF_cmd\|(3),
\fBSSL_CTX_set_max_send_fragment\|(3),
\fBSSL_CTX_set_split_send_fragment\|(3),
\fBSSL_CTX_set_max_pipelines\|(3),
\fBossl_store-file\|(7)
"HISTORY"
Header "HISTORY" The -no_alt_chains option was added in OpenSSL 1.1.0.
The
\-allow-no-dhe-kex and -prioritize_chacha options were added in OpenSSL 1.1.1.
The -srpvfile, -srpuserseed, and -engine
option were deprecated in OpenSSL 3.0.
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved.
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>.