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