1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
54 .\" Avoid warning from groff about undefined register 'F'.
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
62 . tm Index:\\$1\t\\n%\t"\\$2"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear. Run. Save yourself. No user-serviceable parts.
74 . \" fudge factors for nroff and troff
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89 . \" simple accents for nroff and troff
99 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
106 . \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 . \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 . \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
133 .\" ========================================================================
135 .IX Title "S_SERVER 1"
136 .TH S_SERVER 1 "2022-05-03" "1.1.1o" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 openssl\-s_server, s_server \- SSL/TLS server program
144 .IX Header "SYNOPSIS"
145 \&\fBopenssl\fR \fBs_server\fR
153 [\fB\-context val\fR]
156 [\fB\-cert infile\fR]
157 [\fB\-nameopt val\fR]
158 [\fB\-naccept +int\fR]
159 [\fB\-serverinfo val\fR]
160 [\fB\-certform PEM|DER\fR]
162 [\fB\-keyform format\fR]
164 [\fB\-dcert infile\fR]
165 [\fB\-dcertform PEM|DER\fR]
166 [\fB\-dkey infile\fR]
167 [\fB\-dkeyform PEM|DER\fR]
173 [\fB\-msgfile outfile\fR]
175 [\fB\-CAfile infile\fR]
181 [\fB\-no_resume_ephemeral\fR]
185 [\fB\-servername_fatal\fR]
186 [\fB\-cert2 infile\fR]
187 [\fB\-key2 infile\fR]
188 [\fB\-tlsextdebug\fR]
190 [\fB\-id_prefix val\fR]
191 [\fB\-rand file...\fR]
192 [\fB\-writerand file\fR]
193 [\fB\-keymatexport val\fR]
194 [\fB\-keymatexportlen +int\fR]
196 [\fB\-crl_download\fR]
197 [\fB\-cert_chain infile\fR]
198 [\fB\-dcert_chain infile\fR]
199 [\fB\-chainCApath dir\fR]
200 [\fB\-verifyCApath dir\fR]
203 [\fB\-CRLform PEM|DER\fR]
204 [\fB\-verify_return_error\fR]
205 [\fB\-verify_quiet\fR]
206 [\fB\-build_chain\fR]
207 [\fB\-chainCAfile infile\fR]
208 [\fB\-verifyCAfile infile\fR]
212 [\fB\-status_verbose\fR]
213 [\fB\-status_timeout int\fR]
214 [\fB\-status_url val\fR]
215 [\fB\-status_file infile\fR]
217 [\fB\-security_debug\fR]
218 [\fB\-security_debug_verbose\fR]
222 [\fB\-ssl_config val\fR]
223 [\fB\-max_send_frag +int\fR]
224 [\fB\-split_send_frag +int\fR]
225 [\fB\-max_pipelines +int\fR]
226 [\fB\-read_buf +int\fR]
236 [\fB\-num_tickets\fR]
238 [\fB\-legacy_renegotiation\fR]
239 [\fB\-no_renegotiation\fR]
240 [\fB\-legacy_server_connect\fR]
241 [\fB\-no_resumption_on_reneg\fR]
242 [\fB\-no_legacy_server_connect\fR]
243 [\fB\-allow_no_dhe_kex\fR]
244 [\fB\-prioritize_chacha\fR]
246 [\fB\-sigalgs val\fR]
247 [\fB\-client_sigalgs val\fR]
250 [\fB\-named_curve val\fR]
252 [\fB\-ciphersuites val\fR]
253 [\fB\-dhparam infile\fR]
254 [\fB\-record_padding val\fR]
255 [\fB\-debug_broken_protocol\fR]
257 [\fB\-purpose val\fR]
258 [\fB\-verify_name val\fR]
259 [\fB\-verify_depth int\fR]
260 [\fB\-auth_level int\fR]
261 [\fB\-attime intmax\fR]
262 [\fB\-verify_hostname val\fR]
263 [\fB\-verify_email val\fR]
265 [\fB\-ignore_critical\fR]
266 [\fB\-issuer_checks\fR]
268 [\fB\-crl_check_all\fR]
269 [\fB\-policy_check\fR]
270 [\fB\-explicit_policy\fR]
271 [\fB\-inhibit_any\fR]
272 [\fB\-inhibit_map\fR]
273 [\fB\-x509_strict\fR]
274 [\fB\-extended_crl\fR]
276 [\fB\-policy_print\fR]
277 [\fB\-check_ss_sig\fR]
278 [\fB\-trusted_first\fR]
279 [\fB\-suiteB_128_only\fR]
282 [\fB\-partial_chain\fR]
283 [\fB\-no_alt_chains\fR]
284 [\fB\-no_check_time\fR]
285 [\fB\-allow_proxy_certs\fR]
289 [\fB\-xchain_build\fR]
290 [\fB\-xcertform PEM|DER\fR]
291 [\fB\-xkeyform PEM|DER\fR]
293 [\fB\-psk_identity val\fR]
294 [\fB\-psk_hint val\fR]
296 [\fB\-psk_session file\fR]
297 [\fB\-srpvfile infile\fR]
298 [\fB\-srpuserseed val\fR]
311 [\fB\-sctp_label_bug\fR]
313 [\fB\-nextprotoneg val\fR]
314 [\fB\-use_srtp val\fR]
317 [\fB\-keylogfile outfile\fR]
318 [\fB\-max_early_data int\fR]
320 [\fB\-anti_replay\fR]
321 [\fB\-no_anti_replay\fR]
323 .IX Header "DESCRIPTION"
324 The \fBs_server\fR command implements a generic \s-1SSL/TLS\s0 server which listens
325 for connections on a given port using \s-1SSL/TLS.\s0
328 In addition to the options below the \fBs_server\fR utility also supports the
329 common and server only options documented
330 in the \*(L"Supported Command Line Commands\*(R" section of the \fBSSL_CONF_cmd\fR\|(3)
334 Print out a usage message.
335 .IP "\fB\-port +int\fR" 4
336 .IX Item "-port +int"
337 The \s-1TCP\s0 port to listen on for connections. If not specified 4433 is used.
338 .IP "\fB\-accept val\fR" 4
339 .IX Item "-accept val"
340 The optional \s-1TCP\s0 host and port to listen on for connections. If not specified, *:4433 is used.
341 .IP "\fB\-unix val\fR" 4
343 Unix domain socket to accept on.
350 .IP "\fB\-unlink\fR" 4
352 For \-unix, unlink any existing socket first.
353 .IP "\fB\-context val\fR" 4
354 .IX Item "-context val"
355 Sets the \s-1SSL\s0 context id. It can be given any string value. If this option
356 is not present a default value will be used.
357 .IP "\fB\-verify int\fR, \fB\-Verify int\fR" 4
358 .IX Item "-verify int, -Verify int"
359 The verify depth to use. This specifies the maximum length of the
360 client certificate chain and makes the server request a certificate from
361 the client. With the \fB\-verify\fR option a certificate is requested but the
362 client does not have to send one, with the \fB\-Verify\fR option the client
363 must supply a certificate or an error occurs.
365 If the cipher suite cannot request a client certificate (for example an
366 anonymous cipher suite or \s-1PSK\s0) this option has no effect.
367 .IP "\fB\-cert infile\fR" 4
368 .IX Item "-cert infile"
369 The certificate to use, most servers cipher suites require the use of a
370 certificate and some require a certificate with a certain public key type:
371 for example the \s-1DSS\s0 cipher suites require a certificate containing a \s-1DSS\s0
372 (\s-1DSA\s0) key. If not specified then the filename \*(L"server.pem\*(R" will be used.
373 .IP "\fB\-cert_chain\fR" 4
374 .IX Item "-cert_chain"
375 A file containing trusted certificates to use when attempting to build the
376 client/server certificate chain related to the certificate specified via the
377 \&\fB\-cert\fR option.
378 .IP "\fB\-build_chain\fR" 4
379 .IX Item "-build_chain"
380 Specify whether the application should build the certificate chain to be
381 provided to the client.
382 .IP "\fB\-nameopt val\fR" 4
383 .IX Item "-nameopt val"
384 Option which determines how the subject or issuer names are displayed. The
385 \&\fBval\fR argument can be a single option or multiple options separated by
386 commas. Alternatively the \fB\-nameopt\fR switch may be used more than once to
387 set multiple options. See the \fBx509\fR\|(1) manual page for details.
388 .IP "\fB\-naccept +int\fR" 4
389 .IX Item "-naccept +int"
390 The server will exit after receiving the specified number of connections,
392 .IP "\fB\-serverinfo val\fR" 4
393 .IX Item "-serverinfo val"
394 A file containing one or more blocks of \s-1PEM\s0 data. Each \s-1PEM\s0 block
395 must encode a \s-1TLS\s0 ServerHello extension (2 bytes type, 2 bytes length,
396 followed by \*(L"length\*(R" bytes of extension data). If the client sends
397 an empty \s-1TLS\s0 ClientHello extension matching the type, the corresponding
398 ServerHello extension will be returned.
399 .IP "\fB\-certform PEM|DER\fR" 4
400 .IX Item "-certform PEM|DER"
401 The certificate format to use: \s-1DER\s0 or \s-1PEM. PEM\s0 is the default.
402 .IP "\fB\-key infile\fR" 4
403 .IX Item "-key infile"
404 The private key to use. If not specified then the certificate file will
406 .IP "\fB\-keyform format\fR" 4
407 .IX Item "-keyform format"
408 The private format to use: \s-1DER\s0 or \s-1PEM. PEM\s0 is the default.
409 .IP "\fB\-pass val\fR" 4
411 The private key password source. For more information about the format of \fBval\fR
412 see \*(L"Pass Phrase Options\*(R" in \fBopenssl\fR\|(1).
413 .IP "\fB\-dcert infile\fR, \fB\-dkey infile\fR" 4
414 .IX Item "-dcert infile, -dkey infile"
415 Specify an additional certificate and private key, these behave in the
416 same manner as the \fB\-cert\fR and \fB\-key\fR options except there is no default
417 if they are not specified (no additional certificate and key is used). As
418 noted above some cipher suites require a certificate containing a key of
419 a certain type. Some cipher suites need a certificate carrying an \s-1RSA\s0 key
420 and some a \s-1DSS\s0 (\s-1DSA\s0) key. By using \s-1RSA\s0 and \s-1DSS\s0 certificates and keys
421 a server can support clients which only support \s-1RSA\s0 or \s-1DSS\s0 cipher suites
422 by using an appropriate certificate.
423 .IP "\fB\-dcert_chain\fR" 4
424 .IX Item "-dcert_chain"
425 A file containing trusted certificates to use when attempting to build the
426 server certificate chain when a certificate specified via the \fB\-dcert\fR option
428 .IP "\fB\-dcertform PEM|DER\fR, \fB\-dkeyform PEM|DER\fR, \fB\-dpass val\fR" 4
429 .IX Item "-dcertform PEM|DER, -dkeyform PEM|DER, -dpass val"
430 Additional certificate and private key format and passphrase respectively.
431 .IP "\fB\-xkey infile\fR, \fB\-xcert infile\fR, \fB\-xchain\fR" 4
432 .IX Item "-xkey infile, -xcert infile, -xchain"
433 Specify an extra certificate, private key and certificate chain. These behave
434 in the same manner as the \fB\-cert\fR, \fB\-key\fR and \fB\-cert_chain\fR options. When
435 specified, the callback returning the first valid chain will be in use by
437 .IP "\fB\-xchain_build\fR" 4
438 .IX Item "-xchain_build"
439 Specify whether the application should build the certificate chain to be
440 provided to the client for the extra certificates provided via \fB\-xkey infile\fR,
441 \&\fB\-xcert infile\fR, \fB\-xchain\fR options.
442 .IP "\fB\-xcertform PEM|DER\fR, \fB\-xkeyform PEM|DER\fR" 4
443 .IX Item "-xcertform PEM|DER, -xkeyform PEM|DER"
444 Extra certificate and private key format respectively.
445 .IP "\fB\-nbio_test\fR" 4
446 .IX Item "-nbio_test"
447 Tests non blocking I/O.
450 This option translated a line feed from the terminal into \s-1CR+LF.\s0
451 .IP "\fB\-debug\fR" 4
453 Print extensive debugging information including a hex dump of all traffic.
456 Show all protocol messages with hex dump.
457 .IP "\fB\-msgfile outfile\fR" 4
458 .IX Item "-msgfile outfile"
459 File to send output of \fB\-msg\fR or \fB\-trace\fR to, default standard output.
460 .IP "\fB\-state\fR" 4
462 Prints the \s-1SSL\s0 session states.
463 .IP "\fB\-CAfile infile\fR" 4
464 .IX Item "-CAfile infile"
465 A file containing trusted certificates to use during client authentication
466 and to use when attempting to build the server certificate chain. The list
467 is also used in the list of acceptable client CAs passed to the client when
468 a certificate is requested.
469 .IP "\fB\-CApath dir\fR" 4
470 .IX Item "-CApath dir"
471 The directory to use for client certificate verification. This directory
472 must be in \*(L"hash format\*(R", see \fBverify\fR\|(1) for more information. These are
473 also used when building the server certificate chain.
474 .IP "\fB\-chainCApath dir\fR" 4
475 .IX Item "-chainCApath dir"
476 The directory to use for building the chain provided to the client. This
477 directory must be in \*(L"hash format\*(R", see \fBverify\fR\|(1) for more information.
478 .IP "\fB\-chainCAfile file\fR" 4
479 .IX Item "-chainCAfile file"
480 A file containing trusted certificates to use when attempting to build the
481 server certificate chain.
482 .IP "\fB\-no\-CAfile\fR" 4
483 .IX Item "-no-CAfile"
484 Do not load the trusted \s-1CA\s0 certificates from the default file location.
485 .IP "\fB\-no\-CApath\fR" 4
486 .IX Item "-no-CApath"
487 Do not load the trusted \s-1CA\s0 certificates from the default directory location.
488 .IP "\fB\-nocert\fR" 4
490 If this option is set then no certificate is used. This restricts the
491 cipher suites available to the anonymous ones (currently just anonymous
493 .IP "\fB\-quiet\fR" 4
495 Inhibit printing of session and certificate information.
498 Sends a status message back to the client when it connects. This includes
499 information about the ciphers used and various session parameters.
500 The output is in \s-1HTML\s0 format so this option will normally be used with a
501 web browser. Cannot be used in conjunction with \fB\-early_data\fR.
504 Emulates a simple web server. Pages will be resolved relative to the
505 current directory, for example if the \s-1URL\s0 https://myhost/page.html is
506 requested the file ./page.html will be loaded. Cannot be used in conjunction
507 with \fB\-early_data\fR.
508 .IP "\fB\-tlsextdebug\fR" 4
509 .IX Item "-tlsextdebug"
510 Print a hex dump of any \s-1TLS\s0 extensions received from the server.
513 Emulates a simple web server. Pages will be resolved relative to the
514 current directory, for example if the \s-1URL\s0 https://myhost/page.html is
515 requested the file ./page.html will be loaded. The files loaded are
516 assumed to contain a complete and correct \s-1HTTP\s0 response (lines that
517 are part of the \s-1HTTP\s0 response line and headers must end with \s-1CRLF\s0). Cannot be
518 used in conjunction with \fB\-early_data\fR.
519 .IP "\fB\-id_prefix val\fR" 4
520 .IX Item "-id_prefix val"
521 Generate \s-1SSL/TLS\s0 session IDs prefixed by \fBval\fR. This is mostly useful
522 for testing any \s-1SSL/TLS\s0 code (e.g. proxies) that wish to deal with multiple
523 servers, when each of which might be generating a unique range of session
524 IDs (e.g. with a certain prefix).
525 .IP "\fB\-rand file...\fR" 4
526 .IX Item "-rand file..."
527 A file or files containing random data used to seed the random number
529 Multiple files can be specified separated by an OS-dependent character.
530 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
532 .IP "[\fB\-writerand file\fR]" 4
533 .IX Item "[-writerand file]"
534 Writes random data to the specified \fIfile\fR upon exit.
535 This can be used with a subsequent \fB\-rand\fR flag.
536 .IP "\fB\-verify_return_error\fR" 4
537 .IX Item "-verify_return_error"
538 Verification errors normally just print a message but allow the
539 connection to continue, for debugging purposes.
540 If this option is used, then verification errors close the connection.
541 .IP "\fB\-status\fR" 4
543 Enables certificate status request support (aka \s-1OCSP\s0 stapling).
544 .IP "\fB\-status_verbose\fR" 4
545 .IX Item "-status_verbose"
546 Enables certificate status request support (aka \s-1OCSP\s0 stapling) and gives
547 a verbose printout of the \s-1OCSP\s0 response.
548 .IP "\fB\-status_timeout int\fR" 4
549 .IX Item "-status_timeout int"
550 Sets the timeout for \s-1OCSP\s0 response to \fBint\fR seconds.
551 .IP "\fB\-status_url val\fR" 4
552 .IX Item "-status_url val"
553 Sets a fallback responder \s-1URL\s0 to use if no responder \s-1URL\s0 is present in the
554 server certificate. Without this option an error is returned if the server
555 certificate does not contain a responder address.
556 .IP "\fB\-status_file infile\fR" 4
557 .IX Item "-status_file infile"
558 Overrides any \s-1OCSP\s0 responder URLs from the certificate and always provides the
559 \&\s-1OCSP\s0 Response stored in the file. The file must be in \s-1DER\s0 format.
560 .IP "\fB\-trace\fR" 4
562 Show verbose trace output of protocol messages. OpenSSL needs to be compiled
563 with \fBenable-ssl-trace\fR for this option to work.
564 .IP "\fB\-brief\fR" 4
566 Provide a brief summary of connection parameters instead of the normal verbose
570 Simple test server which just reverses the text received from the client
571 and sends it back to the server. Also sets \fB\-brief\fR. Cannot be used in
572 conjunction with \fB\-early_data\fR.
573 .IP "\fB\-async\fR" 4
575 Switch on asynchronous mode. Cryptographic operations will be performed
576 asynchronously. This will only have an effect if an asynchronous capable engine
577 is also used via the \fB\-engine\fR option. For test purposes the dummy async engine
578 (dasync) can be used (if available).
579 .IP "\fB\-max_send_frag +int\fR" 4
580 .IX Item "-max_send_frag +int"
581 The maximum size of data fragment to send.
582 See \fBSSL_CTX_set_max_send_fragment\fR\|(3) for further information.
583 .IP "\fB\-split_send_frag +int\fR" 4
584 .IX Item "-split_send_frag +int"
585 The size used to split data for encrypt pipelines. If more data is written in
586 one go than this value then it will be split into multiple pipelines, up to the
587 maximum number of pipelines defined by max_pipelines. This only has an effect if
588 a suitable cipher suite has been negotiated, an engine that supports pipelining
589 has been loaded, and max_pipelines is greater than 1. See
590 \&\fBSSL_CTX_set_split_send_fragment\fR\|(3) for further information.
591 .IP "\fB\-max_pipelines +int\fR" 4
592 .IX Item "-max_pipelines +int"
593 The maximum number of encrypt/decrypt pipelines to be used. This will only have
594 an effect if an engine has been loaded that supports pipelining (e.g. the dasync
595 engine) and a suitable cipher suite has been negotiated. The default value is 1.
596 See \fBSSL_CTX_set_max_pipelines\fR\|(3) for further information.
597 .IP "\fB\-read_buf +int\fR" 4
598 .IX Item "-read_buf +int"
599 The default read buffer size to be used for connections. This will only have an
600 effect if the buffer size is larger than the size that would otherwise be used
601 and pipelining is in use (see \fBSSL_CTX_set_default_read_buffer_len\fR\|(3) for
602 further information).
603 .IP "\fB\-ssl2\fR, \fB\-ssl3\fR, \fB\-tls1\fR, \fB\-tls1_1\fR, \fB\-tls1_2\fR, \fB\-tls1_3\fR, \fB\-no_ssl2\fR, \fB\-no_ssl3\fR, \fB\-no_tls1\fR, \fB\-no_tls1_1\fR, \fB\-no_tls1_2\fR, \fB\-no_tls1_3\fR" 4
604 .IX Item "-ssl2, -ssl3, -tls1, -tls1_1, -tls1_2, -tls1_3, -no_ssl2, -no_ssl3, -no_tls1, -no_tls1_1, -no_tls1_2, -no_tls1_3"
605 These options require or disable the use of the specified \s-1SSL\s0 or \s-1TLS\s0 protocols.
606 By default \fBs_server\fR will negotiate the highest mutually supported protocol
608 When a specific \s-1TLS\s0 version is required, only that version will be accepted
610 Note that not all protocols and flags may be available, depending on how
614 There are several known bugs in \s-1SSL\s0 and \s-1TLS\s0 implementations. Adding this
615 option enables various workarounds.
616 .IP "\fB\-no_comp\fR" 4
618 Disable negotiation of \s-1TLS\s0 compression.
619 \&\s-1TLS\s0 compression is not recommended and is off by default as of
623 Enable negotiation of \s-1TLS\s0 compression.
624 This option was introduced in OpenSSL 1.1.0.
625 \&\s-1TLS\s0 compression is not recommended and is off by default as of
627 .IP "\fB\-no_ticket\fR" 4
628 .IX Item "-no_ticket"
629 Disable RFC4507bis session ticket support. This option has no effect if TLSv1.3
630 is negotiated. See \fB\-num_tickets\fR.
631 .IP "\fB\-num_tickets\fR" 4
632 .IX Item "-num_tickets"
633 Control the number of tickets that will be sent to the client after a full
634 handshake in TLSv1.3. The default number of tickets is 2. This option does not
635 affect the number of tickets sent after a resumption handshake.
636 .IP "\fB\-serverpref\fR" 4
637 .IX Item "-serverpref"
638 Use the server's cipher preferences, rather than the client's preferences.
639 .IP "\fB\-prioritize_chacha\fR" 4
640 .IX Item "-prioritize_chacha"
641 Prioritize ChaCha ciphers when preferred by clients. Requires \fB\-serverpref\fR.
642 .IP "\fB\-no_resumption_on_reneg\fR" 4
643 .IX Item "-no_resumption_on_reneg"
644 Set the \fB\s-1SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION\s0\fR option.
645 .IP "\fB\-client_sigalgs val\fR" 4
646 .IX Item "-client_sigalgs val"
647 Signature algorithms to support for client certificate authentication
648 (colon-separated list).
649 .IP "\fB\-named_curve val\fR" 4
650 .IX Item "-named_curve val"
651 Specifies the elliptic curve to use. \s-1NOTE:\s0 this is single curve, not a list.
652 For a list of all possible curves, use:
655 \& $ openssl ecparam \-list_curves
657 .IP "\fB\-cipher val\fR" 4
658 .IX Item "-cipher val"
659 This allows the list of TLSv1.2 and below ciphersuites used by the server to be
660 modified. This list is combined with any TLSv1.3 ciphersuites that have been
661 configured. When the client sends a list of supported ciphers the first client
662 cipher also included in the server list is used. Because the client specifies
663 the preference order, the order of the server cipherlist is irrelevant. See
664 the \fBciphers\fR command for more information.
665 .IP "\fB\-ciphersuites val\fR" 4
666 .IX Item "-ciphersuites val"
667 This allows the list of TLSv1.3 ciphersuites used by the server to be modified.
668 This list is combined with any TLSv1.2 and below ciphersuites that have been
669 configured. When the client sends a list of supported ciphers the first client
670 cipher also included in the server list is used. Because the client specifies
671 the preference order, the order of the server cipherlist is irrelevant. See
672 the \fBciphers\fR command for more information. The format for this list is a
673 simple colon (\*(L":\*(R") separated list of TLSv1.3 ciphersuite names.
674 .IP "\fB\-dhparam infile\fR" 4
675 .IX Item "-dhparam infile"
676 The \s-1DH\s0 parameter file to use. The ephemeral \s-1DH\s0 cipher suites generate keys
677 using a set of \s-1DH\s0 parameters. If not specified then an attempt is made to
678 load the parameters from the server certificate file.
679 If this fails then a static set of parameters hard coded into the \fBs_server\fR
680 program will be used.
681 .IP "\fB\-attime\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\-no_check_time\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" 4
682 .IX Item "-attime, -check_ss_sig, -crl_check, -crl_check_all, -explicit_policy, -extended_crl, -ignore_critical, -inhibit_any, -inhibit_map, -no_alt_chains, -no_check_time, -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"
683 Set different peer certificate verification options.
684 See the \fBverify\fR\|(1) manual page for details.
685 .IP "\fB\-crl_check\fR, \fB\-crl_check_all\fR" 4
686 .IX Item "-crl_check, -crl_check_all"
687 Check the peer certificate has not been revoked by its \s-1CA.\s0
688 The \s-1CRL\s0(s) are appended to the certificate file. With the \fB\-crl_check_all\fR
689 option all CRLs of all CAs in the chain are checked.
692 Turns on non blocking I/O.
693 .IP "\fB\-psk_identity val\fR" 4
694 .IX Item "-psk_identity val"
695 Expect the client to send \s-1PSK\s0 identity \fBval\fR when using a \s-1PSK\s0
696 cipher suite, and warn if they do not. By default, the expected \s-1PSK\s0
697 identity is the string \*(L"Client_identity\*(R".
698 .IP "\fB\-psk_hint val\fR" 4
699 .IX Item "-psk_hint val"
700 Use the \s-1PSK\s0 identity hint \fBval\fR when using a \s-1PSK\s0 cipher suite.
701 .IP "\fB\-psk val\fR" 4
703 Use the \s-1PSK\s0 key \fBval\fR when using a \s-1PSK\s0 cipher suite. The key is
704 given as a hexadecimal number without leading 0x, for example \-psk
706 This option must be provided in order to use a \s-1PSK\s0 cipher.
707 .IP "\fB\-psk_session file\fR" 4
708 .IX Item "-psk_session file"
709 Use the pem encoded \s-1SSL_SESSION\s0 data stored in \fBfile\fR as the basis of a \s-1PSK.\s0
710 Note that this will only work if TLSv1.3 is negotiated.
711 .IP "\fB\-listen\fR" 4
713 This option can only be used in conjunction with one of the \s-1DTLS\s0 options above.
714 With this option \fBs_server\fR will listen on a \s-1UDP\s0 port for incoming connections.
715 Any ClientHellos that arrive will be checked to see if they have a cookie in
717 Any without a cookie will be responded to with a HelloVerifyRequest.
718 If a ClientHello with a cookie is received then \fBs_server\fR will connect to
719 that peer and complete the handshake.
720 .IP "\fB\-dtls\fR, \fB\-dtls1\fR, \fB\-dtls1_2\fR" 4
721 .IX Item "-dtls, -dtls1, -dtls1_2"
722 These options make \fBs_server\fR use \s-1DTLS\s0 protocols instead of \s-1TLS.\s0
723 With \fB\-dtls\fR, \fBs_server\fR will negotiate any supported \s-1DTLS\s0 protocol version,
724 whilst \fB\-dtls1\fR and \fB\-dtls1_2\fR will only support DTLSv1.0 and DTLSv1.2
728 Use \s-1SCTP\s0 for the transport protocol instead of \s-1UDP\s0 in \s-1DTLS.\s0 Must be used in
729 conjunction with \fB\-dtls\fR, \fB\-dtls1\fR or \fB\-dtls1_2\fR. This option is only
730 available where OpenSSL has support for \s-1SCTP\s0 enabled.
731 .IP "\fB\-sctp_label_bug\fR" 4
732 .IX Item "-sctp_label_bug"
733 Use the incorrect behaviour of older OpenSSL implementations when computing
734 endpoint-pair shared secrets for \s-1DTLS/SCTP.\s0 This allows communication with
735 older broken implementations but breaks interoperability with correct
736 implementations. Must be used in conjunction with \fB\-sctp\fR. This option is only
737 available where OpenSSL has support for \s-1SCTP\s0 enabled.
738 .IP "\fB\-no_dhe\fR" 4
740 If this option is set then no \s-1DH\s0 parameters will be loaded effectively
741 disabling the ephemeral \s-1DH\s0 cipher suites.
742 .IP "\fB\-alpn val\fR, \fB\-nextprotoneg val\fR" 4
743 .IX Item "-alpn val, -nextprotoneg val"
744 These flags enable the Application-Layer Protocol Negotiation
745 or Next Protocol Negotiation (\s-1NPN\s0) extension, respectively. \s-1ALPN\s0 is the
746 \&\s-1IETF\s0 standard and replaces \s-1NPN.\s0
747 The \fBval\fR list is a comma-separated list of supported protocol
748 names. The list should contain the most desirable protocols first.
749 Protocol names are printable \s-1ASCII\s0 strings, for example \*(L"http/1.1\*(R" or
751 The flag \fB\-nextprotoneg\fR cannot be specified if \fB\-tls1_3\fR is used.
752 .IP "\fB\-engine val\fR" 4
753 .IX Item "-engine val"
754 Specifying an engine (by its unique id string in \fBval\fR) will cause \fBs_server\fR
755 to attempt to obtain a functional reference to the specified engine,
756 thus initialising it if needed. The engine will then be set as the default
757 for all available algorithms.
758 .IP "\fB\-keylogfile outfile\fR" 4
759 .IX Item "-keylogfile outfile"
760 Appends \s-1TLS\s0 secrets to the specified keylog file such that external programs
761 (like Wireshark) can decrypt \s-1TLS\s0 connections.
762 .IP "\fB\-max_early_data int\fR" 4
763 .IX Item "-max_early_data int"
764 Change the default maximum early data bytes that are specified for new sessions
765 and any incoming early data (when used in conjunction with the \fB\-early_data\fR
766 flag). The default value is approximately 16k. The argument must be an integer
767 greater than or equal to 0.
768 .IP "\fB\-early_data\fR" 4
769 .IX Item "-early_data"
770 Accept early data where possible. Cannot be used in conjunction with \fB\-www\fR,
771 \&\fB\-WWW\fR, \fB\-HTTP\fR or \fB\-rev\fR.
772 .IP "\fB\-anti_replay\fR, \fB\-no_anti_replay\fR" 4
773 .IX Item "-anti_replay, -no_anti_replay"
774 Switches replay protection on or off, respectively. Replay protection is on by
775 default unless overridden by a configuration file. When it is on, OpenSSL will
776 automatically detect if a session ticket has been used more than once, TLSv1.3
777 has been negotiated, and early data is enabled on the server. A full handshake
778 is forced if a session ticket is used a second or subsequent time. Any early
779 data that was sent will be rejected.
780 .SH "CONNECTED COMMANDS"
781 .IX Header "CONNECTED COMMANDS"
782 If a connection request is established with an \s-1SSL\s0 client and neither the
783 \&\fB\-www\fR nor the \fB\-WWW\fR option has been used then normally any data received
784 from the client is displayed and any key presses will be sent to the client.
786 Certain commands are also recognized which perform special operations. These
787 commands are a letter which must appear at the start of a line. They are listed
791 End the current \s-1SSL\s0 connection but still accept new connections.
794 End the current \s-1SSL\s0 connection and exit.
797 Renegotiate the \s-1SSL\s0 session (TLSv1.2 and below only).
800 Renegotiate the \s-1SSL\s0 session and request a client certificate (TLSv1.2 and below
804 Send some plain text down the underlying \s-1TCP\s0 connection: this should
805 cause the client to disconnect due to a protocol violation.
808 Print out some session cache status information.
811 Send a heartbeat message to the client (\s-1DTLS\s0 only)
814 Send a key update message to the client (TLSv1.3 only)
817 Send a key update message to the client and request one back (TLSv1.3 only)
820 Send a certificate request to the client (TLSv1.3 only)
823 \&\fBs_server\fR can be used to debug \s-1SSL\s0 clients. To accept connections from
824 a web browser the command:
827 \& openssl s_server \-accept 443 \-www
830 can be used for example.
832 Although specifying an empty list of CAs when requesting a client certificate
833 is strictly speaking a protocol violation, some \s-1SSL\s0 clients interpret this to
834 mean any \s-1CA\s0 is acceptable. This is useful for debugging purposes.
836 The session parameters can printed out using the \fBsess_id\fR program.
839 Because this program has a lot of options and also because some of the
840 techniques used are rather old, the C source of \fBs_server\fR is rather hard to
841 read and not a model of how things should be done.
842 A typical \s-1SSL\s0 server program would be much simpler.
844 The output of common ciphers is wrong: it just gives the list of ciphers that
845 OpenSSL recognizes and the client supports.
847 There should be a way for the \fBs_server\fR program to print out details of any
848 unknown cipher suites a client says it supports.
850 .IX Header "SEE ALSO"
851 \&\fBSSL_CONF_cmd\fR\|(3), \fBsess_id\fR\|(1), \fBs_client\fR\|(1), \fBciphers\fR\|(1)
852 \&\fBSSL_CTX_set_max_send_fragment\fR\|(3),
853 \&\fBSSL_CTX_set_split_send_fragment\fR\|(3),
854 \&\fBSSL_CTX_set_max_pipelines\fR\|(3)
857 The \-no_alt_chains option was added in OpenSSL 1.1.0.
860 \&\-allow\-no\-dhe\-kex and \-prioritize_chacha options were added in OpenSSL 1.1.1.
862 .IX Header "COPYRIGHT"
863 Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
865 Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
866 this file except in compliance with the License. You can obtain a copy
867 in the file \s-1LICENSE\s0 in the source distribution or at
868 <https://www.openssl.org/source/license.html>.
projects / FreeBSD / FreeBSD.git / blob