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