document -trace and -msgfile options
[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<-verify depth>]
13 [B<-cert filename>]
14 [B<-certform DER|PEM>]
15 [B<-key filename>]
16 [B<-keyform DER|PEM>]
17 [B<-pass arg>]
18 [B<-CApath directory>]
19 [B<-CAfile filename>]
20 [B<-reconnect>]
21 [B<-pause>]
22 [B<-showcerts>]
23 [B<-debug>]
24 [B<-msg>]
25 [B<-nbio_test>]
26 [B<-state>]
27 [B<-nbio>]
28 [B<-crlf>]
29 [B<-ign_eof>]
30 [B<-quiet>]
31 [B<-ssl2>]
32 [B<-ssl3>]
33 [B<-tls1>]
34 [B<-no_ssl2>]
35 [B<-no_ssl3>]
36 [B<-no_tls1>]
37 [B<-bugs>]
38 [B<-cipher cipherlist>]
39 [B<-starttls protocol>]
40 [B<-engine id>]
41 [B<-tlsextdebug>]
42 [B<-no_ticket>]
43 [B<-sess_out filename>]
44 [B<-sess_in filename>]
45 [B<-rand file(s)>]
46
47 =head1 DESCRIPTION
48
49 The B<s_client> command implements a generic SSL/TLS client which connects
50 to a remote host using SSL/TLS. It is a I<very> useful diagnostic tool for
51 SSL servers.
52
53 =head1 OPTIONS
54
55 In addition to the options below the B<s_client> utility also supports the
56 common and client only options documented in the
57 B<SUPPORTED COMMAND LINE OPTIONS> section in L<SSL_CONF_cmd(3)|SSL_CONF_cmd(3)>.
58
59 =over 4
60
61 =item B<-connect host:port>
62
63 This specifies the host and optional port to connect to. If not specified
64 then an attempt is made to connect to the local host on port 4433.
65
66 =item B<-cert certname>
67
68 The certificate to use, if one is requested by the server. The default is
69 not to use a certificate.
70
71 =item B<-certform format>
72
73 The certificate format to use: DER or PEM. PEM is the default.
74
75 =item B<-key keyfile>
76
77 The private key to use. If not specified then the certificate file will
78 be used.
79
80 =item B<-keyform format>
81
82 The private format to use: DER or PEM. PEM is the default.
83
84 =item B<-pass arg>
85
86 the private key password source. For more information about the format of B<arg>
87 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)|openssl(1)>.
88
89 =item B<-verify depth>
90
91 The verify depth to use. This specifies the maximum length of the
92 server certificate chain and turns on server certificate verification.
93 Currently the verify operation continues after errors so all the problems
94 with a certificate chain can be seen. As a side effect the connection
95 will never fail due to a server certificate verify failure.
96
97 =item B<-CApath directory>
98
99 The directory to use for server certificate verification. This directory
100 must be in "hash format", see B<verify> for more information. These are
101 also used when building the client certificate chain.
102
103 =item B<-CAfile file>
104
105 A file containing trusted certificates to use during server authentication
106 and to use when attempting to build the client certificate chain.
107
108 =item B<-purpose, -ignore_critical, -issuer_checks, -crl_check, -crl_check_all, -policy_check, -extended_crl, -x509_strict, -policy -check_ss_sig>
109
110 Set various certificate chain valiadition option. See the
111 L<B<verify>|verify(1)> manual page for details.
112
113 =item B<-reconnect>
114
115 reconnects to the same server 5 times using the same session ID, this can
116 be used as a test that session caching is working.
117
118 =item B<-pause>
119
120 pauses 1 second between each read and write call.
121
122 =item B<-showcerts>
123
124 display the whole server certificate chain: normally only the server
125 certificate itself is displayed.
126
127 =item B<-prexit>
128
129 print session information when the program exits. This will always attempt
130 to print out information even if the connection fails. Normally information
131 will only be printed out once if the connection succeeds. This option is useful
132 because the cipher in use may be renegotiated or the connection may fail
133 because a client certificate is required or is requested only after an
134 attempt is made to access a certain URL. Note: the output produced by this
135 option is not always accurate because a connection might never have been
136 established.
137
138 =item B<-state>
139
140 prints out the SSL session states.
141
142 =item B<-debug>
143
144 print extensive debugging information including a hex dump of all traffic.
145
146 =item B<-msg>
147
148 show all protocol messages with hex dump.
149
150 =item B<-trace>
151
152 show verbose trace output of protocol messages. OpenSSL needs to be compiled
153 with B<enable-ssl-trace> for this option to work.
154
155 =item B<-msgfile>
156
157 file to send output of B<-msg> or B<-trace> to, default standard output.
158
159 =item B<-nbio_test>
160
161 tests non-blocking I/O
162
163 =item B<-nbio>
164
165 turns on non-blocking I/O
166
167 =item B<-crlf>
168
169 this option translated a line feed from the terminal into CR+LF as required
170 by some servers.
171
172 =item B<-ign_eof>
173
174 inhibit shutting down the connection when end of file is reached in the
175 input.
176
177 =item B<-quiet>
178
179 inhibit printing of session and certificate information.  This implicitly
180 turns on B<-ign_eof> as well.
181
182 =item B<-psk_identity identity>
183
184 Use the PSK identity B<identity> when using a PSK cipher suite.
185
186 =item B<-psk key>
187
188 Use the PSK key B<key> when using a PSK cipher suite. The key is
189 given as a hexadecimal number without leading 0x, for example -psk
190 1a2b3c4d.
191
192 =item B<-ssl2>, B<-ssl3>, B<-tls1>, B<-no_ssl2>, B<-no_ssl3>, B<-no_tls1>
193
194 these options disable the use of certain SSL or TLS protocols. By default
195 the initial handshake uses a method which should be compatible with all
196 servers and permit them to use SSL v3, SSL v2 or TLS as appropriate.
197
198 Unfortunately there are a lot of ancient and broken servers in use which
199 cannot handle this technique and will fail to connect. Some servers only
200 work if TLS is turned off with the B<-no_tls> option others will only
201 support SSL v2 and may need the B<-ssl2> option.
202
203 =item B<-bugs>
204
205 there are several known bug in SSL and TLS implementations. Adding this
206 option enables various workarounds.
207
208 =item B<-brief>
209
210 only provide a brief summary of connection parameters instead of the
211 normal verbose output.
212
213 =item B<-cipher cipherlist>
214
215 this allows the cipher list sent by the client to be modified. Although
216 the server determines which cipher suite is used it should take the first
217 supported cipher in the list sent by the client. See the B<ciphers>
218 command for more information.
219
220 =item B<-starttls protocol>
221
222 send the protocol-specific message(s) to switch to TLS for communication.
223 B<protocol> is a keyword for the intended protocol.  Currently, the only
224 supported keywords are "smtp", "pop3", "imap", and "ftp".
225
226 =item B<-tlsextdebug>
227
228 print out a hex dump of any TLS extensions received from the server.
229
230 =item B<-no_ticket>
231
232 disable RFC4507bis session ticket support. 
233
234 =item B<-sess_out filename>
235
236 output SSL session to B<filename>
237
238 =item B<-sess_in sess.pem>
239
240 load SSL session from B<filename>. The client will attempt to resume a
241 connection from this session.
242
243 =item B<-engine id>
244
245 specifying an engine (by its unique B<id> string) will cause B<s_client>
246 to attempt to obtain a functional reference to the specified engine,
247 thus initialising it if needed. The engine will then be set as the default
248 for all available algorithms.
249
250 =item B<-rand file(s)>
251
252 a file or files containing random data used to seed the random number
253 generator, or an EGD socket (see L<RAND_egd(3)|RAND_egd(3)>).
254 Multiple files can be specified separated by a OS-dependent character.
255 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
256 all others.
257
258 =back
259
260 =head1 CONNECTED COMMANDS
261
262 If a connection is established with an SSL server then any data received
263 from the server is displayed and any key presses will be sent to the
264 server. When used interactively (which means neither B<-quiet> nor B<-ign_eof>
265 have been given), the session will be renegotiated if the line begins with an
266 B<R>, and if the line begins with a B<Q> or if end of file is reached, the
267 connection will be closed down.
268
269 =head1 NOTES
270
271 B<s_client> can be used to debug SSL servers. To connect to an SSL HTTP
272 server the command:
273
274  openssl s_client -connect servername:443
275
276 would typically be used (https uses port 443). If the connection succeeds
277 then an HTTP command can be given such as "GET /" to retrieve a web page.
278
279 If the handshake fails then there are several possible causes, if it is
280 nothing obvious like no client certificate then the B<-bugs>, B<-ssl2>,
281 B<-ssl3>, B<-tls1>, B<-no_ssl2>, B<-no_ssl3>, B<-no_tls1> options can be tried
282 in case it is a buggy server. In particular you should play with these
283 options B<before> submitting a bug report to an OpenSSL mailing list.
284
285 A frequent problem when attempting to get client certificates working
286 is that a web client complains it has no certificates or gives an empty
287 list to choose from. This is normally because the server is not sending
288 the clients certificate authority in its "acceptable CA list" when it
289 requests a certificate. By using B<s_client> the CA list can be viewed
290 and checked. However some servers only request client authentication
291 after a specific URL is requested. To obtain the list in this case it
292 is necessary to use the B<-prexit> option and send an HTTP request
293 for an appropriate page.
294
295 If a certificate is specified on the command line using the B<-cert>
296 option it will not be used unless the server specifically requests
297 a client certificate. Therefor merely including a client certificate
298 on the command line is no guarantee that the certificate works.
299
300 If there are problems verifying a server certificate then the
301 B<-showcerts> option can be used to show the whole chain.
302
303 Since the SSLv23 client hello cannot include compression methods or extensions
304 these will only be supported if its use is disabled, for example by using the
305 B<-no_sslv2> option.
306
307 =head1 BUGS
308
309 Because this program has a lot of options and also because some of
310 the techniques used are rather old, the C source of s_client is rather
311 hard to read and not a model of how things should be done. A typical
312 SSL client program would be much simpler.
313
314 The B<-verify> option should really exit if the server verification
315 fails.
316
317 The B<-prexit> option is a bit of a hack. We should really report
318 information whenever a session is renegotiated.
319
320 =head1 SEE ALSO
321
322 L<sess_id(1)|sess_id(1)>, L<s_server(1)|s_server(1)>, L<ciphers(1)|ciphers(1)>
323
324 =cut