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