| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "OPENSSL-S_SERVER 1SSL" |
| 58 |
.TH OPENSSL-S_SERVER 1SSL 2026-04-07 3.6.2 OpenSSL |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
openssl\-s_server \- SSL/TLS server program |
| 65 |
.SH SYNOPSIS |
| 66 |
.IX Header "SYNOPSIS" |
| 67 |
\&\fBopenssl\fR \fBs_server\fR |
| 68 |
[\fB\-help\fR] |
| 69 |
[\fB\-port\fR \fI+int\fR] |
| 70 |
[\fB\-accept\fR \fIval\fR] |
| 71 |
[\fB\-unix\fR \fIval\fR] |
| 72 |
[\fB\-4\fR] |
| 73 |
[\fB\-6\fR] |
| 74 |
[\fB\-unlink\fR] |
| 75 |
[\fB\-context\fR \fIval\fR] |
| 76 |
[\fB\-verify\fR \fIint\fR] |
| 77 |
[\fB\-Verify\fR \fIint\fR] |
| 78 |
[\fB\-cert\fR \fIinfile\fR] |
| 79 |
[\fB\-cert2\fR \fIinfile\fR] |
| 80 |
[\fB\-certform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR] |
| 81 |
[\fB\-cert_chain\fR \fIinfile\fR] |
| 82 |
[\fB\-build_chain\fR] |
| 83 |
[\fB\-serverinfo\fR \fIval\fR] |
| 84 |
[\fB\-key\fR \fIfilename\fR|\fIuri\fR] |
| 85 |
[\fB\-key2\fR \fIfilename\fR|\fIuri\fR] |
| 86 |
[\fB\-keyform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR|\fBENGINE\fR] |
| 87 |
[\fB\-pass\fR \fIval\fR] |
| 88 |
[\fB\-dcert\fR \fIinfile\fR] |
| 89 |
[\fB\-dcertform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR] |
| 90 |
[\fB\-dcert_chain\fR \fIinfile\fR] |
| 91 |
[\fB\-dkey\fR \fIfilename\fR|\fIuri\fR] |
| 92 |
[\fB\-dkeyform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR|\fBENGINE\fR] |
| 93 |
[\fB\-dpass\fR \fIval\fR] |
| 94 |
[\fB\-nbio_test\fR] |
| 95 |
[\fB\-crlf\fR] |
| 96 |
[\fB\-debug\fR] |
| 97 |
[\fB\-msg\fR] |
| 98 |
[\fB\-msgfile\fR \fIoutfile\fR] |
| 99 |
[\fB\-state\fR] |
| 100 |
[\fB\-nocert\fR] |
| 101 |
[\fB\-quiet\fR] |
| 102 |
[\fB\-no_resume_ephemeral\fR] |
| 103 |
[\fB\-www\fR] |
| 104 |
[\fB\-WWW\fR] |
| 105 |
[\fB\-http_server_binmode\fR] |
| 106 |
[\fB\-no_ca_names\fR] |
| 107 |
[\fB\-ignore_unexpected_eof\fR] |
| 108 |
[\fB\-servername\fR] |
| 109 |
[\fB\-servername_fatal\fR] |
| 110 |
[\fB\-tlsextdebug\fR] |
| 111 |
[\fB\-HTTP\fR] |
| 112 |
[\fB\-id_prefix\fR \fIval\fR] |
| 113 |
[\fB\-keymatexport\fR \fIval\fR] |
| 114 |
[\fB\-keymatexportlen\fR \fI+int\fR] |
| 115 |
[\fB\-CRL\fR \fIinfile\fR] |
| 116 |
[\fB\-CRLform\fR \fBDER\fR|\fBPEM\fR] |
| 117 |
[\fB\-crl_download\fR] |
| 118 |
[\fB\-chainCAfile\fR \fIinfile\fR] |
| 119 |
[\fB\-chainCApath\fR \fIdir\fR] |
| 120 |
[\fB\-chainCAstore\fR \fIuri\fR] |
| 121 |
[\fB\-verifyCAfile\fR \fIinfile\fR] |
| 122 |
[\fB\-verifyCApath\fR \fIdir\fR] |
| 123 |
[\fB\-verifyCAstore\fR \fIuri\fR] |
| 124 |
[\fB\-no_cache\fR] |
| 125 |
[\fB\-ext_cache\fR] |
| 126 |
[\fB\-verify_return_error\fR] |
| 127 |
[\fB\-verify_quiet\fR] |
| 128 |
[\fB\-ign_eof\fR] |
| 129 |
[\fB\-no_ign_eof\fR] |
| 130 |
[\fB\-no_ems\fR] |
| 131 |
[\fB\-status\fR] |
| 132 |
[\fB\-status_all\fR] |
| 133 |
[\fB\-status_verbose\fR] |
| 134 |
[\fB\-status_timeout\fR \fIint\fR] |
| 135 |
[\fB\-proxy\fR \fI[http[s]://][userinfo@]host[:port][/path][?query][#fragment]\fR] |
| 136 |
[\fB\-no_proxy\fR \fIaddresses\fR] |
| 137 |
[\fB\-status_url\fR \fIval\fR] |
| 138 |
[\fB\-status_file\fR \fIinfile\fR] |
| 139 |
[\fB\-ssl_config\fR \fIval\fR] |
| 140 |
[\fB\-trace\fR] |
| 141 |
[\fB\-security_debug\fR] |
| 142 |
[\fB\-security_debug_verbose\fR] |
| 143 |
[\fB\-brief\fR] |
| 144 |
[\fB\-rev\fR] |
| 145 |
[\fB\-async\fR] |
| 146 |
[\fB\-max_send_frag\fR \fI+int\fR] |
| 147 |
[\fB\-split_send_frag\fR \fI+int\fR] |
| 148 |
[\fB\-max_pipelines\fR \fI+int\fR] |
| 149 |
[\fB\-naccept\fR \fI+int\fR] |
| 150 |
[\fB\-read_buf\fR \fI+int\fR] |
| 151 |
[\fB\-no_tx_cert_comp\fR] |
| 152 |
[\fB\-no_rx_cert_comp\fR] |
| 153 |
[\fB\-dhparam\fR \fIinfile\fR] |
| 154 |
[\fB\-nbio\fR] |
| 155 |
[\fB\-psk_identity\fR \fIval\fR] |
| 156 |
[\fB\-psk_hint\fR \fIval\fR] |
| 157 |
[\fB\-psk\fR \fIval\fR] |
| 158 |
[\fB\-psk_session\fR \fIfile\fR] |
| 159 |
[\fB\-srpvfile\fR \fIinfile\fR] |
| 160 |
[\fB\-srpuserseed\fR \fIval\fR] |
| 161 |
[\fB\-timeout\fR] |
| 162 |
[\fB\-mtu\fR \fI+int\fR] |
| 163 |
[\fB\-listen\fR] |
| 164 |
[\fB\-sctp\fR] |
| 165 |
[\fB\-sctp_label_bug\fR] |
| 166 |
[\fB\-use_srtp\fR \fIval\fR] |
| 167 |
[\fB\-no_dhe\fR] |
| 168 |
[\fB\-nextprotoneg\fR \fIval\fR] |
| 169 |
[\fB\-alpn\fR \fIval\fR] |
| 170 |
[\fB\-ktls\fR] |
| 171 |
[\fB\-sendfile\fR] |
| 172 |
[\fB\-zerocopy_sendfile\fR] |
| 173 |
[\fB\-keylogfile\fR \fIoutfile\fR] |
| 174 |
[\fB\-recv_max_early_data\fR \fIint\fR] |
| 175 |
[\fB\-max_early_data\fR \fIint\fR] |
| 176 |
[\fB\-early_data\fR] |
| 177 |
[\fB\-stateless\fR] |
| 178 |
[\fB\-anti_replay\fR] |
| 179 |
[\fB\-no_anti_replay\fR] |
| 180 |
[\fB\-num_tickets\fR] |
| 181 |
[\fB\-tfo\fR] |
| 182 |
[\fB\-cert_comp\fR] |
| 183 |
[\fB\-nameopt\fR \fIoption\fR] |
| 184 |
[\fB\-no_ssl3\fR] |
| 185 |
[\fB\-no_tls1\fR] |
| 186 |
[\fB\-no_tls1_1\fR] |
| 187 |
[\fB\-no_tls1_2\fR] |
| 188 |
[\fB\-no_tls1_3\fR] |
| 189 |
[\fB\-ssl3\fR] |
| 190 |
[\fB\-tls1\fR] |
| 191 |
[\fB\-tls1_1\fR] |
| 192 |
[\fB\-tls1_2\fR] |
| 193 |
[\fB\-tls1_3\fR] |
| 194 |
[\fB\-dtls\fR] |
| 195 |
[\fB\-dtls1\fR] |
| 196 |
[\fB\-dtls1_2\fR] |
| 197 |
[\fB\-allow_proxy_certs\fR] |
| 198 |
[\fB\-attime\fR \fItimestamp\fR] |
| 199 |
[\fB\-no_check_time\fR] |
| 200 |
[\fB\-check_ss_sig\fR] |
| 201 |
[\fB\-crl_check\fR] |
| 202 |
[\fB\-crl_check_all\fR] |
| 203 |
[\fB\-explicit_policy\fR] |
| 204 |
[\fB\-extended_crl\fR] |
| 205 |
[\fB\-ignore_critical\fR] |
| 206 |
[\fB\-inhibit_any\fR] |
| 207 |
[\fB\-inhibit_map\fR] |
| 208 |
[\fB\-partial_chain\fR] |
| 209 |
[\fB\-policy\fR \fIarg\fR] |
| 210 |
[\fB\-policy_check\fR] |
| 211 |
[\fB\-policy_print\fR] |
| 212 |
[\fB\-purpose\fR \fIpurpose\fR] |
| 213 |
[\fB\-suiteB_128\fR] |
| 214 |
[\fB\-suiteB_128_only\fR] |
| 215 |
[\fB\-suiteB_192\fR] |
| 216 |
[\fB\-trusted_first\fR] |
| 217 |
[\fB\-no_alt_chains\fR] |
| 218 |
[\fB\-use_deltas\fR] |
| 219 |
[\fB\-auth_level\fR \fInum\fR] |
| 220 |
[\fB\-verify_depth\fR \fInum\fR] |
| 221 |
[\fB\-verify_email\fR \fIemail\fR] |
| 222 |
[\fB\-verify_hostname\fR \fIhostname\fR] |
| 223 |
[\fB\-verify_ip\fR \fIip\fR] |
| 224 |
[\fB\-verify_name\fR \fIname\fR] |
| 225 |
[\fB\-x509_strict\fR] |
| 226 |
[\fB\-issuer_checks\fR] |
| 227 |
[\fB\-bugs\fR] |
| 228 |
[\fB\-no_comp\fR] |
| 229 |
[\fB\-comp\fR] |
| 230 |
[\fB\-no_ticket\fR] |
| 231 |
[\fB\-serverpref\fR] |
| 232 |
[\fB\-client_renegotiation\fR] |
| 233 |
[\fB\-legacy_renegotiation\fR] |
| 234 |
[\fB\-no_renegotiation\fR] |
| 235 |
[\fB\-no_resumption_on_reneg\fR] |
| 236 |
[\fB\-legacy_server_connect\fR] |
| 237 |
[\fB\-no_legacy_server_connect\fR] |
| 238 |
[\fB\-no_etm\fR] |
| 239 |
[\fB\-allow_no_dhe_kex\fR] |
| 240 |
[\fB\-prefer_no_dhe_kex\fR] |
| 241 |
[\fB\-prioritize_chacha\fR] |
| 242 |
[\fB\-strict\fR] |
| 243 |
[\fB\-sigalgs\fR \fIalgs\fR] |
| 244 |
[\fB\-client_sigalgs\fR \fIalgs\fR] |
| 245 |
[\fB\-groups\fR \fIgroups\fR] |
| 246 |
[\fB\-curves\fR \fIcurves\fR] |
| 247 |
[\fB\-named_curve\fR \fIcurve\fR] |
| 248 |
[\fB\-cipher\fR \fIciphers\fR] |
| 249 |
[\fB\-ciphersuites\fR \fI1.3ciphers\fR] |
| 250 |
[\fB\-min_protocol\fR \fIminprot\fR] |
| 251 |
[\fB\-max_protocol\fR \fImaxprot\fR] |
| 252 |
[\fB\-record_padding\fR \fIpadding\fR] |
| 253 |
[\fB\-debug_broken_protocol\fR] |
| 254 |
[\fB\-no_middlebox\fR] |
| 255 |
[\fB\-xkey\fR \fIinfile\fR] |
| 256 |
[\fB\-xcert\fR \fIfile\fR] |
| 257 |
[\fB\-xchain\fR \fIfile\fR] |
| 258 |
[\fB\-xchain_build\fR \fIfile\fR] |
| 259 |
[\fB\-xcertform\fR \fBDER\fR|\fBPEM\fR]> |
| 260 |
[\fB\-xkeyform\fR \fBDER\fR|\fBPEM\fR]> |
| 261 |
[\fB\-CAfile\fR \fIfile\fR] |
| 262 |
[\fB\-no\-CAfile\fR] |
| 263 |
[\fB\-CApath\fR \fIdir\fR] |
| 264 |
[\fB\-no\-CApath\fR] |
| 265 |
[\fB\-CAstore\fR \fIuri\fR] |
| 266 |
[\fB\-no\-CAstore\fR] |
| 267 |
[\fB\-rand\fR \fIfiles\fR] |
| 268 |
[\fB\-writerand\fR \fIfile\fR] |
| 269 |
[\fB\-engine\fR \fIid\fR] |
| 270 |
[\fB\-provider\fR \fIname\fR] |
| 271 |
[\fB\-provider\-path\fR \fIpath\fR] |
| 272 |
[\fB\-provparam\fR \fI[name:]key=value\fR] |
| 273 |
[\fB\-propquery\fR \fIpropq\fR] |
| 274 |
[\fB\-enable_server_rpk\fR] |
| 275 |
[\fB\-enable_client_rpk\fR] |
| 276 |
.SH DESCRIPTION |
| 277 |
.IX Header "DESCRIPTION" |
| 278 |
This command implements a generic SSL/TLS server which |
| 279 |
listens for connections on a given port using SSL/TLS. |
| 280 |
.SH OPTIONS |
| 281 |
.IX Header "OPTIONS" |
| 282 |
In addition to the options below, this command also supports |
| 283 |
the common and server only options documented |
| 284 |
"Supported Command Line Commands" in \fBSSL_CONF_cmd\fR\|(3) |
| 285 |
.IP \fB\-help\fR 4 |
| 286 |
.IX Item "-help" |
| 287 |
Print out a usage message. |
| 288 |
.IP "\fB\-port\fR \fI+int\fR" 4 |
| 289 |
.IX Item "-port +int" |
| 290 |
The TCP port to listen on for connections. If not specified 4433 is used. |
| 291 |
.IP "\fB\-accept\fR \fIval\fR" 4 |
| 292 |
.IX Item "-accept val" |
| 293 |
The optional TCP host and port to listen on for connections. If not specified, *:4433 is used. |
| 294 |
.IP "\fB\-unix\fR \fIval\fR" 4 |
| 295 |
.IX Item "-unix val" |
| 296 |
Unix domain socket to accept on. |
| 297 |
.IP \fB\-4\fR 4 |
| 298 |
.IX Item "-4" |
| 299 |
Use IPv4 only. |
| 300 |
.IP \fB\-6\fR 4 |
| 301 |
.IX Item "-6" |
| 302 |
Use IPv6 only. |
| 303 |
.IP \fB\-unlink\fR 4 |
| 304 |
.IX Item "-unlink" |
| 305 |
For \-unix, unlink any existing socket first. |
| 306 |
.IP "\fB\-context\fR \fIval\fR" 4 |
| 307 |
.IX Item "-context val" |
| 308 |
Sets the SSL context id. It can be given any string value. If this option |
| 309 |
is not present a default value will be used. |
| 310 |
.IP "\fB\-verify\fR \fIint\fR, \fB\-Verify\fR \fIint\fR" 4 |
| 311 |
.IX Item "-verify int, -Verify int" |
| 312 |
The verify depth to use. This specifies the maximum length of the |
| 313 |
client certificate chain and makes the server request a certificate from |
| 314 |
the client. With the \fB\-verify\fR option a certificate is requested but the |
| 315 |
client does not have to send one, with the \fB\-Verify\fR option the client |
| 316 |
must supply a certificate or an error occurs. |
| 317 |
.Sp |
| 318 |
If the cipher suite cannot request a client certificate (for example an |
| 319 |
anonymous cipher suite or PSK) this option has no effect. |
| 320 |
.Sp |
| 321 |
By default, validation of any supplied client certificate and its chain |
| 322 |
is done w.r.t. the (D)TLS Client (\f(CW\*(C`sslclient\*(C'\fR) purpose. |
| 323 |
For details see "Certificate Extensions" in \fBopenssl\-verification\-options\fR\|(1). |
| 324 |
.IP "\fB\-cert\fR \fIinfile\fR" 4 |
| 325 |
.IX Item "-cert infile" |
| 326 |
The certificate to use, most servers cipher suites require the use of a |
| 327 |
certificate and some require a certificate with a certain public key type: |
| 328 |
for example the DSS cipher suites require a certificate containing a DSS |
| 329 |
(DSA) key. If not specified then the filename \fIserver.pem\fR will be used. |
| 330 |
.IP "\fB\-cert2\fR \fIinfile\fR" 4 |
| 331 |
.IX Item "-cert2 infile" |
| 332 |
The certificate file to use for servername; default is \f(CW\*(C`server2.pem\*(C'\fR. |
| 333 |
.IP "\fB\-certform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR" 4 |
| 334 |
.IX Item "-certform DER|PEM|P12" |
| 335 |
The server certificate file format; unspecified by default. |
| 336 |
See \fBopenssl\-format\-options\fR\|(1) for details. |
| 337 |
.IP \fB\-cert_chain\fR 4 |
| 338 |
.IX Item "-cert_chain" |
| 339 |
A file or URI of untrusted certificates to use when attempting to build the |
| 340 |
certificate chain related to the certificate specified via the \fB\-cert\fR option. |
| 341 |
These untrusted certificates are sent to clients and used for generating |
| 342 |
certificate status (aka OCSP stapling) requests. |
| 343 |
The input can be in PEM, DER, or PKCS#12 format. |
| 344 |
.IP \fB\-build_chain\fR 4 |
| 345 |
.IX Item "-build_chain" |
| 346 |
Specify whether the application should build the server certificate chain to be |
| 347 |
provided to the client. |
| 348 |
.IP "\fB\-serverinfo\fR \fIval\fR" 4 |
| 349 |
.IX Item "-serverinfo val" |
| 350 |
A file containing one or more blocks of PEM data. Each PEM block |
| 351 |
must encode a TLS ServerHello extension (2 bytes type, 2 bytes length, |
| 352 |
followed by "length" bytes of extension data). If the client sends |
| 353 |
an empty TLS ClientHello extension matching the type, the corresponding |
| 354 |
ServerHello extension will be returned. |
| 355 |
.IP "\fB\-key\fR \fIfilename\fR|\fIuri\fR" 4 |
| 356 |
.IX Item "-key filename|uri" |
| 357 |
The private key to use. If not specified then the certificate file will |
| 358 |
be used. |
| 359 |
.IP "\fB\-key2\fR \fIfilename\fR|\fIuri\fR" 4 |
| 360 |
.IX Item "-key2 filename|uri" |
| 361 |
The private Key file to use for servername if not given via \fB\-cert2\fR. |
| 362 |
.IP "\fB\-keyform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR|\fBENGINE\fR" 4 |
| 363 |
.IX Item "-keyform DER|PEM|P12|ENGINE" |
| 364 |
The key format; unspecified by default. |
| 365 |
See \fBopenssl\-format\-options\fR\|(1) for details. |
| 366 |
.IP "\fB\-pass\fR \fIval\fR" 4 |
| 367 |
.IX Item "-pass val" |
| 368 |
The private key and certificate file password source. |
| 369 |
For more information about the format of \fIval\fR, |
| 370 |
see \fBopenssl\-passphrase\-options\fR\|(1). |
| 371 |
.IP "\fB\-dcert\fR \fIinfile\fR, \fB\-dkey\fR \fIfilename\fR|\fIuri\fR" 4 |
| 372 |
.IX Item "-dcert infile, -dkey filename|uri" |
| 373 |
Specify an additional certificate and private key, these behave in the |
| 374 |
same manner as the \fB\-cert\fR and \fB\-key\fR options except there is no default |
| 375 |
if they are not specified (no additional certificate and key is used). As |
| 376 |
noted above some cipher suites require a certificate containing a key of |
| 377 |
a certain type. Some cipher suites need a certificate carrying an RSA key |
| 378 |
and some a DSS (DSA) key. By using RSA and DSS certificates and keys |
| 379 |
a server can support clients which only support RSA or DSS cipher suites |
| 380 |
by using an appropriate certificate. |
| 381 |
.IP \fB\-dcert_chain\fR 4 |
| 382 |
.IX Item "-dcert_chain" |
| 383 |
A file or URI of untrusted certificates to use when attempting to build the |
| 384 |
server certificate chain when a certificate specified via the \fB\-dcert\fR option |
| 385 |
is in use. |
| 386 |
The input can be in PEM, DER, or PKCS#12 format. |
| 387 |
.IP "\fB\-dcertform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR" 4 |
| 388 |
.IX Item "-dcertform DER|PEM|P12" |
| 389 |
The format of the additional certificate file; unspecified by default. |
| 390 |
See \fBopenssl\-format\-options\fR\|(1) for details. |
| 391 |
.IP "\fB\-dkeyform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR|\fBENGINE\fR" 4 |
| 392 |
.IX Item "-dkeyform DER|PEM|P12|ENGINE" |
| 393 |
The format of the additional private key; unspecified by default. |
| 394 |
See \fBopenssl\-format\-options\fR\|(1) for details. |
| 395 |
.IP "\fB\-dpass\fR \fIval\fR" 4 |
| 396 |
.IX Item "-dpass val" |
| 397 |
The passphrase for the additional private key and certificate. |
| 398 |
For more information about the format of \fIval\fR, |
| 399 |
see \fBopenssl\-passphrase\-options\fR\|(1). |
| 400 |
.IP \fB\-nbio_test\fR 4 |
| 401 |
.IX Item "-nbio_test" |
| 402 |
Tests non blocking I/O. |
| 403 |
.IP \fB\-crlf\fR 4 |
| 404 |
.IX Item "-crlf" |
| 405 |
This option translated a line feed from the terminal into CR+LF. |
| 406 |
.IP \fB\-debug\fR 4 |
| 407 |
.IX Item "-debug" |
| 408 |
Print extensive debugging information including a hex dump of all traffic. |
| 409 |
.IP \fB\-security_debug\fR 4 |
| 410 |
.IX Item "-security_debug" |
| 411 |
Print output from SSL/TLS security framework. |
| 412 |
.IP \fB\-security_debug_verbose\fR 4 |
| 413 |
.IX Item "-security_debug_verbose" |
| 414 |
Print more output from SSL/TLS security framework |
| 415 |
.IP \fB\-msg\fR 4 |
| 416 |
.IX Item "-msg" |
| 417 |
Show all protocol messages with hex dump. |
| 418 |
.IP "\fB\-msgfile\fR \fIoutfile\fR" 4 |
| 419 |
.IX Item "-msgfile outfile" |
| 420 |
File to send output of \fB\-msg\fR or \fB\-trace\fR to, default standard output. |
| 421 |
.IP \fB\-state\fR 4 |
| 422 |
.IX Item "-state" |
| 423 |
Prints the SSL session states. |
| 424 |
.IP "\fB\-CRL\fR \fIinfile\fR" 4 |
| 425 |
.IX Item "-CRL infile" |
| 426 |
The CRL file to use. |
| 427 |
.IP "\fB\-CRLform\fR \fBDER\fR|\fBPEM\fR" 4 |
| 428 |
.IX Item "-CRLform DER|PEM" |
| 429 |
The CRL file format; unspecified by default. |
| 430 |
See \fBopenssl\-format\-options\fR\|(1) for details. |
| 431 |
.IP \fB\-crl_download\fR 4 |
| 432 |
.IX Item "-crl_download" |
| 433 |
Download CRLs from distribution points given in CDP extensions of certificates |
| 434 |
.IP "\fB\-verifyCAfile\fR \fIfilename\fR" 4 |
| 435 |
.IX Item "-verifyCAfile filename" |
| 436 |
A file in PEM format CA containing trusted certificates to use |
| 437 |
for verifying client certificates. |
| 438 |
.IP "\fB\-verifyCApath\fR \fIdir\fR" 4 |
| 439 |
.IX Item "-verifyCApath dir" |
| 440 |
A directory containing trusted certificates to use |
| 441 |
for verifying client certificates. |
| 442 |
This directory must be in "hash format", |
| 443 |
see \fBopenssl\-verify\fR\|(1) for more information. |
| 444 |
.IP "\fB\-verifyCAstore\fR \fIuri\fR" 4 |
| 445 |
.IX Item "-verifyCAstore uri" |
| 446 |
The URI of a store containing trusted certificates to use |
| 447 |
for verifying client certificates. |
| 448 |
.IP "\fB\-chainCAfile\fR \fIfile\fR" 4 |
| 449 |
.IX Item "-chainCAfile file" |
| 450 |
A file in PEM format containing trusted certificates to use |
| 451 |
when attempting to build the server certificate chain. |
| 452 |
.IP "\fB\-chainCApath\fR \fIdir\fR" 4 |
| 453 |
.IX Item "-chainCApath dir" |
| 454 |
A directory containing trusted certificates to use |
| 455 |
for building the server certificate chain provided to the client. |
| 456 |
This directory must be in "hash format", |
| 457 |
see \fBopenssl\-verify\fR\|(1) for more information. |
| 458 |
.IP "\fB\-chainCAstore\fR \fIuri\fR" 4 |
| 459 |
.IX Item "-chainCAstore uri" |
| 460 |
The URI of a store containing trusted certificates to use |
| 461 |
for building the server certificate chain provided to the client. |
| 462 |
The URI may indicate a single certificate, as well as a collection of them. |
| 463 |
With URIs in the \f(CW\*(C`file:\*(C'\fR scheme, this acts as \fB\-chainCAfile\fR or |
| 464 |
\&\fB\-chainCApath\fR, depending on if the URI indicates a directory or a |
| 465 |
single file. |
| 466 |
See \fBossl_store\-file\fR\|(7) for more information on the \f(CW\*(C`file:\*(C'\fR scheme. |
| 467 |
.IP \fB\-nocert\fR 4 |
| 468 |
.IX Item "-nocert" |
| 469 |
If this option is set then no certificate is used. This restricts the |
| 470 |
cipher suites available to the anonymous ones (currently just anonymous |
| 471 |
DH). |
| 472 |
.IP \fB\-quiet\fR 4 |
| 473 |
.IX Item "-quiet" |
| 474 |
Inhibit printing of session and certificate information. |
| 475 |
.IP \fB\-no_resume_ephemeral\fR 4 |
| 476 |
.IX Item "-no_resume_ephemeral" |
| 477 |
Disable caching and tickets if ephemeral (EC)DH is used. |
| 478 |
.IP \fB\-tlsextdebug\fR 4 |
| 479 |
.IX Item "-tlsextdebug" |
| 480 |
Print a hex dump of any TLS extensions received from the server. |
| 481 |
.IP \fB\-www\fR 4 |
| 482 |
.IX Item "-www" |
| 483 |
Sends a status message back to the client when it connects. This includes |
| 484 |
information about the ciphers used and various session parameters. |
| 485 |
The output is in HTML format so this option can be used with a web browser. |
| 486 |
The special URL \f(CW\*(C`/renegcert\*(C'\fR turns on client cert validation, and \f(CW\*(C`/reneg\*(C'\fR |
| 487 |
tells the server to request renegotiation. |
| 488 |
.IP "\fB\-WWW\fR, \fB\-HTTP\fR" 4 |
| 489 |
.IX Item "-WWW, -HTTP" |
| 490 |
Emulates a simple web server. Pages will be resolved relative to the |
| 491 |
current directory, for example if the URL \f(CW\*(C`https://myhost/page.html\*(C'\fR is |
| 492 |
requested the file \fI./page.html\fR will be sent. |
| 493 |
If the \fB\-HTTP\fR flag is used, the files are sent directly, and should contain |
| 494 |
any HTTP response headers (including status response line). |
| 495 |
If the \fB\-WWW\fR option is used, |
| 496 |
the response headers are generated by the server, and the file extension is |
| 497 |
examined to determine the \fBContent-Type\fR header. |
| 498 |
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 |
| 499 |
\&\f(CW\*(C`text/plain\*(C'\fR. |
| 500 |
In addition, the special URL \f(CW\*(C`/stats\*(C'\fR will return status |
| 501 |
information like the \fB\-www\fR option. |
| 502 |
.IP \fB\-http_server_binmode\fR 4 |
| 503 |
.IX Item "-http_server_binmode" |
| 504 |
When acting as web-server (using option \fB\-WWW\fR or \fB\-HTTP\fR) open files requested |
| 505 |
by the client in binary mode. |
| 506 |
.IP \fB\-no_ca_names\fR 4 |
| 507 |
.IX Item "-no_ca_names" |
| 508 |
Disable TLS Extension CA Names. You may want to disable it for security reasons |
| 509 |
or for compatibility with some Windows TLS implementations crashing when this |
| 510 |
extension is larger than 1024 bytes. |
| 511 |
.IP \fB\-ignore_unexpected_eof\fR 4 |
| 512 |
.IX Item "-ignore_unexpected_eof" |
| 513 |
Some TLS implementations do not send the mandatory close_notify alert on |
| 514 |
shutdown. If the application tries to wait for the close_notify alert but the |
| 515 |
peer closes the connection without sending it, an error is generated. When this |
| 516 |
option is enabled the peer does not need to send the close_notify alert and a |
| 517 |
closed connection will be treated as if the close_notify alert was received. |
| 518 |
For more information on shutting down a connection, see \fBSSL_shutdown\fR\|(3). |
| 519 |
.IP \fB\-servername\fR 4 |
| 520 |
.IX Item "-servername" |
| 521 |
Servername for HostName TLS extension. |
| 522 |
.IP \fB\-servername_fatal\fR 4 |
| 523 |
.IX Item "-servername_fatal" |
| 524 |
On servername mismatch send fatal alert (default: warning alert). |
| 525 |
.IP "\fB\-id_prefix\fR \fIval\fR" 4 |
| 526 |
.IX Item "-id_prefix val" |
| 527 |
Generate SSL/TLS session IDs prefixed by \fIval\fR. This is mostly useful |
| 528 |
for testing any SSL/TLS code (e.g. proxies) that wish to deal with multiple |
| 529 |
servers, when each of which might be generating a unique range of session |
| 530 |
IDs (e.g. with a certain prefix). |
| 531 |
.IP \fB\-keymatexport\fR 4 |
| 532 |
.IX Item "-keymatexport" |
| 533 |
Export keying material using label. |
| 534 |
.IP \fB\-keymatexportlen\fR 4 |
| 535 |
.IX Item "-keymatexportlen" |
| 536 |
Export the given number of bytes of keying material; default 20. |
| 537 |
.IP \fB\-no_cache\fR 4 |
| 538 |
.IX Item "-no_cache" |
| 539 |
Disable session cache. |
| 540 |
.IP \fB\-ext_cache\fR. 4 |
| 541 |
.IX Item "-ext_cache." |
| 542 |
Disable internal cache, set up and use external cache. |
| 543 |
.IP \fB\-verify_return_error\fR 4 |
| 544 |
.IX Item "-verify_return_error" |
| 545 |
Verification errors normally just print a message but allow the |
| 546 |
connection to continue, for debugging purposes. |
| 547 |
If this option is used, then verification errors close the connection. |
| 548 |
.IP \fB\-verify_quiet\fR 4 |
| 549 |
.IX Item "-verify_quiet" |
| 550 |
No verify output except verify errors. |
| 551 |
.IP \fB\-ign_eof\fR 4 |
| 552 |
.IX Item "-ign_eof" |
| 553 |
Ignore input EOF (default: when \fB\-quiet\fR). |
| 554 |
.IP \fB\-no_ign_eof\fR 4 |
| 555 |
.IX Item "-no_ign_eof" |
| 556 |
Do not ignore input EOF. |
| 557 |
.IP \fB\-no_ems\fR 4 |
| 558 |
.IX Item "-no_ems" |
| 559 |
Disable Extended master secret negotiation. |
| 560 |
.IP \fB\-status\fR 4 |
| 561 |
.IX Item "-status" |
| 562 |
Enables certificate status request support (aka OCSP stapling): |
| 563 |
an OCSP response is provided for the leaf (server) certificate |
| 564 |
if requested by the client side. |
| 565 |
.IP \fB\-status_all\fR 4 |
| 566 |
.IX Item "-status_all" |
| 567 |
Like before, but for TLS v1.3 and beyond, status responses for all |
| 568 |
certificates in the chain (except the trust anchor) are provided |
| 569 |
if requested by the client side. |
| 570 |
.IP \fB\-status_verbose\fR 4 |
| 571 |
.IX Item "-status_verbose" |
| 572 |
Enables certificate status request support (aka OCSP stapling) and gives |
| 573 |
a verbose printout of the OCSP response. |
| 574 |
Use the \fB\-cert_chain\fR option to specify the certificate of the server's |
| 575 |
certificate signer that is required for certificate status requests. |
| 576 |
.IP "\fB\-status_timeout\fR \fIint\fR" 4 |
| 577 |
.IX Item "-status_timeout int" |
| 578 |
Sets the timeout for OCSP response to \fIint\fR seconds. |
| 579 |
.IP "\fB\-proxy\fR \fI[http[s]://][userinfo@]host[:port][/path][?query][#fragment]\fR" 4 |
| 580 |
.IX Item "-proxy [http[s]://][userinfo@]host[:port][/path][?query][#fragment]" |
| 581 |
The HTTP(S) proxy server to use for reaching the OCSP server unless \fB\-no_proxy\fR |
| 582 |
applies, see below. |
| 583 |
If the host string is an IPv6 address, it must be enclosed in \f(CW\*(C`[\*(C'\fR and \f(CW\*(C`]\*(C'\fR. |
| 584 |
The proxy port defaults to 80 or 443 if the scheme is \f(CW\*(C`https\*(C'\fR; apart from that |
| 585 |
the optional \f(CW\*(C`http://\*(C'\fR or \f(CW\*(C`https://\*(C'\fR prefix is ignored, |
| 586 |
as well as any userinfo, path, query, and fragment components. |
| 587 |
Defaults to the environment variable \f(CW\*(C`http_proxy\*(C'\fR if set, else \f(CW\*(C`HTTP_PROXY\*(C'\fR |
| 588 |
in case no TLS is used, otherwise \f(CW\*(C`https_proxy\*(C'\fR if set, else \f(CW\*(C`HTTPS_PROXY\*(C'\fR. |
| 589 |
.IP "\fB\-no_proxy\fR \fIaddresses\fR" 4 |
| 590 |
.IX Item "-no_proxy addresses" |
| 591 |
List of IP addresses and/or DNS names of servers |
| 592 |
not to use an HTTP(S) proxy for, separated by commas and/or whitespace |
| 593 |
(where in the latter case the whole argument must be enclosed in "..."). |
| 594 |
Default is from the environment variable \f(CW\*(C`no_proxy\*(C'\fR if set, else \f(CW\*(C`NO_PROXY\*(C'\fR. |
| 595 |
.IP "\fB\-status_url\fR \fIval\fR" 4 |
| 596 |
.IX Item "-status_url val" |
| 597 |
Sets a fallback responder URL to use if no responder URL is present in the |
| 598 |
server certificate. Without this option an error is returned if the server |
| 599 |
certificate does not contain a responder address. |
| 600 |
The optional userinfo and fragment URL components are ignored. |
| 601 |
Any given query component is handled as part of the path component. |
| 602 |
.IP "\fB\-status_file\fR \fIinfile\fR" 4 |
| 603 |
.IX Item "-status_file infile" |
| 604 |
Overrides any OCSP responder URLs from the certificate and always provides the |
| 605 |
OCSP Response stored in the file. The file must be in DER format. |
| 606 |
This option may be used multiple times to specify OCSP responses for all |
| 607 |
certificates in the server certificate chain. |
| 608 |
.IP "\fB\-ssl_config\fR \fIval\fR" 4 |
| 609 |
.IX Item "-ssl_config val" |
| 610 |
Configure SSL_CTX using the given configuration value. |
| 611 |
.IP \fB\-trace\fR 4 |
| 612 |
.IX Item "-trace" |
| 613 |
Show verbose trace output of protocol messages. |
| 614 |
.IP \fB\-brief\fR 4 |
| 615 |
.IX Item "-brief" |
| 616 |
Provide a brief summary of connection parameters instead of the normal verbose |
| 617 |
output. |
| 618 |
.IP \fB\-rev\fR 4 |
| 619 |
.IX Item "-rev" |
| 620 |
Simple echo server that sends back received text reversed. Also sets \fB\-brief\fR. |
| 621 |
Cannot be used in conjunction with \fB\-early_data\fR. |
| 622 |
.IP \fB\-async\fR 4 |
| 623 |
.IX Item "-async" |
| 624 |
Switch on asynchronous mode. Cryptographic operations will be performed |
| 625 |
asynchronously. This will only have an effect if an asynchronous capable engine |
| 626 |
is also used via the \fB\-engine\fR option. For test purposes the dummy async engine |
| 627 |
(dasync) can be used (if available). |
| 628 |
.IP "\fB\-max_send_frag\fR \fI+int\fR" 4 |
| 629 |
.IX Item "-max_send_frag +int" |
| 630 |
The maximum size of data fragment to send. |
| 631 |
See \fBSSL_CTX_set_max_send_fragment\fR\|(3) for further information. |
| 632 |
.IP "\fB\-split_send_frag\fR \fI+int\fR" 4 |
| 633 |
.IX Item "-split_send_frag +int" |
| 634 |
The size used to split data for encrypt pipelines. If more data is written in |
| 635 |
one go than this value then it will be split into multiple pipelines, up to the |
| 636 |
maximum number of pipelines defined by max_pipelines. This only has an effect if |
| 637 |
a suitable cipher suite has been negotiated, an engine that supports pipelining |
| 638 |
has been loaded, and max_pipelines is greater than 1. See |
| 639 |
\&\fBSSL_CTX_set_split_send_fragment\fR\|(3) for further information. |
| 640 |
.IP "\fB\-max_pipelines\fR \fI+int\fR" 4 |
| 641 |
.IX Item "-max_pipelines +int" |
| 642 |
The maximum number of encrypt/decrypt pipelines to be used. This will only have |
| 643 |
an effect if an engine has been loaded that supports pipelining (e.g. the dasync |
| 644 |
engine) and a suitable cipher suite has been negotiated. The default value is 1. |
| 645 |
See \fBSSL_CTX_set_max_pipelines\fR\|(3) for further information. |
| 646 |
.IP "\fB\-naccept\fR \fI+int\fR" 4 |
| 647 |
.IX Item "-naccept +int" |
| 648 |
The server will exit after receiving the specified number of connections, |
| 649 |
default unlimited. |
| 650 |
.IP "\fB\-read_buf\fR \fI+int\fR" 4 |
| 651 |
.IX Item "-read_buf +int" |
| 652 |
The default read buffer size to be used for connections. This will only have an |
| 653 |
effect if the buffer size is larger than the size that would otherwise be used |
| 654 |
and pipelining is in use (see \fBSSL_CTX_set_default_read_buffer_len\fR\|(3) for |
| 655 |
further information). |
| 656 |
.IP \fB\-no_tx_cert_comp\fR 4 |
| 657 |
.IX Item "-no_tx_cert_comp" |
| 658 |
Disables support for sending TLSv1.3 compressed certificates. |
| 659 |
.IP \fB\-no_rx_cert_comp\fR 4 |
| 660 |
.IX Item "-no_rx_cert_comp" |
| 661 |
Disables support for receiving TLSv1.3 compressed certificates. |
| 662 |
.IP \fB\-no_comp\fR 4 |
| 663 |
.IX Item "-no_comp" |
| 664 |
Disable negotiation of TLS compression. |
| 665 |
TLS compression is not recommended and is off by default as of |
| 666 |
OpenSSL 1.1.0. |
| 667 |
.IP \fB\-num_tickets\fR 4 |
| 668 |
.IX Item "-num_tickets" |
| 669 |
Control the number of tickets that will be sent to the client after a full |
| 670 |
handshake in TLSv1.3. The default number of tickets is 2. This option does not |
| 671 |
affect the number of tickets sent after a resumption handshake. |
| 672 |
.IP "\fB\-dhparam\fR \fIinfile\fR" 4 |
| 673 |
.IX Item "-dhparam infile" |
| 674 |
The DH parameter file to use. The ephemeral DH cipher suites generate keys |
| 675 |
using a set of DH parameters. If not specified then an attempt is made to |
| 676 |
load the parameters from the server certificate file. |
| 677 |
If this fails then a static set of parameters hard coded into this command |
| 678 |
will be used. |
| 679 |
.IP \fB\-nbio\fR 4 |
| 680 |
.IX Item "-nbio" |
| 681 |
Turns on non blocking I/O. |
| 682 |
.IP \fB\-timeout\fR 4 |
| 683 |
.IX Item "-timeout" |
| 684 |
Enable timeouts. |
| 685 |
.IP \fB\-mtu\fR 4 |
| 686 |
.IX Item "-mtu" |
| 687 |
Set link-layer MTU. |
| 688 |
.IP "\fB\-psk_identity\fR \fIval\fR" 4 |
| 689 |
.IX Item "-psk_identity val" |
| 690 |
Expect the client to send PSK identity \fIval\fR when using a PSK |
| 691 |
cipher suite, and warn if they do not. By default, the expected PSK |
| 692 |
identity is the string "Client_identity". |
| 693 |
.IP "\fB\-psk_hint\fR \fIval\fR" 4 |
| 694 |
.IX Item "-psk_hint val" |
| 695 |
Use the PSK identity hint \fIval\fR when using a PSK cipher suite. |
| 696 |
.IP "\fB\-psk\fR \fIval\fR" 4 |
| 697 |
.IX Item "-psk val" |
| 698 |
Use the PSK key \fIval\fR when using a PSK cipher suite. The key is |
| 699 |
given as a hexadecimal number without leading 0x, for example \-psk |
| 700 |
1a2b3c4d. |
| 701 |
This option must be provided in order to use a PSK cipher. |
| 702 |
.IP "\fB\-psk_session\fR \fIfile\fR" 4 |
| 703 |
.IX Item "-psk_session file" |
| 704 |
Use the pem encoded SSL_SESSION data stored in \fIfile\fR as the basis of a PSK. |
| 705 |
Note that this will only work if TLSv1.3 is negotiated. |
| 706 |
.IP \fB\-srpvfile\fR 4 |
| 707 |
.IX Item "-srpvfile" |
| 708 |
The verifier file for SRP. |
| 709 |
This option is deprecated. |
| 710 |
.IP \fB\-srpuserseed\fR 4 |
| 711 |
.IX Item "-srpuserseed" |
| 712 |
A seed string for a default user salt. |
| 713 |
This option is deprecated. |
| 714 |
.IP \fB\-listen\fR 4 |
| 715 |
.IX Item "-listen" |
| 716 |
This option can only be used in conjunction with one of the DTLS options above. |
| 717 |
With this option, this command will listen on a UDP port for incoming |
| 718 |
connections. |
| 719 |
Any ClientHellos that arrive will be checked to see if they have a cookie in |
| 720 |
them or not. |
| 721 |
Any without a cookie will be responded to with a HelloVerifyRequest. |
| 722 |
If a ClientHello with a cookie is received then this command will |
| 723 |
connect to that peer and complete the handshake. |
| 724 |
.IP \fB\-sctp\fR 4 |
| 725 |
.IX Item "-sctp" |
| 726 |
Use SCTP for the transport protocol instead of UDP in DTLS. Must be used in |
| 727 |
conjunction with \fB\-dtls\fR, \fB\-dtls1\fR or \fB\-dtls1_2\fR. This option is only |
| 728 |
available where OpenSSL has support for SCTP enabled. |
| 729 |
.IP \fB\-sctp_label_bug\fR 4 |
| 730 |
.IX Item "-sctp_label_bug" |
| 731 |
Use the incorrect behaviour of older OpenSSL implementations when computing |
| 732 |
endpoint-pair shared secrets for DTLS/SCTP. This allows communication with |
| 733 |
older broken implementations but breaks interoperability with correct |
| 734 |
implementations. Must be used in conjunction with \fB\-sctp\fR. This option is only |
| 735 |
available where OpenSSL has support for SCTP enabled. |
| 736 |
.IP \fB\-use_srtp\fR 4 |
| 737 |
.IX Item "-use_srtp" |
| 738 |
Offer SRTP key management with a colon-separated profile list. |
| 739 |
.IP \fB\-no_dhe\fR 4 |
| 740 |
.IX Item "-no_dhe" |
| 741 |
If this option is set then no DH parameters will be loaded effectively |
| 742 |
disabling the ephemeral DH cipher suites. |
| 743 |
.IP "\fB\-alpn\fR \fIval\fR, \fB\-nextprotoneg\fR \fIval\fR" 4 |
| 744 |
.IX Item "-alpn val, -nextprotoneg val" |
| 745 |
These flags enable the Application-Layer Protocol Negotiation |
| 746 |
or Next Protocol Negotiation (NPN) extension, respectively. ALPN is the |
| 747 |
IETF standard and replaces NPN. |
| 748 |
The \fIval\fR list is a comma-separated list of supported protocol |
| 749 |
names. The list should contain the most desirable protocols first. |
| 750 |
Protocol names are printable ASCII strings, for example "http/1.1" or |
| 751 |
"spdy/3". |
| 752 |
The flag \fB\-nextprotoneg\fR cannot be specified if \fB\-tls1_3\fR is used. |
| 753 |
.IP \fB\-ktls\fR 4 |
| 754 |
.IX Item "-ktls" |
| 755 |
Enable Kernel TLS for sending and receiving. |
| 756 |
This option was introduced in OpenSSL 3.2.0. |
| 757 |
Kernel TLS is off by default as of OpenSSL 3.2.0. |
| 758 |
.IP \fB\-sendfile\fR 4 |
| 759 |
.IX Item "-sendfile" |
| 760 |
If this option is set and KTLS is enabled, \fBSSL_sendfile()\fR will be used |
| 761 |
instead of \fBBIO_write()\fR to send the HTTP response requested by a client. |
| 762 |
This option is only valid when \fB\-ktls\fR along with \fB\-WWW\fR or \fB\-HTTP\fR |
| 763 |
are specified. |
| 764 |
.IP \fB\-zerocopy_sendfile\fR 4 |
| 765 |
.IX Item "-zerocopy_sendfile" |
| 766 |
If this option is set, \fBSSL_sendfile()\fR will use the zerocopy TX mode, which gives |
| 767 |
a performance boost when used with KTLS hardware offload. Note that invalid |
| 768 |
TLS records might be transmitted if the file is changed while being sent. |
| 769 |
This option depends on \fB\-sendfile\fR; when used alone, \fB\-sendfile\fR is implied, |
| 770 |
and a warning is shown. Note that KTLS sendfile on FreeBSD always runs in the |
| 771 |
zerocopy mode. |
| 772 |
.IP "\fB\-keylogfile\fR \fIoutfile\fR" 4 |
| 773 |
.IX Item "-keylogfile outfile" |
| 774 |
Appends TLS secrets to the specified keylog file such that external programs |
| 775 |
(like Wireshark) can decrypt TLS connections. |
| 776 |
.IP "\fB\-max_early_data\fR \fIint\fR" 4 |
| 777 |
.IX Item "-max_early_data int" |
| 778 |
Change the default maximum early data bytes that are specified for new sessions |
| 779 |
and any incoming early data (when used in conjunction with the \fB\-early_data\fR |
| 780 |
flag). The default value is approximately 16k. The argument must be an integer |
| 781 |
greater than or equal to 0. |
| 782 |
.IP "\fB\-recv_max_early_data\fR \fIint\fR" 4 |
| 783 |
.IX Item "-recv_max_early_data int" |
| 784 |
Specify the hard limit on the maximum number of early data bytes that will |
| 785 |
be accepted. |
| 786 |
.IP \fB\-early_data\fR 4 |
| 787 |
.IX Item "-early_data" |
| 788 |
Accept early data where possible. Cannot be used in conjunction with \fB\-www\fR, |
| 789 |
\&\fB\-WWW\fR, \fB\-HTTP\fR or \fB\-rev\fR. |
| 790 |
.IP \fB\-stateless\fR 4 |
| 791 |
.IX Item "-stateless" |
| 792 |
Require TLSv1.3 cookies. |
| 793 |
.IP "\fB\-anti_replay\fR, \fB\-no_anti_replay\fR" 4 |
| 794 |
.IX Item "-anti_replay, -no_anti_replay" |
| 795 |
Switches replay protection on or off, respectively. Replay protection is on by |
| 796 |
default unless overridden by a configuration file. When it is on, OpenSSL will |
| 797 |
automatically detect if a session ticket has been used more than once, TLSv1.3 |
| 798 |
has been negotiated, and early data is enabled on the server. A full handshake |
| 799 |
is forced if a session ticket is used a second or subsequent time. Any early |
| 800 |
data that was sent will be rejected. |
| 801 |
.IP \fB\-tfo\fR 4 |
| 802 |
.IX Item "-tfo" |
| 803 |
Enable acceptance of TCP Fast Open (RFC7413) connections. |
| 804 |
.IP \fB\-cert_comp\fR 4 |
| 805 |
.IX Item "-cert_comp" |
| 806 |
Pre-compresses certificates (RFC8879) that will be sent during the handshake. |
| 807 |
.IP "\fB\-nameopt\fR \fIoption\fR" 4 |
| 808 |
.IX Item "-nameopt option" |
| 809 |
This specifies how the subject or issuer names are displayed. |
| 810 |
See \fBopenssl\-namedisplay\-options\fR\|(1) for details. |
| 811 |
.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 |
| 812 |
.IX Item "-no_ssl3, -no_tls1, -no_tls1_1, -no_tls1_2, -no_tls1_3, -ssl3, -tls1, -tls1_1, -tls1_2, -tls1_3" |
| 813 |
See "TLS Version Options" in \fBopenssl\fR\|(1). |
| 814 |
.IP "\fB\-dtls\fR, \fB\-dtls1\fR, \fB\-dtls1_2\fR" 4 |
| 815 |
.IX Item "-dtls, -dtls1, -dtls1_2" |
| 816 |
These specify the use of DTLS instead of TLS. |
| 817 |
See "TLS Version Options" in \fBopenssl\fR\|(1). |
| 818 |
.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 |
| 819 |
.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" |
| 820 |
See "SUPPORTED COMMAND LINE COMMANDS" in \fBSSL_CONF_cmd\fR\|(3) for details. |
| 821 |
.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 |
| 822 |
.IX Item "-xkey infile, -xcert file, -xchain file, -xchain_build file, -xcertform DER|PEM, -xkeyform DER|PEM" |
| 823 |
Set extended certificate verification options. |
| 824 |
See "Extended Verification Options" in \fBopenssl\-verification\-options\fR\|(1) for details. |
| 825 |
.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 |
| 826 |
.IX Item "-CAfile file, -no-CAfile, -CApath dir, -no-CApath, -CAstore uri, -no-CAstore" |
| 827 |
See "Trusted Certificate Options" in \fBopenssl\-verification\-options\fR\|(1) for details. |
| 828 |
.IP "\fB\-rand\fR \fIfiles\fR, \fB\-writerand\fR \fIfile\fR" 4 |
| 829 |
.IX Item "-rand files, -writerand file" |
| 830 |
See "Random State Options" in \fBopenssl\fR\|(1) for details. |
| 831 |
.IP "\fB\-engine\fR \fIid\fR" 4 |
| 832 |
.IX Item "-engine id" |
| 833 |
See "Engine Options" in \fBopenssl\fR\|(1). |
| 834 |
This option is deprecated. |
| 835 |
.IP "\fB\-provider\fR \fIname\fR" 4 |
| 836 |
.IX Item "-provider name" |
| 837 |
.PD 0 |
| 838 |
.IP "\fB\-provider\-path\fR \fIpath\fR" 4 |
| 839 |
.IX Item "-provider-path path" |
| 840 |
.IP "\fB\-provparam\fR \fI[name:]key=value\fR" 4 |
| 841 |
.IX Item "-provparam [name:]key=value" |
| 842 |
.IP "\fB\-propquery\fR \fIpropq\fR" 4 |
| 843 |
.IX Item "-propquery propq" |
| 844 |
.PD |
| 845 |
See "Provider Options" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7). |
| 846 |
.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 |
| 847 |
.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" |
| 848 |
Set various options of certificate chain verification. |
| 849 |
See "Verification Options" in \fBopenssl\-verification\-options\fR\|(1) for details. |
| 850 |
.Sp |
| 851 |
If the server requests a client certificate, then |
| 852 |
verification errors are displayed, for debugging, but the command will |
| 853 |
proceed unless the \fB\-verify_return_error\fR option is used. |
| 854 |
.IP \fB\-enable_server_rpk\fR 4 |
| 855 |
.IX Item "-enable_server_rpk" |
| 856 |
Enable support for sending raw public keys (RFC7250) to the client. |
| 857 |
A raw public key will be sent by the server, if solicited by the client, |
| 858 |
provided a suitable key and public certificate pair is configured. |
| 859 |
Clients that don't support raw public keys or prefer to use X.509 |
| 860 |
certificates can still elect to receive X.509 certificates as usual. |
| 861 |
.Sp |
| 862 |
Raw public keys are extracted from the configured certificate/private key. |
| 863 |
.IP \fB\-enable_client_rpk\fR 4 |
| 864 |
.IX Item "-enable_client_rpk" |
| 865 |
Enable support for receiving raw public keys (RFC7250) from the client. |
| 866 |
Use of X.509 certificates by the client becomes optional, and clients that |
| 867 |
support raw public keys may elect to use them. |
| 868 |
Clients that don't support raw public keys or prefer to use X.509 |
| 869 |
certificates can still elect to send X.509 certificates as usual. |
| 870 |
.Sp |
| 871 |
Raw public keys are extracted from the configured certificate/private key. |
| 872 |
.SH "CONNECTED COMMANDS" |
| 873 |
.IX Header "CONNECTED COMMANDS" |
| 874 |
If a connection request is established with an SSL client and neither the |
| 875 |
\&\fB\-www\fR nor the \fB\-WWW\fR option has been used then normally any data received |
| 876 |
from the client is displayed and any key presses will be sent to the client. |
| 877 |
.PP |
| 878 |
Certain commands are also recognized which perform special operations. These |
| 879 |
commands are a letter which must appear at the start of a line. They are listed |
| 880 |
below. |
| 881 |
.IP \fBq\fR 4 |
| 882 |
.IX Item "q" |
| 883 |
End the current SSL connection but still accept new connections. |
| 884 |
.IP \fBQ\fR 4 |
| 885 |
.IX Item "Q" |
| 886 |
End the current SSL connection and exit. |
| 887 |
.IP \fBr\fR 4 |
| 888 |
.IX Item "r" |
| 889 |
Renegotiate the SSL session (TLSv1.2 and below only). |
| 890 |
.IP \fBR\fR 4 |
| 891 |
.IX Item "R" |
| 892 |
Renegotiate the SSL session and request a client certificate (TLSv1.2 and below |
| 893 |
only). |
| 894 |
.IP \fBP\fR 4 |
| 895 |
.IX Item "P" |
| 896 |
Send some plain text down the underlying TCP connection: this should |
| 897 |
cause the client to disconnect due to a protocol violation. |
| 898 |
.IP \fBS\fR 4 |
| 899 |
.IX Item "S" |
| 900 |
Print out some session cache status information. |
| 901 |
.IP \fBk\fR 4 |
| 902 |
.IX Item "k" |
| 903 |
Send a key update message to the client (TLSv1.3 only) |
| 904 |
.IP \fBK\fR 4 |
| 905 |
.IX Item "K" |
| 906 |
Send a key update message to the client and request one back (TLSv1.3 only) |
| 907 |
.IP \fBc\fR 4 |
| 908 |
.IX Item "c" |
| 909 |
Send a certificate request to the client (TLSv1.3 only) |
| 910 |
.SH NOTES |
| 911 |
.IX Header "NOTES" |
| 912 |
This command can be used to debug SSL clients. To accept connections |
| 913 |
from a web browser the command: |
| 914 |
.PP |
| 915 |
.Vb 1 |
| 916 |
\& openssl s_server \-accept 443 \-www |
| 917 |
.Ve |
| 918 |
.PP |
| 919 |
can be used for example. |
| 920 |
.PP |
| 921 |
Although specifying an empty list of CAs when requesting a client certificate |
| 922 |
is strictly speaking a protocol violation, some SSL clients interpret this to |
| 923 |
mean any CA is acceptable. This is useful for debugging purposes. |
| 924 |
.PP |
| 925 |
The session parameters can printed out using the \fBopenssl\-sess_id\fR\|(1) command. |
| 926 |
.SH BUGS |
| 927 |
.IX Header "BUGS" |
| 928 |
Because this program has a lot of options and also because some of the |
| 929 |
techniques used are rather old, the C source for this command is rather |
| 930 |
hard to read and not a model of how things should be done. |
| 931 |
A typical SSL server program would be much simpler. |
| 932 |
.PP |
| 933 |
The output of common ciphers is wrong: it just gives the list of ciphers that |
| 934 |
OpenSSL recognizes and the client supports. |
| 935 |
.PP |
| 936 |
There should be a way for this command to print out details |
| 937 |
of any unknown cipher suites a client says it supports. |
| 938 |
.SH "SEE ALSO" |
| 939 |
.IX Header "SEE ALSO" |
| 940 |
\&\fBopenssl\fR\|(1), |
| 941 |
\&\fBopenssl\-sess_id\fR\|(1), |
| 942 |
\&\fBopenssl\-s_client\fR\|(1), |
| 943 |
\&\fBopenssl\-ciphers\fR\|(1), |
| 944 |
\&\fBSSL_CONF_cmd\fR\|(3), |
| 945 |
\&\fBSSL_CTX_set_max_send_fragment\fR\|(3), |
| 946 |
\&\fBSSL_CTX_set_split_send_fragment\fR\|(3), |
| 947 |
\&\fBSSL_CTX_set_max_pipelines\fR\|(3), |
| 948 |
\&\fBossl_store\-file\fR\|(7) |
| 949 |
.SH HISTORY |
| 950 |
.IX Header "HISTORY" |
| 951 |
The \-no_alt_chains option was added in OpenSSL 1.1.0. |
| 952 |
.PP |
| 953 |
The |
| 954 |
\&\-allow\-no\-dhe\-kex and \-prioritize_chacha options were added in OpenSSL 1.1.1. |
| 955 |
.PP |
| 956 |
The \fB\-srpvfile\fR, \fB\-srpuserseed\fR, and \fB\-engine\fR |
| 957 |
option were deprecated in OpenSSL 3.0. |
| 958 |
.PP |
| 959 |
The |
| 960 |
\&\fB\-enable_client_rpk\fR, |
| 961 |
\&\fB\-enable_server_rpk\fR, |
| 962 |
\&\fB\-no_rx_cert_comp\fR, |
| 963 |
\&\fB\-no_tx_cert_comp\fR, |
| 964 |
and \fB\-tfo\fR |
| 965 |
options were added in OpenSSL 3.2. |
| 966 |
.PP |
| 967 |
The \fB\-status_all\fR option was added in OpenSSL 3.6. |
| 968 |
.SH COPYRIGHT |
| 969 |
.IX Header "COPYRIGHT" |
| 970 |
Copyright 2000\-2025 The OpenSSL Project Authors. All Rights Reserved. |
| 971 |
.PP |
| 972 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 973 |
this file except in compliance with the License. You can obtain a copy |
| 974 |
in the file LICENSE in the source distribution or at |
| 975 |
<https://www.openssl.org/source/license.html>. |