doc/man1/s_client.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 s_client - SSL/TLS client program
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl> B<s_client>
  10 [B<-help>]
  11 [B<-connect host:port>]
  12 [B<-proxy host:port>]
  13 [B<-unix path>]
  14 [B<-4>]
  15 [B<-6>]
  16 [B<-servername name>]
  17 [B<-verify depth>]
  18 [B<-verify_return_error>]
  19 [B<-cert filename>]
  20 [B<-certform DER|PEM>]
  21 [B<-key filename>]
  22 [B<-keyform DER|PEM>]
  23 [B<-pass arg>]
  24 [B<-CApath directory>]
  25 [B<-CAfile filename>]
  26 [B<-no-CAfile>]
  27 [B<-no-CApath>]
  28 [B<-dane_tlsa_domain domain>]
  29 [B<-dane_tlsa_rrdata rrdata>]
  30 [B<-dane_ee_no_namechecks>]
  31 [B<-attime timestamp>]
  32 [B<-check_ss_sig>]
  33 [B<-crl_check>]
  34 [B<-crl_check_all>]
  35 [B<-explicit_policy>]
  36 [B<-extended_crl>]
  37 [B<-ignore_critical>]
  38 [B<-inhibit_any>]
  39 [B<-inhibit_map>]
  40 [B<-no_check_time>]
  41 [B<-partial_chain>]
  42 [B<-policy arg>]
  43 [B<-policy_check>]
  44 [B<-policy_print>]
  45 [B<-purpose purpose>]
  46 [B<-suiteB_128>]
  47 [B<-suiteB_128_only>]
  48 [B<-suiteB_192>]
  49 [B<-trusted_first>]
  50 [B<-no_alt_chains>]
  51 [B<-use_deltas>]
  52 [B<-auth_level num>]
  53 [B<-nameopt option>]
  54 [B<-verify_depth num>]
  55 [B<-verify_email email>]
  56 [B<-verify_hostname hostname>]
  57 [B<-verify_ip ip>]
  58 [B<-verify_name name>]
  59 [B<-x509_strict>]
  60 [B<-reconnect>]
  61 [B<-showcerts>]
  62 [B<-debug>]
  63 [B<-msg>]
  64 [B<-nbio_test>]
  65 [B<-state>]
  66 [B<-nbio>]
  67 [B<-crlf>]
  68 [B<-ign_eof>]
  69 [B<-no_ign_eof>]
  70 [B<-quiet>]
  71 [B<-ssl3>]
  72 [B<-tls1>]
  73 [B<-tls1_1>]
  74 [B<-tls1_2>]
  75 [B<-tls1_3>]
  76 [B<-no_ssl3>]
  77 [B<-no_tls1>]
  78 [B<-no_tls1_1>]
  79 [B<-no_tls1_2>]
  80 [B<-no_tls1_3>]
  81 [B<-dtls>]
  82 [B<-dtls1>]
  83 [B<-dtls1_2>]
  84 [B<-fallback_scsv>]
  85 [B<-async>]
  86 [B<-split_send_frag>]
  87 [B<-max_pipelines>]
  88 [B<-read_buf>]
  89 [B<-bugs>]
  90 [B<-comp>]
  91 [B<-no_comp>]
  92 [B<-cipher cipherlist>]
  93 [B<-serverpref>]
  94 [B<-starttls protocol>]
  95 [B<-xmpphost hostname>]
  96 [B<-engine id>]
  97 [B<-tlsextdebug>]
  98 [B<-no_ticket>]
  99 [B<-sess_out filename>]
 100 [B<-sess_in filename>]
 101 [B<-rand file(s)>]
 102 [B<-serverinfo types>]
 103 [B<-status>]
 104 [B<-alpn protocols>]
 105 [B<-nextprotoneg protocols>]
 106 [B<-ct|noct>]
 107 [B<-ctlogfile>]
 108 [B<-keylogfile file>]
 109 [B<-early_data file>]
 110
 111 =head1 DESCRIPTION
 112
 113 The B<s_client> command implements a generic SSL/TLS client which connects
 114 to a remote host using SSL/TLS. It is a I<very> useful diagnostic tool for
 115 SSL servers.
 116
 117 =head1 OPTIONS
 118
 119 In addition to the options below the B<s_client> utility also supports the
 120 common and client only options documented in the
 121 in the "Supported Command Line Commands" section of the L<SSL_CONF_cmd(3)>
 122 manual page.
 123
 124 =over 4
 125
 126 =item B<-help>
 127
 128 Print out a usage message.
 129
 130 =item B<-connect host:port>
 131
 132 This specifies the host and optional port to connect to. If not specified
 133 then an attempt is made to connect to the local host on port 4433.
 134
 135 =item B<-proxy host:port>
 136
 137 When used with the B<-connect> flag, the program uses the host and port
 138 specified with this flag and issues an HTTP CONNECT command to connect
 139 to the desired server.
 140
 141 =item B<-unix path>
 142
 143 Connect over the specified Unix-domain socket.
 144
 145 =item B<-4>
 146
 147 Use IPv4 only.
 148
 149 =item B<-6>
 150
 151 Use IPv6 only.
 152
 153 =item B<-servername name>
 154
 155 Set the TLS SNI (Server Name Indication) extension in the ClientHello message.
 156
 157 =item B<-cert certname>
 158
 159 The certificate to use, if one is requested by the server. The default is
 160 not to use a certificate.
 161
 162 =item B<-certform format>
 163
 164 The certificate format to use: DER or PEM. PEM is the default.
 165
 166 =item B<-key keyfile>
 167
 168 The private key to use. If not specified then the certificate file will
 169 be used.
 170
 171 =item B<-keyform format>
 172
 173 The private format to use: DER or PEM. PEM is the default.
 174
 175 =item B<-pass arg>
 176
 177 the private key password source. For more information about the format of B<arg>
 178 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
 179
 180 =item B<-verify depth>
 181
 182 The verify depth to use. This specifies the maximum length of the
 183 server certificate chain and turns on server certificate verification.
 184 Currently the verify operation continues after errors so all the problems
 185 with a certificate chain can be seen. As a side effect the connection
 186 will never fail due to a server certificate verify failure.
 187
 188 =item B<-verify_return_error>
 189
 190 Return verification errors instead of continuing. This will typically
 191 abort the handshake with a fatal error.
 192
 193 =item B<-nameopt option>
 194
 195 option which determines how the subject or issuer names are displayed. The
 196 B<option> argument can be a single option or multiple options separated by
 197 commas.  Alternatively the B<-nameopt> switch may be used more than once to
 198 set multiple options. See the L<x509(1)> manual page for details.
 199
 200 =item B<-CApath directory>
 201
 202 The directory to use for server certificate verification. This directory
 203 must be in "hash format", see B<verify> for more information. These are
 204 also used when building the client certificate chain.
 205
 206 =item B<-CAfile file>
 207
 208 A file containing trusted certificates to use during server authentication
 209 and to use when attempting to build the client certificate chain.
 210
 211 =item B<-no-CAfile>
 212
 213 Do not load the trusted CA certificates from the default file location
 214
 215 =item B<-no-CApath>
 216
 217 Do not load the trusted CA certificates from the default directory location
 218
 219 =item B<-dane_tlsa_domain domain>
 220
 221 Enable RFC6698/RFC7671 DANE TLSA authentication and specify the
 222 TLSA base domain which becomes the default SNI hint and the primary
 223 reference identifier for hostname checks.  This must be used in
 224 combination with at least one instance of the B<-dane_tlsa_rrdata>
 225 option below.
 226
 227 When DANE authentication succeeds, the diagnostic output will include
 228 the lowest (closest to 0) depth at which a TLSA record authenticated
 229 a chain certificate.  When that TLSA record is a "2 1 0" trust
 230 anchor public key that signed (rather than matched) the top-most
 231 certificate of the chain, the result is reported as "TA public key
 232 verified".  Otherwise, either the TLSA record "matched TA certificate"
 233 at a positive depth or else "matched EE certificate" at depth 0.
 234
 235 =item B<-dane_tlsa_rrdata rrdata>
 236
 237 Use one or more times to specify the RRDATA fields of the DANE TLSA
 238 RRset associated with the target service.  The B<rrdata> value is
 239 specied in "presentation form", that is four whitespace separated
 240 fields that specify the usage, selector, matching type and associated
 241 data, with the last of these encoded in hexadecimal.  Optional
 242 whitespace is ignored in the associated data field.  For example:
 243
 244   $ openssl s_client -brief -starttls smtp \
 245     -connect smtp.example.com:25 \
 246     -dane_tlsa_domain smtp.example.com \
 247     -dane_tlsa_rrdata "2 1 1
 248       B111DD8A1C2091A89BD4FD60C57F0716CCE50FEEFF8137CDBEE0326E 02CF362B" \
 249     -dane_tlsa_rrdata "2 1 1
 250       60B87575447DCBA2A36B7D11AC09FB24A9DB406FEE12D2CC90180517 616E8A18"
 251   ...
 252   Verification: OK
 253   Verified peername: smtp.example.com
 254   DANE TLSA 2 1 1 ...ee12d2cc90180517616e8a18 matched TA certificate at depth 1
 255   ...
 256
 257 =item B<-dane_ee_no_namechecks>
 258
 259 This disables server name checks when authenticating via DANE-EE(3) TLSA
 260 records.
 261 For some applications, primarily web browsers, it is not safe to disable name
 262 checks due to "unknown key share" attacks, in which a malicious server can
 263 convince a client that a connection to a victim server is instead a secure
 264 connection to the malicious server.
 265 The malicious server may then be able to violate cross-origin scripting
 266 restrictions.
 267 Thus, despite the text of RFC7671, name checks are by default enabled for
 268 DANE-EE(3) TLSA records, and can be disabled in applications where it is safe
 269 to do so.
 270 In particular, SMTP and XMPP clients should set this option as SRV and MX
 271 records already make it possible for a remote domain to redirect client
 272 connections to any server of its choice, and in any case SMTP and XMPP clients
 273 do not execute scripts downloaded from remote servers.
 274
 275 =item B<-attime>, B<-check_ss_sig>, B<-crl_check>, B<-crl_check_all>,
 276 B<-explicit_policy>, B<-extended_crl>, B<-ignore_critical>, B<-inhibit_any>,
 277 B<-inhibit_map>, B<-no_alt_chains>, B<-no_check_time>, B<-partial_chain>, B<-policy>,
 278 B<-policy_check>, B<-policy_print>, B<-purpose>, B<-suiteB_128>,
 279 B<-suiteB_128_only>, B<-suiteB_192>, B<-trusted_first>, B<-use_deltas>,
 280 B<-auth_level>, B<-verify_depth>, B<-verify_email>, B<-verify_hostname>,
 281 B<-verify_ip>, B<-verify_name>, B<-x509_strict>
 282
 283 Set various certificate chain validation options. See the
 284 L<verify(1)> manual page for details.
 285
 286 =item B<-reconnect>
 287
 288 reconnects to the same server 5 times using the same session ID, this can
 289 be used as a test that session caching is working.
 290
 291 =item B<-showcerts>
 292
 293 display the whole server certificate chain: normally only the server
 294 certificate itself is displayed.
 295
 296 =item B<-prexit>
 297
 298 print session information when the program exits. This will always attempt
 299 to print out information even if the connection fails. Normally information
 300 will only be printed out once if the connection succeeds. This option is useful
 301 because the cipher in use may be renegotiated or the connection may fail
 302 because a client certificate is required or is requested only after an
 303 attempt is made to access a certain URL. Note: the output produced by this
 304 option is not always accurate because a connection might never have been
 305 established.
 306
 307 =item B<-state>
 308
 309 prints out the SSL session states.
 310
 311 =item B<-debug>
 312
 313 print extensive debugging information including a hex dump of all traffic.
 314
 315 =item B<-msg>
 316
 317 show all protocol messages with hex dump.
 318
 319 =item B<-trace>
 320
 321 show verbose trace output of protocol messages. OpenSSL needs to be compiled
 322 with B<enable-ssl-trace> for this option to work.
 323
 324 =item B<-msgfile>
 325
 326 file to send output of B<-msg> or B<-trace> to, default standard output.
 327
 328 =item B<-nbio_test>
 329
 330 tests non-blocking I/O
 331
 332 =item B<-nbio>
 333
 334 turns on non-blocking I/O
 335
 336 =item B<-crlf>
 337
 338 this option translated a line feed from the terminal into CR+LF as required
 339 by some servers.
 340
 341 =item B<-ign_eof>
 342
 343 inhibit shutting down the connection when end of file is reached in the
 344 input.
 345
 346 =item B<-quiet>
 347
 348 inhibit printing of session and certificate information.  This implicitly
 349 turns on B<-ign_eof> as well.
 350
 351 =item B<-no_ign_eof>
 352
 353 shut down the connection when end of file is reached in the input.
 354 Can be used to override the implicit B<-ign_eof> after B<-quiet>.
 355
 356 =item B<-psk_identity identity>
 357
 358 Use the PSK identity B<identity> when using a PSK cipher suite.
 359
 360 =item B<-psk key>
 361
 362 Use the PSK key B<key> when using a PSK cipher suite. The key is
 363 given as a hexadecimal number without leading 0x, for example -psk
 364 1a2b3c4d.
 365
 366 =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>
 367
 368 These options require or disable the use of the specified SSL or TLS protocols.
 369 By default B<s_client> will negotiate the highest mutually supported protocol
 370 version.
 371 When a specific TLS version is required, only that version will be offered to
 372 and accepted from the server.
 373
 374 =item B<-dtls>, B<-dtls1>, B<-dtls1_2>
 375
 376 These options make B<s_client> use DTLS protocols instead of TLS.
 377 With B<-dtls>, B<s_client> will negotiate any supported DTLS protocol version,
 378 whilst B<-dtls1> and B<-dtls1_2> will only support DTLS1.0 and DTLS1.2
 379 respectively.
 380
 381 =item B<-fallback_scsv>
 382
 383 Send TLS_FALLBACK_SCSV in the ClientHello.
 384
 385 =item B<-async>
 386
 387 switch on asynchronous mode. Cryptographic operations will be performed
 388 asynchronously. This will only have an effect if an asynchronous capable engine
 389 is also used via the B<-engine> option. For test purposes the dummy async engine
 390 (dasync) can be used (if available).
 391
 392 =item B<-split_send_frag int>
 393
 394 The size used to split data for encrypt pipelines. If more data is written in
 395 one go than this value then it will be split into multiple pipelines, up to the
 396 maximum number of pipelines defined by max_pipelines. This only has an effect if
 397 a suitable ciphersuite has been negotiated, an engine that supports pipelining
 398 has been loaded, and max_pipelines is greater than 1. See
 399 L<SSL_CTX_set_split_send_fragment(3)> for further information.
 400
 401 =item B<-max_pipelines int>
 402
 403 The maximum number of encrypt/decrypt pipelines to be used. This will only have
 404 an effect if an engine has been loaded that supports pipelining (e.g. the dasync
 405 engine) and a suitable ciphersuite has been negotiated. The default value is 1.
 406 See L<SSL_CTX_set_max_pipelines(3)> for further information.
 407
 408 =item B<-read_buf int>
 409
 410 The default read buffer size to be used for connections. This will only have an
 411 effect if the buffer size is larger than the size that would otherwise be used
 412 and pipelining is in use (see L<SSL_CTX_set_default_read_buffer_len(3)> for
 413 further information).
 414
 415 =item B<-bugs>
 416
 417 there are several known bug in SSL and TLS implementations. Adding this
 418 option enables various workarounds.
 419
 420 =item B<-comp>
 421
 422 Enables support for SSL/TLS compression.
 423 This option was introduced in OpenSSL 1.1.0.
 424 TLS compression is not recommended and is off by default as of
 425 OpenSSL 1.1.0.
 426
 427 =item B<-no_comp>
 428
 429 Disables support for SSL/TLS compression.
 430 TLS compression is not recommended and is off by default as of
 431 OpenSSL 1.1.0.
 432
 433 =item B<-brief>
 434
 435 only provide a brief summary of connection parameters instead of the
 436 normal verbose output.
 437
 438 =item B<-cipher cipherlist>
 439
 440 this allows the cipher list sent by the client to be modified. Although
 441 the server determines which cipher suite is used it should take the first
 442 supported cipher in the list sent by the client. See the B<ciphers>
 443 command for more information.
 444
 445 =item B<-starttls protocol>
 446
 447 send the protocol-specific message(s) to switch to TLS for communication.
 448 B<protocol> is a keyword for the intended protocol.  Currently, the only
 449 supported keywords are "smtp", "pop3", "imap", "ftp", "xmpp", "xmpp-server",
 450 "irc", "postgres", "lmtp", "nntp", "sieve" and "ldap".
 451
 452 =item B<-xmpphost hostname>
 453
 454 This option, when used with "-starttls xmpp" or "-starttls xmpp-server",
 455 specifies the host for the "to" attribute of the stream element.
 456 If this option is not specified, then the host specified with "-connect"
 457 will be used.
 458
 459 =item B<-tlsextdebug>
 460
 461 print out a hex dump of any TLS extensions received from the server.
 462
 463 =item B<-no_ticket>
 464
 465 disable RFC4507bis session ticket support.
 466
 467 =item B<-sess_out filename>
 468
 469 output SSL session to B<filename>
 470
 471 =item B<-sess_in sess.pem>
 472
 473 load SSL session from B<filename>. The client will attempt to resume a
 474 connection from this session.
 475
 476 =item B<-engine id>
 477
 478 specifying an engine (by its unique B<id> string) will cause B<s_client>
 479 to attempt to obtain a functional reference to the specified engine,
 480 thus initialising it if needed. The engine will then be set as the default
 481 for all available algorithms.
 482
 483 =item B<-rand file(s)>
 484
 485 a file or files containing random data used to seed the random number
 486 generator, or an EGD socket (see L<RAND_egd(3)>).
 487 Multiple files can be specified separated by an OS-dependent character.
 488 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
 489 all others.
 490
 491 =item B<-serverinfo types>
 492
 493 a list of comma-separated TLS Extension Types (numbers between 0 and
 494 65535).  Each type will be sent as an empty ClientHello TLS Extension.
 495 The server's response (if any) will be encoded and displayed as a PEM
 496 file.
 497
 498 =item B<-status>
 499
 500 sends a certificate status request to the server (OCSP stapling). The server
 501 response (if any) is printed out.
 502
 503 =item B<-alpn protocols>, B<-nextprotoneg protocols>
 504
 505 these flags enable the
 506 Enable the Application-Layer Protocol Negotiation or Next Protocol
 507 Negotiation extension, respectively. ALPN is the IETF standard and
 508 replaces NPN.
 509 The B<protocols> list is a
 510 comma-separated protocol names that the client should advertise
 511 support for. The list should contain most wanted protocols first.
 512 Protocol names are printable ASCII strings, for example "http/1.1" or
 513 "spdy/3".
 514 Empty list of protocols is treated specially and will cause the client to
 515 advertise support for the TLS extension but disconnect just after
 516 receiving ServerHello with a list of server supported protocols.
 517
 518 =item B<-ct|noct>
 519
 520 Use one of these two options to control whether Certificate Transparency (CT)
 521 is enabled (B<-ct>) or disabled (B<-noct>).
 522 If CT is enabled, signed certificate timestamps (SCTs) will be requested from
 523 the server and reported at handshake completion.
 524
 525 Enabling CT also enables OCSP stapling, as this is one possible delivery method
 526 for SCTs.
 527
 528 =item B<-ctlogfile>
 529
 530 A file containing a list of known Certificate Transparency logs. See
 531 L<SSL_CTX_set_ctlog_list_file(3)> for the expected file format.
 532
 533 =item B<-keylogfile file>
 534
 535 Appends TLS secrets to the specified keylog file such that external programs
 536 (like Wireshark) can decrypt TLS connections.
 537
 538 =item B<-early_data file>
 539
 540 Reads the contents of the specified file and attempts to send it as early data
 541 to the server. This will only work with resumed sessions that support early
 542 data and when the server accepts the early data.
 543
 544 =back
 545
 546 =head1 CONNECTED COMMANDS
 547
 548 If a connection is established with an SSL server then any data received
 549 from the server is displayed and any key presses will be sent to the
 550 server. When used interactively (which means neither B<-quiet> nor B<-ign_eof>
 551 have been given), the session will be renegotiated if the line begins with an
 552 B<R>, and if the line begins with a B<Q> or if end of file is reached, the
 553 connection will be closed down.
 554
 555 =head1 NOTES
 556
 557 B<s_client> can be used to debug SSL servers. To connect to an SSL HTTP
 558 server the command:
 559
 560  openssl s_client -connect servername:443
 561
 562 would typically be used (https uses port 443). If the connection succeeds
 563 then an HTTP command can be given such as "GET /" to retrieve a web page.
 564
 565 If the handshake fails then there are several possible causes, if it is
 566 nothing obvious like no client certificate then the B<-bugs>,
 567 B<-ssl3>, B<-tls1>, B<-no_ssl3>, B<-no_tls1> options can be tried
 568 in case it is a buggy server. In particular you should play with these
 569 options B<before> submitting a bug report to an OpenSSL mailing list.
 570
 571 A frequent problem when attempting to get client certificates working
 572 is that a web client complains it has no certificates or gives an empty
 573 list to choose from. This is normally because the server is not sending
 574 the clients certificate authority in its "acceptable CA list" when it
 575 requests a certificate. By using B<s_client> the CA list can be viewed
 576 and checked. However some servers only request client authentication
 577 after a specific URL is requested. To obtain the list in this case it
 578 is necessary to use the B<-prexit> option and send an HTTP request
 579 for an appropriate page.
 580
 581 If a certificate is specified on the command line using the B<-cert>
 582 option it will not be used unless the server specifically requests
 583 a client certificate. Therefor merely including a client certificate
 584 on the command line is no guarantee that the certificate works.
 585
 586 If there are problems verifying a server certificate then the
 587 B<-showcerts> option can be used to show the whole chain.
 588
 589 The B<s_client> utility is a test tool and is designed to continue the
 590 handshake after any certificate verification errors. As a result it will
 591 accept any certificate chain (trusted or not) sent by the peer. None test
 592 applications should B<not> do this as it makes them vulnerable to a MITM
 593 attack. This behaviour can be changed by with the B<-verify_return_error>
 594 option: any verify errors are then returned aborting the handshake.
 595
 596 =head1 BUGS
 597
 598 Because this program has a lot of options and also because some of the
 599 techniques used are rather old, the C source of B<s_client> is rather hard to
 600 read and not a model of how things should be done.
 601 A typical SSL client program would be much simpler.
 602
 603 The B<-prexit> option is a bit of a hack. We should really report
 604 information whenever a session is renegotiated.
 605
 606 =head1 SEE ALSO
 607
 608 L<SSL_CONF_cmd(3)>,
 609 L<sess_id(1)>, L<s_server(1)>, L<ciphers(1)>
 610
 611 =head1 HISTORY
 612
 613 The -no_alt_chains options was first added to OpenSSL 1.1.0.
 614
 615 =head1 COPYRIGHT
 616
 617 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
 618
 619 Licensed under the OpenSSL license (the "License").  You may not use
 620 this file except in compliance with the License.  You can obtain a copy
 621 in the file LICENSE in the source distribution or at
 622 L<https://www.openssl.org/source/license.html>.
 623
 624 =cut