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