secure/usr.bin/openssl/man/s_client.1

   1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is turned on, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{
  60 .    if \nF \{
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "S_CLIENT 1"
 136 .TH S_CLIENT 1 "2015-07-09" "1.0.1p" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 s_client \- SSL/TLS client program
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 \&\fBopenssl\fR \fBs_client\fR
 146 [\fB\-connect host:port\fR]
 147 [\fB\-servername name\fR]
 148 [\fB\-verify depth\fR]
 149 [\fB\-verify_return_error\fR]
 150 [\fB\-cert filename\fR]
 151 [\fB\-certform DER|PEM\fR]
 152 [\fB\-key filename\fR]
 153 [\fB\-keyform DER|PEM\fR]
 154 [\fB\-pass arg\fR]
 155 [\fB\-CApath directory\fR]
 156 [\fB\-CAfile filename\fR]
 157 [\fB\-no_alt_chains\fR]
 158 [\fB\-reconnect\fR]
 159 [\fB\-pause\fR]
 160 [\fB\-showcerts\fR]
 161 [\fB\-debug\fR]
 162 [\fB\-msg\fR]
 163 [\fB\-nbio_test\fR]
 164 [\fB\-state\fR]
 165 [\fB\-nbio\fR]
 166 [\fB\-crlf\fR]
 167 [\fB\-ign_eof\fR]
 168 [\fB\-no_ign_eof\fR]
 169 [\fB\-quiet\fR]
 170 [\fB\-ssl2\fR]
 171 [\fB\-ssl3\fR]
 172 [\fB\-tls1\fR]
 173 [\fB\-no_ssl2\fR]
 174 [\fB\-no_ssl3\fR]
 175 [\fB\-no_tls1\fR]
 176 [\fB\-bugs\fR]
 177 [\fB\-cipher cipherlist\fR]
 178 [\fB\-serverpref\fR]
 179 [\fB\-starttls protocol\fR]
 180 [\fB\-engine id\fR]
 181 [\fB\-tlsextdebug\fR]
 182 [\fB\-no_ticket\fR]
 183 [\fB\-sess_out filename\fR]
 184 [\fB\-sess_in filename\fR]
 185 [\fB\-rand file(s)\fR]
 186 [\fB\-status\fR]
 187 [\fB\-nextprotoneg protocols\fR]
 188 .SH "DESCRIPTION"
 189 .IX Header "DESCRIPTION"
 190 The \fBs_client\fR command implements a generic \s-1SSL/TLS\s0 client which connects
 191 to a remote host using \s-1SSL/TLS.\s0 It is a \fIvery\fR useful diagnostic tool for
 192 \&\s-1SSL\s0 servers.
 193 .SH "OPTIONS"
 194 .IX Header "OPTIONS"
 195 .IP "\fB\-connect host:port\fR" 4
 196 .IX Item "-connect host:port"
 197 This specifies the host and optional port to connect to. If not specified
 198 then an attempt is made to connect to the local host on port 4433.
 199 .IP "\fB\-servername name\fR" 4
 200 .IX Item "-servername name"
 201 Set the \s-1TLS SNI \s0(Server Name Indication) extension in the ClientHello message.
 202 .IP "\fB\-cert certname\fR" 4
 203 .IX Item "-cert certname"
 204 The certificate to use, if one is requested by the server. The default is
 205 not to use a certificate.
 206 .IP "\fB\-certform format\fR" 4
 207 .IX Item "-certform format"
 208 The certificate format to use: \s-1DER\s0 or \s-1PEM. PEM\s0 is the default.
 209 .IP "\fB\-key keyfile\fR" 4
 210 .IX Item "-key keyfile"
 211 The private key to use. If not specified then the certificate file will
 212 be used.
 213 .IP "\fB\-keyform format\fR" 4
 214 .IX Item "-keyform format"
 215 The private format to use: \s-1DER\s0 or \s-1PEM. PEM\s0 is the default.
 216 .IP "\fB\-pass arg\fR" 4
 217 .IX Item "-pass arg"
 218 the private key password source. For more information about the format of \fBarg\fR
 219 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 220 .IP "\fB\-verify depth\fR" 4
 221 .IX Item "-verify depth"
 222 The verify depth to use. This specifies the maximum length of the
 223 server certificate chain and turns on server certificate verification.
 224 Currently the verify operation continues after errors so all the problems
 225 with a certificate chain can be seen. As a side effect the connection
 226 will never fail due to a server certificate verify failure.
 227 .IP "\fB\-verify_return_error\fR" 4
 228 .IX Item "-verify_return_error"
 229 Return verification errors instead of continuing. This will typically
 230 abort the handshake with a fatal error.
 231 .IP "\fB\-CApath directory\fR" 4
 232 .IX Item "-CApath directory"
 233 The directory to use for server certificate verification. This directory
 234 must be in \*(L"hash format\*(R", see \fBverify\fR for more information. These are
 235 also used when building the client certificate chain.
 236 .IP "\fB\-CAfile file\fR" 4
 237 .IX Item "-CAfile file"
 238 A file containing trusted certificates to use during server authentication
 239 and to use when attempting to build the client certificate chain.
 240 .IP "\fB\-purpose, \-ignore_critical, \-issuer_checks, \-crl_check, \-crl_check_all, \-policy_check, \-extended_crl, \-x509_strict, \-policy \-check_ss_sig \-no_alt_chains\fR" 4
 241 .IX Item "-purpose, -ignore_critical, -issuer_checks, -crl_check, -crl_check_all, -policy_check, -extended_crl, -x509_strict, -policy -check_ss_sig -no_alt_chains"
 242 Set various certificate chain valiadition option. See the
 243 \&\fBverify\fR manual page for details.
 244 .IP "\fB\-reconnect\fR" 4
 245 .IX Item "-reconnect"
 246 reconnects to the same server 5 times using the same session \s-1ID,\s0 this can
 247 be used as a test that session caching is working.
 248 .IP "\fB\-pause\fR" 4
 249 .IX Item "-pause"
 250 pauses 1 second between each read and write call.
 251 .IP "\fB\-showcerts\fR" 4
 252 .IX Item "-showcerts"
 253 display the whole server certificate chain: normally only the server
 254 certificate itself is displayed.
 255 .IP "\fB\-prexit\fR" 4
 256 .IX Item "-prexit"
 257 print session information when the program exits. This will always attempt
 258 to print out information even if the connection fails. Normally information
 259 will only be printed out once if the connection succeeds. This option is useful
 260 because the cipher in use may be renegotiated or the connection may fail
 261 because a client certificate is required or is requested only after an
 262 attempt is made to access a certain \s-1URL.\s0 Note: the output produced by this
 263 option is not always accurate because a connection might never have been
 264 established.
 265 .IP "\fB\-state\fR" 4
 266 .IX Item "-state"
 267 prints out the \s-1SSL\s0 session states.
 268 .IP "\fB\-debug\fR" 4
 269 .IX Item "-debug"
 270 print extensive debugging information including a hex dump of all traffic.
 271 .IP "\fB\-msg\fR" 4
 272 .IX Item "-msg"
 273 show all protocol messages with hex dump.
 274 .IP "\fB\-nbio_test\fR" 4
 275 .IX Item "-nbio_test"
 276 tests non-blocking I/O
 277 .IP "\fB\-nbio\fR" 4
 278 .IX Item "-nbio"
 279 turns on non-blocking I/O
 280 .IP "\fB\-crlf\fR" 4
 281 .IX Item "-crlf"
 282 this option translated a line feed from the terminal into \s-1CR+LF\s0 as required
 283 by some servers.
 284 .IP "\fB\-ign_eof\fR" 4
 285 .IX Item "-ign_eof"
 286 inhibit shutting down the connection when end of file is reached in the
 287 input.
 288 .IP "\fB\-quiet\fR" 4
 289 .IX Item "-quiet"
 290 inhibit printing of session and certificate information.  This implicitly
 291 turns on \fB\-ign_eof\fR as well.
 292 .IP "\fB\-no_ign_eof\fR" 4
 293 .IX Item "-no_ign_eof"
 294 shut down the connection when end of file is reached in the input.
 295 Can be used to override the implicit \fB\-ign_eof\fR after \fB\-quiet\fR.
 296 .IP "\fB\-psk_identity identity\fR" 4
 297 .IX Item "-psk_identity identity"
 298 Use the \s-1PSK\s0 identity \fBidentity\fR when using a \s-1PSK\s0 cipher suite.
 299 .IP "\fB\-psk key\fR" 4
 300 .IX Item "-psk key"
 301 Use the \s-1PSK\s0 key \fBkey\fR when using a \s-1PSK\s0 cipher suite. The key is
 302 given as a hexadecimal number without leading 0x, for example \-psk
 303 1a2b3c4d.
 304 .IP "\fB\-ssl2\fR, \fB\-ssl3\fR, \fB\-tls1\fR, \fB\-no_ssl2\fR, \fB\-no_ssl3\fR, \fB\-no_tls1\fR" 4
 305 .IX Item "-ssl2, -ssl3, -tls1, -no_ssl2, -no_ssl3, -no_tls1"
 306 these options disable the use of certain \s-1SSL\s0 or \s-1TLS\s0 protocols. By default
 307 the initial handshake uses a method which should be compatible with all
 308 servers and permit them to use \s-1SSL\s0 v3, \s-1SSL\s0 v2 or \s-1TLS\s0 as appropriate.
 309 .Sp
 310 Unfortunately there are a lot of ancient and broken servers in use which
 311 cannot handle this technique and will fail to connect. Some servers only
 312 work if \s-1TLS\s0 is turned off with the \fB\-no_tls\fR option others will only
 313 support \s-1SSL\s0 v2 and may need the \fB\-ssl2\fR option.
 314 .IP "\fB\-bugs\fR" 4
 315 .IX Item "-bugs"
 316 there are several known bug in \s-1SSL\s0 and \s-1TLS\s0 implementations. Adding this
 317 option enables various workarounds.
 318 .IP "\fB\-cipher cipherlist\fR" 4
 319 .IX Item "-cipher cipherlist"
 320 this allows the cipher list sent by the client to be modified. Although
 321 the server determines which cipher suite is used it should take the first
 322 supported cipher in the list sent by the client. See the \fBciphers\fR
 323 command for more information.
 324 .IP "\fB\-serverpref\fR" 4
 325 .IX Item "-serverpref"
 326 use the server's cipher preferences; only used for \s-1SSLV2.\s0
 327 .IP "\fB\-starttls protocol\fR" 4
 328 .IX Item "-starttls protocol"
 329 send the protocol-specific message(s) to switch to \s-1TLS\s0 for communication.
 330 \&\fBprotocol\fR is a keyword for the intended protocol.  Currently, the only
 331 supported keywords are \*(L"smtp\*(R", \*(L"pop3\*(R", \*(L"imap\*(R", and \*(L"ftp\*(R".
 332 .IP "\fB\-tlsextdebug\fR" 4
 333 .IX Item "-tlsextdebug"
 334 print out a hex dump of any \s-1TLS\s0 extensions received from the server.
 335 .IP "\fB\-no_ticket\fR" 4
 336 .IX Item "-no_ticket"
 337 disable RFC4507bis session ticket support.
 338 .IP "\fB\-sess_out filename\fR" 4
 339 .IX Item "-sess_out filename"
 340 output \s-1SSL\s0 session to \fBfilename\fR
 341 .IP "\fB\-sess_in sess.pem\fR" 4
 342 .IX Item "-sess_in sess.pem"
 343 load \s-1SSL\s0 session from \fBfilename\fR. The client will attempt to resume a
 344 connection from this session.
 345 .IP "\fB\-engine id\fR" 4
 346 .IX Item "-engine id"
 347 specifying an engine (by its unique \fBid\fR string) will cause \fBs_client\fR
 348 to attempt to obtain a functional reference to the specified engine,
 349 thus initialising it if needed. The engine will then be set as the default
 350 for all available algorithms.
 351 .IP "\fB\-rand file(s)\fR" 4
 352 .IX Item "-rand file(s)"
 353 a file or files containing random data used to seed the random number
 354 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
 355 Multiple files can be specified separated by a OS-dependent character.
 356 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 357 all others.
 358 .IP "\fB\-status\fR" 4
 359 .IX Item "-status"
 360 sends a certificate status request to the server (\s-1OCSP\s0 stapling). The server
 361 response (if any) is printed out.
 362 .IP "\fB\-nextprotoneg protocols\fR" 4
 363 .IX Item "-nextprotoneg protocols"
 364 enable Next Protocol Negotiation \s-1TLS\s0 extension and provide a list of
 365 comma-separated protocol names that the client should advertise
 366 support for. The list should contain most wanted protocols first.
 367 Protocol names are printable \s-1ASCII\s0 strings, for example \*(L"http/1.1\*(R" or
 368 \&\*(L"spdy/3\*(R".
 369 Empty list of protocols is treated specially and will cause the client to
 370 advertise support for the \s-1TLS\s0 extension but disconnect just after
 371 reciving ServerHello with a list of server supported protocols.
 372 .SH "CONNECTED COMMANDS"
 373 .IX Header "CONNECTED COMMANDS"
 374 If a connection is established with an \s-1SSL\s0 server then any data received
 375 from the server is displayed and any key presses will be sent to the
 376 server. When used interactively (which means neither \fB\-quiet\fR nor \fB\-ign_eof\fR
 377 have been given), the session will be renegotiated if the line begins with an
 378 \&\fBR\fR, and if the line begins with a \fBQ\fR or if end of file is reached, the
 379 connection will be closed down.
 380 .SH "NOTES"
 381 .IX Header "NOTES"
 382 \&\fBs_client\fR can be used to debug \s-1SSL\s0 servers. To connect to an \s-1SSL HTTP\s0
 383 server the command:
 384 .PP
 385 .Vb 1
 386 \& openssl s_client \-connect servername:443
 387 .Ve
 388 .PP
 389 would typically be used (https uses port 443). If the connection succeeds
 390 then an \s-1HTTP\s0 command can be given such as \*(L"\s-1GET /\*(R"\s0 to retrieve a web page.
 391 .PP
 392 If the handshake fails then there are several possible causes, if it is
 393 nothing obvious like no client certificate then the \fB\-bugs\fR, \fB\-ssl2\fR,
 394 \&\fB\-ssl3\fR, \fB\-tls1\fR, \fB\-no_ssl2\fR, \fB\-no_ssl3\fR, \fB\-no_tls1\fR options can be tried
 395 in case it is a buggy server. In particular you should play with these
 396 options \fBbefore\fR submitting a bug report to an OpenSSL mailing list.
 397 .PP
 398 A frequent problem when attempting to get client certificates working
 399 is that a web client complains it has no certificates or gives an empty
 400 list to choose from. This is normally because the server is not sending
 401 the clients certificate authority in its \*(L"acceptable \s-1CA\s0 list\*(R" when it
 402 requests a certificate. By using \fBs_client\fR the \s-1CA\s0 list can be viewed
 403 and checked. However some servers only request client authentication
 404 after a specific \s-1URL\s0 is requested. To obtain the list in this case it
 405 is necessary to use the \fB\-prexit\fR option and send an \s-1HTTP\s0 request
 406 for an appropriate page.
 407 .PP
 408 If a certificate is specified on the command line using the \fB\-cert\fR
 409 option it will not be used unless the server specifically requests
 410 a client certificate. Therefor merely including a client certificate
 411 on the command line is no guarantee that the certificate works.
 412 .PP
 413 If there are problems verifying a server certificate then the
 414 \&\fB\-showcerts\fR option can be used to show the whole chain.
 415 .PP
 416 Since the SSLv23 client hello cannot include compression methods or extensions
 417 these will only be supported if its use is disabled, for example by using the
 418 \&\fB\-no_sslv2\fR option.
 419 .PP
 420 The \fBs_client\fR utility is a test tool and is designed to continue the
 421 handshake after any certificate verification errors. As a result it will
 422 accept any certificate chain (trusted or not) sent by the peer. None test
 423 applications should \fBnot\fR do this as it makes them vulnerable to a \s-1MITM\s0
 424 attack. This behaviour can be changed by with the \fB\-verify_return_error\fR
 425 option: any verify errors are then returned aborting the handshake.
 426 .SH "BUGS"
 427 .IX Header "BUGS"
 428 Because this program has a lot of options and also because some of
 429 the techniques used are rather old, the C source of s_client is rather
 430 hard to read and not a model of how things should be done. A typical
 431 \&\s-1SSL\s0 client program would be much simpler.
 432 .PP
 433 The \fB\-prexit\fR option is a bit of a hack. We should really report
 434 information whenever a session is renegotiated.
 435 .SH "SEE ALSO"
 436 .IX Header "SEE ALSO"
 437 \&\fIsess_id\fR\|(1), \fIs_server\fR\|(1), \fIciphers\fR\|(1)
 438 .SH "HISTORY"
 439 .IX Header "HISTORY"
 440 The \-no_alt_chains options was first added to OpenSSL 1.0.1n and 1.0.2b.