GH875: Document -no_check_time
[openssl.git] / doc / apps / s_client.pod
1
2 =pod
3
4 =head1 NAME
5
6 s_client - SSL/TLS client program
7
8 =head1 SYNOPSIS
9
10 B<openssl> B<s_client>
11 [B<-help>]
12 [B<-connect host:port>]
13 [B<-proxy host:port>]
14 [B<-servername name>]
15 [B<-verify depth>]
16 [B<-verify_return_error>]
17 [B<-cert filename>]
18 [B<-certform DER|PEM>]
19 [B<-key filename>]
20 [B<-keyform DER|PEM>]
21 [B<-pass arg>]
22 [B<-CApath directory>]
23 [B<-CAfile filename>]
24 [B<-no-CAfile>]
25 [B<-no-CApath>]
26 [B<-dane_tlsa_domain domain>]
27 [B<-dane_tlsa_rrdata rrdata>]
28 [B<-attime timestamp>]
29 [B<-check_ss_sig>]
30 [B<-crl_check>]
31 [B<-crl_check_all>]
32 [B<-explicit_policy>]
33 [B<-extended_crl>]
34 [B<-ignore_critical>]
35 [B<-inhibit_any>]
36 [B<-inhibit_map>]
37 [B<-no_check_time>]
38 [B<-partial_chain>]
39 [B<-policy arg>]
40 [B<-policy_check>]
41 [B<-policy_print>]
42 [B<-purpose purpose>]
43 [B<-suiteB_128>]
44 [B<-suiteB_128_only>]
45 [B<-suiteB_192>]
46 [B<-trusted_first>]
47 [B<-no_alt_chains>]
48 [B<-use_deltas>]
49 [B<-auth_level num>]
50 [B<-verify_depth num>]
51 [B<-verify_email email>]
52 [B<-verify_hostname hostname>]
53 [B<-verify_ip ip>]
54 [B<-verify_name name>]
55 [B<-x509_strict>]
56 [B<-reconnect>]
57 [B<-showcerts>]
58 [B<-debug>]
59 [B<-msg>]
60 [B<-nbio_test>]
61 [B<-state>]
62 [B<-nbio>]
63 [B<-crlf>]
64 [B<-ign_eof>]
65 [B<-no_ign_eof>]
66 [B<-quiet>]
67 [B<-ssl3>]
68 [B<-tls1>]
69 [B<-tls1_1>]
70 [B<-tls1_2>]
71 [B<-no_ssl3>]
72 [B<-no_tls1>]
73 [B<-no_tls1_1>]
74 [B<-no_tls1_2>]
75 [B<-dtls>]
76 [B<-dtls1>]
77 [B<-dtls1_2>]
78 [B<-fallback_scsv>]
79 [B<-async>]
80 [B<-split_send_frag>]
81 [B<-max_pipelines>]
82 [B<-read_buf>]
83 [B<-bugs>]
84 [B<-comp>]
85 [B<-no_comp>]
86 [B<-cipher cipherlist>]
87 [B<-serverpref>]
88 [B<-starttls protocol>]
89 [B<-xmpphost hostname>]
90 [B<-engine id>]
91 [B<-tlsextdebug>]
92 [B<-no_ticket>]
93 [B<-sess_out filename>]
94 [B<-sess_in filename>]
95 [B<-rand file(s)>]
96 [B<-serverinfo types>]
97 [B<-status>]
98 [B<-nextprotoneg protocols>]
99 [B<-ct|noct>]
100 [B<-ctlogfile>]
101
102 =head1 DESCRIPTION
103
104 The B<s_client> command implements a generic SSL/TLS client which connects
105 to a remote host using SSL/TLS. It is a I<very> useful diagnostic tool for
106 SSL servers.
107
108 =head1 OPTIONS
109
110 In addition to the options below the B<s_client> utility also supports the
111 common and client only options documented in the
112 in the L<SSL_CONF_cmd(3)|SSL_CONF_cmd(3)/SUPPORTED COMMAND LINE COMMANDS>
113 manual page.
114
115 =over 4
116
117 =item B<-help>
118
119 Print out a usage message.
120
121 =item B<-connect host:port>
122
123 This specifies the host and optional port to connect to. If not specified
124 then an attempt is made to connect to the local host on port 4433.
125
126 =item B<-proxy host:port>
127
128 When used with the B<-connect> flag, the program uses the host and port
129 specified with this flag and issues an HTTP CONNECT command to connect
130 to the desired server.
131
132 =item B<-servername name>
133
134 Set the TLS SNI (Server Name Indication) extension in the ClientHello message.
135
136 =item B<-cert certname>
137
138 The certificate to use, if one is requested by the server. The default is
139 not to use a certificate.
140
141 =item B<-certform format>
142
143 The certificate format to use: DER or PEM. PEM is the default.
144
145 =item B<-key keyfile>
146
147 The private key to use. If not specified then the certificate file will
148 be used.
149
150 =item B<-keyform format>
151
152 The private format to use: DER or PEM. PEM is the default.
153
154 =item B<-pass arg>
155
156 the private key password source. For more information about the format of B<arg>
157 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
158
159 =item B<-verify depth>
160
161 The verify depth to use. This specifies the maximum length of the
162 server certificate chain and turns on server certificate verification.
163 Currently the verify operation continues after errors so all the problems
164 with a certificate chain can be seen. As a side effect the connection
165 will never fail due to a server certificate verify failure.
166
167 =item B<-verify_return_error>
168
169 Return verification errors instead of continuing. This will typically
170 abort the handshake with a fatal error.
171
172 =item B<-CApath directory>
173
174 The directory to use for server certificate verification. This directory
175 must be in "hash format", see B<verify> for more information. These are
176 also used when building the client certificate chain.
177
178 =item B<-CAfile file>
179
180 A file containing trusted certificates to use during server authentication
181 and to use when attempting to build the client certificate chain.
182
183 =item B<-no-CAfile>
184
185 Do not load the trusted CA certificates from the default file location
186
187 =item B<-no-CApath>
188
189 Do not load the trusted CA certificates from the default directory location
190
191 =item B<-dane_tlsa_domain domain>
192
193 Enable RFC6698/RFC7671 DANE TLSA authentication and specify the
194 TLSA base domain which becomes the default SNI hint and the primary
195 reference identifier for hostname checks.  This must be used in
196 combination with at least one instance of the B<-dane_tlsa_rrdata>
197 option below.
198
199 When DANE authentication succeeds, the diagnostic output will include
200 the lowest (closest to 0) depth at which a TLSA record authenticated
201 a chain certificate.  When that TLSA record is a "2 1 0" trust
202 anchor public key that signed (rather than matched) the top-most
203 certificate of the chain, the result is reported as "TA public key
204 verified".  Otherwise, either the TLSA record "matched TA certificate"
205 at a positive depth or else "matched EE certificate" at depth 0.
206
207 =item B<-dane_tlsa_rrdata rrdata>
208
209 Use one or more times to specify the RRDATA fields of the DANE TLSA
210 RRset associated with the target service.  The B<rrdata> value is
211 specied in "presentation form", that is four whitespace separated
212 fields that specify the usage, selector, matching type and associated
213 data, with the last of these encoded in hexadecimal.  Optional
214 whitespace is ignored in the associated data field.  For example:
215
216   $ openssl s_client -brief -starttls smtp \
217     -connect smtp.example.com:25 \
218     -dane_tlsa_domain smtp.example.com \
219     -dane_tlsa_rrdata "2 1 1
220       B111DD8A1C2091A89BD4FD60C57F0716CCE50FEEFF8137CDBEE0326E 02CF362B" \
221     -dane_tlsa_rrdata "2 1 1
222       60B87575447DCBA2A36B7D11AC09FB24A9DB406FEE12D2CC90180517 616E8A18"
223   ...
224   Verification: OK
225   Verified peername: smtp.example.com
226   DANE TLSA 2 1 1 ...ee12d2cc90180517616e8a18 matched TA certificate at depth 1
227   ...
228
229 =item B<-attime>, B<-check_ss_sig>, B<-crl_check>, B<-crl_check_all>,
230 B<-explicit_policy>, B<-extended_crl>, B<-ignore_critical>, B<-inhibit_any>,
231 B<-inhibit_map>, B<-no_alt_chains>, B<-no_check_time>, B<-partial_chain>, B<-policy>,
232 B<-policy_check>, B<-policy_print>, B<-purpose>, B<-suiteB_128>,
233 B<-suiteB_128_only>, B<-suiteB_192>, B<-trusted_first>, B<-use_deltas>,
234 B<-auth_level>, B<-verify_depth>, B<-verify_email>, B<-verify_hostname>,
235 B<-verify_ip>, B<-verify_name>, B<-x509_strict>
236
237 Set various certificate chain validation options. See the
238 L<verify(1)> manual page for details.
239
240 =item B<-reconnect>
241
242 reconnects to the same server 5 times using the same session ID, this can
243 be used as a test that session caching is working.
244
245 =item B<-showcerts>
246
247 display the whole server certificate chain: normally only the server
248 certificate itself is displayed.
249
250 =item B<-prexit>
251
252 print session information when the program exits. This will always attempt
253 to print out information even if the connection fails. Normally information
254 will only be printed out once if the connection succeeds. This option is useful
255 because the cipher in use may be renegotiated or the connection may fail
256 because a client certificate is required or is requested only after an
257 attempt is made to access a certain URL. Note: the output produced by this
258 option is not always accurate because a connection might never have been
259 established.
260
261 =item B<-state>
262
263 prints out the SSL session states.
264
265 =item B<-debug>
266
267 print extensive debugging information including a hex dump of all traffic.
268
269 =item B<-msg>
270
271 show all protocol messages with hex dump.
272
273 =item B<-trace>
274
275 show verbose trace output of protocol messages. OpenSSL needs to be compiled
276 with B<enable-ssl-trace> for this option to work.
277
278 =item B<-msgfile>
279
280 file to send output of B<-msg> or B<-trace> to, default standard output.
281
282 =item B<-nbio_test>
283
284 tests non-blocking I/O
285
286 =item B<-nbio>
287
288 turns on non-blocking I/O
289
290 =item B<-crlf>
291
292 this option translated a line feed from the terminal into CR+LF as required
293 by some servers.
294
295 =item B<-ign_eof>
296
297 inhibit shutting down the connection when end of file is reached in the
298 input.
299
300 =item B<-quiet>
301
302 inhibit printing of session and certificate information.  This implicitly
303 turns on B<-ign_eof> as well.
304
305 =item B<-no_ign_eof>
306
307 shut down the connection when end of file is reached in the input.
308 Can be used to override the implicit B<-ign_eof> after B<-quiet>.
309
310 =item B<-psk_identity identity>
311
312 Use the PSK identity B<identity> when using a PSK cipher suite.
313
314 =item B<-psk key>
315
316 Use the PSK key B<key> when using a PSK cipher suite. The key is
317 given as a hexadecimal number without leading 0x, for example -psk
318 1a2b3c4d.
319
320 =item B<-ssl3>, B<-tls1>, B<-tls1_1>, B<-tls1_2>, B<-no_ssl3>, B<-no_tls1>, B<-no_tls1_1>, B<-no_tls1_2>
321
322 These options require or disable the use of the specified SSL or TLS protocols.
323 By default B<s_client> will negotiate the highest mutually supported protocol
324 version.
325 When a specific TLS version is required, only that version will be offered to
326 and accepted from the server.
327
328 =item B<-dtls>, B<-dtls1>, B<-dtls1_2>
329
330 These options make B<s_client> use DTLS protocols instead of TLS.
331 With B<-dtls>, B<s_client> will negotiate any supported DTLS protcol version,
332 whilst B<-dtls1> and B<-dtls1_2> will only support DTLS1.0 and DTLS1.2
333 respectively.
334
335 =item B<-fallback_scsv>
336
337 Send TLS_FALLBACK_SCSV in the ClientHello.
338
339 =item B<-async>
340
341 switch on asynchronous mode. Cryptographic operations will be performed
342 asynchronously. This will only have an effect if an asynchronous capable engine
343 is also used via the B<-engine> option. For test purposes the dummy async engine
344 (dasync) can be used (if available).
345
346 =item B<-split_send_frag int>
347
348 The size used to split data for encrypt pipelines. If more data is written in
349 one go than this value then it will be split into multiple pipelines, up to the
350 maximum number of pipelines defined by max_pipelines. This only has an effect if
351 a suitable ciphersuite has been negotiated, an engine that supports pipelining
352 has been loaded, and max_pipelines is greater than 1. See
353 L<SSL_CTX_set_split_send_fragment(3)> for further information.
354
355 =item B<-max_pipelines int>
356
357 The maximum number of encrypt/decrypt pipelines to be used. This will only have
358 an effect if an engine has been loaded that supports pipelining (e.g. the dasync
359 engine) and a suiteable ciphersuite has been negotiated. The default value is 1.
360 See L<SSL_CTX_set_max_pipelines(3)> for further information.
361
362 =item B<-read_buf int>
363
364 The default read buffer size to be used for connections. This will only have an
365 effect if the buffer size is larger than the size that would otherwise be used
366 and pipelining is in use (see L<SSL_CTX_set_default_read_buffer_len(3)> for
367 further information).
368
369 =item B<-bugs>
370
371 there are several known bug in SSL and TLS implementations. Adding this
372 option enables various workarounds.
373
374 =item B<-comp>
375
376 Enables support for SSL/TLS compression.
377 This option was introduced in OpenSSL 1.1.0.
378 TLS compression is not recommended and is off by default as of
379 OpenSSL 1.1.0.
380
381 =item B<-no_comp>
382
383 Disables support for SSL/TLS compression.
384 TLS compression is not recommended and is off by default as of
385 OpenSSL 1.1.0.
386
387 =item B<-brief>
388
389 only provide a brief summary of connection parameters instead of the
390 normal verbose output.
391
392 =item B<-cipher cipherlist>
393
394 this allows the cipher list sent by the client to be modified. Although
395 the server determines which cipher suite is used it should take the first
396 supported cipher in the list sent by the client. See the B<ciphers>
397 command for more information.
398
399 =item B<-starttls protocol>
400
401 send the protocol-specific message(s) to switch to TLS for communication.
402 B<protocol> is a keyword for the intended protocol.  Currently, the only
403 supported keywords are "smtp", "pop3", "imap", "ftp", "xmpp", "xmpp-server",
404 and "irc."
405
406 =item B<-xmpphost hostname>
407
408 This option, when used with "-starttls xmpp" or "-starttls xmpp-server",
409 specifies the host for the "to" attribute of the stream element.
410 If this option is not specified, then the host specified with "-connect"
411 will be used.
412
413 =item B<-tlsextdebug>
414
415 print out a hex dump of any TLS extensions received from the server.
416
417 =item B<-no_ticket>
418
419 disable RFC4507bis session ticket support. 
420
421 =item B<-sess_out filename>
422
423 output SSL session to B<filename>
424
425 =item B<-sess_in sess.pem>
426
427 load SSL session from B<filename>. The client will attempt to resume a
428 connection from this session.
429
430 =item B<-engine id>
431
432 specifying an engine (by its unique B<id> string) will cause B<s_client>
433 to attempt to obtain a functional reference to the specified engine,
434 thus initialising it if needed. The engine will then be set as the default
435 for all available algorithms.
436
437 =item B<-rand file(s)>
438
439 a file or files containing random data used to seed the random number
440 generator, or an EGD socket (see L<RAND_egd(3)>).
441 Multiple files can be specified separated by an OS-dependent character.
442 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
443 all others.
444
445 =item B<-serverinfo types>
446
447 a list of comma-separated TLS Extension Types (numbers between 0 and 
448 65535).  Each type will be sent as an empty ClientHello TLS Extension.
449 The server's response (if any) will be encoded and displayed as a PEM
450 file.
451
452 =item B<-status>
453
454 sends a certificate status request to the server (OCSP stapling). The server
455 response (if any) is printed out.
456
457 =item B<-nextprotoneg protocols>
458
459 enable Next Protocol Negotiation TLS extension and provide a list of
460 comma-separated protocol names that the client should advertise
461 support for. The list should contain most wanted protocols first.
462 Protocol names are printable ASCII strings, for example "http/1.1" or
463 "spdy/3".
464 Empty list of protocols is treated specially and will cause the client to
465 advertise support for the TLS extension but disconnect just after
466 receiving ServerHello with a list of server supported protocols.
467
468 =item B<-ct|noct>
469
470 Use one of these two options to control whether Certificate Transparency (CT)
471 is enabled (B<-ct>) or disabled (B<-noct>).
472 If CT is enabled, signed certificate timestamps (SCTs) will be requested from
473 the server and reported at handshake completion.
474
475 Enabling CT also enables OCSP stapling, as this is one possible delivery method
476 for SCTs.
477
478 =item B<-ctlogfile>
479
480 A file containing a list of known Certificate Transparency logs. See
481 L<SSL_CTX_set_ctlog_list_file(3)> for the expected file format.
482
483 =back
484
485 =head1 CONNECTED COMMANDS
486
487 If a connection is established with an SSL server then any data received
488 from the server is displayed and any key presses will be sent to the
489 server. When used interactively (which means neither B<-quiet> nor B<-ign_eof>
490 have been given), the session will be renegotiated if the line begins with an
491 B<R>, and if the line begins with a B<Q> or if end of file is reached, the
492 connection will be closed down.
493
494 =head1 NOTES
495
496 B<s_client> can be used to debug SSL servers. To connect to an SSL HTTP
497 server the command:
498
499  openssl s_client -connect servername:443
500
501 would typically be used (https uses port 443). If the connection succeeds
502 then an HTTP command can be given such as "GET /" to retrieve a web page.
503
504 If the handshake fails then there are several possible causes, if it is
505 nothing obvious like no client certificate then the B<-bugs>,
506 B<-ssl3>, B<-tls1>, B<-no_ssl3>, B<-no_tls1> options can be tried
507 in case it is a buggy server. In particular you should play with these
508 options B<before> submitting a bug report to an OpenSSL mailing list.
509
510 A frequent problem when attempting to get client certificates working
511 is that a web client complains it has no certificates or gives an empty
512 list to choose from. This is normally because the server is not sending
513 the clients certificate authority in its "acceptable CA list" when it
514 requests a certificate. By using B<s_client> the CA list can be viewed
515 and checked. However some servers only request client authentication
516 after a specific URL is requested. To obtain the list in this case it
517 is necessary to use the B<-prexit> option and send an HTTP request
518 for an appropriate page.
519
520 If a certificate is specified on the command line using the B<-cert>
521 option it will not be used unless the server specifically requests
522 a client certificate. Therefor merely including a client certificate
523 on the command line is no guarantee that the certificate works.
524
525 If there are problems verifying a server certificate then the
526 B<-showcerts> option can be used to show the whole chain.
527
528 The B<s_client> utility is a test tool and is designed to continue the
529 handshake after any certificate verification errors. As a result it will
530 accept any certificate chain (trusted or not) sent by the peer. None test
531 applications should B<not> do this as it makes them vulnerable to a MITM
532 attack. This behaviour can be changed by with the B<-verify_return_error>
533 option: any verify errors are then returned aborting the handshake.
534
535 =head1 BUGS
536
537 Because this program has a lot of options and also because some of the
538 techniques used are rather old, the C source of B<s_client> is rather hard to
539 read and not a model of how things should be done.
540 A typical SSL client program would be much simpler.
541
542 The B<-prexit> option is a bit of a hack. We should really report
543 information whenever a session is renegotiated.
544
545 =head1 SEE ALSO
546
547 L<sess_id(1)>, L<s_server(1)>, L<ciphers(1)>
548
549 =head1 HISTORY
550
551 The -no_alt_chains options was first added to OpenSSL 1.1.0.
552
553 =cut