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