Document -no-CApath and -no-CAfile
[openssl.git] / doc / apps / s_client.pod
1
2 =pod
3
4 =head1 NAME
5
6 s_client - SSL/TLS client program
7
8 =head1 SYNOPSIS
9
10 B<openssl> B<s_client>
11 [B<-connect host:port>]
12 [B<-proxy host:port>]
13 [B<-servername name>]
14 [B<-verify depth>]
15 [B<-verify_return_error>]
16 [B<-cert filename>]
17 [B<-certform DER|PEM>]
18 [B<-key filename>]
19 [B<-keyform DER|PEM>]
20 [B<-pass arg>]
21 [B<-CApath directory>]
22 [B<-CAfile filename>]
23 [B<-no-CAfile>]
24 [B<-no-CApath>]
25 [B<-attime timestamp>]
26 [B<-check_ss_sig>]
27 [B<-crl_check>]
28 [B<-crl_check_all>]
29 [B<-explicit_policy>]
30 [B<-extended_crl>]
31 [B<-ignore_critical>]
32 [B<-inhibit_any>]
33 [B<-inhibit_map>]
34 [B<-issuer_checks>]
35 [B<-partial_chain>]
36 [B<-policy arg>]
37 [B<-policy_check>]
38 [B<-policy_print>]
39 [B<-purpose purpose>]
40 [B<-suiteB_128>]
41 [B<-suiteB_128_only>]
42 [B<-suiteB_192>]
43 [B<-trusted_first>]
44 [B<-no_alt_chains>]
45 [B<-use_deltas>]
46 [B<-verify_depth num>]
47 [B<-verify_email email>]
48 [B<-verify_hostname hostname>]
49 [B<-verify_ip ip>]
50 [B<-verify_name name>]
51 [B<-x509_strict>]
52 [B<-reconnect>]
53 [B<-pause>]
54 [B<-showcerts>]
55 [B<-debug>]
56 [B<-msg>]
57 [B<-nbio_test>]
58 [B<-state>]
59 [B<-nbio>]
60 [B<-crlf>]
61 [B<-ign_eof>]
62 [B<-no_ign_eof>]
63 [B<-quiet>]
64 [B<-ssl3>]
65 [B<-tls1>]
66 [B<-no_ssl3>]
67 [B<-no_tls1>]
68 [B<-no_tls1_1>]
69 [B<-no_tls1_2>]
70 [B<-fallback_scsv>]
71 [B<-bugs>]
72 [B<-cipher cipherlist>]
73 [B<-serverpref>]
74 [B<-starttls protocol>]
75 [B<-xmpphost hostname>]
76 [B<-engine id>]
77 [B<-tlsextdebug>]
78 [B<-no_ticket>]
79 [B<-sess_out filename>]
80 [B<-sess_in filename>]
81 [B<-rand file(s)>]
82 [B<-serverinfo types>]
83 [B<-status>]
84 [B<-nextprotoneg protocols>]
85
86 =head1 DESCRIPTION
87
88 The B<s_client> command implements a generic SSL/TLS client which connects
89 to a remote host using SSL/TLS. It is a I<very> useful diagnostic tool for
90 SSL servers.
91
92 =head1 OPTIONS
93
94 In addition to the options below the B<s_client> utility also supports the
95 common and client only options documented in the
96 in the L<SSL_CONF_cmd(3)|SSL_CONF_cmd(3)/SUPPORTED COMMAND LINE COMMANDS>
97 manual page.
98
99 =over 4
100
101 =item B<-connect host:port>
102
103 This specifies the host and optional port to connect to. If not specified
104 then an attempt is made to connect to the local host on port 4433.
105
106 =item B<-proxy host:port>
107
108 When used with the B<-connect> flag, the program uses the host and port
109 specified with this flag and issues an HTTP CONNECT command to connect
110 to the desired server.
111
112 =item B<-servername name>
113
114 Set the TLS SNI (Server Name Indication) extension in the ClientHello message.
115
116 =item B<-cert certname>
117
118 The certificate to use, if one is requested by the server. The default is
119 not to use a certificate.
120
121 =item B<-certform format>
122
123 The certificate format to use: DER or PEM. PEM is the default.
124
125 =item B<-key keyfile>
126
127 The private key to use. If not specified then the certificate file will
128 be used.
129
130 =item B<-keyform format>
131
132 The private format to use: DER or PEM. PEM is the default.
133
134 =item B<-pass arg>
135
136 the private key password source. For more information about the format of B<arg>
137 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
138
139 =item B<-verify depth>
140
141 The verify depth to use. This specifies the maximum length of the
142 server certificate chain and turns on server certificate verification.
143 Currently the verify operation continues after errors so all the problems
144 with a certificate chain can be seen. As a side effect the connection
145 will never fail due to a server certificate verify failure.
146
147 =item B<-verify_return_error>
148
149 Return verification errors instead of continuing. This will typically
150 abort the handshake with a fatal error.
151
152 =item B<-CApath directory>
153
154 The directory to use for server certificate verification. This directory
155 must be in "hash format", see B<verify> for more information. These are
156 also used when building the client certificate chain.
157
158 =item B<-CAfile file>
159
160 A file containing trusted certificates to use during server authentication
161 and to use when attempting to build the client certificate chain.
162
163 =item B<-no-CAfile>
164
165 Do not load the trusted CA certificates from the default file location
166
167 =item B<-no-CApath>
168
169 Do not load the trusted CA certificates from the default directory location
170
171 =item B<-attime>, B<-check_ss_sig>, B<-crl_check>, B<-crl_check_all>,
172 B<explicit_policy>, B<-extended_crl>, B<-ignore_critical>, B<-inhibit_any>,
173 B<-inhibit_map>, B<-issuer_checks>, B<-partial_chain>, B<-policy>,
174 B<-policy_check>, B<-policy_print>, B<-purpose>, B<-suiteB_128>,
175 B<-suiteB_128_only>, B<-suiteB_192>, B<-trusted_first>, B<-no_alt_chains>,
176 B<-use_deltas>, B<-verify_depth>, B<-verify_email>, B<-verify_hostname>,
177 B<-verify_ip>, B<-verify_name>, B<-x509_strict>
178
179 Set various certificate chain validation options. See the
180 L<verify(1)> manual page for details.
181
182 =item B<-reconnect>
183
184 reconnects to the same server 5 times using the same session ID, this can
185 be used as a test that session caching is working.
186
187 =item B<-pause>
188
189 pauses 1 second between each read and write call.
190
191 =item B<-showcerts>
192
193 display the whole server certificate chain: normally only the server
194 certificate itself is displayed.
195
196 =item B<-prexit>
197
198 print session information when the program exits. This will always attempt
199 to print out information even if the connection fails. Normally information
200 will only be printed out once if the connection succeeds. This option is useful
201 because the cipher in use may be renegotiated or the connection may fail
202 because a client certificate is required or is requested only after an
203 attempt is made to access a certain URL. Note: the output produced by this
204 option is not always accurate because a connection might never have been
205 established.
206
207 =item B<-state>
208
209 prints out the SSL session states.
210
211 =item B<-debug>
212
213 print extensive debugging information including a hex dump of all traffic.
214
215 =item B<-msg>
216
217 show all protocol messages with hex dump.
218
219 =item B<-trace>
220
221 show verbose trace output of protocol messages. OpenSSL needs to be compiled
222 with B<enable-ssl-trace> for this option to work.
223
224 =item B<-msgfile>
225
226 file to send output of B<-msg> or B<-trace> to, default standard output.
227
228 =item B<-nbio_test>
229
230 tests non-blocking I/O
231
232 =item B<-nbio>
233
234 turns on non-blocking I/O
235
236 =item B<-crlf>
237
238 this option translated a line feed from the terminal into CR+LF as required
239 by some servers.
240
241 =item B<-ign_eof>
242
243 inhibit shutting down the connection when end of file is reached in the
244 input.
245
246 =item B<-quiet>
247
248 inhibit printing of session and certificate information.  This implicitly
249 turns on B<-ign_eof> as well.
250
251 =item B<-no_ign_eof>
252
253 shut down the connection when end of file is reached in the input.
254 Can be used to override the implicit B<-ign_eof> after B<-quiet>.
255
256 =item B<-psk_identity identity>
257
258 Use the PSK identity B<identity> when using a PSK cipher suite.
259
260 =item B<-psk key>
261
262 Use the PSK key B<key> when using a PSK cipher suite. The key is
263 given as a hexadecimal number without leading 0x, for example -psk
264 1a2b3c4d.
265
266 =item B<-ssl3>, B<-tls1>, B<-no_ssl3>, B<-no_tls1>, B<-no_tls1_1>, B<-no_tls1_2>
267
268 these options disable the use of certain SSL or TLS protocols. By default
269 the initial handshake uses a method which should be compatible with all
270 servers and permit them to use SSL v3 or TLS as appropriate.
271
272 Unfortunately there are still ancient and broken servers in use which
273 cannot handle this technique and will fail to connect. Some servers only
274 work if TLS is turned off.
275
276 =item B<-fallback_scsv>
277
278 Send TLS_FALLBACK_SCSV in the ClientHello.
279
280 =item B<-bugs>
281
282 there are several known bug in SSL and TLS implementations. Adding this
283 option enables various workarounds.
284
285 =item B<-brief>
286
287 only provide a brief summary of connection parameters instead of the
288 normal verbose output.
289
290 =item B<-cipher cipherlist>
291
292 this allows the cipher list sent by the client to be modified. Although
293 the server determines which cipher suite is used it should take the first
294 supported cipher in the list sent by the client. See the B<ciphers>
295 command for more information.
296
297 =item B<-starttls protocol>
298
299 send the protocol-specific message(s) to switch to TLS for communication.
300 B<protocol> is a keyword for the intended protocol.  Currently, the only
301 supported keywords are "smtp", "pop3", "imap", "ftp", "xmpp",
302 and "xmpp-server".
303
304 =item B<-xmpphost hostname>
305
306 This option, when used with "-starttls xmpp" or "-starttls xmpp-server",
307 specifies the host for the "to" attribute of the stream element.
308 If this option is not specified, then the host specified with "-connect"
309 will be used.
310
311 =item B<-tlsextdebug>
312
313 print out a hex dump of any TLS extensions received from the server.
314
315 =item B<-no_ticket>
316
317 disable RFC4507bis session ticket support. 
318
319 =item B<-sess_out filename>
320
321 output SSL session to B<filename>
322
323 =item B<-sess_in sess.pem>
324
325 load SSL session from B<filename>. The client will attempt to resume a
326 connection from this session.
327
328 =item B<-engine id>
329
330 specifying an engine (by its unique B<id> string) will cause B<s_client>
331 to attempt to obtain a functional reference to the specified engine,
332 thus initialising it if needed. The engine will then be set as the default
333 for all available algorithms.
334
335 =item B<-rand file(s)>
336
337 a file or files containing random data used to seed the random number
338 generator, or an EGD socket (see L<RAND_egd(3)>).
339 Multiple files can be specified separated by a OS-dependent character.
340 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
341 all others.
342
343 =item B<-serverinfo types>
344
345 a list of comma-separated TLS Extension Types (numbers between 0 and 
346 65535).  Each type will be sent as an empty ClientHello TLS Extension.
347 The server's response (if any) will be encoded and displayed as a PEM
348 file.
349
350 =item B<-status>
351
352 sends a certificate status request to the server (OCSP stapling). The server
353 response (if any) is printed out.
354
355 =item B<-nextprotoneg protocols>
356
357 enable Next Protocol Negotiation TLS extension and provide a list of
358 comma-separated protocol names that the client should advertise
359 support for. The list should contain most wanted protocols first.
360 Protocol names are printable ASCII strings, for example "http/1.1" or
361 "spdy/3".
362 Empty list of protocols is treated specially and will cause the client to
363 advertise support for the TLS extension but disconnect just after
364 receiving ServerHello with a list of server supported protocols.
365
366 =back
367
368 =head1 CONNECTED COMMANDS
369
370 If a connection is established with an SSL server then any data received
371 from the server is displayed and any key presses will be sent to the
372 server. When used interactively (which means neither B<-quiet> nor B<-ign_eof>
373 have been given), the session will be renegotiated if the line begins with an
374 B<R>, and if the line begins with a B<Q> or if end of file is reached, the
375 connection will be closed down.
376
377 =head1 NOTES
378
379 B<s_client> can be used to debug SSL servers. To connect to an SSL HTTP
380 server the command:
381
382  openssl s_client -connect servername:443
383
384 would typically be used (https uses port 443). If the connection succeeds
385 then an HTTP command can be given such as "GET /" to retrieve a web page.
386
387 If the handshake fails then there are several possible causes, if it is
388 nothing obvious like no client certificate then the B<-bugs>,
389 B<-ssl3>, B<-tls1>, B<-no_ssl3>, B<-no_tls1> options can be tried
390 in case it is a buggy server. In particular you should play with these
391 options B<before> submitting a bug report to an OpenSSL mailing list.
392
393 A frequent problem when attempting to get client certificates working
394 is that a web client complains it has no certificates or gives an empty
395 list to choose from. This is normally because the server is not sending
396 the clients certificate authority in its "acceptable CA list" when it
397 requests a certificate. By using B<s_client> the CA list can be viewed
398 and checked. However some servers only request client authentication
399 after a specific URL is requested. To obtain the list in this case it
400 is necessary to use the B<-prexit> option and send an HTTP request
401 for an appropriate page.
402
403 If a certificate is specified on the command line using the B<-cert>
404 option it will not be used unless the server specifically requests
405 a client certificate. Therefor merely including a client certificate
406 on the command line is no guarantee that the certificate works.
407
408 If there are problems verifying a server certificate then the
409 B<-showcerts> option can be used to show the whole chain.
410
411 The B<s_client> utility is a test tool and is designed to continue the
412 handshake after any certificate verification errors. As a result it will
413 accept any certificate chain (trusted or not) sent by the peer. None test
414 applications should B<not> do this as it makes them vulnerable to a MITM
415 attack. This behaviour can be changed by with the B<-verify_return_error>
416 option: any verify errors are then returned aborting the handshake.
417
418 =head1 BUGS
419
420 Because this program has a lot of options and also because some of
421 the techniques used are rather old, the C source of s_client is rather
422 hard to read and not a model of how things should be done. A typical
423 SSL client program would be much simpler.
424
425 The B<-prexit> option is a bit of a hack. We should really report
426 information whenever a session is renegotiated.
427
428 =head1 SEE ALSO
429
430 L<sess_id(1)>, L<s_server(1)>, L<ciphers(1)>
431
432 =head1 HISTORY
433
434 The -no_alt_chains options was first added to OpenSSL 1.1.0.
435
436 =cut