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

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