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