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