doc/apps/s_client.pod

   1
   2 =pod
   3
   4 =head1 NAME
   5
   6 s_client - SSL/TLS client program
   7
   8 =head1 SYNOPSIS
   9
  10 B<openssl> B<s_client>
  11 [B<-help>]
  12 [B<-connect host:port>]
  13 [B<-proxy host:port>]
  14 [B<-servername name>]
  15 [B<-verify depth>]
  16 [B<-verify_return_error>]
  17 [B<-cert filename>]
  18 [B<-certform DER|PEM>]
  19 [B<-key filename>]
  20 [B<-keyform DER|PEM>]
  21 [B<-pass arg>]
  22 [B<-CApath directory>]
  23 [B<-CAfile filename>]
  24 [B<-no-CAfile>]
  25 [B<-no-CApath>]
  26 [B<-dane_tlsa_domain domain>]
  27 [B<-dane_tlsa_rrdata rrdata>]
  28 [B<-attime timestamp>]
  29 [B<-check_ss_sig>]
  30 [B<-crl_check>]
  31 [B<-crl_check_all>]
  32 [B<-explicit_policy>]
  33 [B<-extended_crl>]
  34 [B<-ignore_critical>]
  35 [B<-inhibit_any>]
  36 [B<-inhibit_map>]
  37 [B<-partial_chain>]
  38 [B<-policy arg>]
  39 [B<-policy_check>]
  40 [B<-policy_print>]
  41 [B<-purpose purpose>]
  42 [B<-suiteB_128>]
  43 [B<-suiteB_128_only>]
  44 [B<-suiteB_192>]
  45 [B<-trusted_first>]
  46 [B<-no_alt_chains>]
  47 [B<-use_deltas>]
  48 [B<-verify_depth num>]
  49 [B<-verify_email email>]
  50 [B<-verify_hostname hostname>]
  51 [B<-verify_ip ip>]
  52 [B<-verify_name name>]
  53 [B<-x509_strict>]
  54 [B<-reconnect>]
  55 [B<-showcerts>]
  56 [B<-debug>]
  57 [B<-msg>]
  58 [B<-nbio_test>]
  59 [B<-state>]
  60 [B<-nbio>]
  61 [B<-crlf>]
  62 [B<-ign_eof>]
  63 [B<-no_ign_eof>]
  64 [B<-quiet>]
  65 [B<-ssl3>]
  66 [B<-tls1>]
  67 [B<-no_ssl3>]
  68 [B<-no_tls1>]
  69 [B<-no_tls1_1>]
  70 [B<-no_tls1_2>]
  71 [B<-fallback_scsv>]
  72 [B<-async>]
  73 [B<-bugs>]
  74 [B<-comp>]
  75 [B<-no_comp>]
  76 [B<-cipher cipherlist>]
  77 [B<-serverpref>]
  78 [B<-starttls protocol>]
  79 [B<-xmpphost hostname>]
  80 [B<-engine id>]
  81 [B<-tlsextdebug>]
  82 [B<-no_ticket>]
  83 [B<-sess_out filename>]
  84 [B<-sess_in filename>]
  85 [B<-rand file(s)>]
  86 [B<-serverinfo types>]
  87 [B<-status>]
  88 [B<-nextprotoneg protocols>]
  89
  90 =head1 DESCRIPTION
  91
  92 The B<s_client> command implements a generic SSL/TLS client which connects
  93 to a remote host using SSL/TLS. It is a I<very> useful diagnostic tool for
  94 SSL servers.
  95
  96 =head1 OPTIONS
  97
  98 In addition to the options below the B<s_client> utility also supports the
  99 common and client only options documented in the
 100 in the L<SSL_CONF_cmd(3)|SSL_CONF_cmd(3)/SUPPORTED COMMAND LINE COMMANDS>
 101 manual page.
 102
 103 =over 4
 104
 105 =item B<-help>
 106
 107 Print out a usage message.
 108
 109 =item B<-connect host:port>
 110
 111 This specifies the host and optional port to connect to. If not specified
 112 then an attempt is made to connect to the local host on port 4433.
 113
 114 =item B<-proxy host:port>
 115
 116 When used with the B<-connect> flag, the program uses the host and port
 117 specified with this flag and issues an HTTP CONNECT command to connect
 118 to the desired server.
 119
 120 =item B<-servername name>
 121
 122 Set the TLS SNI (Server Name Indication) extension in the ClientHello message.
 123
 124 =item B<-cert certname>
 125
 126 The certificate to use, if one is requested by the server. The default is
 127 not to use a certificate.
 128
 129 =item B<-certform format>
 130
 131 The certificate format to use: DER or PEM. PEM is the default.
 132
 133 =item B<-key keyfile>
 134
 135 The private key to use. If not specified then the certificate file will
 136 be used.
 137
 138 =item B<-keyform format>
 139
 140 The private format to use: DER or PEM. PEM is the default.
 141
 142 =item B<-pass arg>
 143
 144 the private key password source. For more information about the format of B<arg>
 145 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
 146
 147 =item B<-verify depth>
 148
 149 The verify depth to use. This specifies the maximum length of the
 150 server certificate chain and turns on server certificate verification.
 151 Currently the verify operation continues after errors so all the problems
 152 with a certificate chain can be seen. As a side effect the connection
 153 will never fail due to a server certificate verify failure.
 154
 155 =item B<-verify_return_error>
 156
 157 Return verification errors instead of continuing. This will typically
 158 abort the handshake with a fatal error.
 159
 160 =item B<-CApath directory>
 161
 162 The directory to use for server certificate verification. This directory
 163 must be in "hash format", see B<verify> for more information. These are
 164 also used when building the client certificate chain.
 165
 166 =item B<-CAfile file>
 167
 168 A file containing trusted certificates to use during server authentication
 169 and to use when attempting to build the client certificate chain.
 170
 171 =item B<-no-CAfile>
 172
 173 Do not load the trusted CA certificates from the default file location
 174
 175 =item B<-no-CApath>
 176
 177 Do not load the trusted CA certificates from the default directory location
 178
 179 =item B<-dane_tlsa_domain domain>
 180
 181 Enable RFC6698/RFC7671 DANE TLSA authentication and specify the
 182 TLSA base domain which becomes the default SNI hint and the primary
 183 reference identifier for hostname checks.  This must be used in
 184 combination with at least one instance of the B<-dane_tlsa_rrdata>
 185 option below.
 186
 187 When DANE authentication succeeds, the diagnostic output will include
 188 the lowest (closest to 0) depth at which a TLSA record authenticated
 189 a chain certificate.  When that TLSA record is a "2 1 0" trust
 190 anchor public key that signed (rather than matched) the top-most
 191 certificate of the chain, the result is reported as "TA public key
 192 verified".  Otherwise, either the TLSA record "matched TA certificate"
 193 at a positive depth or else "matched EE certificate" at depth 0.
 194
 195 =item B<-dane_tlsa_rrdata rrdata>
 196
 197 Use one or more times to specify the RRDATA fields of the DANE TLSA
 198 RRset associated with the target service.  The B<rrdata> value is
 199 specied in "presentation form", that is four whitespace separated
 200 fields that specify the usage, selector, matching type and associated
 201 data, with the last of these encoded in hexadecimal.  Optional
 202 whitespace is ignored in the associated data field.  For example:
 203
 204   $ openssl s_client -brief -starttls smtp \
 205     -connect smtp.example.com:25 \
 206     -dane_tlsa_domain smtp.example.com \
 207     -dane_tlsa_rrdata "2 1 1
 208       B111DD8A1C2091A89BD4FD60C57F0716CCE50FEEFF8137CDBEE0326E 02CF362B" \
 209     -dane_tlsa_rrdata "2 1 1
 210       60B87575447DCBA2A36B7D11AC09FB24A9DB406FEE12D2CC90180517 616E8A18"
 211   ...
 212   Verification: OK
 213   Verified peername: smtp.example.com
 214   DANE TLSA 2 1 1 ...ee12d2cc90180517616e8a18 matched TA certificate at depth 1
 215   ...
 216
 217 =item B<-attime>, B<-check_ss_sig>, B<-crl_check>, B<-crl_check_all>,
 218 B<-explicit_policy>, B<-extended_crl>, B<-ignore_critical>, B<-inhibit_any>,
 219 B<-inhibit_map>, B<-no_alt_chains>, B<-partial_chain>, B<-policy>,
 220 B<-policy_check>, B<-policy_print>, B<-purpose>, B<-suiteB_128>,
 221 B<-suiteB_128_only>, B<-suiteB_192>, B<-trusted_first>, B<-use_deltas>,
 222 B<-verify_depth>, B<-verify_email>, B<-verify_hostname>, B<-verify_ip>,
 223 B<-verify_name>, B<-x509_strict>
 224
 225 Set various certificate chain validation options. See the
 226 L<verify(1)> manual page for details.
 227
 228 =item B<-reconnect>
 229
 230 reconnects to the same server 5 times using the same session ID, this can
 231 be used as a test that session caching is working.
 232
 233 =item B<-showcerts>
 234
 235 display the whole server certificate chain: normally only the server
 236 certificate itself is displayed.
 237
 238 =item B<-prexit>
 239
 240 print session information when the program exits. This will always attempt
 241 to print out information even if the connection fails. Normally information
 242 will only be printed out once if the connection succeeds. This option is useful
 243 because the cipher in use may be renegotiated or the connection may fail
 244 because a client certificate is required or is requested only after an
 245 attempt is made to access a certain URL. Note: the output produced by this
 246 option is not always accurate because a connection might never have been
 247 established.
 248
 249 =item B<-state>
 250
 251 prints out the SSL session states.
 252
 253 =item B<-debug>
 254
 255 print extensive debugging information including a hex dump of all traffic.
 256
 257 =item B<-msg>
 258
 259 show all protocol messages with hex dump.
 260
 261 =item B<-trace>
 262
 263 show verbose trace output of protocol messages. OpenSSL needs to be compiled
 264 with B<enable-ssl-trace> for this option to work.
 265
 266 =item B<-msgfile>
 267
 268 file to send output of B<-msg> or B<-trace> to, default standard output.
 269
 270 =item B<-nbio_test>
 271
 272 tests non-blocking I/O
 273
 274 =item B<-nbio>
 275
 276 turns on non-blocking I/O
 277
 278 =item B<-crlf>
 279
 280 this option translated a line feed from the terminal into CR+LF as required
 281 by some servers.
 282
 283 =item B<-ign_eof>
 284
 285 inhibit shutting down the connection when end of file is reached in the
 286 input.
 287
 288 =item B<-quiet>
 289
 290 inhibit printing of session and certificate information.  This implicitly
 291 turns on B<-ign_eof> as well.
 292
 293 =item B<-no_ign_eof>
 294
 295 shut down the connection when end of file is reached in the input.
 296 Can be used to override the implicit B<-ign_eof> after B<-quiet>.
 297
 298 =item B<-psk_identity identity>
 299
 300 Use the PSK identity B<identity> when using a PSK cipher suite.
 301
 302 =item B<-psk key>
 303
 304 Use the PSK key B<key> when using a PSK cipher suite. The key is
 305 given as a hexadecimal number without leading 0x, for example -psk
 306 1a2b3c4d.
 307
 308 =item B<-ssl3>, B<-tls1>, B<-no_ssl3>, B<-no_tls1>, B<-no_tls1_1>, B<-no_tls1_2>
 309
 310 these options disable the use of certain SSL or TLS protocols. By default
 311 the initial handshake uses a method which should be compatible with all
 312 servers and permit them to use SSL v3 or TLS as appropriate.
 313
 314 Unfortunately there are still ancient and broken servers in use which
 315 cannot handle this technique and will fail to connect. Some servers only
 316 work if TLS is turned off.
 317
 318 =item B<-fallback_scsv>
 319
 320 Send TLS_FALLBACK_SCSV in the ClientHello.
 321
 322 =item B<-async>
 323
 324 switch on asynchronous mode. Cryptographic operations will be performed
 325 asynchronously. This will only have an effect if an asynchronous capable engine
 326 is also used via the B<-engine> option. For test purposes the dummy async engine
 327 (dasync) can be used (if available).
 328
 329 =item B<-bugs>
 330
 331 there are several known bug in SSL and TLS implementations. Adding this
 332 option enables various workarounds.
 333
 334 =item B<-comp>
 335
 336 Enables support for SSL/TLS compression.
 337 This option was introduced in OpenSSL 1.1.0.
 338 TLS compression is not recommended and is off by default as of
 339 OpenSSL 1.1.0.
 340
 341 =item B<-no_comp>
 342
 343 Disables support for SSL/TLS compression.
 344 TLS compression is not recommended and is off by default as of
 345 OpenSSL 1.1.0.
 346
 347 =item B<-brief>
 348
 349 only provide a brief summary of connection parameters instead of the
 350 normal verbose output.
 351
 352 =item B<-cipher cipherlist>
 353
 354 this allows the cipher list sent by the client to be modified. Although
 355 the server determines which cipher suite is used it should take the first
 356 supported cipher in the list sent by the client. See the B<ciphers>
 357 command for more information.
 358
 359 =item B<-starttls protocol>
 360
 361 send the protocol-specific message(s) to switch to TLS for communication.
 362 B<protocol> is a keyword for the intended protocol.  Currently, the only
 363 supported keywords are "smtp", "pop3", "imap", "ftp", "xmpp", "xmpp-server",
 364 and "irc."
 365
 366 =item B<-xmpphost hostname>
 367
 368 This option, when used with "-starttls xmpp" or "-starttls xmpp-server",
 369 specifies the host for the "to" attribute of the stream element.
 370 If this option is not specified, then the host specified with "-connect"
 371 will be used.
 372
 373 =item B<-tlsextdebug>
 374
 375 print out a hex dump of any TLS extensions received from the server.
 376
 377 =item B<-no_ticket>
 378
 379 disable RFC4507bis session ticket support.
 380
 381 =item B<-sess_out filename>
 382
 383 output SSL session to B<filename>
 384
 385 =item B<-sess_in sess.pem>
 386
 387 load SSL session from B<filename>. The client will attempt to resume a
 388 connection from this session.
 389
 390 =item B<-engine id>
 391
 392 specifying an engine (by its unique B<id> string) will cause B<s_client>
 393 to attempt to obtain a functional reference to the specified engine,
 394 thus initialising it if needed. The engine will then be set as the default
 395 for all available algorithms.
 396
 397 =item B<-rand file(s)>
 398
 399 a file or files containing random data used to seed the random number
 400 generator, or an EGD socket (see L<RAND_egd(3)>).
 401 Multiple files can be specified separated by a OS-dependent character.
 402 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
 403 all others.
 404
 405 =item B<-serverinfo types>
 406
 407 a list of comma-separated TLS Extension Types (numbers between 0 and
 408 65535).  Each type will be sent as an empty ClientHello TLS Extension.
 409 The server's response (if any) will be encoded and displayed as a PEM
 410 file.
 411
 412 =item B<-status>
 413
 414 sends a certificate status request to the server (OCSP stapling). The server
 415 response (if any) is printed out.
 416
 417 =item B<-nextprotoneg protocols>
 418
 419 enable Next Protocol Negotiation TLS extension and provide a list of
 420 comma-separated protocol names that the client should advertise
 421 support for. The list should contain most wanted protocols first.
 422 Protocol names are printable ASCII strings, for example "http/1.1" or
 423 "spdy/3".
 424 Empty list of protocols is treated specially and will cause the client to
 425 advertise support for the TLS extension but disconnect just after
 426 receiving ServerHello with a list of server supported protocols.
 427
 428 =back
 429
 430 =head1 CONNECTED COMMANDS
 431
 432 If a connection is established with an SSL server then any data received
 433 from the server is displayed and any key presses will be sent to the
 434 server. When used interactively (which means neither B<-quiet> nor B<-ign_eof>
 435 have been given), the session will be renegotiated if the line begins with an
 436 B<R>, and if the line begins with a B<Q> or if end of file is reached, the
 437 connection will be closed down.
 438
 439 =head1 NOTES
 440
 441 B<s_client> can be used to debug SSL servers. To connect to an SSL HTTP
 442 server the command:
 443
 444  openssl s_client -connect servername:443
 445
 446 would typically be used (https uses port 443). If the connection succeeds
 447 then an HTTP command can be given such as "GET /" to retrieve a web page.
 448
 449 If the handshake fails then there are several possible causes, if it is
 450 nothing obvious like no client certificate then the B<-bugs>,
 451 B<-ssl3>, B<-tls1>, B<-no_ssl3>, B<-no_tls1> options can be tried
 452 in case it is a buggy server. In particular you should play with these
 453 options B<before> submitting a bug report to an OpenSSL mailing list.
 454
 455 A frequent problem when attempting to get client certificates working
 456 is that a web client complains it has no certificates or gives an empty
 457 list to choose from. This is normally because the server is not sending
 458 the clients certificate authority in its "acceptable CA list" when it
 459 requests a certificate. By using B<s_client> the CA list can be viewed
 460 and checked. However some servers only request client authentication
 461 after a specific URL is requested. To obtain the list in this case it
 462 is necessary to use the B<-prexit> option and send an HTTP request
 463 for an appropriate page.
 464
 465 If a certificate is specified on the command line using the B<-cert>
 466 option it will not be used unless the server specifically requests
 467 a client certificate. Therefor merely including a client certificate
 468 on the command line is no guarantee that the certificate works.
 469
 470 If there are problems verifying a server certificate then the
 471 B<-showcerts> option can be used to show the whole chain.
 472
 473 The B<s_client> utility is a test tool and is designed to continue the
 474 handshake after any certificate verification errors. As a result it will
 475 accept any certificate chain (trusted or not) sent by the peer. None test
 476 applications should B<not> do this as it makes them vulnerable to a MITM
 477 attack. This behaviour can be changed by with the B<-verify_return_error>
 478 option: any verify errors are then returned aborting the handshake.
 479
 480 =head1 BUGS
 481
 482 Because this program has a lot of options and also because some of
 483 the techniques used are rather old, the C source of s_client is rather
 484 hard to read and not a model of how things should be done. A typical
 485 SSL client program would be much simpler.
 486
 487 The B<-prexit> option is a bit of a hack. We should really report
 488 information whenever a session is renegotiated.
 489
 490 =head1 SEE ALSO
 491
 492 L<sess_id(1)>, L<s_server(1)>, L<ciphers(1)>
 493
 494 =head1 HISTORY
 495
 496 The -no_alt_chains options was first added to OpenSSL 1.1.0.
 497
 498 =cut