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