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