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" "0.9.8zc" "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\-verify depth\fR]
 139 [\fB\-cert filename\fR]
 140 [\fB\-certform DER|PEM\fR]
 141 [\fB\-key filename\fR]
 142 [\fB\-keyform DER|PEM\fR]
 143 [\fB\-pass arg\fR]
 144 [\fB\-CApath directory\fR]
 145 [\fB\-CAfile filename\fR]
 146 [\fB\-attime timestamp\fR]
 147 [\fB\-check_ss_sig\fR]
 148 [\fB\-crl_check\fR]
 149 [\fB\-crl_check_all\fR]
 150 [\fB\-explicit_policy\fR]
 151 [\fB\-ignore_critical\fR]
 152 [\fB\-inhibit_any\fR]
 153 [\fB\-inhibit_map\fR]
 154 [\fB\-issuer_checks\fR]
 155 [\fB\-policy arg\fR]
 156 [\fB\-policy_check\fR]
 157 [\fB\-policy_print\fR]
 158 [\fB\-purpose purpose\fR]
 159 [\fB\-use_deltas\fR]
 160 [\fB\-verify_depth num\fR]
 161 [\fB\-x509_strict\fR]
 162 [\fB\-reconnect\fR]
 163 [\fB\-pause\fR]
 164 [\fB\-showcerts\fR]
 165 [\fB\-debug\fR]
 166 [\fB\-msg\fR]
 167 [\fB\-nbio_test\fR]
 168 [\fB\-state\fR]
 169 [\fB\-nbio\fR]
 170 [\fB\-crlf\fR]
 171 [\fB\-ign_eof\fR]
 172 [\fB\-quiet\fR]
 173 [\fB\-ssl2\fR]
 174 [\fB\-ssl3\fR]
 175 [\fB\-tls1\fR]
 176 [\fB\-no_ssl2\fR]
 177 [\fB\-no_ssl3\fR]
 178 [\fB\-no_tls1\fR]
 179 [\fB\-fallback_scsv\fR]
 180 [\fB\-bugs\fR]
 181 [\fB\-cipher cipherlist\fR]
 182 [\fB\-starttls protocol\fR]
 183 [\fB\-xmpphost hostname\fR]
 184 [\fB\-engine id\fR]
 185 [\fB\-tlsextdebug\fR]
 186 [\fB\-no_ticket\fR]
 187 [\fB\-sess_out filename\fR]
 188 [\fB\-sess_in filename\fR]
 189 [\fB\-rand file(s)\fR]
 190 .SH "DESCRIPTION"
 191 .IX Header "DESCRIPTION"
 192 The \fBs_client\fR command implements a generic \s-1SSL/TLS\s0 client which connects
 193 to a remote host using \s-1SSL/TLS\s0. It is a \fIvery\fR useful diagnostic tool for
 194 \&\s-1SSL\s0 servers.
 195 .SH "OPTIONS"
 196 .IX Header "OPTIONS"
 197 In addition to the options below the \fBs_client\fR utility also supports the
 198 common and client only options documented in the
 199 in the \fISSL_CONF_cmd\fR\|(3)
 200 manual page.
 201 .IP "\fB\-connect host:port\fR" 4
 202 .IX Item "-connect host:port"
 203 This specifies the host and optional port to connect to. If not specified
 204 then an attempt is made to connect to the local host on port 4433.
 205 .IP "\fB\-cert certname\fR" 4
 206 .IX Item "-cert certname"
 207 The certificate to use, if one is requested by the server. The default is
 208 not to use a certificate.
 209 .IP "\fB\-certform format\fR" 4
 210 .IX Item "-certform format"
 211 The certificate format to use: \s-1DER\s0 or \s-1PEM\s0. \s-1PEM\s0 is the default.
 212 .IP "\fB\-key keyfile\fR" 4
 213 .IX Item "-key keyfile"
 214 The private key to use. If not specified then the certificate file will
 215 be used.
 216 .IP "\fB\-keyform format\fR" 4
 217 .IX Item "-keyform format"
 218 The private format to use: \s-1DER\s0 or \s-1PEM\s0. \s-1PEM\s0 is the default.
 219 .IP "\fB\-pass arg\fR" 4
 220 .IX Item "-pass arg"
 221 the private key password source. For more information about the format of \fBarg\fR
 222 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 223 .IP "\fB\-verify depth\fR" 4
 224 .IX Item "-verify depth"
 225 The verify depth to use. This specifies the maximum length of the
 226 server certificate chain and turns on server certificate verification.
 227 Currently the verify operation continues after errors so all the problems
 228 with a certificate chain can be seen. As a side effect the connection
 229 will never fail due to a server certificate verify failure.
 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\-attime\fR, \fB\-check_ss_sig\fR, \fB\-crl_check\fR, \fB\-crl_check_all\fR, \fBexplicit_policy\fR, \fB\-ignore_critical\fR, \fB\-inhibit_any\fR, \fB\-inhibit_map\fR, \fB\-issuer_checks\fR, \fB\-policy\fR, \fB\-policy_check\fR, \fB\-policy_print\fR, \fB\-purpose\fR, \fB\-use_deltas\fR, \fB\-verify_depth\fR, \fB\-x509_strict\fR" 4
 240 .IX Item "-attime, -check_ss_sig, -crl_check, -crl_check_all, explicit_policy, -ignore_critical, -inhibit_any, -inhibit_map, -issuer_checks, -policy, -policy_check, -policy_print, -purpose, -use_deltas, -verify_depth, -x509_strict"
 241 Set various certificate chain valiadition options. 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\-ssl2\fR, \fB\-ssl3\fR, \fB\-tls1\fR, \fB\-no_ssl2\fR, \fB\-no_ssl3\fR, \fB\-no_tls1\fR" 4
 292 .IX Item "-ssl2, -ssl3, -tls1, -no_ssl2, -no_ssl3, -no_tls1"
 293 these options disable the use of certain \s-1SSL\s0 or \s-1TLS\s0 protocols. By default
 294 the initial handshake uses a method which should be compatible with all
 295 servers and permit them to use \s-1SSL\s0 v3, \s-1SSL\s0 v2 or \s-1TLS\s0 as appropriate.
 296 .Sp
 297 Unfortunately there are still ancient and broken servers in use which
 298 cannot handle this technique and will fail to connect. Some servers only
 299 work if \s-1TLS\s0 is turned off.
 300 .IP "\fB\-fallback_scsv\fR" 4
 301 .IX Item "-fallback_scsv"
 302 Send \s-1TLS_FALLBACK_SCSV\s0 in the ClientHello.
 303 .IP "\fB\-bugs\fR" 4
 304 .IX Item "-bugs"
 305 there are several known bug in \s-1SSL\s0 and \s-1TLS\s0 implementations. Adding this
 306 option enables various workarounds.
 307 .IP "\fB\-cipher cipherlist\fR" 4
 308 .IX Item "-cipher cipherlist"
 309 this allows the cipher list sent by the client to be modified. Although
 310 the server determines which cipher suite is used it should take the first
 311 supported cipher in the list sent by the client. See the \fBciphers\fR
 312 command for more information.
 313 .IP "\fB\-starttls protocol\fR" 4
 314 .IX Item "-starttls protocol"
 315 send the protocol-specific message(s) to switch to \s-1TLS\s0 for communication.
 316 \&\fBprotocol\fR is a keyword for the intended protocol.  Currently, the only
 317 supported keywords are \*(L"smtp\*(R", \*(L"pop3\*(R", \*(L"imap\*(R", \*(L"ftp\*(R" and \*(L"xmpp\*(R".
 318 .IP "\fB\-xmpphost hostname\fR" 4
 319 .IX Item "-xmpphost hostname"
 320 This option, when used with \*(L"\-starttls xmpp\*(R", specifies the host for the
 321 \&\*(L"to\*(R" attribute of the stream element.
 322 If this option is not specified, then the host specified with \*(L"\-connect\*(R"
 323 will be used.
 324 .IP "\fB\-tlsextdebug\fR" 4
 325 .IX Item "-tlsextdebug"
 326 print out a hex dump of any \s-1TLS\s0 extensions received from the server.
 327 .IP "\fB\-no_ticket\fR" 4
 328 .IX Item "-no_ticket"
 329 disable RFC4507bis session ticket support.
 330 .IP "\fB\-sess_out filename\fR" 4
 331 .IX Item "-sess_out filename"
 332 output \s-1SSL\s0 session to \fBfilename\fR
 333 .IP "\fB\-sess_in sess.pem\fR" 4
 334 .IX Item "-sess_in sess.pem"
 335 load \s-1SSL\s0 session from \fBfilename\fR. The client will attempt to resume a
 336 connection from this session.
 337 .IP "\fB\-engine id\fR" 4
 338 .IX Item "-engine id"
 339 specifying an engine (by its unique \fBid\fR string) will cause \fBs_client\fR
 340 to attempt to obtain a functional reference to the specified engine,
 341 thus initialising it if needed. The engine will then be set as the default
 342 for all available algorithms.
 343 .IP "\fB\-rand file(s)\fR" 4
 344 .IX Item "-rand file(s)"
 345 a file or files containing random data used to seed the random number
 346 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
 347 Multiple files can be specified separated by a OS-dependent character.
 348 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 349 all others.
 350 .SH "CONNECTED COMMANDS"
 351 .IX Header "CONNECTED COMMANDS"
 352 If a connection is established with an \s-1SSL\s0 server then any data received
 353 from the server is displayed and any key presses will be sent to the
 354 server. When used interactively (which means neither \fB\-quiet\fR nor \fB\-ign_eof\fR
 355 have been given), the session will be renegotiated if the line begins with an
 356 \&\fBR\fR, and if the line begins with a \fBQ\fR or if end of file is reached, the
 357 connection will be closed down.
 358 .SH "NOTES"
 359 .IX Header "NOTES"
 360 \&\fBs_client\fR can be used to debug \s-1SSL\s0 servers. To connect to an \s-1SSL\s0 \s-1HTTP\s0
 361 server the command:
 362 .PP
 363 .Vb 1
 364 \& openssl s_client \-connect servername:443
 365 .Ve
 366 .PP
 367 would typically be used (https uses port 443). If the connection succeeds
 368 then an \s-1HTTP\s0 command can be given such as \*(L"\s-1GET\s0 /\*(R" to retrieve a web page.
 369 .PP
 370 If the handshake fails then there are several possible causes, if it is
 371 nothing obvious like no client certificate then the \fB\-bugs\fR, \fB\-ssl2\fR,
 372 \&\fB\-ssl3\fR, \fB\-tls1\fR, \fB\-no_ssl2\fR, \fB\-no_ssl3\fR, \fB\-no_tls1\fR options can be tried
 373 in case it is a buggy server. In particular you should play with these
 374 options \fBbefore\fR submitting a bug report to an OpenSSL mailing list.
 375 .PP
 376 A frequent problem when attempting to get client certificates working
 377 is that a web client complains it has no certificates or gives an empty
 378 list to choose from. This is normally because the server is not sending
 379 the clients certificate authority in its \*(L"acceptable \s-1CA\s0 list\*(R" when it
 380 requests a certificate. By using \fBs_client\fR the \s-1CA\s0 list can be viewed
 381 and checked. However some servers only request client authentication
 382 after a specific \s-1URL\s0 is requested. To obtain the list in this case it
 383 is necessary to use the \fB\-prexit\fR option and send an \s-1HTTP\s0 request
 384 for an appropriate page.
 385 .PP
 386 If a certificate is specified on the command line using the \fB\-cert\fR
 387 option it will not be used unless the server specifically requests
 388 a client certificate. Therefor merely including a client certificate
 389 on the command line is no guarantee that the certificate works.
 390 .PP
 391 If there are problems verifying a server certificate then the
 392 \&\fB\-showcerts\fR option can be used to show the whole chain.
 393 .PP
 394 Since the SSLv23 client hello cannot include compression methods or extensions
 395 these will only be supported if its use is disabled, for example by using the
 396 \&\fB\-no_sslv2\fR option.
 397 .PP
 398 The \fBs_client\fR utility is a test tool and is designed to continue the
 399 handshake after any certificate verification errors. As a result it will
 400 accept any certificate chain (trusted or not) sent by the peer. None test
 401 applications should \fBnot\fR do this as it makes them vulnerable to a \s-1MITM\s0
 402 attack.
 403 .SH "BUGS"
 404 .IX Header "BUGS"
 405 Because this program has a lot of options and also because some of
 406 the techniques used are rather old, the C source of s_client is rather
 407 hard to read and not a model of how things should be done. A typical
 408 \&\s-1SSL\s0 client program would be much simpler.
 409 .PP
 410 The \fB\-prexit\fR option is a bit of a hack. We should really report
 411 information whenever a session is renegotiated.
 412 .SH "SEE ALSO"
 413 .IX Header "SEE ALSO"
 414 \&\fIsess_id\fR\|(1), \fIs_server\fR\|(1), \fIciphers\fR\|(1)