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