be70cfcff5261f4efe499ebf922c148ceb53a0ca
[openssl.git] / doc / man1 / openssl-s_server.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-s_server - SSL/TLS server program
6
7 =head1 SYNOPSIS
8
9 B<openssl> B<s_server>
10 [B<-help>]
11 [B<-port> I<+int>]
12 [B<-accept> I<val>]
13 [B<-unix> I<val>]
14 [B<-4>]
15 [B<-6>]
16 [B<-unlink>]
17 [B<-context> I<val>]
18 [B<-verify> I<int>]
19 [B<-Verify> I<int>]
20 [B<-cert> I<infile>]
21 [B<-nameopt> I<val>]
22 [B<-naccept> I<+int>]
23 [B<-serverinfo> I<val>]
24 [B<-certform> B<DER>|B<PEM>]
25 [B<-key> I<infile>]
26 [B<-keyform> B<DER>|B<PEM>]
27 [B<-pass> I<val>]
28 [B<-dcert> I<infile>]
29 [B<-dcertform> B<DER>|B<PEM>]
30 [B<-dkey> I<infile>]
31 [B<-dkeyform> B<DER>|B<PEM>]
32 [B<-dpass> I<val>]
33 [B<-nbio_test>]
34 [B<-crlf>]
35 [B<-debug>]
36 [B<-msg>]
37 [B<-msgfile> I<outfile>]
38 [B<-state>]
39 [B<-CAfile> I<infile>]
40 [B<-CApath> I<dir>]
41 [B<-no-CAfile>]
42 [B<-no-CApath>]
43 [B<-nocert>]
44 [B<-quiet>]
45 [B<-no_resume_ephemeral>]
46 [B<-www>]
47 [B<-WWW>]
48 [B<-servername>]
49 [B<-servername_fatal>]
50 [B<-cert2> I<infile>]
51 [B<-key2> I<infile>]
52 [B<-tlsextdebug>]
53 [B<-HTTP>]
54 [B<-id_prefix> I<val>]
55 [B<-rand> I<files>]
56 [B<-writerand> I<file>]
57 [B<-keymatexport> I<val>]
58 [B<-keymatexportlen> I<+int>]
59 [B<-CRL> I<infile>]
60 [B<-crl_download>]
61 [B<-cert_chain> I<infile>]
62 [B<-dcert_chain> I<infile>]
63 [B<-chainCApath> I<dir>]
64 [B<-verifyCApath> I<dir>]
65 [B<-no_cache>]
66 [B<-ext_cache>]
67 [B<-verify_return_error>]
68 [B<-verify_quiet>]
69 [B<-build_chain>]
70 [B<-chainCAfile> I<infile>]
71 [B<-verifyCAfile> I<infile>]
72 [B<-ign_eof>]
73 [B<-no_ign_eof>]
74 [B<-status>]
75 [B<-status_verbose>]
76 [B<-status_timeout> I<int>]
77 [B<-status_url> I<val>]
78 [B<-status_file> I<infile>]
79 [B<-trace>]
80 [B<-security_debug>]
81 [B<-security_debug_verbose>]
82 [B<-brief>]
83 [B<-rev>]
84 [B<-async>]
85 [B<-ssl_config> I<val>]
86 [B<-max_send_frag> I<+int>]
87 [B<-split_send_frag> I<+int>]
88 [B<-max_pipelines> I<+int>]
89 [B<-read_buf> I<+int>]
90 [B<-no_ssl3>]
91 [B<-no_tls1>]
92 [B<-no_tls1_1>]
93 [B<-no_tls1_2>]
94 [B<-no_tls1_3>]
95 [B<-bugs>]
96 [B<-no_comp>]
97 [B<-comp>]
98 [B<-no_ticket>]
99 [B<-num_tickets>]
100 [B<-serverpref>]
101 [B<-legacy_renegotiation>]
102 [B<-no_renegotiation>]
103 [B<-legacy_server_connect>]
104 [B<-no_resumption_on_reneg>]
105 [B<-no_legacy_server_connect>]
106 [B<-allow_no_dhe_kex>]
107 [B<-prioritize_chacha>]
108 [B<-strict>]
109 [B<-sigalgs> I<val>]
110 [B<-client_sigalgs> I<val>]
111 [B<-groups> I<val>]
112 [B<-curves> I<val>]
113 [B<-named_curve> I<val>]
114 [B<-cipher> I<val>]
115 [B<-ciphersuites> I<val>]
116 [B<-dhparam> I<infile>]
117 [B<-record_padding> I<val>]
118 [B<-debug_broken_protocol>]
119 [B<-policy> I<val>]
120 [B<-purpose> I<val>]
121 [B<-verify_name> I<val>]
122 [B<-verify_depth> I<int>]
123 [B<-auth_level> I<int>]
124 [B<-attime> I<intmax>]
125 [B<-verify_hostname> I<val>]
126 [B<-verify_email> I<val>]
127 [B<-verify_ip>]
128 [B<-ignore_critical>]
129 [B<-issuer_checks>]
130 [B<-crl_check>]
131 [B<-crl_check_all>]
132 [B<-policy_check>]
133 [B<-explicit_policy>]
134 [B<-inhibit_any>]
135 [B<-inhibit_map>]
136 [B<-x509_strict>]
137 [B<-extended_crl>]
138 [B<-use_deltas>]
139 [B<-policy_print>]
140 [B<-check_ss_sig>]
141 [B<-trusted_first>]
142 [B<-suiteB_128_only>]
143 [B<-suiteB_128>]
144 [B<-suiteB_192>]
145 [B<-partial_chain>]
146 [B<-no_alt_chains>]
147 [B<-no_check_time>]
148 [B<-allow_proxy_certs>]
149 [B<-xkey>]
150 [B<-xcert>]
151 [B<-xchain>]
152 [B<-xchain_build>]
153 [B<-CRLform> B<DER>|B<PEM>]
154 [B<-xcertform> B<DER>|B<PEM>]
155 [B<-xkeyform> B<DER>|B<PEM>]
156 [B<-nbio>]
157 [B<-psk_identity> I<val>]
158 [B<-psk_hint> I<val>]
159 [B<-psk> I<val>]
160 [B<-psk_session> I<file>]
161 [B<-srpvfile> I<infile>]
162 [B<-srpuserseed> I<val>]
163 [B<-ssl3>]
164 [B<-tls1>]
165 [B<-tls1_1>]
166 [B<-tls1_2>]
167 [B<-tls1_3>]
168 [B<-dtls>]
169 [B<-timeout>]
170 [B<-mtu> I<+int>]
171 [B<-listen>]
172 [B<-dtls1>]
173 [B<-dtls1_2>]
174 [B<-sctp>]
175 [B<-sctp_label_bug>]
176 [B<-no_dhe>]
177 [B<-nextprotoneg> I<val>]
178 [B<-use_srtp> I<val>]
179 [B<-alpn> I<val>]
180 [B<-engine> I<val>]
181 [B<-keylogfile> I<outfile>]
182 [B<-max_early_data> I<int>]
183 [B<-early_data>]
184 [B<-anti_replay>]
185 [B<-no_anti_replay>]
186 [B<-http_server_binmode>]
187
188 =for openssl ifdef unix 4 6 unlink no_dhe nextprotoneg use_srtp engine
189
190 =for openssl ifdef status status_verbose status_timeout status_url status_file
191
192 =for openssl ifdef psk_hint srpvfile srpuserseed sctp sctp_label_bug
193
194 =for openssl ifdef sctp sctp_label_bug trace mtu timeout listen
195
196 =for openssl ifdef ssl3 tls1 tls1_1 tls1_2 tls1_3 dtls mtu dtls1 dtls1_2
197
198 =head1 DESCRIPTION
199
200 This command implements a generic SSL/TLS server which
201 listens for connections on a given port using SSL/TLS.
202
203 =head1 OPTIONS
204
205 In addition to the options below, this command also supports
206 the common and server only options documented
207 L<SSL_CONF_cmd(3)/Supported Command Line Commands>
208
209 =over 4
210
211 =item B<-help>
212
213 Print out a usage message.
214
215 =item B<-port> I<+int>
216
217 The TCP port to listen on for connections. If not specified 4433 is used.
218
219 =item B<-accept> I<val>
220
221 The optional TCP host and port to listen on for connections. If not specified, *:4433 is used.
222
223 =item B<-unix> I<val>
224
225 Unix domain socket to accept on.
226
227 =item B<-4>
228
229 Use IPv4 only.
230
231 =item B<-6>
232
233 Use IPv6 only.
234
235 =item B<-unlink>
236
237 For -unix, unlink any existing socket first.
238
239 =item B<-context> I<val>
240
241 Sets the SSL context id. It can be given any string value. If this option
242 is not present a default value will be used.
243
244 =item B<-verify> I<int>, B<-Verify> I<int>
245
246 The verify depth to use. This specifies the maximum length of the
247 client certificate chain and makes the server request a certificate from
248 the client. With the B<-verify> option a certificate is requested but the
249 client does not have to send one, with the B<-Verify> option the client
250 must supply a certificate or an error occurs.
251
252 If the cipher suite cannot request a client certificate (for example an
253 anonymous cipher suite or PSK) this option has no effect.
254
255 =item B<-cert> I<infile>
256
257 The certificate to use, most servers cipher suites require the use of a
258 certificate and some require a certificate with a certain public key type:
259 for example the DSS cipher suites require a certificate containing a DSS
260 (DSA) key. If not specified then the filename F<server.pem> will be used.
261
262 =item B<-cert_chain>
263
264 A file containing trusted certificates to use when attempting to build the
265 client/server certificate chain related to the certificate specified via the
266 B<-cert> option.
267
268 =item B<-build_chain>
269
270 Specify whether the application should build the certificate chain to be
271 provided to the client.
272
273 =item B<-nameopt> I<val>
274
275 Option which determines how the subject or issuer names are displayed. The
276 I<val> argument can be a single option or multiple options separated by
277 commas.  Alternatively the B<-nameopt> switch may be used more than once to
278 set multiple options. See the L<openssl-x509(1)> manual page for details.
279
280 =item B<-naccept> I<+int>
281
282 The server will exit after receiving the specified number of connections,
283 default unlimited.
284
285 =item B<-serverinfo> I<val>
286
287 A file containing one or more blocks of PEM data.  Each PEM block
288 must encode a TLS ServerHello extension (2 bytes type, 2 bytes length,
289 followed by "length" bytes of extension data).  If the client sends
290 an empty TLS ClientHello extension matching the type, the corresponding
291 ServerHello extension will be returned.
292
293 =item B<-certform> B<DER>|B<PEM>, B<-CRLForm> B<DER>|B<PEM>
294
295 The certificate and CRL format; the default is PEM.
296 See L<openssl(1)/Format Options> for details.
297
298 =item B<-key> I<infile>
299
300 The private key to use. If not specified then the certificate file will
301 be used.
302
303 =item B<-keyform> B<DER>|B<PEM>]
304
305 The key format; the default is B<PEM>.
306 See L<openssl(1)/Format Options> for details.
307
308 =item B<-pass> I<val>
309
310 The private key password source.
311 For more information about the format of I<val>,
312 see L<openssl(1)/Pass Phrase Options>.
313
314 =item B<-dcert> I<infile>, B<-dkey> I<infile>
315
316 Specify an additional certificate and private key, these behave in the
317 same manner as the B<-cert> and B<-key> options except there is no default
318 if they are not specified (no additional certificate and key is used). As
319 noted above some cipher suites require a certificate containing a key of
320 a certain type. Some cipher suites need a certificate carrying an RSA key
321 and some a DSS (DSA) key. By using RSA and DSS certificates and keys
322 a server can support clients which only support RSA or DSS cipher suites
323 by using an appropriate certificate.
324
325 =item B<-dcert_chain>
326
327 A file containing trusted certificates to use when attempting to build the
328 server certificate chain when a certificate specified via the B<-dcert> option
329 is in use.
330
331 =item B<-dcertform> B<DER>|B<PEM>, B<-dkeyform> B<DER>|B<PEM>
332
333 The format of the certificate and private key; the default is B<PEM>
334 see L<openssl(1)/Format Options>.
335
336 =item B<-dpass> I<val>
337
338 The passphrase for the additional private key.
339 For more information about the format of I<val>,
340 see L<openssl(1)/Pass Phrase Options>.
341
342 =item B<-xkey> I<infile>, B<-xcert> I<infile>, B<-xchain>
343
344 Specify an extra certificate, private key and certificate chain. These behave
345 in the same manner as the B<-cert>, B<-key> and B<-cert_chain> options.  When
346 specified, the callback returning the first valid chain will be in use by
347 the server.
348
349 =item B<-xchain_build>
350
351 Specify whether the application should build the certificate chain to be
352 provided to the client for the extra certificates provided via B<-xkey> I<infile>,
353 B<-xcert> I<infile>, B<-xchain> options.
354
355 =item B<-xcertform> B<DER>|B<PEM>, B<-xkeyform> B<DER>|B<PEM>
356
357 The format for the extra certificate and private key, respectively;
358 the default format is B<PEM>.
359 see L<openssl(1)/Pass Phrase Options>.
360
361 =item B<-nbio_test>
362
363 Tests non blocking I/O.
364
365 =item B<-crlf>
366
367 This option translated a line feed from the terminal into CR+LF.
368
369 =item B<-debug>
370
371 Print extensive debugging information including a hex dump of all traffic.
372
373 =item B<-msg>
374
375 Show all protocol messages with hex dump.
376
377 =item B<-msgfile> I<outfile>
378
379 File to send output of B<-msg> or B<-trace> to, default standard output.
380
381 =item B<-state>
382
383 Prints the SSL session states.
384
385 =item B<-CAfile> I<file>, B<-no-CAfile>, B<-CApath> I<dir>, B<-no-CApath>
386
387 See L<openssl(1)/Trusted Certificate Options> for more information.
388
389 =item B<-chainCApath> I<dir>
390
391 The directory to use for building the chain provided to the client. This
392 directory must be in "hash format", see L<openssl-verify(1)> for more
393 information.
394
395 =item B<-chainCAfile> I<file>
396
397 A file containing trusted certificates to use when attempting to build the
398 server certificate chain.
399
400 =item B<-nocert>
401
402 If this option is set then no certificate is used. This restricts the
403 cipher suites available to the anonymous ones (currently just anonymous
404 DH).
405
406 =item B<-quiet>
407
408 Inhibit printing of session and certificate information.
409
410 =item B<-www>
411
412 Sends a status message back to the client when it connects. This includes
413 information about the ciphers used and various session parameters.
414 The output is in HTML format so this option will normally be used with a
415 web browser. Cannot be used in conjunction with B<-early_data>.
416
417 =item B<-WWW>
418
419 Emulates a simple web server. Pages will be resolved relative to the
420 current directory, for example if the URL https://myhost/page.html is
421 requested the file F<./page.html> will be loaded. Cannot be used in conjunction
422 with B<-early_data>.
423
424 =item B<-tlsextdebug>
425
426 Print a hex dump of any TLS extensions received from the server.
427
428 =item B<-HTTP>
429
430 Emulates a simple web server. Pages will be resolved relative to the
431 current directory, for example if the URL https://myhost/page.html is
432 requested the file F<./page.html> will be loaded. The files loaded are
433 assumed to contain a complete and correct HTTP response (lines that
434 are part of the HTTP response line and headers must end with CRLF). Cannot be
435 used in conjunction with B<-early_data>.
436
437 =item B<-id_prefix> I<val>
438
439 Generate SSL/TLS session IDs prefixed by I<val>. This is mostly useful
440 for testing any SSL/TLS code (eg. proxies) that wish to deal with multiple
441 servers, when each of which might be generating a unique range of session
442 IDs (eg. with a certain prefix).
443
444 =item B<-rand> I<files>, B<-writerand> I<file>
445
446 See L<openssl(1)/Random State Options> for more information.
447
448 =item B<-verify_return_error>
449
450 Verification errors normally just print a message but allow the
451 connection to continue, for debugging purposes.
452 If this option is used, then verification errors close the connection.
453
454 =item B<-status>
455
456 Enables certificate status request support (aka OCSP stapling).
457
458 =item B<-status_verbose>
459
460 Enables certificate status request support (aka OCSP stapling) and gives
461 a verbose printout of the OCSP response.
462
463 =item B<-status_timeout> I<int>
464
465 Sets the timeout for OCSP response to I<int> seconds.
466
467 =item B<-status_url> I<val>
468
469 Sets a fallback responder URL to use if no responder URL is present in the
470 server certificate. Without this option an error is returned if the server
471 certificate does not contain a responder address.
472
473 =item B<-status_file> I<infile>
474
475 Overrides any OCSP responder URLs from the certificate and always provides the
476 OCSP Response stored in the file. The file must be in DER format.
477
478 =item B<-trace>
479
480 Show verbose trace output of protocol messages. OpenSSL needs to be compiled
481 with B<enable-ssl-trace> for this option to work.
482
483 =item B<-brief>
484
485 Provide a brief summary of connection parameters instead of the normal verbose
486 output.
487
488 =item B<-rev>
489
490 Simple test server which just reverses the text received from the client
491 and sends it back to the server. Also sets B<-brief>. Cannot be used in
492 conjunction with B<-early_data>.
493
494 =item B<-async>
495
496 Switch on asynchronous mode. Cryptographic operations will be performed
497 asynchronously. This will only have an effect if an asynchronous capable engine
498 is also used via the B<-engine> option. For test purposes the dummy async engine
499 (dasync) can be used (if available).
500
501 =item B<-max_send_frag> I<+int>
502
503 The maximum size of data fragment to send.
504 See L<SSL_CTX_set_max_send_fragment(3)> for further information.
505
506 =item B<-split_send_frag> I<+int>
507
508 The size used to split data for encrypt pipelines. If more data is written in
509 one go than this value then it will be split into multiple pipelines, up to the
510 maximum number of pipelines defined by max_pipelines. This only has an effect if
511 a suitable cipher suite has been negotiated, an engine that supports pipelining
512 has been loaded, and max_pipelines is greater than 1. See
513 L<SSL_CTX_set_split_send_fragment(3)> for further information.
514
515 =item B<-max_pipelines> I<+int>
516
517 The maximum number of encrypt/decrypt pipelines to be used. This will only have
518 an effect if an engine has been loaded that supports pipelining (e.g. the dasync
519 engine) and a suitable cipher suite has been negotiated. The default value is 1.
520 See L<SSL_CTX_set_max_pipelines(3)> for further information.
521
522 =item B<-read_buf> I<+int>
523
524 The default read buffer size to be used for connections. This will only have an
525 effect if the buffer size is larger than the size that would otherwise be used
526 and pipelining is in use (see L<SSL_CTX_set_default_read_buffer_len(3)> for
527 further information).
528
529 =item B<-ssl2>, B<-ssl3>, B<-tls1>, B<-tls1_1>, B<-tls1_2>, B<-tls1_3>, B<-no_ssl2>, B<-no_ssl3>, B<-no_tls1>, B<-no_tls1_1>, B<-no_tls1_2>, B<-no_tls1_3>
530
531 These options require or disable the use of the specified SSL or TLS protocols.
532 By default, this command will negotiate the highest mutually supported
533 protocol version.
534 When a specific TLS version is required, only that version will be accepted
535 from the client.
536 Note that not all protocols and flags may be available, depending on how
537 OpenSSL was built.
538
539 =item B<-bugs>
540
541 There are several known bugs in SSL and TLS implementations. Adding this
542 option enables various workarounds.
543
544 =item B<-no_comp>
545
546 Disable negotiation of TLS compression.
547 TLS compression is not recommended and is off by default as of
548 OpenSSL 1.1.0.
549
550 =item B<-comp>
551
552 Enable negotiation of TLS compression.
553 This option was introduced in OpenSSL 1.1.0.
554 TLS compression is not recommended and is off by default as of
555 OpenSSL 1.1.0.
556
557 =item B<-no_ticket>
558
559 Disable RFC4507bis session ticket support. This option has no effect if TLSv1.3
560 is negotiated. See B<-num_tickets>.
561
562 =item B<-num_tickets>
563
564 Control the number of tickets that will be sent to the client after a full
565 handshake in TLSv1.3. The default number of tickets is 2. This option does not
566 affect the number of tickets sent after a resumption handshake.
567
568 =item B<-serverpref>
569
570 Use the server's cipher preferences, rather than the client's preferences.
571
572 =item B<-prioritize_chacha>
573
574 Prioritize ChaCha ciphers when preferred by clients. Requires B<-serverpref>.
575
576 =item B<-no_resumption_on_reneg>
577
578 Set the B<SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION> option.
579
580 =item B<-client_sigalgs> I<val>
581
582 Signature algorithms to support for client certificate authentication
583 (colon-separated list).
584
585 =item B<-named_curve> I<val>
586
587 Specifies the elliptic curve to use. NOTE: this is single curve, not a list.
588 For a list of all possible curves, use:
589
590     $ openssl ecparam -list_curves
591
592 =item B<-cipher> I<val>
593
594 This allows the list of TLSv1.2 and below ciphersuites used by the server to be
595 modified. This list is combined with any TLSv1.3 ciphersuites that have been
596 configured. When the client sends a list of supported ciphers the first client
597 cipher also included in the server list is used. Because the client specifies
598 the preference order, the order of the server cipherlist is irrelevant. See
599 L<openssl-ciphers(1)> for more information.
600
601 =item B<-ciphersuites> I<val>
602
603 This allows the list of TLSv1.3 ciphersuites used by the server to be modified.
604 This list is combined with any TLSv1.2 and below ciphersuites that have been
605 configured. When the client sends a list of supported ciphers the first client
606 cipher also included in the server list is used. Because the client specifies
607 the preference order, the order of the server cipherlist is irrelevant. See
608 L<openssl-ciphers(1)> command for more information. The format for this list is
609 a simple colon (":") separated list of TLSv1.3 ciphersuite names.
610
611 =item B<-dhparam> I<infile>
612
613 The DH parameter file to use. The ephemeral DH cipher suites generate keys
614 using a set of DH parameters. If not specified then an attempt is made to
615 load the parameters from the server certificate file.
616 If this fails then a static set of parameters hard coded into this command
617 will be used.
618
619 =item B<-attime>, B<-check_ss_sig>, B<-crl_check>, B<-crl_check_all>,
620 B<-explicit_policy>, B<-extended_crl>, B<-ignore_critical>, B<-inhibit_any>,
621 B<-inhibit_map>, B<-no_alt_chains>, B<-no_check_time>, B<-partial_chain>, B<-policy>,
622 B<-policy_check>, B<-policy_print>, B<-purpose>, B<-suiteB_128>,
623 B<-suiteB_128_only>, B<-suiteB_192>, B<-trusted_first>, B<-use_deltas>,
624 B<-auth_level>, B<-verify_depth>, B<-verify_email>, B<-verify_hostname>,
625 B<-verify_ip>, B<-verify_name>, B<-x509_strict>
626
627 Set different peer certificate verification options.
628 See the L<openssl-verify(1)> manual page for details.
629
630 =item B<-crl_check>, B<-crl_check_all>
631
632 Check the peer certificate has not been revoked by its CA.
633 The CRL(s) are appended to the certificate file. With the B<-crl_check_all>
634 option all CRLs of all CAs in the chain are checked.
635
636 =item B<-nbio>
637
638 Turns on non blocking I/O.
639
640 =item B<-psk_identity> I<val>
641
642 Expect the client to send PSK identity I<val> when using a PSK
643 cipher suite, and warn if they do not.  By default, the expected PSK
644 identity is the string "Client_identity".
645
646 =item B<-psk_hint> I<val>
647
648 Use the PSK identity hint I<val> when using a PSK cipher suite.
649
650 =item B<-psk> I<val>
651
652 Use the PSK key I<val> when using a PSK cipher suite. The key is
653 given as a hexadecimal number without leading 0x, for example -psk
654 1a2b3c4d.
655 This option must be provided in order to use a PSK cipher.
656
657 =item B<-psk_session> I<file>
658
659 Use the pem encoded SSL_SESSION data stored in I<file> as the basis of a PSK.
660 Note that this will only work if TLSv1.3 is negotiated.
661
662 =item B<-listen>
663
664 This option can only be used in conjunction with one of the DTLS options above.
665 With this option, this command will listen on a UDP port for incoming
666 connections.
667 Any ClientHellos that arrive will be checked to see if they have a cookie in
668 them or not.
669 Any without a cookie will be responded to with a HelloVerifyRequest.
670 If a ClientHello with a cookie is received then this command will
671 connect to that peer and complete the handshake.
672
673 =item B<-dtls>, B<-dtls1>, B<-dtls1_2>
674
675 These options make this command use DTLS protocols instead of TLS.
676 With B<-dtls>, it will negotiate any supported DTLS protocol
677 version, whilst B<-dtls1> and B<-dtls1_2> will only support DTLSv1.0 and
678 DTLSv1.2 respectively.
679
680 =item B<-sctp>
681
682 Use SCTP for the transport protocol instead of UDP in DTLS. Must be used in
683 conjunction with B<-dtls>, B<-dtls1> or B<-dtls1_2>. This option is only
684 available where OpenSSL has support for SCTP enabled.
685
686 =item B<-sctp_label_bug>
687
688 Use the incorrect behaviour of older OpenSSL implementations when computing
689 endpoint-pair shared secrets for DTLS/SCTP. This allows communication with
690 older broken implementations but breaks interoperability with correct
691 implementations. Must be used in conjunction with B<-sctp>. This option is only
692 available where OpenSSL has support for SCTP enabled.
693
694 =item B<-no_dhe>
695
696 If this option is set then no DH parameters will be loaded effectively
697 disabling the ephemeral DH cipher suites.
698
699 =item B<-alpn> I<val>, B<-nextprotoneg> I<val>
700
701 These flags enable the Enable the Application-Layer Protocol Negotiation
702 or Next Protocol Negotiation (NPN) extension, respectively. ALPN is the
703 IETF standard and replaces NPN.
704 The I<val> list is a comma-separated list of supported protocol
705 names.  The list should contain the most desirable protocols first.
706 Protocol names are printable ASCII strings, for example "http/1.1" or
707 "spdy/3".
708 The flag B<-nextprotoneg> cannot be specified if B<-tls1_3> is used.
709
710 =item B<-engine> I<val>
711
712 Specifying an engine (by its unique id string in I<val>) will cause
713 this command to attempt to obtain a functional reference to the
714 specified engine, thus initialising it if needed. The engine will then be
715 set as the default for all available algorithms.
716
717 =item B<-keylogfile> I<outfile>
718
719 Appends TLS secrets to the specified keylog file such that external programs
720 (like Wireshark) can decrypt TLS connections.
721
722 =item B<-max_early_data> I<int>
723
724 Change the default maximum early data bytes that are specified for new sessions
725 and any incoming early data (when used in conjunction with the B<-early_data>
726 flag). The default value is approximately 16k. The argument must be an integer
727 greater than or equal to 0.
728
729 =item B<-early_data>
730
731 Accept early data where possible. Cannot be used in conjunction with B<-www>,
732 B<-WWW>, B<-HTTP> or B<-rev>.
733
734 =item B<-anti_replay>, B<-no_anti_replay>
735
736 Switches replay protection on or off, respectively. Replay protection is on by
737 default unless overridden by a configuration file. When it is on, OpenSSL will
738 automatically detect if a session ticket has been used more than once, TLSv1.3
739 has been negotiated, and early data is enabled on the server. A full handshake
740 is forced if a session ticket is used a second or subsequent time. Any early
741 data that was sent will be rejected.
742
743 =item B<-http_server_binmode>
744
745 When acting as web-server (using option B<-WWW> or B<-HTTP>) open files requested
746 by the client in binary mode.
747
748 =back
749
750 =head1 CONNECTED COMMANDS
751
752 If a connection request is established with an SSL client and neither the
753 B<-www> nor the B<-WWW> option has been used then normally any data received
754 from the client is displayed and any key presses will be sent to the client.
755
756 Certain commands are also recognized which perform special operations. These
757 commands are a letter which must appear at the start of a line. They are listed
758 below.
759
760 =over 4
761
762 =item B<q>
763
764 End the current SSL connection but still accept new connections.
765
766 =item B<Q>
767
768 End the current SSL connection and exit.
769
770 =item B<r>
771
772 Renegotiate the SSL session (TLSv1.2 and below only).
773
774 =item B<R>
775
776 Renegotiate the SSL session and request a client certificate (TLSv1.2 and below
777 only).
778
779 =item B<P>
780
781 Send some plain text down the underlying TCP connection: this should
782 cause the client to disconnect due to a protocol violation.
783
784 =item B<S>
785
786 Print out some session cache status information.
787
788 =item B<k>
789
790 Send a key update message to the client (TLSv1.3 only)
791
792 =item B<K>
793
794 Send a key update message to the client and request one back (TLSv1.3 only)
795
796 =item B<c>
797
798 Send a certificate request to the client (TLSv1.3 only)
799
800 =back
801
802 =head1 NOTES
803
804 This command can be used to debug SSL clients. To accept connections
805 from a web browser the command:
806
807  openssl s_server -accept 443 -www
808
809 can be used for example.
810
811 Although specifying an empty list of CAs when requesting a client certificate
812 is strictly speaking a protocol violation, some SSL clients interpret this to
813 mean any CA is acceptable. This is useful for debugging purposes.
814
815 The session parameters can printed out using the L<openssl-sess_id(1)> command.
816
817 =head1 BUGS
818
819 Because this program has a lot of options and also because some of the
820 techniques used are rather old, the C source for this command is rather
821 hard to read and not a model of how things should be done.
822 A typical SSL server program would be much simpler.
823
824 The output of common ciphers is wrong: it just gives the list of ciphers that
825 OpenSSL recognizes and the client supports.
826
827 There should be a way for this command to print out details
828 of any unknown cipher suites a client says it supports.
829
830 =head1 SEE ALSO
831
832 L<openssl(1)>,
833 L<openssl-sess_id(1)>,
834 L<openssl-s_client(1)>,
835 L<openssl-ciphers(1)>,
836 L<SSL_CONF_cmd(3)>,
837 L<SSL_CTX_set_max_send_fragment(3)>,
838 L<SSL_CTX_set_split_send_fragment(3)>,
839 L<SSL_CTX_set_max_pipelines(3)>
840
841 =head1 HISTORY
842
843 The -no_alt_chains option was added in OpenSSL 1.1.0.
844
845 The
846 -allow-no-dhe-kex and -prioritize_chacha options were added in OpenSSL 1.1.1.
847
848 =head1 COPYRIGHT
849
850 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
851
852 Licensed under the Apache License 2.0 (the "License").  You may not use
853 this file except in compliance with the License.  You can obtain a copy
854 in the file LICENSE in the source distribution or at
855 L<https://www.openssl.org/source/license.html>.
856
857 =cut