diff options
Diffstat (limited to 'secure/usr.bin/openssl/man/openssl-s_server.1')
| -rw-r--r-- | secure/usr.bin/openssl/man/openssl-s_server.1 | 657 |
1 files changed, 290 insertions, 367 deletions
diff --git a/secure/usr.bin/openssl/man/openssl-s_server.1 b/secure/usr.bin/openssl/man/openssl-s_server.1 index dbf1872c85a4..425b41f0156e 100644 --- a/secure/usr.bin/openssl/man/openssl-s_server.1 +++ b/secure/usr.bin/openssl/man/openssl-s_server.1 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .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' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .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\} @@ -68,77 +52,17 @@ . \} .\} .rr rF -.\" 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 "OPENSSL-S_SERVER 1ossl" -.TH OPENSSL-S_SERVER 1ossl "2023-09-22" "3.0.11" "OpenSSL" +.TH OPENSSL-S_SERVER 1ossl 2025-07-24 3.5.1 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" +.SH NAME openssl\-s_server \- SSL/TLS server program -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBopenssl\fR \fBs_server\fR [\fB\-help\fR] @@ -153,19 +77,19 @@ openssl\-s_server \- SSL/TLS server program [\fB\-Verify\fR \fIint\fR] [\fB\-cert\fR \fIinfile\fR] [\fB\-cert2\fR \fIinfile\fR] -[\fB\-certform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR] +[\fB\-certform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR] [\fB\-cert_chain\fR \fIinfile\fR] [\fB\-build_chain\fR] [\fB\-serverinfo\fR \fIval\fR] [\fB\-key\fR \fIfilename\fR|\fIuri\fR] [\fB\-key2\fR \fIfilename\fR|\fIuri\fR] -[\fB\-keyform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR|\fB\s-1ENGINE\s0\fR] +[\fB\-keyform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR|\fBENGINE\fR] [\fB\-pass\fR \fIval\fR] [\fB\-dcert\fR \fIinfile\fR] -[\fB\-dcertform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR] +[\fB\-dcertform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR] [\fB\-dcert_chain\fR \fIinfile\fR] [\fB\-dkey\fR \fIfilename\fR|\fIuri\fR] -[\fB\-dkeyform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR|\fB\s-1ENGINE\s0\fR] +[\fB\-dkeyform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR|\fBENGINE\fR] [\fB\-dpass\fR \fIval\fR] [\fB\-nbio_test\fR] [\fB\-crlf\fR] @@ -189,7 +113,7 @@ openssl\-s_server \- SSL/TLS server program [\fB\-keymatexport\fR \fIval\fR] [\fB\-keymatexportlen\fR \fI+int\fR] [\fB\-CRL\fR \fIinfile\fR] -[\fB\-CRLform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR] +[\fB\-CRLform\fR \fBDER\fR|\fBPEM\fR] [\fB\-crl_download\fR] [\fB\-chainCAfile\fR \fIinfile\fR] [\fB\-chainCApath\fR \fIdir\fR] @@ -203,11 +127,11 @@ openssl\-s_server \- SSL/TLS server program [\fB\-verify_quiet\fR] [\fB\-ign_eof\fR] [\fB\-no_ign_eof\fR] -[\fB\-no_etm\fR] +[\fB\-no_ems\fR] [\fB\-status\fR] [\fB\-status_verbose\fR] [\fB\-status_timeout\fR \fIint\fR] -[\fB\-proxy\fR \fI[http[s]://][userinfo@]host[:port][/path]\fR] +[\fB\-proxy\fR \fI[http[s]://][userinfo@]host[:port][/path][?query][#fragment]\fR] [\fB\-no_proxy\fR \fIaddresses\fR] [\fB\-status_url\fR \fIval\fR] [\fB\-status_file\fR \fIinfile\fR] @@ -223,27 +147,9 @@ openssl\-s_server \- SSL/TLS server program [\fB\-max_pipelines\fR \fI+int\fR] [\fB\-naccept\fR \fI+int\fR] [\fB\-read_buf\fR \fI+int\fR] -[\fB\-bugs\fR] -[\fB\-no_comp\fR] -[\fB\-comp\fR] -[\fB\-no_ticket\fR] -[\fB\-serverpref\fR] -[\fB\-legacy_renegotiation\fR] -[\fB\-no_renegotiation\fR] -[\fB\-no_resumption_on_reneg\fR] -[\fB\-allow_no_dhe_kex\fR] -[\fB\-prioritize_chacha\fR] -[\fB\-strict\fR] -[\fB\-sigalgs\fR \fIval\fR] -[\fB\-client_sigalgs\fR \fIval\fR] -[\fB\-groups\fR \fIval\fR] -[\fB\-curves\fR \fIval\fR] -[\fB\-named_curve\fR \fIval\fR] -[\fB\-cipher\fR \fIval\fR] -[\fB\-ciphersuites\fR \fIval\fR] +[\fB\-no_tx_cert_comp\fR] +[\fB\-no_rx_cert_comp\fR] [\fB\-dhparam\fR \fIinfile\fR] -[\fB\-record_padding\fR \fIval\fR] -[\fB\-debug_broken_protocol\fR] [\fB\-nbio\fR] [\fB\-psk_identity\fR \fIval\fR] [\fB\-psk_hint\fR \fIval\fR] @@ -260,7 +166,9 @@ openssl\-s_server \- SSL/TLS server program [\fB\-no_dhe\fR] [\fB\-nextprotoneg\fR \fIval\fR] [\fB\-alpn\fR \fIval\fR] +[\fB\-ktls\fR] [\fB\-sendfile\fR] +[\fB\-zerocopy_sendfile\fR] [\fB\-keylogfile\fR \fIoutfile\fR] [\fB\-recv_max_early_data\fR \fIint\fR] [\fB\-max_early_data\fR \fIint\fR] @@ -269,6 +177,8 @@ openssl\-s_server \- SSL/TLS server program [\fB\-anti_replay\fR] [\fB\-no_anti_replay\fR] [\fB\-num_tickets\fR] +[\fB\-tfo\fR] +[\fB\-cert_comp\fR] [\fB\-nameopt\fR \fIoption\fR] [\fB\-no_ssl3\fR] [\fB\-no_tls1\fR] @@ -326,6 +236,7 @@ openssl\-s_server \- SSL/TLS server program [\fB\-no_legacy_server_connect\fR] [\fB\-no_etm\fR] [\fB\-allow_no_dhe_kex\fR] +[\fB\-prefer_no_dhe_kex\fR] [\fB\-prioritize_chacha\fR] [\fB\-strict\fR] [\fB\-sigalgs\fR \fIalgs\fR] @@ -344,8 +255,8 @@ openssl\-s_server \- SSL/TLS server program [\fB\-xcert\fR \fIfile\fR] [\fB\-xchain\fR \fIfile\fR] [\fB\-xchain_build\fR \fIfile\fR] -[\fB\-xcertform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR]> -[\fB\-xkeyform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR]> +[\fB\-xcertform\fR \fBDER\fR|\fBPEM\fR]> +[\fB\-xkeyform\fR \fBDER\fR|\fBPEM\fR]> [\fB\-CAfile\fR \fIfile\fR] [\fB\-no\-CAfile\fR] [\fB\-CApath\fR \fIdir\fR] @@ -357,40 +268,43 @@ openssl\-s_server \- SSL/TLS server program [\fB\-engine\fR \fIid\fR] [\fB\-provider\fR \fIname\fR] [\fB\-provider\-path\fR \fIpath\fR] +[\fB\-provparam\fR \fI[name:]key=value\fR] [\fB\-propquery\fR \fIpropq\fR] -.SH "DESCRIPTION" +[\fB\-enable_server_rpk\fR] +[\fB\-enable_client_rpk\fR] +.SH DESCRIPTION .IX 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 -.SH "OPTIONS" +This command implements a generic SSL/TLS server which +listens for connections on a given port using SSL/TLS. +.SH OPTIONS .IX 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 \fBSSL_CONF_cmd\fR\|(3) -.IP "\fB\-help\fR" 4 +"Supported Command Line Commands" in \fBSSL_CONF_cmd\fR\|(3) +.IP \fB\-help\fR 4 .IX Item "-help" Print out a usage message. .IP "\fB\-port\fR \fI+int\fR" 4 .IX Item "-port +int" -The \s-1TCP\s0 port to listen on for connections. If not specified 4433 is used. +The TCP port to listen on for connections. If not specified 4433 is used. .IP "\fB\-accept\fR \fIval\fR" 4 .IX Item "-accept val" -The optional \s-1TCP\s0 host and port to listen on for connections. If not specified, *:4433 is used. +The optional TCP host and port to listen on for connections. If not specified, *:4433 is used. .IP "\fB\-unix\fR \fIval\fR" 4 .IX Item "-unix val" Unix domain socket to accept on. -.IP "\fB\-4\fR" 4 +.IP \fB\-4\fR 4 .IX Item "-4" Use IPv4 only. -.IP "\fB\-6\fR" 4 +.IP \fB\-6\fR 4 .IX Item "-6" Use IPv6 only. -.IP "\fB\-unlink\fR" 4 +.IP \fB\-unlink\fR 4 .IX Item "-unlink" For \-unix, unlink any existing socket first. .IP "\fB\-context\fR \fIval\fR" 4 .IX Item "-context val" -Sets the \s-1SSL\s0 context id. It can be given any string value. If this option +Sets the SSL context id. It can be given any string value. If this option is not present a default value will be used. .IP "\fB\-verify\fR \fIint\fR, \fB\-Verify\fR \fIint\fR" 4 .IX Item "-verify int, -Verify int" @@ -401,35 +315,41 @@ client does not have to send one, with the \fB\-Verify\fR 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. +anonymous cipher suite or PSK) this option has no effect. +.Sp +By default, validation of any supplied client certificate and its chain +is done w.r.t. the (D)TLS Client (\f(CW\*(C`sslclient\*(C'\fR) purpose. +For details see "Certificate Extensions" in \fBopenssl\-verification\-options\fR\|(1). .IP "\fB\-cert\fR \fIinfile\fR" 4 .IX 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 \fIserver.pem\fR will be used. +for example the DSS cipher suites require a certificate containing a DSS +(DSA) key. If not specified then the filename \fIserver.pem\fR will be used. .IP "\fB\-cert2\fR \fIinfile\fR" 4 .IX Item "-cert2 infile" The certificate file to use for servername; default is \f(CW\*(C`server2.pem\*(C'\fR. -.IP "\fB\-certform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR" 4 +.IP "\fB\-certform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR" 4 .IX Item "-certform DER|PEM|P12" The server certificate file format; unspecified by default. See \fBopenssl\-format\-options\fR\|(1) for details. -.IP "\fB\-cert_chain\fR" 4 +.IP \fB\-cert_chain\fR 4 .IX Item "-cert_chain" -A file or \s-1URI\s0 of untrusted certificates to use when attempting to build the +A file or URI of untrusted certificates to use when attempting to build the certificate chain related to the certificate specified via the \fB\-cert\fR option. -The input can be in \s-1PEM, DER,\s0 or PKCS#12 format. -.IP "\fB\-build_chain\fR" 4 +These untrusted certificates are sent to clients and used for generating +certificate status (aka OCSP stapling) requests. +The input can be in PEM, DER, or PKCS#12 format. +.IP \fB\-build_chain\fR 4 .IX Item "-build_chain" Specify whether the application should build the server certificate chain to be provided to the client. .IP "\fB\-serverinfo\fR \fIval\fR" 4 .IX 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 +A file containing one or more blocks of PEM data. Each PEM block +must encode a TLS ServerHello extension (2 bytes type, 2 bytes length, +followed by "length" bytes of extension data). If the client sends +an empty TLS ClientHello extension matching the type, the corresponding ServerHello extension will be returned. .IP "\fB\-key\fR \fIfilename\fR|\fIuri\fR" 4 .IX Item "-key filename|uri" @@ -438,7 +358,7 @@ be used. .IP "\fB\-key2\fR \fIfilename\fR|\fIuri\fR" 4 .IX Item "-key2 filename|uri" The private Key file to use for servername if not given via \fB\-cert2\fR. -.IP "\fB\-keyform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR|\fB\s-1ENGINE\s0\fR" 4 +.IP "\fB\-keyform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR|\fBENGINE\fR" 4 .IX Item "-keyform DER|PEM|P12|ENGINE" The key format; unspecified by default. See \fBopenssl\-format\-options\fR\|(1) for details. @@ -453,21 +373,21 @@ Specify an additional certificate and private key, these behave in the same manner as the \fB\-cert\fR and \fB\-key\fR 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 +a certain type. Some cipher suites need a certificate carrying an RSA key +and some a DSS (DSA) key. By using RSA and DSS certificates and keys +a server can support clients which only support RSA or DSS cipher suites by using an appropriate certificate. -.IP "\fB\-dcert_chain\fR" 4 +.IP \fB\-dcert_chain\fR 4 .IX Item "-dcert_chain" -A file or \s-1URI\s0 of untrusted certificates to use when attempting to build the +A file or URI of untrusted certificates to use when attempting to build the server certificate chain when a certificate specified via the \fB\-dcert\fR option is in use. -The input can be in \s-1PEM, DER,\s0 or PKCS#12 format. -.IP "\fB\-dcertform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR" 4 +The input can be in PEM, DER, or PKCS#12 format. +.IP "\fB\-dcertform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR" 4 .IX Item "-dcertform DER|PEM|P12" The format of the additional certificate file; unspecified by default. See \fBopenssl\-format\-options\fR\|(1) for details. -.IP "\fB\-dkeyform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR|\fB\s-1ENGINE\s0\fR" 4 +.IP "\fB\-dkeyform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR|\fBENGINE\fR" 4 .IX Item "-dkeyform DER|PEM|P12|ENGINE" The format of the additional private key; unspecified by default. See \fBopenssl\-format\-options\fR\|(1) for details. @@ -476,219 +396,220 @@ See \fBopenssl\-format\-options\fR\|(1) for details. The passphrase for the additional private key and certificate. For more information about the format of \fIval\fR, see \fBopenssl\-passphrase\-options\fR\|(1). -.IP "\fB\-nbio_test\fR" 4 +.IP \fB\-nbio_test\fR 4 .IX Item "-nbio_test" Tests non blocking I/O. -.IP "\fB\-crlf\fR" 4 +.IP \fB\-crlf\fR 4 .IX Item "-crlf" -This option translated a line feed from the terminal into \s-1CR+LF.\s0 -.IP "\fB\-debug\fR" 4 +This option translated a line feed from the terminal into CR+LF. +.IP \fB\-debug\fR 4 .IX Item "-debug" Print extensive debugging information including a hex dump of all traffic. -.IP "\fB\-security_debug\fR" 4 +.IP \fB\-security_debug\fR 4 .IX Item "-security_debug" -Print output from \s-1SSL/TLS\s0 security framework. -.IP "\fB\-security_debug_verbose\fR" 4 +Print output from SSL/TLS security framework. +.IP \fB\-security_debug_verbose\fR 4 .IX Item "-security_debug_verbose" -Print more output from \s-1SSL/TLS\s0 security framework -.IP "\fB\-msg\fR" 4 +Print more output from SSL/TLS security framework +.IP \fB\-msg\fR 4 .IX Item "-msg" Show all protocol messages with hex dump. .IP "\fB\-msgfile\fR \fIoutfile\fR" 4 .IX Item "-msgfile outfile" File to send output of \fB\-msg\fR or \fB\-trace\fR to, default standard output. -.IP "\fB\-state\fR" 4 +.IP \fB\-state\fR 4 .IX Item "-state" -Prints the \s-1SSL\s0 session states. +Prints the SSL session states. .IP "\fB\-CRL\fR \fIinfile\fR" 4 .IX Item "-CRL infile" -The \s-1CRL\s0 file to use. -.IP "\fB\-CRLform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR" 4 +The CRL file to use. +.IP "\fB\-CRLform\fR \fBDER\fR|\fBPEM\fR" 4 .IX Item "-CRLform DER|PEM" -The \s-1CRL\s0 file format; unspecified by default. +The CRL file format; unspecified by default. See \fBopenssl\-format\-options\fR\|(1) for details. -.IP "\fB\-crl_download\fR" 4 +.IP \fB\-crl_download\fR 4 .IX Item "-crl_download" -Download CRLs from distribution points given in \s-1CDP\s0 extensions of certificates +Download CRLs from distribution points given in CDP extensions of certificates .IP "\fB\-verifyCAfile\fR \fIfilename\fR" 4 .IX Item "-verifyCAfile filename" -A file in \s-1PEM\s0 format \s-1CA\s0 containing trusted certificates to use +A file in PEM format CA containing trusted certificates to use for verifying client certificates. .IP "\fB\-verifyCApath\fR \fIdir\fR" 4 .IX Item "-verifyCApath dir" A directory containing trusted certificates to use for verifying client certificates. -This directory must be in \*(L"hash format\*(R", +This directory must be in "hash format", see \fBopenssl\-verify\fR\|(1) for more information. .IP "\fB\-verifyCAstore\fR \fIuri\fR" 4 .IX Item "-verifyCAstore uri" -The \s-1URI\s0 of a store containing trusted certificates to use +The URI of a store containing trusted certificates to use for verifying client certificates. .IP "\fB\-chainCAfile\fR \fIfile\fR" 4 .IX Item "-chainCAfile file" -A file in \s-1PEM\s0 format containing trusted certificates to use +A file in PEM format containing trusted certificates to use when attempting to build the server certificate chain. .IP "\fB\-chainCApath\fR \fIdir\fR" 4 .IX 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", +This directory must be in "hash format", see \fBopenssl\-verify\fR\|(1) for more information. .IP "\fB\-chainCAstore\fR \fIuri\fR" 4 .IX Item "-chainCAstore uri" -The \s-1URI\s0 of a store containing trusted certificates to use +The URI 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. +The URI may indicate a single certificate, as well as a collection of them. With URIs in the \f(CW\*(C`file:\*(C'\fR scheme, this acts as \fB\-chainCAfile\fR or -\&\fB\-chainCApath\fR, depending on if the \s-1URI\s0 indicates a directory or a +\&\fB\-chainCApath\fR, depending on if the URI indicates a directory or a single file. See \fBossl_store\-file\fR\|(7) for more information on the \f(CW\*(C`file:\*(C'\fR scheme. -.IP "\fB\-nocert\fR" 4 +.IP \fB\-nocert\fR 4 .IX 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). -.IP "\fB\-quiet\fR" 4 +DH). +.IP \fB\-quiet\fR 4 .IX Item "-quiet" Inhibit printing of session and certificate information. -.IP "\fB\-no_resume_ephemeral\fR" 4 +.IP \fB\-no_resume_ephemeral\fR 4 .IX Item "-no_resume_ephemeral" -Disable caching and tickets if ephemeral (\s-1EC\s0)DH is used. -.IP "\fB\-tlsextdebug\fR" 4 +Disable caching and tickets if ephemeral (EC)DH is used. +.IP \fB\-tlsextdebug\fR 4 .IX Item "-tlsextdebug" -Print a hex dump of any \s-1TLS\s0 extensions received from the server. -.IP "\fB\-www\fR" 4 +Print a hex dump of any TLS extensions received from the server. +.IP \fB\-www\fR 4 .IX 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 \f(CW\*(C`/renegcert\*(C'\fR turns on client cert validation, and \f(CW\*(C`/reneg\*(C'\fR +The output is in HTML format so this option can be used with a web browser. +The special URL \f(CW\*(C`/renegcert\*(C'\fR turns on client cert validation, and \f(CW\*(C`/reneg\*(C'\fR tells the server to request renegotiation. -The \fB\-early_data\fR option cannot be used with this option. .IP "\fB\-WWW\fR, \fB\-HTTP\fR" 4 .IX Item "-WWW, -HTTP" Emulates a simple web server. Pages will be resolved relative to the -current directory, for example if the \s-1URL\s0 \f(CW\*(C`https://myhost/page.html\*(C'\fR is +current directory, for example if the URL \f(CW\*(C`https://myhost/page.html\*(C'\fR is requested the file \fI./page.html\fR will be sent. If the \fB\-HTTP\fR flag is used, the files are sent directly, and should contain -any \s-1HTTP\s0 response headers (including status response line). +any HTTP response headers (including status response line). If the \fB\-WWW\fR option is used, the response headers are generated by the server, and the file extension is examined to determine the \fBContent-Type\fR header. Extensions of \f(CW\*(C`html\*(C'\fR, \f(CW\*(C`htm\*(C'\fR, and \f(CW\*(C`php\*(C'\fR are \f(CW\*(C`text/html\*(C'\fR and all others are \&\f(CW\*(C`text/plain\*(C'\fR. -In addition, the special \s-1URL\s0 \f(CW\*(C`/stats\*(C'\fR will return status +In addition, the special URL \f(CW\*(C`/stats\*(C'\fR will return status information like the \fB\-www\fR option. -Neither of these options can be used in conjunction with \fB\-early_data\fR. -.IP "\fB\-http_server_binmode\fR" 4 +.IP \fB\-http_server_binmode\fR 4 .IX Item "-http_server_binmode" When acting as web-server (using option \fB\-WWW\fR or \fB\-HTTP\fR) open files requested by the client in binary mode. -.IP "\fB\-no_ca_names\fR" 4 +.IP \fB\-no_ca_names\fR 4 .IX 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 +Disable TLS Extension CA Names. You may want to disable it for security reasons +or for compatibility with some Windows TLS implementations crashing when this extension is larger than 1024 bytes. -.IP "\fB\-ignore_unexpected_eof\fR" 4 +.IP \fB\-ignore_unexpected_eof\fR 4 .IX Item "-ignore_unexpected_eof" -Some \s-1TLS\s0 implementations do not send the mandatory close_notify alert on +Some TLS 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 \fBSSL_shutdown\fR\|(3). -.IP "\fB\-servername\fR" 4 +.IP \fB\-servername\fR 4 .IX Item "-servername" -Servername for HostName \s-1TLS\s0 extension. -.IP "\fB\-servername_fatal\fR" 4 +Servername for HostName TLS extension. +.IP \fB\-servername_fatal\fR 4 .IX Item "-servername_fatal" On servername mismatch send fatal alert (default: warning alert). .IP "\fB\-id_prefix\fR \fIval\fR" 4 .IX Item "-id_prefix val" -Generate \s-1SSL/TLS\s0 session IDs prefixed by \fIval\fR. This is mostly useful -for testing any \s-1SSL/TLS\s0 code (e.g. proxies) that wish to deal with multiple +Generate SSL/TLS session IDs prefixed by \fIval\fR. This is mostly useful +for testing any SSL/TLS 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). -.IP "\fB\-keymatexport\fR" 4 +.IP \fB\-keymatexport\fR 4 .IX Item "-keymatexport" Export keying material using label. -.IP "\fB\-keymatexportlen\fR" 4 +.IP \fB\-keymatexportlen\fR 4 .IX Item "-keymatexportlen" Export the given number of bytes of keying material; default 20. -.IP "\fB\-no_cache\fR" 4 +.IP \fB\-no_cache\fR 4 .IX Item "-no_cache" Disable session cache. -.IP "\fB\-ext_cache\fR." 4 +.IP \fB\-ext_cache\fR. 4 .IX Item "-ext_cache." Disable internal cache, set up and use external cache. -.IP "\fB\-verify_return_error\fR" 4 +.IP \fB\-verify_return_error\fR 4 .IX 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. -.IP "\fB\-verify_quiet\fR" 4 +.IP \fB\-verify_quiet\fR 4 .IX Item "-verify_quiet" No verify output except verify errors. -.IP "\fB\-ign_eof\fR" 4 +.IP \fB\-ign_eof\fR 4 .IX Item "-ign_eof" -Ignore input \s-1EOF\s0 (default: when \fB\-quiet\fR). -.IP "\fB\-no_ign_eof\fR" 4 +Ignore input EOF (default: when \fB\-quiet\fR). +.IP \fB\-no_ign_eof\fR 4 .IX Item "-no_ign_eof" -Do not ignore input \s-1EOF.\s0 -.IP "\fB\-no_etm\fR" 4 -.IX Item "-no_etm" -Disable Encrypt-then-MAC negotiation. -.IP "\fB\-status\fR" 4 +Do not ignore input EOF. +.IP \fB\-no_ems\fR 4 +.IX Item "-no_ems" +Disable Extended master secret negotiation. +.IP \fB\-status\fR 4 .IX Item "-status" -Enables certificate status request support (aka \s-1OCSP\s0 stapling). -.IP "\fB\-status_verbose\fR" 4 +Enables certificate status request support (aka OCSP stapling). +.IP \fB\-status_verbose\fR 4 .IX Item "-status_verbose" -Enables certificate status request support (aka \s-1OCSP\s0 stapling) and gives -a verbose printout of the \s-1OCSP\s0 response. +Enables certificate status request support (aka OCSP stapling) and gives +a verbose printout of the OCSP response. +Use the \fB\-cert_chain\fR option to specify the certificate of the server's +certificate signer that is required for certificate status requests. .IP "\fB\-status_timeout\fR \fIint\fR" 4 .IX Item "-status_timeout int" -Sets the timeout for \s-1OCSP\s0 response to \fIint\fR seconds. -.IP "\fB\-proxy\fR \fI[http[s]://][userinfo@]host[:port][/path]\fR" 4 -.IX 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 \fB\-no_proxy\fR +Sets the timeout for OCSP response to \fIint\fR seconds. +.IP "\fB\-proxy\fR \fI[http[s]://][userinfo@]host[:port][/path][?query][#fragment]\fR" 4 +.IX Item "-proxy [http[s]://][userinfo@]host[:port][/path][?query][#fragment]" +The HTTP(S) proxy server to use for reaching the OCSP server unless \fB\-no_proxy\fR applies, see below. +If the host string is an IPv6 address, it must be enclosed in \f(CW\*(C`[\*(C'\fR and \f(CW\*(C`]\*(C'\fR. The proxy port defaults to 80 or 443 if the scheme is \f(CW\*(C`https\*(C'\fR; apart from that the optional \f(CW\*(C`http://\*(C'\fR or \f(CW\*(C`https://\*(C'\fR prefix is ignored, -as well as any userinfo and path components. +as well as any userinfo, path, query, and fragment components. Defaults to the environment variable \f(CW\*(C`http_proxy\*(C'\fR if set, else \f(CW\*(C`HTTP_PROXY\*(C'\fR -in case no \s-1TLS\s0 is used, otherwise \f(CW\*(C`https_proxy\*(C'\fR if set, else \f(CW\*(C`HTTPS_PROXY\*(C'\fR. +in case no TLS is used, otherwise \f(CW\*(C`https_proxy\*(C'\fR if set, else \f(CW\*(C`HTTPS_PROXY\*(C'\fR. .IP "\fB\-no_proxy\fR \fIaddresses\fR" 4 .IX 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"). +List of IP addresses and/or DNS names of servers +not to use an HTTP(S) proxy for, separated by commas and/or whitespace +(where in the latter case the whole argument must be enclosed in "..."). Default is from the environment variable \f(CW\*(C`no_proxy\*(C'\fR if set, else \f(CW\*(C`NO_PROXY\*(C'\fR. .IP "\fB\-status_url\fR \fIval\fR" 4 .IX Item "-status_url val" -Sets a fallback responder \s-1URL\s0 to use if no responder \s-1URL\s0 is present in the +Sets a fallback responder URL to use if no responder URL 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. +The optional userinfo and fragment URL components are ignored. Any given query component is handled as part of the path component. .IP "\fB\-status_file\fR \fIinfile\fR" 4 .IX 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. +Overrides any OCSP responder URLs from the certificate and always provides the +OCSP Response stored in the file. The file must be in DER format. .IP "\fB\-ssl_config\fR \fIval\fR" 4 .IX Item "-ssl_config val" -Configure \s-1SSL_CTX\s0 using the given configuration value. -.IP "\fB\-trace\fR" 4 +Configure SSL_CTX using the given configuration value. +.IP \fB\-trace\fR 4 .IX Item "-trace" Show verbose trace output of protocol messages. -.IP "\fB\-brief\fR" 4 +.IP \fB\-brief\fR 4 .IX Item "-brief" Provide a brief summary of connection parameters instead of the normal verbose output. -.IP "\fB\-rev\fR" 4 +.IP \fB\-rev\fR 4 .IX Item "-rev" Simple echo server that sends back received text reversed. Also sets \fB\-brief\fR. Cannot be used in conjunction with \fB\-early_data\fR. -.IP "\fB\-async\fR" 4 +.IP \fB\-async\fR 4 .IX Item "-async" Switch on asynchronous mode. Cryptographic operations will be performed asynchronously. This will only have an effect if an asynchronous capable engine @@ -722,158 +643,126 @@ 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 \fBSSL_CTX_set_default_read_buffer_len\fR\|(3) for further information). -.IP "\fB\-bugs\fR" 4 -.IX Item "-bugs" -There are several known bugs in \s-1SSL\s0 and \s-1TLS\s0 implementations. Adding this -option enables various workarounds. -.IP "\fB\-no_comp\fR" 4 +.IP \fB\-no_tx_cert_comp\fR 4 +.IX Item "-no_tx_cert_comp" +Disables support for sending 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\-no_comp\fR 4 .IX 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. -.IP "\fB\-comp\fR" 4 -.IX 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 +Disable negotiation of TLS compression. +TLS compression is not recommended and is off by default as of OpenSSL 1.1.0. -.IP "\fB\-no_ticket\fR" 4 -.IX Item "-no_ticket" -Disable RFC4507bis session ticket support. This option has no effect if TLSv1.3 -is negotiated. See \fB\-num_tickets\fR. -.IP "\fB\-num_tickets\fR" 4 +.IP \fB\-num_tickets\fR 4 .IX 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. -.IP "\fB\-serverpref\fR" 4 -.IX Item "-serverpref" -Use the server's cipher preferences, rather than the client's preferences. -.IP "\fB\-prioritize_chacha\fR" 4 -.IX Item "-prioritize_chacha" -Prioritize ChaCha ciphers when preferred by clients. Requires \fB\-serverpref\fR. -.IP "\fB\-no_resumption_on_reneg\fR" 4 -.IX Item "-no_resumption_on_reneg" -Set the \fB\s-1SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION\s0\fR option. -.IP "\fB\-client_sigalgs\fR \fIval\fR" 4 -.IX Item "-client_sigalgs val" -Signature algorithms to support for client certificate authentication -(colon-separated list). -.IP "\fB\-named_curve\fR \fIval\fR" 4 -.IX 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 -.IP "\fB\-cipher\fR \fIval\fR" 4 -.IX 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\fR\|(1) for more information. -.IP "\fB\-ciphersuites\fR \fIval\fR" 4 -.IX 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\fR\|(1) command for more information. The format for this list is -a simple colon (\*(L":\*(R") separated list of TLSv1.3 ciphersuite names. .IP "\fB\-dhparam\fR \fIinfile\fR" 4 .IX 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 +The DH parameter file to use. The ephemeral DH cipher suites generate keys +using a set of DH 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. -.IP "\fB\-nbio\fR" 4 +.IP \fB\-nbio\fR 4 .IX Item "-nbio" Turns on non blocking I/O. -.IP "\fB\-timeout\fR" 4 +.IP \fB\-timeout\fR 4 .IX Item "-timeout" Enable timeouts. -.IP "\fB\-mtu\fR" 4 +.IP \fB\-mtu\fR 4 .IX Item "-mtu" -Set link-layer \s-1MTU.\s0 +Set link-layer MTU. .IP "\fB\-psk_identity\fR \fIval\fR" 4 .IX Item "-psk_identity val" -Expect the client to send \s-1PSK\s0 identity \fIval\fR 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". +Expect the client to send PSK identity \fIval\fR when using a PSK +cipher suite, and warn if they do not. By default, the expected PSK +identity is the string "Client_identity". .IP "\fB\-psk_hint\fR \fIval\fR" 4 .IX Item "-psk_hint val" -Use the \s-1PSK\s0 identity hint \fIval\fR when using a \s-1PSK\s0 cipher suite. +Use the PSK identity hint \fIval\fR when using a PSK cipher suite. .IP "\fB\-psk\fR \fIval\fR" 4 .IX Item "-psk val" -Use the \s-1PSK\s0 key \fIval\fR when using a \s-1PSK\s0 cipher suite. The key is +Use the PSK key \fIval\fR when using a PSK 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. +This option must be provided in order to use a PSK cipher. .IP "\fB\-psk_session\fR \fIfile\fR" 4 .IX Item "-psk_session file" -Use the pem encoded \s-1SSL_SESSION\s0 data stored in \fIfile\fR as the basis of a \s-1PSK.\s0 +Use the pem encoded SSL_SESSION data stored in \fIfile\fR as the basis of a PSK. Note that this will only work if TLSv1.3 is negotiated. -.IP "\fB\-srpvfile\fR" 4 +.IP \fB\-srpvfile\fR 4 .IX Item "-srpvfile" -The verifier file for \s-1SRP.\s0 +The verifier file for SRP. This option is deprecated. -.IP "\fB\-srpuserseed\fR" 4 +.IP \fB\-srpuserseed\fR 4 .IX Item "-srpuserseed" A seed string for a default user salt. This option is deprecated. -.IP "\fB\-listen\fR" 4 +.IP \fB\-listen\fR 4 .IX 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 +This option can only be used in conjunction with one of the DTLS options above. +With this option, this command will listen on a UDP 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. -.IP "\fB\-sctp\fR" 4 +.IP \fB\-sctp\fR 4 .IX Item "-sctp" -Use \s-1SCTP\s0 for the transport protocol instead of \s-1UDP\s0 in \s-1DTLS.\s0 Must be used in +Use SCTP for the transport protocol instead of UDP in DTLS. Must be used in conjunction with \fB\-dtls\fR, \fB\-dtls1\fR or \fB\-dtls1_2\fR. This option is only -available where OpenSSL has support for \s-1SCTP\s0 enabled. -.IP "\fB\-sctp_label_bug\fR" 4 +available where OpenSSL has support for SCTP enabled. +.IP \fB\-sctp_label_bug\fR 4 .IX 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 +endpoint-pair shared secrets for DTLS/SCTP. This allows communication with older broken implementations but breaks interoperability with correct implementations. Must be used in conjunction with \fB\-sctp\fR. This option is only -available where OpenSSL has support for \s-1SCTP\s0 enabled. -.IP "\fB\-use_srtp\fR" 4 +available where OpenSSL has support for SCTP enabled. +.IP \fB\-use_srtp\fR 4 .IX Item "-use_srtp" -Offer \s-1SRTP\s0 key management with a colon-separated profile list. -.IP "\fB\-no_dhe\fR" 4 +Offer SRTP key management with a colon-separated profile list. +.IP \fB\-no_dhe\fR 4 .IX 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. +If this option is set then no DH parameters will be loaded effectively +disabling the ephemeral DH cipher suites. .IP "\fB\-alpn\fR \fIval\fR, \fB\-nextprotoneg\fR \fIval\fR" 4 .IX 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 +or Next Protocol Negotiation (NPN) extension, respectively. ALPN is the +IETF standard and replaces NPN. The \fIval\fR 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". +Protocol names are printable ASCII strings, for example "http/1.1" or +"spdy/3". The flag \fB\-nextprotoneg\fR cannot be specified if \fB\-tls1_3\fR is used. -.IP "\fB\-sendfile\fR" 4 +.IP \fB\-ktls\fR 4 +.IX Item "-ktls" +Enable Kernel TLS for sending and receiving. +This option was introduced in OpenSSL 3.2.0. +Kernel TLS is off by default as of OpenSSL 3.2.0. +.IP \fB\-sendfile\fR 4 .IX Item "-sendfile" -If this option is set and \s-1KTLS\s0 is enabled, \fBSSL_sendfile()\fR will be used -instead of \fBBIO_write()\fR to send the \s-1HTTP\s0 response requested by a client. -This option is only valid if \fB\-WWW\fR or \fB\-HTTP\fR is specified. +If this option is set and KTLS is enabled, \fBSSL_sendfile()\fR will be used +instead of \fBBIO_write()\fR to send the HTTP response requested by a client. +This option is only valid when \fB\-ktls\fR along with \fB\-WWW\fR or \fB\-HTTP\fR +are specified. +.IP \fB\-zerocopy_sendfile\fR 4 +.IX Item "-zerocopy_sendfile" +If this option is set, \fBSSL_sendfile()\fR will use the zerocopy TX mode, which gives +a performance boost when used with KTLS hardware offload. Note that invalid +TLS records might be transmitted if the file is changed while being sent. +This option depends on \fB\-sendfile\fR; when used alone, \fB\-sendfile\fR is implied, +and a warning is shown. Note that KTLS sendfile on FreeBSD always runs in the +zerocopy mode. .IP "\fB\-keylogfile\fR \fIoutfile\fR" 4 .IX 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. +Appends TLS secrets to the specified keylog file such that external programs +(like Wireshark) can decrypt TLS connections. .IP "\fB\-max_early_data\fR \fIint\fR" 4 .IX Item "-max_early_data int" Change the default maximum early data bytes that are specified for new sessions @@ -884,11 +773,11 @@ greater than or equal to 0. .IX Item "-recv_max_early_data int" Specify the hard limit on the maximum number of early data bytes that will be accepted. -.IP "\fB\-early_data\fR" 4 +.IP \fB\-early_data\fR 4 .IX Item "-early_data" Accept early data where possible. Cannot be used in conjunction with \fB\-www\fR, \&\fB\-WWW\fR, \fB\-HTTP\fR or \fB\-rev\fR. -.IP "\fB\-stateless\fR" 4 +.IP \fB\-stateless\fR 4 .IX Item "-stateless" Require TLSv1.3 cookies. .IP "\fB\-anti_replay\fR, \fB\-no_anti_replay\fR" 4 @@ -899,92 +788,118 @@ 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. +.IP \fB\-tfo\fR 4 +.IX Item "-tfo" +Enable acceptance of TCP Fast Open (RFC7413) connections. +.IP \fB\-cert_comp\fR 4 +.IX Item "-cert_comp" +Pre-compresses certificates (RFC8879) that will be sent during the handshake. .IP "\fB\-nameopt\fR \fIoption\fR" 4 .IX Item "-nameopt option" This specifies how the subject or issuer names are displayed. See \fBopenssl\-namedisplay\-options\fR\|(1) for details. .IP "\fB\-no_ssl3\fR, \fB\-no_tls1\fR, \fB\-no_tls1_1\fR, \fB\-no_tls1_2\fR, \fB\-no_tls1_3\fR, \fB\-ssl3\fR, \fB\-tls1\fR, \fB\-tls1_1\fR, \fB\-tls1_2\fR, \fB\-tls1_3\fR" 4 .IX 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 \fBopenssl\fR\|(1). +See "TLS Version Options" in \fBopenssl\fR\|(1). .IP "\fB\-dtls\fR, \fB\-dtls1\fR, \fB\-dtls1_2\fR" 4 .IX 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 \fBopenssl\fR\|(1). -.IP "\fB\-bugs\fR, \fB\-comp\fR, \fB\-no_comp\fR, \fB\-no_ticket\fR, \fB\-serverpref\fR, \fB\-client_renegotiation\fR, \fB\-legacy_renegotiation\fR, \fB\-no_renegotiation\fR, \fB\-no_resumption_on_reneg\fR, \fB\-legacy_server_connect\fR, \fB\-no_legacy_server_connect\fR, \fB\-no_etm\fR \fB\-allow_no_dhe_kex\fR, \fB\-prioritize_chacha\fR, \fB\-strict\fR, \fB\-sigalgs\fR \fIalgs\fR, \fB\-client_sigalgs\fR \fIalgs\fR, \fB\-groups\fR \fIgroups\fR, \fB\-curves\fR \fIcurves\fR, \fB\-named_curve\fR \fIcurve\fR, \fB\-cipher\fR \fIciphers\fR, \fB\-ciphersuites\fR \fI1.3ciphers\fR, \fB\-min_protocol\fR \fIminprot\fR, \fB\-max_protocol\fR \fImaxprot\fR, \fB\-record_padding\fR \fIpadding\fR, \fB\-debug_broken_protocol\fR, \fB\-no_middlebox\fR" 4 -.IX 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 \fBSSL_CONF_cmd\fR\|(3) for details. -.IP "\fB\-xkey\fR \fIinfile\fR, \fB\-xcert\fR \fIfile\fR, \fB\-xchain\fR \fIfile\fR, \fB\-xchain_build\fR \fIfile\fR, \fB\-xcertform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR, \fB\-xkeyform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR" 4 +These specify the use of DTLS instead of TLS. +See "TLS Version Options" in \fBopenssl\fR\|(1). +.IP "\fB\-bugs\fR, \fB\-comp\fR, \fB\-no_comp\fR, \fB\-no_ticket\fR, \fB\-serverpref\fR, \fB\-client_renegotiation\fR, \fB\-legacy_renegotiation\fR, \fB\-no_renegotiation\fR, \fB\-no_resumption_on_reneg\fR, \fB\-legacy_server_connect\fR, \fB\-no_legacy_server_connect\fR, \fB\-no_etm\fR \fB\-allow_no_dhe_kex\fR, \fB\-prefer_no_dhe_kex\fR, \fB\-prioritize_chacha\fR, \fB\-strict\fR, \fB\-sigalgs\fR \fIalgs\fR, \fB\-client_sigalgs\fR \fIalgs\fR, \fB\-groups\fR \fIgroups\fR, \fB\-curves\fR \fIcurves\fR, \fB\-named_curve\fR \fIcurve\fR, \fB\-cipher\fR \fIciphers\fR, \fB\-ciphersuites\fR \fI1.3ciphers\fR, \fB\-min_protocol\fR \fIminprot\fR, \fB\-max_protocol\fR \fImaxprot\fR, \fB\-record_padding\fR \fIpadding\fR, \fB\-debug_broken_protocol\fR, \fB\-no_middlebox\fR" 4 +.IX 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, -prefer_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 "SUPPORTED COMMAND LINE COMMANDS" in \fBSSL_CONF_cmd\fR\|(3) for details. +.IP "\fB\-xkey\fR \fIinfile\fR, \fB\-xcert\fR \fIfile\fR, \fB\-xchain\fR \fIfile\fR, \fB\-xchain_build\fR \fIfile\fR, \fB\-xcertform\fR \fBDER\fR|\fBPEM\fR, \fB\-xkeyform\fR \fBDER\fR|\fBPEM\fR" 4 .IX 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 \fBopenssl\-verification\-options\fR\|(1) for details. +See "Extended Verification Options" in \fBopenssl\-verification\-options\fR\|(1) for details. .IP "\fB\-CAfile\fR \fIfile\fR, \fB\-no\-CAfile\fR, \fB\-CApath\fR \fIdir\fR, \fB\-no\-CApath\fR, \fB\-CAstore\fR \fIuri\fR, \fB\-no\-CAstore\fR" 4 .IX Item "-CAfile file, -no-CAfile, -CApath dir, -no-CApath, -CAstore uri, -no-CAstore" -See \*(L"Trusted Certificate Options\*(R" in \fBopenssl\-verification\-options\fR\|(1) for details. +See "Trusted Certificate Options" in \fBopenssl\-verification\-options\fR\|(1) for details. .IP "\fB\-rand\fR \fIfiles\fR, \fB\-writerand\fR \fIfile\fR" 4 .IX Item "-rand files, -writerand file" -See \*(L"Random State Options\*(R" in \fBopenssl\fR\|(1) for details. +See "Random State Options" in \fBopenssl\fR\|(1) for details. .IP "\fB\-engine\fR \fIid\fR" 4 .IX Item "-engine id" -See \*(L"Engine Options\*(R" in \fBopenssl\fR\|(1). +See "Engine Options" in \fBopenssl\fR\|(1). This option is deprecated. .IP "\fB\-provider\fR \fIname\fR" 4 .IX Item "-provider name" .PD 0 .IP "\fB\-provider\-path\fR \fIpath\fR" 4 .IX Item "-provider-path path" +.IP "\fB\-provparam\fR \fI[name:]key=value\fR" 4 +.IX Item "-provparam [name:]key=value" .IP "\fB\-propquery\fR \fIpropq\fR" 4 .IX Item "-propquery propq" .PD -See \*(L"Provider Options\*(R" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7). +See "Provider Options" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7). .IP "\fB\-allow_proxy_certs\fR, \fB\-attime\fR, \fB\-no_check_time\fR, \fB\-check_ss_sig\fR, \fB\-crl_check\fR, \fB\-crl_check_all\fR, \fB\-explicit_policy\fR, \fB\-extended_crl\fR, \fB\-ignore_critical\fR, \fB\-inhibit_any\fR, \fB\-inhibit_map\fR, \fB\-no_alt_chains\fR, \fB\-partial_chain\fR, \fB\-policy\fR, \fB\-policy_check\fR, \fB\-policy_print\fR, \fB\-purpose\fR, \fB\-suiteB_128\fR, \fB\-suiteB_128_only\fR, \fB\-suiteB_192\fR, \fB\-trusted_first\fR, \fB\-use_deltas\fR, \fB\-auth_level\fR, \fB\-verify_depth\fR, \fB\-verify_email\fR, \fB\-verify_hostname\fR, \fB\-verify_ip\fR, \fB\-verify_name\fR, \fB\-x509_strict\fR \fB\-issuer_checks\fR" 4 .IX 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 \fBopenssl\-verification\-options\fR\|(1) for details. +See "Verification Options" in \fBopenssl\-verification\-options\fR\|(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 \fB\-verify_return_error\fR option is used. +.IP \fB\-enable_server_rpk\fR 4 +.IX Item "-enable_server_rpk" +Enable support for sending raw public keys (RFC7250) to the client. +A raw public key will be sent by the server, if solicited by the client, +provided a suitable key and public certificate pair is configured. +Clients that don't support raw public keys or prefer to use X.509 +certificates can still elect to receive X.509 certificates as usual. +.Sp +Raw public keys are extracted from the configured certificate/private key. +.IP \fB\-enable_client_rpk\fR 4 +.IX Item "-enable_client_rpk" +Enable support for receiving raw public keys (RFC7250) from the client. +Use of X.509 certificates by the client becomes optional, and clients that +support raw public keys may elect to use them. +Clients that don't support raw public keys or prefer to use X.509 +certificates can still elect to send X.509 certificates as usual. +.Sp +Raw public keys are extracted from the configured certificate/private key. .SH "CONNECTED COMMANDS" .IX Header "CONNECTED COMMANDS" -If a connection request is established with an \s-1SSL\s0 client and neither the +If a connection request is established with an SSL client and neither the \&\fB\-www\fR nor the \fB\-WWW\fR option has been used then normally any data received from the client is displayed and any key presses will be sent to the client. .PP 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. -.IP "\fBq\fR" 4 +.IP \fBq\fR 4 .IX Item "q" -End the current \s-1SSL\s0 connection but still accept new connections. -.IP "\fBQ\fR" 4 +End the current SSL connection but still accept new connections. +.IP \fBQ\fR 4 .IX Item "Q" -End the current \s-1SSL\s0 connection and exit. -.IP "\fBr\fR" 4 +End the current SSL connection and exit. +.IP \fBr\fR 4 .IX Item "r" -Renegotiate the \s-1SSL\s0 session (TLSv1.2 and below only). -.IP "\fBR\fR" 4 +Renegotiate the SSL session (TLSv1.2 and below only). +.IP \fBR\fR 4 .IX Item "R" -Renegotiate the \s-1SSL\s0 session and request a client certificate (TLSv1.2 and below +Renegotiate the SSL session and request a client certificate (TLSv1.2 and below only). -.IP "\fBP\fR" 4 +.IP \fBP\fR 4 .IX Item "P" -Send some plain text down the underlying \s-1TCP\s0 connection: this should +Send some plain text down the underlying TCP connection: this should cause the client to disconnect due to a protocol violation. -.IP "\fBS\fR" 4 +.IP \fBS\fR 4 .IX Item "S" Print out some session cache status information. -.IP "\fBk\fR" 4 +.IP \fBk\fR 4 .IX Item "k" Send a key update message to the client (TLSv1.3 only) -.IP "\fBK\fR" 4 +.IP \fBK\fR 4 .IX Item "K" Send a key update message to the client and request one back (TLSv1.3 only) -.IP "\fBc\fR" 4 +.IP \fBc\fR 4 .IX Item "c" Send a certificate request to the client (TLSv1.3 only) -.SH "NOTES" +.SH NOTES .IX Header "NOTES" -This command can be used to debug \s-1SSL\s0 clients. To accept connections +This command can be used to debug SSL clients. To accept connections from a web browser the command: .PP .Vb 1 @@ -994,16 +909,16 @@ from a web browser the command: can be used for example. .PP 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. +is strictly speaking a protocol violation, some SSL clients interpret this to +mean any CA is acceptable. This is useful for debugging purposes. .PP The session parameters can printed out using the \fBopenssl\-sess_id\fR\|(1) command. -.SH "BUGS" +.SH BUGS .IX 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. +A typical SSL server program would be much simpler. .PP The output of common ciphers is wrong: it just gives the list of ciphers that OpenSSL recognizes and the client supports. @@ -1021,7 +936,7 @@ of any unknown cipher suites a client says it supports. \&\fBSSL_CTX_set_split_send_fragment\fR\|(3), \&\fBSSL_CTX_set_max_pipelines\fR\|(3), \&\fBossl_store\-file\fR\|(7) -.SH "HISTORY" +.SH HISTORY .IX Header "HISTORY" The \-no_alt_chains option was added in OpenSSL 1.1.0. .PP @@ -1030,11 +945,19 @@ The .PP The \fB\-srpvfile\fR, \fB\-srpuserseed\fR, and \fB\-engine\fR option were deprecated in OpenSSL 3.0. -.SH "COPYRIGHT" +.PP +The +\&\fB\-enable_client_rpk\fR, +\&\fB\-enable_server_rpk\fR, +\&\fB\-no_rx_cert_comp\fR, +\&\fB\-no_tx_cert_comp\fR, +and \fB\-tfo\fR +options were added in OpenSSL 3.2. +.SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2000\-2022 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000\-2025 The OpenSSL Project Authors. All Rights Reserved. .PP -Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use +Licensed under the Apache License 2.0 (the "License"). 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 +in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>. |