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