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