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