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