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

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