]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - secure/usr.bin/openssl/man/s_client.1
Merge ^/head r312720 through r312893.
[FreeBSD/FreeBSD.git] / secure / usr.bin / openssl / man / s_client.1
1 .\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
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 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .if !\nF .nr F 0
58 .if \nF>0 \{\
59 .    de IX
60 .    tm Index:\\$1\t\\n%\t"\\$2"
61 ..
62 .    if !\nF==2 \{\
63 .        nr % 0
64 .        nr F 2
65 .    \}
66 .\}
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 "2017-01-26" "1.0.2k" "OpenSSL"
133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
134 .\" way too many mistakes in technical documents.
135 .if n .ad l
136 .nh
137 .SH "NAME"
138 s_client \- SSL/TLS client program
139 .SH "SYNOPSIS"
140 .IX Header "SYNOPSIS"
141 \&\fBopenssl\fR \fBs_client\fR
142 [\fB\-connect host:port\fR]
143 [\fB\-servername name\fR]
144 [\fB\-verify depth\fR]
145 [\fB\-verify_return_error\fR]
146 [\fB\-cert filename\fR]
147 [\fB\-certform DER|PEM\fR]
148 [\fB\-key filename\fR]
149 [\fB\-keyform DER|PEM\fR]
150 [\fB\-pass arg\fR]
151 [\fB\-CApath directory\fR]
152 [\fB\-CAfile filename\fR]
153 [\fB\-no_alt_chains\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\-no_ign_eof\fR]
165 [\fB\-quiet\fR]
166 [\fB\-ssl2\fR]
167 [\fB\-ssl3\fR]
168 [\fB\-tls1\fR]
169 [\fB\-no_ssl2\fR]
170 [\fB\-no_ssl3\fR]
171 [\fB\-no_tls1\fR]
172 [\fB\-no_tls1_1\fR]
173 [\fB\-no_tls1_2\fR]
174 [\fB\-fallback_scsv\fR]
175 [\fB\-bugs\fR]
176 [\fB\-cipher cipherlist\fR]
177 [\fB\-serverpref\fR]
178 [\fB\-starttls protocol\fR]
179 [\fB\-engine id\fR]
180 [\fB\-tlsextdebug\fR]
181 [\fB\-no_ticket\fR]
182 [\fB\-sess_out filename\fR]
183 [\fB\-sess_in filename\fR]
184 [\fB\-rand file(s)\fR]
185 [\fB\-serverinfo types\fR]
186 [\fB\-status\fR]
187 [\fB\-alpn protocols\fR]
188 [\fB\-nextprotoneg protocols\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 .IP "\fB\-connect host:port\fR" 4
197 .IX Item "-connect host:port"
198 This specifies the host and optional port to connect to. If not specified
199 then an attempt is made to connect to the local host on port 4433.
200 .IP "\fB\-servername name\fR" 4
201 .IX Item "-servername name"
202 Set the \s-1TLS SNI \s0(Server Name Indication) extension in the ClientHello message.
203 .IP "\fB\-cert certname\fR" 4
204 .IX Item "-cert certname"
205 The certificate to use, if one is requested by the server. The default is
206 not to use a certificate.
207 .IP "\fB\-certform format\fR" 4
208 .IX Item "-certform format"
209 The certificate format to use: \s-1DER\s0 or \s-1PEM. PEM\s0 is the default.
210 .IP "\fB\-key keyfile\fR" 4
211 .IX Item "-key keyfile"
212 The private key to use. If not specified then the certificate file will
213 be used.
214 .IP "\fB\-keyform format\fR" 4
215 .IX Item "-keyform format"
216 The private format to use: \s-1DER\s0 or \s-1PEM. PEM\s0 is the default.
217 .IP "\fB\-pass arg\fR" 4
218 .IX Item "-pass arg"
219 the private key password source. For more information about the format of \fBarg\fR
220 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
221 .IP "\fB\-verify depth\fR" 4
222 .IX Item "-verify depth"
223 The verify depth to use. This specifies the maximum length of the
224 server certificate chain and turns on server certificate verification.
225 Currently the verify operation continues after errors so all the problems
226 with a certificate chain can be seen. As a side effect the connection
227 will never fail due to a server certificate verify failure.
228 .IP "\fB\-verify_return_error\fR" 4
229 .IX Item "-verify_return_error"
230 Return verification errors instead of continuing. This will typically
231 abort the handshake with a fatal error.
232 .IP "\fB\-CApath directory\fR" 4
233 .IX Item "-CApath directory"
234 The directory to use for server certificate verification. This directory
235 must be in \*(L"hash format\*(R", see \fBverify\fR for more information. These are
236 also used when building the client certificate chain.
237 .IP "\fB\-CAfile file\fR" 4
238 .IX Item "-CAfile file"
239 A file containing trusted certificates to use during server authentication
240 and to use when attempting to build the client certificate chain.
241 .IP "\fB\-purpose, \-ignore_critical, \-issuer_checks, \-crl_check, \-crl_check_all, \-policy_check, \-extended_crl, \-x509_strict, \-policy \-check_ss_sig \-no_alt_chains\fR" 4
242 .IX Item "-purpose, -ignore_critical, -issuer_checks, -crl_check, -crl_check_all, -policy_check, -extended_crl, -x509_strict, -policy -check_ss_sig -no_alt_chains"
243 Set various certificate chain valiadition option. See the
244 \&\fBverify\fR manual page for details.
245 .IP "\fB\-reconnect\fR" 4
246 .IX Item "-reconnect"
247 reconnects to the same server 5 times using the same session \s-1ID,\s0 this can
248 be used as a test that session caching is working.
249 .IP "\fB\-pause\fR" 4
250 .IX Item "-pause"
251 pauses 1 second between each read and write call.
252 .IP "\fB\-showcerts\fR" 4
253 .IX Item "-showcerts"
254 display the whole server certificate chain: normally only the server
255 certificate itself is displayed.
256 .IP "\fB\-prexit\fR" 4
257 .IX Item "-prexit"
258 print session information when the program exits. This will always attempt
259 to print out information even if the connection fails. Normally information
260 will only be printed out once if the connection succeeds. This option is useful
261 because the cipher in use may be renegotiated or the connection may fail
262 because a client certificate is required or is requested only after an
263 attempt is made to access a certain \s-1URL.\s0 Note: the output produced by this
264 option is not always accurate because a connection might never have been
265 established.
266 .IP "\fB\-state\fR" 4
267 .IX Item "-state"
268 prints out the \s-1SSL\s0 session states.
269 .IP "\fB\-debug\fR" 4
270 .IX Item "-debug"
271 print extensive debugging information including a hex dump of all traffic.
272 .IP "\fB\-msg\fR" 4
273 .IX Item "-msg"
274 show all protocol messages with hex dump.
275 .IP "\fB\-nbio_test\fR" 4
276 .IX Item "-nbio_test"
277 tests non-blocking I/O
278 .IP "\fB\-nbio\fR" 4
279 .IX Item "-nbio"
280 turns on non-blocking I/O
281 .IP "\fB\-crlf\fR" 4
282 .IX Item "-crlf"
283 this option translated a line feed from the terminal into \s-1CR+LF\s0 as required
284 by some servers.
285 .IP "\fB\-ign_eof\fR" 4
286 .IX Item "-ign_eof"
287 inhibit shutting down the connection when end of file is reached in the
288 input.
289 .IP "\fB\-quiet\fR" 4
290 .IX Item "-quiet"
291 inhibit printing of session and certificate information.  This implicitly
292 turns on \fB\-ign_eof\fR as well.
293 .IP "\fB\-no_ign_eof\fR" 4
294 .IX Item "-no_ign_eof"
295 shut down the connection when end of file is reached in the input.
296 Can be used to override the implicit \fB\-ign_eof\fR after \fB\-quiet\fR.
297 .IP "\fB\-psk_identity identity\fR" 4
298 .IX Item "-psk_identity identity"
299 Use the \s-1PSK\s0 identity \fBidentity\fR when using a \s-1PSK\s0 cipher suite.
300 .IP "\fB\-psk key\fR" 4
301 .IX Item "-psk key"
302 Use the \s-1PSK\s0 key \fBkey\fR when using a \s-1PSK\s0 cipher suite. The key is
303 given as a hexadecimal number without leading 0x, for example \-psk
304 1a2b3c4d.
305 .IP "\fB\-ssl2\fR, \fB\-ssl3\fR, \fB\-tls1\fR, \fB\-tls1_1\fR, \fB\-tls1_2\fR, \fB\-no_ssl2\fR, \fB\-no_ssl3\fR, \fB\-no_tls1\fR, \fB\-no_tls1_1\fR, \fB\-no_tls1_2\fR" 4
306 .IX Item "-ssl2, -ssl3, -tls1, -tls1_1, -tls1_2, -no_ssl2, -no_ssl3, -no_tls1, -no_tls1_1, -no_tls1_2"
307 These options require or disable the use of the specified \s-1SSL\s0 or \s-1TLS\s0 protocols.
308 By default the initial handshake uses a \fIversion-flexible\fR method which will
309 negotiate the highest mutually supported protocol version.
310 .IP "\fB\-fallback_scsv\fR" 4
311 .IX Item "-fallback_scsv"
312 Send \s-1TLS_FALLBACK_SCSV\s0 in the ClientHello.
313 .IP "\fB\-bugs\fR" 4
314 .IX Item "-bugs"
315 there are several known bug in \s-1SSL\s0 and \s-1TLS\s0 implementations. Adding this
316 option enables various workarounds.
317 .IP "\fB\-cipher cipherlist\fR" 4
318 .IX Item "-cipher cipherlist"
319 this allows the cipher list sent by the client to be modified. Although
320 the server determines which cipher suite is used it should take the first
321 supported cipher in the list sent by the client. See the \fBciphers\fR
322 command for more information.
323 .IP "\fB\-serverpref\fR" 4
324 .IX Item "-serverpref"
325 use the server's cipher preferences; only used for \s-1SSLV2.\s0
326 .IP "\fB\-starttls protocol\fR" 4
327 .IX Item "-starttls protocol"
328 send the protocol-specific message(s) to switch to \s-1TLS\s0 for communication.
329 \&\fBprotocol\fR is a keyword for the intended protocol.  Currently, the only
330 supported keywords are \*(L"smtp\*(R", \*(L"pop3\*(R", \*(L"imap\*(R", and \*(L"ftp\*(R".
331 .IP "\fB\-tlsextdebug\fR" 4
332 .IX Item "-tlsextdebug"
333 print out a hex dump of any \s-1TLS\s0 extensions received from the server.
334 .IP "\fB\-no_ticket\fR" 4
335 .IX Item "-no_ticket"
336 disable RFC4507bis session ticket support.
337 .IP "\fB\-sess_out filename\fR" 4
338 .IX Item "-sess_out filename"
339 output \s-1SSL\s0 session to \fBfilename\fR
340 .IP "\fB\-sess_in sess.pem\fR" 4
341 .IX Item "-sess_in sess.pem"
342 load \s-1SSL\s0 session from \fBfilename\fR. The client will attempt to resume a
343 connection from this session.
344 .IP "\fB\-engine id\fR" 4
345 .IX Item "-engine id"
346 specifying an engine (by its unique \fBid\fR string) will cause \fBs_client\fR
347 to attempt to obtain a functional reference to the specified engine,
348 thus initialising it if needed. The engine will then be set as the default
349 for all available algorithms.
350 .IP "\fB\-rand file(s)\fR" 4
351 .IX Item "-rand file(s)"
352 a file or files containing random data used to seed the random number
353 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
354 Multiple files can be specified separated by a OS-dependent character.
355 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
356 all others.
357 .IP "\fB\-serverinfo types\fR" 4
358 .IX Item "-serverinfo types"
359 a list of comma-separated \s-1TLS\s0 Extension Types (numbers between 0 and 
360 65535).  Each type will be sent as an empty ClientHello \s-1TLS\s0 Extension.
361 The server's response (if any) will be encoded and displayed as a \s-1PEM\s0
362 file.
363 .IP "\fB\-status\fR" 4
364 .IX Item "-status"
365 sends a certificate status request to the server (\s-1OCSP\s0 stapling). The server
366 response (if any) is printed out.
367 .IP "\fB\-alpn protocols\fR, \fB\-nextprotoneg protocols\fR" 4
368 .IX Item "-alpn protocols, -nextprotoneg protocols"
369 these flags enable the 
370 Enable the Application-Layer Protocol Negotiation or Next Protocol
371 Negotiation extension, respectively. \s-1ALPN\s0 is the \s-1IETF\s0 standard and
372 replaces \s-1NPN.\s0
373 The \fBprotocols\fR list is a
374 comma-separated protocol names that the client should advertise
375 support for. The list should contain most wanted protocols first.
376 Protocol names are printable \s-1ASCII\s0 strings, for example \*(L"http/1.1\*(R" or
377 \&\*(L"spdy/3\*(R".
378 Empty list of protocols is treated specially and will cause the client to
379 advertise support for the \s-1TLS\s0 extension but disconnect just after
380 reciving ServerHello with a list of server supported protocols.
381 .SH "CONNECTED COMMANDS"
382 .IX Header "CONNECTED COMMANDS"
383 If a connection is established with an \s-1SSL\s0 server then any data received
384 from the server is displayed and any key presses will be sent to the
385 server. When used interactively (which means neither \fB\-quiet\fR nor \fB\-ign_eof\fR
386 have been given), the session will be renegotiated if the line begins with an
387 \&\fBR\fR, and if the line begins with a \fBQ\fR or if end of file is reached, the
388 connection will be closed down.
389 .SH "NOTES"
390 .IX Header "NOTES"
391 \&\fBs_client\fR can be used to debug \s-1SSL\s0 servers. To connect to an \s-1SSL HTTP\s0
392 server the command:
393 .PP
394 .Vb 1
395 \& openssl s_client \-connect servername:443
396 .Ve
397 .PP
398 would typically be used (https uses port 443). If the connection succeeds
399 then an \s-1HTTP\s0 command can be given such as \*(L"\s-1GET /\*(R"\s0 to retrieve a web page.
400 .PP
401 If the handshake fails then there are several possible causes, if it is
402 nothing obvious like no client certificate then the \fB\-bugs\fR, \fB\-ssl2\fR,
403 \&\fB\-ssl3\fR, \fB\-tls1\fR, \fB\-no_ssl2\fR, \fB\-no_ssl3\fR, \fB\-no_tls1\fR options can be tried
404 in case it is a buggy server. In particular you should play with these
405 options \fBbefore\fR submitting a bug report to an OpenSSL mailing list.
406 .PP
407 A frequent problem when attempting to get client certificates working
408 is that a web client complains it has no certificates or gives an empty
409 list to choose from. This is normally because the server is not sending
410 the clients certificate authority in its \*(L"acceptable \s-1CA\s0 list\*(R" when it
411 requests a certificate. By using \fBs_client\fR the \s-1CA\s0 list can be viewed
412 and checked. However some servers only request client authentication
413 after a specific \s-1URL\s0 is requested. To obtain the list in this case it
414 is necessary to use the \fB\-prexit\fR option and send an \s-1HTTP\s0 request
415 for an appropriate page.
416 .PP
417 If a certificate is specified on the command line using the \fB\-cert\fR
418 option it will not be used unless the server specifically requests
419 a client certificate. Therefor merely including a client certificate
420 on the command line is no guarantee that the certificate works.
421 .PP
422 If there are problems verifying a server certificate then the
423 \&\fB\-showcerts\fR option can be used to show the whole chain.
424 .PP
425 Since the SSLv23 client hello cannot include compression methods or extensions
426 these will only be supported if its use is disabled, for example by using the
427 \&\fB\-no_sslv2\fR option.
428 .PP
429 The \fBs_client\fR utility is a test tool and is designed to continue the
430 handshake after any certificate verification errors. As a result it will
431 accept any certificate chain (trusted or not) sent by the peer. None test
432 applications should \fBnot\fR do this as it makes them vulnerable to a \s-1MITM\s0
433 attack. This behaviour can be changed by with the \fB\-verify_return_error\fR
434 option: any verify errors are then returned aborting the handshake.
435 .SH "BUGS"
436 .IX Header "BUGS"
437 Because this program has a lot of options and also because some of
438 the techniques used are rather old, the C source of s_client is rather
439 hard to read and not a model of how things should be done. A typical
440 \&\s-1SSL\s0 client program would be much simpler.
441 .PP
442 The \fB\-prexit\fR option is a bit of a hack. We should really report
443 information whenever a session is renegotiated.
444 .SH "SEE ALSO"
445 .IX Header "SEE ALSO"
446 \&\fIsess_id\fR\|(1), \fIs_server\fR\|(1), \fIciphers\fR\|(1)
447 .SH "HISTORY"
448 .IX Header "HISTORY"
449 The \-no_alt_chains options was first added to OpenSSL 1.0.2b.