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