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