Correct minor spelling error.
[openssl.git] / doc / apps / s_server.pod
1
2 =pod
3
4 =head1 NAME
5
6 s_server - SSL/TLS server program
7
8 =head1 SYNOPSIS
9
10 B<openssl> B<s_server>
11 [B<-accept port>]
12 [B<-context id>]
13 [B<-verify depth>]
14 [B<-Verify depth>]
15 [B<-cert filename>]
16 [B<-key keyfile>]
17 [B<-dcert filename>]
18 [B<-dkey keyfile>]
19 [B<-dhparam filename>]
20 [B<-nbio>]
21 [B<-nbio_test>]
22 [B<-crlf>]
23 [B<-debug>]
24 [B<-msg>]
25 [B<-state>]
26 [B<-CApath directory>]
27 [B<-CAfile filename>]
28 [B<-nocert>]
29 [B<-cipher cipherlist>]
30 [B<-quiet>]
31 [B<-no_tmp_rsa>]
32 [B<-ssl2>]
33 [B<-ssl3>]
34 [B<-tls1>]
35 [B<-no_ssl2>]
36 [B<-no_ssl3>]
37 [B<-no_tls1>]
38 [B<-no_dhe>]
39 [B<-bugs>]
40 [B<-hack>]
41 [B<-www>]
42 [B<-WWW>]
43 [B<-HTTP>]
44 [B<-engine id>]
45 [B<-id_prefix arg>]
46 [B<-rand file(s)>]
47
48 =head1 DESCRIPTION
49
50 The B<s_server> command implements a generic SSL/TLS server which listens
51 for connections on a given port using SSL/TLS.
52
53 =head1 OPTIONS
54
55 =over 4
56
57 =item B<-accept port>
58
59 the TCP port to listen on for connections. If not specified 4433 is used.
60
61 =item B<-context id>
62
63 sets the SSL context id. It can be given any string value. If this option
64 is not present a default value will be used.
65
66 =item B<-cert certname>
67
68 The certificate to use, most servers cipher suites require the use of a
69 certificate and some require a certificate with a certain public key type:
70 for example the DSS cipher suites require a certificate containing a DSS
71 (DSA) key. If not specified then the filename "server.pem" will be used.
72
73 =item B<-key keyfile>
74
75 The private key to use. If not specified then the certificate file will
76 be used.
77
78 =item B<-dcert filename>, B<-dkey keyname>
79
80 specify an additional certificate and private key, these behave in the
81 same manner as the B<-cert> and B<-key> options except there is no default
82 if they are not specified (no additional certificate and key is used). As
83 noted above some cipher suites require a certificate containing a key of
84 a certain type. Some cipher suites need a certificate carrying an RSA key
85 and some a DSS (DSA) key. By using RSA and DSS certificates and keys
86 a server can support clients which only support RSA or DSS cipher suites
87 by using an appropriate certificate.
88
89 =item B<-nocert>
90
91 if this option is set then no certificate is used. This restricts the
92 cipher suites available to the anonymous ones (currently just anonymous
93 DH).
94
95 =item B<-dhparam filename>
96
97 the DH parameter file to use. The ephemeral DH cipher suites generate keys
98 using a set of DH parameters. If not specified then an attempt is made to
99 load the parameters from the server certificate file. If this fails then
100 a static set of parameters hard coded into the s_server program will be used.
101
102 =item B<-no_dhe>
103
104 if this option is set then no DH parameters will be loaded effectively
105 disabling the ephemeral DH cipher suites.
106
107 =item B<-no_tmp_rsa>
108
109 certain export cipher suites sometimes use a temporary RSA key, this option
110 disables temporary RSA key generation.
111
112 =item B<-verify depth>, B<-Verify depth>
113
114 The verify depth to use. This specifies the maximum length of the
115 client certificate chain and makes the server request a certificate from
116 the client. With the B<-verify> option a certificate is requested but the
117 client does not have to send one, with the B<-Verify> option the client
118 must supply a certificate or an error occurs.
119
120 =item B<-CApath directory>
121
122 The directory to use for client certificate verification. This directory
123 must be in "hash format", see B<verify> for more information. These are
124 also used when building the server certificate chain.
125
126 =item B<-CAfile file>
127
128 A file containing trusted certificates to use during client authentication
129 and to use when attempting to build the server certificate chain. The list
130 is also used in the list of acceptable client CAs passed to the client when
131 a certificate is requested.
132
133 =item B<-state>
134
135 prints out the SSL session states.
136
137 =item B<-debug>
138
139 print extensive debugging information including a hex dump of all traffic.
140
141 =item B<-msg>
142
143 show all protocol messages with hex dump.
144
145 =item B<-nbio_test>
146
147 tests non blocking I/O
148
149 =item B<-nbio>
150
151 turns on non blocking I/O
152
153 =item B<-crlf>
154
155 this option translated a line feed from the terminal into CR+LF.
156
157 =item B<-quiet>
158
159 inhibit printing of session and certificate information.
160
161 =item B<-ssl2>, B<-ssl3>, B<-tls1>, B<-no_ssl2>, B<-no_ssl3>, B<-no_tls1>
162
163 these options disable the use of certain SSL or TLS protocols. By default
164 the initial handshake uses a method which should be compatible with all
165 servers and permit them to use SSL v3, SSL v2 or TLS as appropriate.
166
167 =item B<-bugs>
168
169 there are several known bug in SSL and TLS implementations. Adding this
170 option enables various workarounds.
171
172 =item B<-hack>
173
174 this option enables a further workaround for some some early Netscape
175 SSL code (?).
176
177 =item B<-cipher cipherlist>
178
179 this allows the cipher list used by the server to be modified.  When
180 the client sends a list of supported ciphers the first client cipher
181 also included in the server list is used. Because the client specifies
182 the preference order, the order of the server cipherlist irrelevant. See
183 the B<ciphers> command for more information.
184
185 =item B<-www>
186
187 sends a status message back to the client when it connects. This includes
188 lots of information about the ciphers used and various session parameters.
189 The output is in HTML format so this option will normally be used with a
190 web browser.
191
192 =item B<-WWW>
193
194 emulates a simple web server. Pages will be resolved relative to the
195 current directory, for example if the URL https://myhost/page.html is
196 requested the file ./page.html will be loaded.
197
198 =item B<-HTTP>
199
200 emulates a simple web server. Pages will be resolved relative to the
201 current directory, for example if the URL https://myhost/page.html is
202 requested the file ./page.html will be loaded. The files loaded are
203 assumed to contain a complete and correct HTTP response (lines that
204 are part of the HTTP response line and headers must end with CRLF).
205
206 =item B<-engine id>
207
208 specifying an engine (by it's unique B<id> string) will cause B<s_server>
209 to attempt to obtain a functional reference to the specified engine,
210 thus initialising it if needed. The engine will then be set as the default
211 for all available algorithms.
212
213 =item B<-id_prefix arg>
214
215 generate SSL/TLS session IDs prefixed by B<arg>. This is mostly useful
216 for testing any SSL/TLS code (eg. proxies) that wish to deal with multiple
217 servers, when each of which might be generating a unique range of session
218 IDs (eg. with a certain prefix).
219
220 =item B<-rand file(s)>
221
222 a file or files containing random data used to seed the random number
223 generator, or an EGD socket (see L<RAND_egd(3)|RAND_egd(3)>).
224 Multiple files can be specified separated by a OS-dependent character.
225 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
226 all others.
227
228 =back
229
230 =head1 CONNECTED COMMANDS
231
232 If a connection request is established with an SSL client and neither the
233 B<-www> nor the B<-WWW> option has been used then normally any data received
234 from the client is displayed and any key presses will be sent to the client. 
235
236 Certain single letter commands are also recognized which perform special
237 operations: these are listed below.
238
239 =over 4
240
241 =item B<q>
242
243 end the current SSL connection but still accept new connections.
244
245 =item B<Q>
246
247 end the current SSL connection and exit.
248
249 =item B<r>
250
251 renegotiate the SSL session.
252
253 =item B<R>
254
255 renegotiate the SSL session and request a client certificate.
256
257 =item B<P>
258
259 send some plain text down the underlying TCP connection: this should
260 cause the client to disconnect due to a protocol violation.
261
262 =item B<S>
263
264 print out some session cache status information.
265
266 =back
267
268 =head1 NOTES
269
270 B<s_server> can be used to debug SSL clients. To accept connections from
271 a web browser the command:
272
273  openssl s_server -accept 443 -www
274
275 can be used for example.
276
277 Most web browsers (in particular Netscape and MSIE) only support RSA cipher
278 suites, so they cannot connect to servers which don't use a certificate
279 carrying an RSA key or a version of OpenSSL with RSA disabled.
280
281 Although specifying an empty list of CAs when requesting a client certificate
282 is strictly speaking a protocol violation, some SSL clients interpret this to
283 mean any CA is acceptable. This is useful for debugging purposes.
284
285 The session parameters can printed out using the B<sess_id> program.
286
287 =head1 BUGS
288
289 Because this program has a lot of options and also because some of
290 the techniques used are rather old, the C source of s_server is rather
291 hard to read and not a model of how things should be done. A typical
292 SSL server program would be much simpler.
293
294 The output of common ciphers is wrong: it just gives the list of ciphers that
295 OpenSSL recognizes and the client supports.
296
297 There should be a way for the B<s_server> program to print out details of any
298 unknown cipher suites a client says it supports.
299
300 =head1 SEE ALSO
301
302 L<sess_id(1)|sess_id(1)>, L<s_client(1)|s_client(1)>, L<ciphers(1)|ciphers(1)>
303
304 =cut