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