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