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