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