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