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

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