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