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-01-15" "1.0.1l" "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\-reconnect\fR]
 158 [\fB\-pause\fR]
 159 [\fB\-showcerts\fR]
 160 [\fB\-debug\fR]
 161 [\fB\-msg\fR]
 162 [\fB\-nbio_test\fR]
 163 [\fB\-state\fR]
 164 [\fB\-nbio\fR]
 165 [\fB\-crlf\fR]
 166 [\fB\-ign_eof\fR]
 167 [\fB\-no_ign_eof\fR]
 168 [\fB\-quiet\fR]
 169 [\fB\-ssl2\fR]
 170 [\fB\-ssl3\fR]
 171 [\fB\-tls1\fR]
 172 [\fB\-no_ssl2\fR]
 173 [\fB\-no_ssl3\fR]
 174 [\fB\-no_tls1\fR]
 175 [\fB\-bugs\fR]
 176 [\fB\-cipher cipherlist\fR]
 177 [\fB\-serverpref\fR]
 178 [\fB\-starttls protocol\fR]
 179 [\fB\-engine id\fR]
 180 [\fB\-tlsextdebug\fR]
 181 [\fB\-no_ticket\fR]
 182 [\fB\-sess_out filename\fR]
 183 [\fB\-sess_in filename\fR]
 184 [\fB\-rand file(s)\fR]
 185 [\fB\-status\fR]
 186 [\fB\-nextprotoneg protocols\fR]
 187 .SH "DESCRIPTION"
 188 .IX Header "DESCRIPTION"
 189 The \fBs_client\fR command implements a generic \s-1SSL/TLS\s0 client which connects
 190 to a remote host using \s-1SSL/TLS.\s0 It is a \fIvery\fR useful diagnostic tool for
 191 \&\s-1SSL\s0 servers.
 192 .SH "OPTIONS"
 193 .IX Header "OPTIONS"
 194 .IP "\fB\-connect host:port\fR" 4
 195 .IX Item "-connect host:port"
 196 This specifies the host and optional port to connect to. If not specified
 197 then an attempt is made to connect to the local host on port 4433.
 198 .IP "\fB\-servername name\fR" 4
 199 .IX Item "-servername name"
 200 Set the \s-1TLS SNI \s0(Server Name Indication) extension in the ClientHello message.
 201 .IP "\fB\-cert certname\fR" 4
 202 .IX Item "-cert certname"
 203 The certificate to use, if one is requested by the server. The default is
 204 not to use a certificate.
 205 .IP "\fB\-certform format\fR" 4
 206 .IX Item "-certform format"
 207 The certificate format to use: \s-1DER\s0 or \s-1PEM. PEM\s0 is the default.
 208 .IP "\fB\-key keyfile\fR" 4
 209 .IX Item "-key keyfile"
 210 The private key to use. If not specified then the certificate file will
 211 be used.
 212 .IP "\fB\-keyform format\fR" 4
 213 .IX Item "-keyform format"
 214 The private format to use: \s-1DER\s0 or \s-1PEM. PEM\s0 is the default.
 215 .IP "\fB\-pass arg\fR" 4
 216 .IX Item "-pass arg"
 217 the private key password source. For more information about the format of \fBarg\fR
 218 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 219 .IP "\fB\-verify depth\fR" 4
 220 .IX Item "-verify depth"
 221 The verify depth to use. This specifies the maximum length of the
 222 server certificate chain and turns on server certificate verification.
 223 Currently the verify operation continues after errors so all the problems
 224 with a certificate chain can be seen. As a side effect the connection
 225 will never fail due to a server certificate verify failure.
 226 .IP "\fB\-verify_return_error\fR" 4
 227 .IX Item "-verify_return_error"
 228 Return verification errors instead of continuing. This will typically
 229 abort the handshake with a fatal error.
 230 .IP "\fB\-CApath directory\fR" 4
 231 .IX Item "-CApath directory"
 232 The directory to use for server certificate verification. This directory
 233 must be in \*(L"hash format\*(R", see \fBverify\fR for more information. These are
 234 also used when building the client certificate chain.
 235 .IP "\fB\-CAfile file\fR" 4
 236 .IX Item "-CAfile file"
 237 A file containing trusted certificates to use during server authentication
 238 and to use when attempting to build the client certificate chain.
 239 .IP "\fB\-purpose, \-ignore_critical, \-issuer_checks, \-crl_check, \-crl_check_all, \-policy_check, \-extended_crl, \-x509_strict, \-policy \-check_ss_sig\fR" 4
 240 .IX Item "-purpose, -ignore_critical, -issuer_checks, -crl_check, -crl_check_all, -policy_check, -extended_crl, -x509_strict, -policy -check_ss_sig"
 241 Set various certificate chain valiadition option. See the
 242 \&\fBverify\fR manual page for details.
 243 .IP "\fB\-reconnect\fR" 4
 244 .IX Item "-reconnect"
 245 reconnects to the same server 5 times using the same session \s-1ID,\s0 this can
 246 be used as a test that session caching is working.
 247 .IP "\fB\-pause\fR" 4
 248 .IX Item "-pause"
 249 pauses 1 second between each read and write call.
 250 .IP "\fB\-showcerts\fR" 4
 251 .IX Item "-showcerts"
 252 display the whole server certificate chain: normally only the server
 253 certificate itself is displayed.
 254 .IP "\fB\-prexit\fR" 4
 255 .IX Item "-prexit"
 256 print session information when the program exits. This will always attempt
 257 to print out information even if the connection fails. Normally information
 258 will only be printed out once if the connection succeeds. This option is useful
 259 because the cipher in use may be renegotiated or the connection may fail
 260 because a client certificate is required or is requested only after an
 261 attempt is made to access a certain \s-1URL.\s0 Note: the output produced by this
 262 option is not always accurate because a connection might never have been
 263 established.
 264 .IP "\fB\-state\fR" 4
 265 .IX Item "-state"
 266 prints out the \s-1SSL\s0 session states.
 267 .IP "\fB\-debug\fR" 4
 268 .IX Item "-debug"
 269 print extensive debugging information including a hex dump of all traffic.
 270 .IP "\fB\-msg\fR" 4
 271 .IX Item "-msg"
 272 show all protocol messages with hex dump.
 273 .IP "\fB\-nbio_test\fR" 4
 274 .IX Item "-nbio_test"
 275 tests non-blocking I/O
 276 .IP "\fB\-nbio\fR" 4
 277 .IX Item "-nbio"
 278 turns on non-blocking I/O
 279 .IP "\fB\-crlf\fR" 4
 280 .IX Item "-crlf"
 281 this option translated a line feed from the terminal into \s-1CR+LF\s0 as required
 282 by some servers.
 283 .IP "\fB\-ign_eof\fR" 4
 284 .IX Item "-ign_eof"
 285 inhibit shutting down the connection when end of file is reached in the
 286 input.
 287 .IP "\fB\-quiet\fR" 4
 288 .IX Item "-quiet"
 289 inhibit printing of session and certificate information.  This implicitly
 290 turns on \fB\-ign_eof\fR as well.
 291 .IP "\fB\-no_ign_eof\fR" 4
 292 .IX Item "-no_ign_eof"
 293 shut down the connection when end of file is reached in the input.
 294 Can be used to override the implicit \fB\-ign_eof\fR after \fB\-quiet\fR.
 295 .IP "\fB\-psk_identity identity\fR" 4
 296 .IX Item "-psk_identity identity"
 297 Use the \s-1PSK\s0 identity \fBidentity\fR when using a \s-1PSK\s0 cipher suite.
 298 .IP "\fB\-psk key\fR" 4
 299 .IX Item "-psk key"
 300 Use the \s-1PSK\s0 key \fBkey\fR when using a \s-1PSK\s0 cipher suite. The key is
 301 given as a hexadecimal number without leading 0x, for example \-psk
 302 1a2b3c4d.
 303 .IP "\fB\-ssl2\fR, \fB\-ssl3\fR, \fB\-tls1\fR, \fB\-no_ssl2\fR, \fB\-no_ssl3\fR, \fB\-no_tls1\fR" 4
 304 .IX Item "-ssl2, -ssl3, -tls1, -no_ssl2, -no_ssl3, -no_tls1"
 305 these options disable the use of certain \s-1SSL\s0 or \s-1TLS\s0 protocols. By default
 306 the initial handshake uses a method which should be compatible with all
 307 servers and permit them to use \s-1SSL\s0 v3, \s-1SSL\s0 v2 or \s-1TLS\s0 as appropriate.
 308 .Sp
 309 Unfortunately there are a lot of ancient and broken servers in use which
 310 cannot handle this technique and will fail to connect. Some servers only
 311 work if \s-1TLS\s0 is turned off with the \fB\-no_tls\fR option others will only
 312 support \s-1SSL\s0 v2 and may need the \fB\-ssl2\fR option.
 313 .IP "\fB\-bugs\fR" 4
 314 .IX Item "-bugs"
 315 there are several known bug in \s-1SSL\s0 and \s-1TLS\s0 implementations. Adding this
 316 option enables various workarounds.
 317 .IP "\fB\-cipher cipherlist\fR" 4
 318 .IX Item "-cipher cipherlist"
 319 this allows the cipher list sent by the client to be modified. Although
 320 the server determines which cipher suite is used it should take the first
 321 supported cipher in the list sent by the client. See the \fBciphers\fR
 322 command for more information.
 323 .IP "\fB\-serverpref\fR" 4
 324 .IX Item "-serverpref"
 325 use the server's cipher preferences; only used for \s-1SSLV2.\s0
 326 .IP "\fB\-starttls protocol\fR" 4
 327 .IX Item "-starttls protocol"
 328 send the protocol-specific message(s) to switch to \s-1TLS\s0 for communication.
 329 \&\fBprotocol\fR is a keyword for the intended protocol.  Currently, the only
 330 supported keywords are \*(L"smtp\*(R", \*(L"pop3\*(R", \*(L"imap\*(R", and \*(L"ftp\*(R".
 331 .IP "\fB\-tlsextdebug\fR" 4
 332 .IX Item "-tlsextdebug"
 333 print out a hex dump of any \s-1TLS\s0 extensions received from the server.
 334 .IP "\fB\-no_ticket\fR" 4
 335 .IX Item "-no_ticket"
 336 disable RFC4507bis session ticket support.
 337 .IP "\fB\-sess_out filename\fR" 4
 338 .IX Item "-sess_out filename"
 339 output \s-1SSL\s0 session to \fBfilename\fR
 340 .IP "\fB\-sess_in sess.pem\fR" 4
 341 .IX Item "-sess_in sess.pem"
 342 load \s-1SSL\s0 session from \fBfilename\fR. The client will attempt to resume a
 343 connection from this session.
 344 .IP "\fB\-engine id\fR" 4
 345 .IX Item "-engine id"
 346 specifying an engine (by its unique \fBid\fR string) will cause \fBs_client\fR
 347 to attempt to obtain a functional reference to the specified engine,
 348 thus initialising it if needed. The engine will then be set as the default
 349 for all available algorithms.
 350 .IP "\fB\-rand file(s)\fR" 4
 351 .IX Item "-rand file(s)"
 352 a file or files containing random data used to seed the random number
 353 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
 354 Multiple files can be specified separated by a OS-dependent character.
 355 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 356 all others.
 357 .IP "\fB\-status\fR" 4
 358 .IX Item "-status"
 359 sends a certificate status request to the server (\s-1OCSP\s0 stapling). The server
 360 response (if any) is printed out.
 361 .IP "\fB\-nextprotoneg protocols\fR" 4
 362 .IX Item "-nextprotoneg protocols"
 363 enable Next Protocol Negotiation \s-1TLS\s0 extension and provide a list of
 364 comma-separated protocol names that the client should advertise
 365 support for. The list should contain most wanted protocols first.
 366 Protocol names are printable \s-1ASCII\s0 strings, for example \*(L"http/1.1\*(R" or
 367 \&\*(L"spdy/3\*(R".
 368 Empty list of protocols is treated specially and will cause the client to
 369 advertise support for the \s-1TLS\s0 extension but disconnect just after
 370 reciving ServerHello with a list of server supported protocols.
 371 .SH "CONNECTED COMMANDS"
 372 .IX Header "CONNECTED COMMANDS"
 373 If a connection is established with an \s-1SSL\s0 server then any data received
 374 from the server is displayed and any key presses will be sent to the
 375 server. When used interactively (which means neither \fB\-quiet\fR nor \fB\-ign_eof\fR
 376 have been given), the session will be renegotiated if the line begins with an
 377 \&\fBR\fR, and if the line begins with a \fBQ\fR or if end of file is reached, the
 378 connection will be closed down.
 379 .SH "NOTES"
 380 .IX Header "NOTES"
 381 \&\fBs_client\fR can be used to debug \s-1SSL\s0 servers. To connect to an \s-1SSL HTTP\s0
 382 server the command:
 383 .PP
 384 .Vb 1
 385 \& openssl s_client \-connect servername:443
 386 .Ve
 387 .PP
 388 would typically be used (https uses port 443). If the connection succeeds
 389 then an \s-1HTTP\s0 command can be given such as \*(L"\s-1GET /\*(R"\s0 to retrieve a web page.
 390 .PP
 391 If the handshake fails then there are several possible causes, if it is
 392 nothing obvious like no client certificate then the \fB\-bugs\fR, \fB\-ssl2\fR,
 393 \&\fB\-ssl3\fR, \fB\-tls1\fR, \fB\-no_ssl2\fR, \fB\-no_ssl3\fR, \fB\-no_tls1\fR options can be tried
 394 in case it is a buggy server. In particular you should play with these
 395 options \fBbefore\fR submitting a bug report to an OpenSSL mailing list.
 396 .PP
 397 A frequent problem when attempting to get client certificates working
 398 is that a web client complains it has no certificates or gives an empty
 399 list to choose from. This is normally because the server is not sending
 400 the clients certificate authority in its \*(L"acceptable \s-1CA\s0 list\*(R" when it
 401 requests a certificate. By using \fBs_client\fR the \s-1CA\s0 list can be viewed
 402 and checked. However some servers only request client authentication
 403 after a specific \s-1URL\s0 is requested. To obtain the list in this case it
 404 is necessary to use the \fB\-prexit\fR option and send an \s-1HTTP\s0 request
 405 for an appropriate page.
 406 .PP
 407 If a certificate is specified on the command line using the \fB\-cert\fR
 408 option it will not be used unless the server specifically requests
 409 a client certificate. Therefor merely including a client certificate
 410 on the command line is no guarantee that the certificate works.
 411 .PP
 412 If there are problems verifying a server certificate then the
 413 \&\fB\-showcerts\fR option can be used to show the whole chain.
 414 .PP
 415 Since the SSLv23 client hello cannot include compression methods or extensions
 416 these will only be supported if its use is disabled, for example by using the
 417 \&\fB\-no_sslv2\fR option.
 418 .PP
 419 The \fBs_client\fR utility is a test tool and is designed to continue the
 420 handshake after any certificate verification errors. As a result it will
 421 accept any certificate chain (trusted or not) sent by the peer. None test
 422 applications should \fBnot\fR do this as it makes them vulnerable to a \s-1MITM\s0
 423 attack. This behaviour can be changed by with the \fB\-verify_return_error\fR
 424 option: any verify errors are then returned aborting the handshake.
 425 .SH "BUGS"
 426 .IX Header "BUGS"
 427 Because this program has a lot of options and also because some of
 428 the techniques used are rather old, the C source of s_client is rather
 429 hard to read and not a model of how things should be done. A typical
 430 \&\s-1SSL\s0 client program would be much simpler.
 431 .PP
 432 The \fB\-prexit\fR option is a bit of a hack. We should really report
 433 information whenever a session is renegotiated.
 434 .SH "SEE ALSO"
 435 .IX Header "SEE ALSO"
 436 \&\fIsess_id\fR\|(1), \fIs_server\fR\|(1), \fIciphers\fR\|(1)