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<-xmpphost hostname>]
  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 In addition to the options below the B<s_client> utility also supports the
  60 common and client only options documented in the
  61 in the L<SSL_CONF_cmd(3)|SSL_CONF_cmd(3)/SUPPORTED COMMAND LINE COMMANDS>
  62 manual page.
  63
  64 =over 4
  65
  66 =item B<-connect host:port>
  67
  68 This specifies the host and optional port to connect to. If not specified
  69 then an attempt is made to connect to the local host on port 4433.
  70
  71 =item B<-cert certname>
  72
  73 The certificate to use, if one is requested by the server. The default is
  74 not to use a certificate.
  75
  76 =item B<-certform format>
  77
  78 The certificate format to use: DER or PEM. PEM is the default.
  79
  80 =item B<-key keyfile>
  81
  82 The private key to use. If not specified then the certificate file will
  83 be used.
  84
  85 =item B<-keyform format>
  86
  87 The private format to use: DER or PEM. PEM is the default.
  88
  89 =item B<-pass arg>
  90
  91 the private key password source. For more information about the format of B<arg>
  92 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)|openssl(1)>.
  93
  94 =item B<-verify depth>
  95
  96 The verify depth to use. This specifies the maximum length of the
  97 server certificate chain and turns on server certificate verification.
  98 Currently the verify operation continues after errors so all the problems
  99 with a certificate chain can be seen. As a side effect the connection
 100 will never fail due to a server certificate verify failure.
 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<-trace>
 156
 157 show verbose trace output of protocol messages. OpenSSL needs to be compiled
 158 with B<enable-ssl-trace> for this option to work.
 159
 160 =item B<-msgfile>
 161
 162 file to send output of B<-msg> or B<-trace> to, default standard output.
 163
 164 =item B<-nbio_test>
 165
 166 tests non-blocking I/O
 167
 168 =item B<-nbio>
 169
 170 turns on non-blocking I/O
 171
 172 =item B<-crlf>
 173
 174 this option translated a line feed from the terminal into CR+LF as required
 175 by some servers.
 176
 177 =item B<-ign_eof>
 178
 179 inhibit shutting down the connection when end of file is reached in the
 180 input.
 181
 182 =item B<-quiet>
 183
 184 inhibit printing of session and certificate information.  This implicitly
 185 turns on B<-ign_eof> as well.
 186
 187 =item B<-psk_identity identity>
 188
 189 Use the PSK identity B<identity> when using a PSK cipher suite.
 190
 191 =item B<-psk key>
 192
 193 Use the PSK key B<key> when using a PSK cipher suite. The key is
 194 given as a hexadecimal number without leading 0x, for example -psk
 195 1a2b3c4d.
 196
 197 =item B<-ssl2>, B<-ssl3>, B<-tls1>, B<-no_ssl2>, B<-no_ssl3>, B<-no_tls1>
 198
 199 these options disable the use of certain SSL or TLS protocols. By default
 200 the initial handshake uses a method which should be compatible with all
 201 servers and permit them to use SSL v3, SSL v2 or TLS as appropriate.
 202
 203 Unfortunately there are a lot of ancient and broken servers in use which
 204 cannot handle this technique and will fail to connect. Some servers only
 205 work if TLS is turned off with the B<-no_tls> option others will only
 206 support SSL v2 and may need the B<-ssl2> option.
 207
 208 =item B<-bugs>
 209
 210 there are several known bug in SSL and TLS implementations. Adding this
 211 option enables various workarounds.
 212
 213 =item B<-brief>
 214
 215 only provide a brief summary of connection parameters instead of the
 216 normal verbose output.
 217
 218 =item B<-cipher cipherlist>
 219
 220 this allows the cipher list sent by the client to be modified. Although
 221 the server determines which cipher suite is used it should take the first
 222 supported cipher in the list sent by the client. See the B<ciphers>
 223 command for more information.
 224
 225 =item B<-starttls protocol>
 226
 227 send the protocol-specific message(s) to switch to TLS for communication.
 228 B<protocol> is a keyword for the intended protocol.  Currently, the only
 229 supported keywords are "smtp", "pop3", "imap", "ftp" and "xmpp".
 230
 231 =item B<-xmpphost hostname>
 232
 233 This option, when used with "-starttls xmpp", specifies the host for the
 234 "to" attribute of the stream element.
 235 If this option is not specified, then the host specified with "-connect"
 236 will be used.
 237
 238 =item B<-tlsextdebug>
 239
 240 print out a hex dump of any TLS extensions received from the server.
 241
 242 =item B<-no_ticket>
 243
 244 disable RFC4507bis session ticket support.
 245
 246 =item B<-sess_out filename>
 247
 248 output SSL session to B<filename>
 249
 250 =item B<-sess_in sess.pem>
 251
 252 load SSL session from B<filename>. The client will attempt to resume a
 253 connection from this session.
 254
 255 =item B<-engine id>
 256
 257 specifying an engine (by its unique B<id> string) will cause B<s_client>
 258 to attempt to obtain a functional reference to the specified engine,
 259 thus initialising it if needed. The engine will then be set as the default
 260 for all available algorithms.
 261
 262 =item B<-rand file(s)>
 263
 264 a file or files containing random data used to seed the random number
 265 generator, or an EGD socket (see L<RAND_egd(3)|RAND_egd(3)>).
 266 Multiple files can be specified separated by a OS-dependent character.
 267 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
 268 all others.
 269
 270 =item B<-serverinfo types>
 271
 272 a list of comma-separated TLS Extension Types (numbers between 0 and
 273 65535).  Each type will be sent as an empty ClientHello TLS Extension.
 274 The server's response (if any) will be encoded and displayed as a PEM
 275 file.
 276
 277 =item B<-auth>
 278
 279 send RFC 5878 client and server authorization extensions in the Client Hello as well as
 280 supplemental data if the server also sent the authorization extensions in the Server Hello.
 281
 282 =item B<-auth_require_reneg>
 283
 284 only send RFC 5878 client and server authorization extensions during renegotiation.
 285
 286 =back
 287
 288 =head1 CONNECTED COMMANDS
 289
 290 If a connection is established with an SSL server then any data received
 291 from the server is displayed and any key presses will be sent to the
 292 server. When used interactively (which means neither B<-quiet> nor B<-ign_eof>
 293 have been given), the session will be renegotiated if the line begins with an
 294 B<R>, and if the line begins with a B<Q> or if end of file is reached, the
 295 connection will be closed down.
 296
 297 =head1 NOTES
 298
 299 B<s_client> can be used to debug SSL servers. To connect to an SSL HTTP
 300 server the command:
 301
 302  openssl s_client -connect servername:443
 303
 304 would typically be used (https uses port 443). If the connection succeeds
 305 then an HTTP command can be given such as "GET /" to retrieve a web page.
 306
 307 If the handshake fails then there are several possible causes, if it is
 308 nothing obvious like no client certificate then the B<-bugs>, B<-ssl2>,
 309 B<-ssl3>, B<-tls1>, B<-no_ssl2>, B<-no_ssl3>, B<-no_tls1> options can be tried
 310 in case it is a buggy server. In particular you should play with these
 311 options B<before> submitting a bug report to an OpenSSL mailing list.
 312
 313 A frequent problem when attempting to get client certificates working
 314 is that a web client complains it has no certificates or gives an empty
 315 list to choose from. This is normally because the server is not sending
 316 the clients certificate authority in its "acceptable CA list" when it
 317 requests a certificate. By using B<s_client> the CA list can be viewed
 318 and checked. However some servers only request client authentication
 319 after a specific URL is requested. To obtain the list in this case it
 320 is necessary to use the B<-prexit> option and send an HTTP request
 321 for an appropriate page.
 322
 323 If a certificate is specified on the command line using the B<-cert>
 324 option it will not be used unless the server specifically requests
 325 a client certificate. Therefor merely including a client certificate
 326 on the command line is no guarantee that the certificate works.
 327
 328 If there are problems verifying a server certificate then the
 329 B<-showcerts> option can be used to show the whole chain.
 330
 331 Since the SSLv23 client hello cannot include compression methods or extensions
 332 these will only be supported if its use is disabled, for example by using the
 333 B<-no_sslv2> option.
 334
 335 =head1 BUGS
 336
 337 Because this program has a lot of options and also because some of
 338 the techniques used are rather old, the C source of s_client is rather
 339 hard to read and not a model of how things should be done. A typical
 340 SSL client program would be much simpler.
 341
 342 The B<-verify> option should really exit if the server verification
 343 fails.
 344
 345 The B<-prexit> option is a bit of a hack. We should really report
 346 information whenever a session is renegotiated.
 347
 348 =head1 SEE ALSO
 349
 350 L<sess_id(1)|sess_id(1)>, L<s_server(1)|s_server(1)>, L<ciphers(1)|ciphers(1)>
 351
 352 =cut