6fe16f3d866f11efaf82bbd4471db6fe711cfb23
[openssl.git] / doc / man1 / s_server.pod
1 =pod
2
3 =head1 NAME
4
5 s_server - SSL/TLS server program
6
7 =head1 SYNOPSIS
8
9 B<openssl> B<s_server>
10 [B<-help>]
11 [B<-port port>]
12 [B<-accept val>]
13 [B<-naccept count>]
14 [B<-unix val>]
15 [B<-unlink>]
16 [B<-4>]
17 [B<-6>]
18 [B<-context id>]
19 [B<-verify depth>]
20 [B<-Verify depth>]
21 [B<-crl_check>]
22 [B<-crl_check_all>]
23 [B<-cert filename>]
24 [B<-certform DER|PEM>]
25 [B<-key keyfile>]
26 [B<-keyform DER|PEM>]
27 [B<-pass arg>]
28 [B<-dcert filename>]
29 [B<-dcertform DER|PEM>]
30 [B<-dkey keyfile>]
31 [B<-dkeyform DER|PEM>]
32 [B<-dpass arg>]
33 [B<-dhparam filename>]
34 [B<-nbio>]
35 [B<-nbio_test>]
36 [B<-crlf>]
37 [B<-debug>]
38 [B<-msg>]
39 [B<-state>]
40 [B<-CApath directory>]
41 [B<-CAfile filename>]
42 [B<-no-CAfile>]
43 [B<-no-CApath>]
44 [B<-attime timestamp>]
45 [B<-check_ss_sig>]
46 [B<-explicit_policy>]
47 [B<-extended_crl>]
48 [B<-ignore_critical>]
49 [B<-inhibit_any>]
50 [B<-inhibit_map>]
51 [B<-no_check_time>]
52 [B<-partial_chain>]
53 [B<-policy arg>]
54 [B<-policy_check>]
55 [B<-policy_print>]
56 [B<-purpose purpose>]
57 [B<-suiteB_128>]
58 [B<-suiteB_128_only>]
59 [B<-suiteB_192>]
60 [B<-trusted_first>]
61 [B<-no_alt_chains>]
62 [B<-use_deltas>]
63 [B<-auth_level num>]
64 [B<-nameopt option>]
65 [B<-verify_depth num>]
66 [B<-verify_return_error>]
67 [B<-verify_email email>]
68 [B<-verify_hostname hostname>]
69 [B<-verify_ip ip>]
70 [B<-verify_name name>]
71 [B<-x509_strict>]
72 [B<-nocert>]
73 [B<-client_sigalgs sigalglist>]
74 [B<-named_curve curve>]
75 [B<-cipher cipherlist>]
76 [B<-serverpref>]
77 [B<-quiet>]
78 [B<-ssl3>]
79 [B<-tls1>]
80 [B<-tls1_1>]
81 [B<-tls1_2>]
82 [B<-tls1_3>]
83 [B<-dtls>]
84 [B<-dtls1>]
85 [B<-dtls1_2>]
86 [B<-listen>]
87 [B<-async>]
88 [B<-split_send_frag>]
89 [B<-max_pipelines>]
90 [B<-read_buf>]
91 [B<-no_ssl3>]
92 [B<-no_tls1>]
93 [B<-no_tls1_1>]
94 [B<-no_tls1_2>]
95 [B<-no_tls1_3>]
96 [B<-no_dhe>]
97 [B<-bugs>]
98 [B<-comp>]
99 [B<-no_comp>]
100 [B<-brief>]
101 [B<-www>]
102 [B<-WWW>]
103 [B<-HTTP>]
104 [B<-engine id>]
105 [B<-tlsextdebug>]
106 [B<-no_ticket>]
107 [B<-id_prefix arg>]
108 [B<-rand file(s)>]
109 [B<-serverinfo file>]
110 [B<-no_resumption_on_reneg>]
111 [B<-status>]
112 [B<-status_verbose>]
113 [B<-status_timeout nsec>]
114 [B<-status_url url>]
115 [B<-status_file file>]
116 [B<-alpn protocols>]
117 [B<-nextprotoneg protocols>]
118 [B<-max_early_data>]
119 [B<-early_data>]
120
121 =head1 DESCRIPTION
122
123 The B<s_server> command implements a generic SSL/TLS server which listens
124 for connections on a given port using SSL/TLS.
125
126 =head1 OPTIONS
127
128 In addition to the options below the B<s_server> utility also supports the
129 common and server only options documented in the
130 in the "Supported Command Line Commands" section of the L<SSL_CONF_cmd(3)>
131 manual page.
132
133 =over 4
134
135 =item B<-help>
136
137 Print out a usage message.
138
139 =item B<-port port>
140
141 The TCP port to listen on for connections. If not specified 4433 is used.
142
143 =item B<-accept val>
144
145 The optional TCP host and port to listen on for connections. If not specified, *:4433 is used.
146
147 =item B<-naccept count>
148
149 The server will exit after receiving B<number> connections, default unlimited.
150
151 =item B<-unix val>
152
153 Unix domain socket to accept on.
154
155 =item B<-unlink>
156
157 For -unix, unlink existing socket first.
158
159 =item B<-4>
160
161 Use IPv4 only.
162
163 =item B<-6>
164
165 Use IPv6 only.
166
167 =item B<-context id>
168
169 Sets the SSL context id. It can be given any string value. If this option
170 is not present a default value will be used.
171
172 =item B<-cert certname>
173
174 The certificate to use, most servers cipher suites require the use of a
175 certificate and some require a certificate with a certain public key type:
176 for example the DSS cipher suites require a certificate containing a DSS
177 (DSA) key. If not specified then the filename "server.pem" will be used.
178
179 =item B<-certform format>
180
181 The certificate format to use: DER or PEM. PEM is the default.
182
183 =item B<-key keyfile>
184
185 The private key to use. If not specified then the certificate file will
186 be used.
187
188 =item B<-keyform format>
189
190 The private format to use: DER or PEM. PEM is the default.
191
192 =item B<-pass arg>
193
194 The private key password source. For more information about the format of B<arg>
195 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
196
197 =item B<-dcert filename>, B<-dkey keyname>
198
199 Specify an additional certificate and private key, these behave in the
200 same manner as the B<-cert> and B<-key> options except there is no default
201 if they are not specified (no additional certificate and key is used). As
202 noted above some cipher suites require a certificate containing a key of
203 a certain type. Some cipher suites need a certificate carrying an RSA key
204 and some a DSS (DSA) key. By using RSA and DSS certificates and keys
205 a server can support clients which only support RSA or DSS cipher suites
206 by using an appropriate certificate.
207
208 =item B<-dcertform format>, B<-dkeyform format>, B<-dpass arg>
209
210 Additional certificate and private key format and passphrase respectively.
211
212 =item B<-nocert>
213
214 If this option is set then no certificate is used. This restricts the
215 cipher suites available to the anonymous ones (currently just anonymous
216 DH).
217
218 =item B<-dhparam filename>
219
220 The DH parameter file to use. The ephemeral DH cipher suites generate keys
221 using a set of DH parameters. If not specified then an attempt is made to
222 load the parameters from the server certificate file.
223 If this fails then a static set of parameters hard coded into the B<s_server>
224 program will be used.
225
226 =item B<-no_dhe>
227
228 If this option is set then no DH parameters will be loaded effectively
229 disabling the ephemeral DH cipher suites.
230
231 =item B<-crl_check>, B<-crl_check_all>
232
233 Check the peer certificate has not been revoked by its CA.
234 The CRL(s) are appended to the certificate file. With the B<-crl_check_all>
235 option all CRLs of all CAs in the chain are checked.
236
237 =item B<-CApath directory>
238
239 The directory to use for client certificate verification. This directory
240 must be in "hash format", see B<verify> for more information. These are
241 also used when building the server certificate chain.
242
243 =item B<-CAfile file>
244
245 A file containing trusted certificates to use during client authentication
246 and to use when attempting to build the server certificate chain. The list
247 is also used in the list of acceptable client CAs passed to the client when
248 a certificate is requested.
249
250 =item B<-no-CAfile>
251
252 Do not load the trusted CA certificates from the default file location
253
254 =item B<-no-CApath>
255
256 Do not load the trusted CA certificates from the default directory location
257
258 =item B<-verify depth>, B<-Verify depth>
259
260 The verify depth to use. This specifies the maximum length of the
261 client certificate chain and makes the server request a certificate from
262 the client. With the B<-verify> option a certificate is requested but the
263 client does not have to send one, with the B<-Verify> option the client
264 must supply a certificate or an error occurs.
265
266 If the ciphersuite cannot request a client certificate (for example an
267 anonymous ciphersuite or PSK) this option has no effect.
268
269 =item B<-nameopt option>
270
271 option which determines how the subject or issuer names are displayed. The
272 B<option> argument can be a single option or multiple options separated by
273 commas.  Alternatively the B<-nameopt> switch may be used more than once to
274 set multiple options. See the L<x509(1)> manual page for details.
275
276 =item B<-attime>, B<-check_ss_sig>, B<-crl_check>, B<-crl_check_all>,
277 B<-explicit_policy>, B<-extended_crl>, B<-ignore_critical>, B<-inhibit_any>,
278 B<-inhibit_map>, B<-no_alt_chains>, B<-no_check_time>, B<-partial_chain>, B<-policy>,
279 B<-policy_check>, B<-policy_print>, B<-purpose>, B<-suiteB_128>,
280 B<-suiteB_128_only>, B<-suiteB_192>, B<-trusted_first>, B<-use_deltas>,
281 B<-auth_level>, B<-verify_depth>, B<-verify_email>, B<-verify_hostname>,
282 B<-verify_ip>, B<-verify_name>, B<-x509_strict>
283
284 Set different peer certificate verification options.
285 See the L<verify(1)> manual page for details.
286
287 =item B<-verify_return_error>
288
289 Verification errors normally just print a message but allow the
290 connection to continue, for debugging purposes.
291 If this option is used, then verification errors close the connection.
292
293 =item B<-state>
294
295 Prints the SSL session states.
296
297 =item B<-debug>
298
299 Print extensive debugging information including a hex dump of all traffic.
300
301 =item B<-msg>
302
303 Show all protocol messages with hex dump.
304
305 =item B<-trace>
306
307 Show verbose trace output of protocol messages. OpenSSL needs to be compiled
308 with B<enable-ssl-trace> for this option to work.
309
310 =item B<-msgfile>
311
312 File to send output of B<-msg> or B<-trace> to, default standard output.
313
314 =item B<-nbio_test>
315
316 Tests non blocking I/O
317
318 =item B<-nbio>
319
320 Turns on non blocking I/O
321
322 =item B<-crlf>
323
324 This option translated a line feed from the terminal into CR+LF.
325
326 =item B<-quiet>
327
328 Inhibit printing of session and certificate information.
329
330 =item B<-psk_hint hint>
331
332 Use the PSK identity hint B<hint> when using a PSK cipher suite.
333
334 =item B<-psk key>
335
336 Use the PSK key B<key> when using a PSK cipher suite. The key is
337 given as a hexadecimal number without leading 0x, for example -psk
338 1a2b3c4d.
339
340 =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>
341
342 These options require or disable the use of the specified SSL or TLS protocols.
343 By default B<s_server> will negotiate the highest mutually supported protocol
344 version.
345 When a specific TLS version is required, only that version will be accepted
346 from the client.
347
348 =item B<-dtls>, B<-dtls1>, B<-dtls1_2>
349
350 These options make B<s_server> use DTLS protocols instead of TLS.
351 With B<-dtls>, B<s_server> will negotiate any supported DTLS protocol version,
352 whilst B<-dtls1> and B<-dtls1_2> will only support DTLSv1.0 and DTLSv1.2
353 respectively.
354
355 =item B<-listen>
356
357 This option can only be used in conjunction with one of the DTLS options above.
358 With this option B<s_server> will listen on a UDP port for incoming connections.
359 Any ClientHellos that arrive will be checked to see if they have a cookie in
360 them or not.
361 Any without a cookie will be responded to with a HelloVerifyRequest.
362 If a ClientHello with a cookie is received then B<s_server> will connect to
363 that peer and complete the handshake.
364
365 =item B<-async>
366
367 Switch on asynchronous mode. Cryptographic operations will be performed
368 asynchronously. This will only have an effect if an asynchronous capable engine
369 is also used via the B<-engine> option. For test purposes the dummy async engine
370 (dasync) can be used (if available).
371
372 =item B<-split_send_frag int>
373
374 The size used to split data for encrypt pipelines. If more data is written in
375 one go than this value then it will be split into multiple pipelines, up to the
376 maximum number of pipelines defined by max_pipelines. This only has an effect if
377 a suitable ciphersuite has been negotiated, an engine that supports pipelining
378 has been loaded, and max_pipelines is greater than 1. See
379 L<SSL_CTX_set_split_send_fragment(3)> for further information.
380
381 =item B<-max_pipelines int>
382
383 The maximum number of encrypt/decrypt pipelines to be used. This will only have
384 an effect if an engine has been loaded that supports pipelining (e.g. the dasync
385 engine) and a suitable ciphersuite has been negotiated. The default value is 1.
386 See L<SSL_CTX_set_max_pipelines(3)> for further information.
387
388 =item B<-read_buf int>
389
390 The default read buffer size to be used for connections. This will only have an
391 effect if the buffer size is larger than the size that would otherwise be used
392 and pipelining is in use (see L<SSL_CTX_set_default_read_buffer_len(3)> for
393 further information).
394
395 =item B<-bugs>
396
397 There are several known bug in SSL and TLS implementations. Adding this
398 option enables various workarounds.
399
400 =item B<-comp>
401
402 Enable negotiation of TLS compression.
403 This option was introduced in OpenSSL 1.1.0.
404 TLS compression is not recommended and is off by default as of
405 OpenSSL 1.1.0.
406
407 =item B<-no_comp>
408
409 Disable negotiation of TLS compression.
410 TLS compression is not recommended and is off by default as of
411 OpenSSL 1.1.0.
412
413 =item B<-brief>
414
415 Provide a brief summary of connection parameters instead of the normal verbose
416 output.
417
418 =item B<-client_sigalgs sigalglist>
419
420 Signature algorithms to support for client certificate authentication
421 (colon-separated list)
422
423 =item B<-named_curve curve>
424
425 Specifies the elliptic curve to use. NOTE: this is single curve, not a list.
426 For a list of all possible curves, use:
427
428     $ openssl ecparam -list_curves
429
430 =item B<-cipher cipherlist>
431
432 This allows the cipher list used by the server to be modified.  When
433 the client sends a list of supported ciphers the first client cipher
434 also included in the server list is used. Because the client specifies
435 the preference order, the order of the server cipherlist irrelevant. See
436 the B<ciphers> command for more information.
437
438 =item B<-serverpref>
439
440 Use the server's cipher preferences, rather than the client's preferences.
441
442 =item B<-tlsextdebug>
443
444 Print a hex dump of any TLS extensions received from the server.
445
446 =item B<-no_ticket>
447
448 Disable RFC4507bis session ticket support.
449
450 =item B<-www>
451
452 Sends a status message back to the client when it connects. This includes
453 information about the ciphers used and various session parameters.
454 The output is in HTML format so this option will normally be used with a
455 web browser.
456
457 =item B<-WWW>
458
459 Emulates a simple web server. Pages will be resolved relative to the
460 current directory, for example if the URL https://myhost/page.html is
461 requested the file ./page.html will be loaded.
462
463 =item B<-HTTP>
464
465 Emulates a simple web server. Pages will be resolved relative to the
466 current directory, for example if the URL https://myhost/page.html is
467 requested the file ./page.html will be loaded. The files loaded are
468 assumed to contain a complete and correct HTTP response (lines that
469 are part of the HTTP response line and headers must end with CRLF).
470
471 =item B<-rev>
472
473 Simple test server which just reverses the text received from the client
474 and sends it back to the server. Also sets B<-brief>.
475
476 =item B<-engine id>
477
478 Specifying an engine (by its unique B<id> string) will cause B<s_server>
479 to attempt to obtain a functional reference to the specified engine,
480 thus initialising it if needed. The engine will then be set as the default
481 for all available algorithms.
482
483 =item B<-id_prefix arg>
484
485 Generate SSL/TLS session IDs prefixed by B<arg>. This is mostly useful
486 for testing any SSL/TLS code (eg. proxies) that wish to deal with multiple
487 servers, when each of which might be generating a unique range of session
488 IDs (eg. with a certain prefix).
489
490 =item B<-rand file(s)>
491
492 A file or files containing random data used to seed the random number
493 generator, or an EGD socket (see L<RAND_egd(3)>).
494 Multiple files can be specified separated by an OS-dependent character.
495 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
496 all others.
497
498 =item B<-serverinfo file>
499
500 A file containing one or more blocks of PEM data.  Each PEM block
501 must encode a TLS ServerHello extension (2 bytes type, 2 bytes length,
502 followed by "length" bytes of extension data).  If the client sends
503 an empty TLS ClientHello extension matching the type, the corresponding
504 ServerHello extension will be returned.
505
506 =item B<-no_resumption_on_reneg>
507
508 Set the B<SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION> option.
509
510 =item B<-status>
511
512 Enables certificate status request support (aka OCSP stapling).
513
514 =item B<-status_verbose>
515
516 Enables certificate status request support (aka OCSP stapling) and gives
517 a verbose printout of the OCSP response.
518
519 =item B<-status_timeout nsec>
520
521 Sets the timeout for OCSP response to B<nsec> seconds.
522
523 =item B<-status_url url>
524
525 Sets a fallback responder URL to use if no responder URL is present in the
526 server certificate. Without this option an error is returned if the server
527 certificate does not contain a responder address.
528
529 =item B<-status_file file>
530
531 Overrides any OCSP responder URLs from the certificate and always provides the
532 OCSP Response stored in the file. The file must be in DER format.
533
534 =item B<-alpn protocols>, B<-nextprotoneg protocols>
535
536 these flags enable the 
537 Enable the Application-Layer Protocol Negotiation or Next Protocol
538 Negotiation extension, respectively. ALPN is the IETF standard and
539 replaces NPN.
540 The B<protocols> list is a
541 comma-separated list of supported protocol names.
542 The list should contain most wanted protocols first.
543 Protocol names are printable ASCII strings, for example "http/1.1" or
544 "spdy/3".
545
546 =item B<-keylogfile path>
547
548 Appends TLS secrets to the specified keylog file such that external programs
549 (like Wireshark) can decrypt TLS connections.
550
551 =item B<-max_early_data arg>
552
553 Change the default maximum early data bytes that are specified for new sessions
554 and any incoming early data (when used in conjunction with the B<-early_data>
555 flag). The default value is approximately 16k. The argument must be an integer
556 greater than or equal to 0.
557
558 =item B<-early_data>
559
560 Accept early data where possible.
561
562 =back
563
564 =head1 CONNECTED COMMANDS
565
566 If a connection request is established with an SSL client and neither the
567 B<-www> nor the B<-WWW> option has been used then normally any data received
568 from the client is displayed and any key presses will be sent to the client.
569
570 Certain single letter commands are also recognized which perform special
571 operations: these are listed below.
572
573 =over 4
574
575 =item B<q>
576
577 end the current SSL connection but still accept new connections.
578
579 =item B<Q>
580
581 end the current SSL connection and exit.
582
583 =item B<r>
584
585 renegotiate the SSL session.
586
587 =item B<R>
588
589 renegotiate the SSL session and request a client certificate.
590
591 =item B<P>
592
593 send some plain text down the underlying TCP connection: this should
594 cause the client to disconnect due to a protocol violation.
595
596 =item B<S>
597
598 print out some session cache status information.
599
600 =back
601
602 =head1 NOTES
603
604 B<s_server> can be used to debug SSL clients. To accept connections from
605 a web browser the command:
606
607  openssl s_server -accept 443 -www
608
609 can be used for example.
610
611 Most web browsers (in particular Netscape and MSIE) only support RSA cipher
612 suites, so they cannot connect to servers which don't use a certificate
613 carrying an RSA key or a version of OpenSSL with RSA disabled.
614
615 Although specifying an empty list of CAs when requesting a client certificate
616 is strictly speaking a protocol violation, some SSL clients interpret this to
617 mean any CA is acceptable. This is useful for debugging purposes.
618
619 The session parameters can printed out using the B<sess_id> program.
620
621 =head1 BUGS
622
623 Because this program has a lot of options and also because some of the
624 techniques used are rather old, the C source of B<s_server> is rather hard to
625 read and not a model of how things should be done.
626 A typical SSL server program would be much simpler.
627
628 The output of common ciphers is wrong: it just gives the list of ciphers that
629 OpenSSL recognizes and the client supports.
630
631 There should be a way for the B<s_server> program to print out details of any
632 unknown cipher suites a client says it supports.
633
634 =head1 SEE ALSO
635
636 L<SSL_CONF_cmd(3)>,
637 L<sess_id(1)>, L<s_client(1)>, L<ciphers(1)>
638
639 =head1 HISTORY
640
641 The -no_alt_chains options was first added to OpenSSL 1.1.0.
642
643 =head1 COPYRIGHT
644
645 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
646
647 Licensed under the OpenSSL license (the "License").  You may not use
648 this file except in compliance with the License.  You can obtain a copy
649 in the file LICENSE in the source distribution or at
650 L<https://www.openssl.org/source/license.html>.
651
652 =cut