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