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