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