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<-key filename>]
  15 [B<-CApath directory>]
  16 [B<-CAfile filename>]
  17 [B<-reconnect>]
  18 [B<-pause>]
  19 [B<-showcerts>]
  20 [B<-debug>]
  21 [B<-nbio_test>]
  22 [B<-state>]
  23 [B<-nbio>]
  24 [B<-crlf>]
  25 [B<-ign_eof>]
  26 [B<-quiet>]
  27 [B<-ssl2>]
  28 [B<-ssl3>]
  29 [B<-tls1>]
  30 [B<-no_ssl2>]
  31 [B<-no_ssl3>]
  32 [B<-no_tls1>]
  33 [B<-bugs>]
  34 [B<-cipher cipherlist>]
  35 [B<-engine id>]
  36 [B<-rand file(s)>]
  37
  38 =head1 DESCRIPTION
  39
  40 The B<s_client> command implements a generic SSL/TLS client which connects
  41 to a remote host using SSL/TLS. It is a I<very> useful diagnostic tool for
  42 SSL servers.
  43
  44 =head1 OPTIONS
  45
  46 =over 4
  47
  48 =item B<-connect host:port>
  49
  50 This specifies the host and optional port to connect to. If not specified
  51 then an attempt is made to connect to the local host on port 4433.
  52
  53 =item B<-cert certname>
  54
  55 The certificate to use, if one is requested by the server. The default is
  56 not to use a certificate.
  57
  58 =item B<-key keyfile>
  59
  60 The private key to use. If not specified then the certificate file will
  61 be used.
  62
  63 =item B<-verify depth>
  64
  65 The verify depth to use. This specifies the maximum length of the
  66 server certificate chain and turns on server certificate verification.
  67 Currently the verify operation continues after errors so all the problems
  68 with a certificate chain can be seen. As a side effect the connection
  69 will never fail due to a server certificate verify failure.
  70
  71 =item B<-CApath directory>
  72
  73 The directory to use for server certificate verification. This directory
  74 must be in "hash format", see B<verify> for more information. These are
  75 also used when building the client certificate chain.
  76
  77 =item B<-CAfile file>
  78
  79 A file containing trusted certificates to use during server authentication
  80 and to use when attempting to build the client certificate chain.
  81
  82 =item B<-reconnect>
  83
  84 reconnects to the same server 5 times using the same session ID, this can
  85 be used as a test that session caching is working.
  86
  87 =item B<-pause>
  88
  89 pauses 1 second between each read and write call.
  90
  91 =item B<-showcerts>
  92
  93 display the whole server certificate chain: normally only the server
  94 certificate itself is displayed.
  95
  96 =item B<-prexit>
  97
  98 print session information when the program exits. This will always attempt
  99 to print out information even if the connection fails. Normally information
 100 will only be printed out once if the connection succeeds. This option is useful
 101 because the cipher in use may be renegotiated or the connection may fail
 102 because a client certificate is required or is requested only after an
 103 attempt is made to access a certain URL. Note: the output produced by this
 104 option is not always accurate because a connection might never have been
 105 established.
 106
 107 =item B<-state>
 108
 109 prints out the SSL session states.
 110
 111 =item B<-debug>
 112
 113 print extensive debugging information including a hex dump of all traffic.
 114
 115 =item B<-nbio_test>
 116
 117 tests non-blocking I/O
 118
 119 =item B<-nbio>
 120
 121 turns on non-blocking I/O
 122
 123 =item B<-crlf>
 124
 125 this option translated a line feed from the terminal into CR+LF as required
 126 by some servers.
 127
 128 =item B<-ign_eof>
 129
 130 inhibit shutting down the connection when end of file is reached in the
 131 input.
 132
 133 =item B<-quiet>
 134
 135 inhibit printing of session and certificate information.  This implicitly
 136 turns on B<-ign_eof> as well.
 137
 138 =item B<-ssl2>, B<-ssl3>, B<-tls1>, B<-no_ssl2>, B<-no_ssl3>, B<-no_tls1>
 139
 140 these options disable the use of certain SSL or TLS protocols. By default
 141 the initial handshake uses a method which should be compatible with all
 142 servers and permit them to use SSL v3, SSL v2 or TLS as appropriate.
 143
 144 Unfortunately there are a lot of ancient and broken servers in use which
 145 cannot handle this technique and will fail to connect. Some servers only
 146 work if TLS is turned off with the B<-no_tls> option others will only
 147 support SSL v2 and may need the B<-ssl2> option.
 148
 149 =item B<-bugs>
 150
 151 there are several known bug in SSL and TLS implementations. Adding this
 152 option enables various workarounds.
 153
 154 =item B<-cipher cipherlist>
 155
 156 this allows the cipher list sent by the client to be modified. Although
 157 the server determines which cipher suite is used it should take the first
 158 supported cipher in the list sent by the client. See the B<ciphers>
 159 command for more information.
 160
 161 =item B<-engine id>
 162
 163 specifying an engine (by it's unique B<id> string) will cause B<s_client>
 164 to attempt to obtain a functional reference to the specified engine,
 165 thus initialising it if needed. The engine will then be set as the default
 166 for all available algorithms.
 167
 168 =item B<-rand file(s)>
 169
 170 a file or files containing random data used to seed the random number
 171 generator, or an EGD socket (see L<RAND_egd(3)|RAND_egd(3)>).
 172 Multiple files can be specified separated by a OS-dependent character.
 173 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
 174 all others.
 175
 176 =back
 177
 178 =head1 CONNECTED COMMANDS
 179
 180 If a connection is established with an SSL server then any data received
 181 from the server is displayed and any key presses will be sent to the
 182 server. When used interactively (which means neither B<-quiet> nor B<-ign_eof>
 183 have been given), the session will be renegotiated if the line begins with an
 184 B<R>, and if the line begins with a B<Q> or if end of file is reached, the
 185 connection will be closed down.
 186
 187 =head1 NOTES
 188
 189 B<s_client> can be used to debug SSL servers. To connect to an SSL HTTP
 190 server the command:
 191
 192  openssl s_client -connect servername:443
 193
 194 would typically be used (https uses port 443). If the connection succeeds
 195 then an HTTP command can be given such as "GET /" to retrieve a web page.
 196
 197 If the handshake fails then there are several possible causes, if it is
 198 nothing obvious like no client certificate then the B<-bugs>, B<-ssl2>,
 199 B<-ssl3>, B<-tls1>, B<-no_ssl2>, B<-no_ssl3>, B<-no_tls1> can be tried
 200 in case it is a buggy server. In particular you should play with these
 201 options B<before> submitting a bug report to an OpenSSL mailing list.
 202
 203 A frequent problem when attempting to get client certificates working
 204 is that a web client complains it has no certificates or gives an empty
 205 list to choose from. This is normally because the server is not sending
 206 the clients certificate authority in its "acceptable CA list" when it
 207 requests a certificate. By using B<s_client> the CA list can be viewed
 208 and checked. However some servers only request client authentication
 209 after a specific URL is requested. To obtain the list in this case it
 210 is necessary to use the B<-prexit> command and send an HTTP request
 211 for an appropriate page.
 212
 213 If a certificate is specified on the command line using the B<-cert>
 214 option it will not be used unless the server specifically requests
 215 a client certificate. Therefor merely including a client certificate
 216 on the command line is no guarantee that the certificate works.
 217
 218 If there are problems verifying a server certificate then the
 219 B<-showcerts> option can be used to show the whole chain.
 220
 221 =head1 BUGS
 222
 223 Because this program has a lot of options and also because some of
 224 the techniques used are rather old, the C source of s_client is rather
 225 hard to read and not a model of how things should be done. A typical
 226 SSL client program would be much simpler.
 227
 228 The B<-verify> option should really exit if the server verification
 229 fails.
 230
 231 The B<-prexit> option is a bit of a hack. We should really report
 232 information whenever a session is renegotiated.
 233
 234 =head1 SEE ALSO
 235
 236 L<sess_id(1)|sess_id(1)>, L<s_server(1)|s_server(1)>, L<ciphers(1)|ciphers(1)>
 237
 238 =cut