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