Update per latest manual pages after 'man-update'.
[dragonfly.git] / secure / usr.bin / openssl / man / s_server.1
1 .rn '' }`
2 ''' $RCSfile$$Revision$$Date$
3 '''
4 ''' $Log$
5 '''
6 .de Sh
7 .br
8 .if t .Sp
9 .ne 5
10 .PP
11 \fB\\$1\fR
12 .PP
13 ..
14 .de Sp
15 .if t .sp .5v
16 .if n .sp
17 ..
18 .de Ip
19 .br
20 .ie \\n(.$>=3 .ne \\$3
21 .el .ne 3
22 .IP "\\$1" \\$2
23 ..
24 .de Vb
25 .ft CW
26 .nf
27 .ne \\$1
28 ..
29 .de Ve
30 .ft R
31
32 .fi
33 ..
34 '''
35 '''
36 '''     Set up \*(-- to give an unbreakable dash;
37 '''     string Tr holds user defined translation string.
38 '''     Bell System Logo is used as a dummy character.
39 '''
40 .tr \(*W-|\(bv\*(Tr
41 .ie n \{\
42 .ds -- \(*W-
43 .ds PI pi
44 .if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
45 .if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
46 .ds L" ""
47 .ds R" ""
48 '''   \*(M", \*(S", \*(N" and \*(T" are the equivalent of
49 '''   \*(L" and \*(R", except that they are used on ".xx" lines,
50 '''   such as .IP and .SH, which do another additional levels of
51 '''   double-quote interpretation
52 .ds M" """
53 .ds S" """
54 .ds N" """""
55 .ds T" """""
56 .ds L' '
57 .ds R' '
58 .ds M' '
59 .ds S' '
60 .ds N' '
61 .ds T' '
62 'br\}
63 .el\{\
64 .ds -- \(em\|
65 .tr \*(Tr
66 .ds L" ``
67 .ds R" ''
68 .ds M" ``
69 .ds S" ''
70 .ds N" ``
71 .ds T" ''
72 .ds L' `
73 .ds R' '
74 .ds M' `
75 .ds S' '
76 .ds N' `
77 .ds T' '
78 .ds PI \(*p
79 'br\}
80 .\"     If the F register is turned on, we'll generate
81 .\"     index entries out stderr for the following things:
82 .\"             TH      Title 
83 .\"             SH      Header
84 .\"             Sh      Subsection 
85 .\"             Ip      Item
86 .\"             X<>     Xref  (embedded
87 .\"     Of course, you have to process the output yourself
88 .\"     in some meaninful fashion.
89 .if \nF \{
90 .de IX
91 .tm Index:\\$1\t\\n%\t"\\$2"
92 ..
93 .nr % 0
94 .rr F
95 .\}
96 .TH S_SERVER 1 "0.9.7d" "2/Sep/2004" "OpenSSL"
97 .UC
98 .if n .hy 0
99 .if n .na
100 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
101 .de CQ          \" put $1 in typewriter font
102 .ft CW
103 'if n "\c
104 'if t \\&\\$1\c
105 'if n \\&\\$1\c
106 'if n \&"
107 \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
108 '.ft R
109 ..
110 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
111 .       \" AM - accent mark definitions
112 .bd B 3
113 .       \" fudge factors for nroff and troff
114 .if n \{\
115 .       ds #H 0
116 .       ds #V .8m
117 .       ds #F .3m
118 .       ds #[ \f1
119 .       ds #] \fP
120 .\}
121 .if t \{\
122 .       ds #H ((1u-(\\\\n(.fu%2u))*.13m)
123 .       ds #V .6m
124 .       ds #F 0
125 .       ds #[ \&
126 .       ds #] \&
127 .\}
128 .       \" simple accents for nroff and troff
129 .if n \{\
130 .       ds ' \&
131 .       ds ` \&
132 .       ds ^ \&
133 .       ds , \&
134 .       ds ~ ~
135 .       ds ? ?
136 .       ds ! !
137 .       ds /
138 .       ds q
139 .\}
140 .if t \{\
141 .       ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
142 .       ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
143 .       ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
144 .       ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
145 .       ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
146 .       ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
147 .       ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
148 .       ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
149 .       ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
150 .\}
151 .       \" troff and (daisy-wheel) nroff accents
152 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
153 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
154 .ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
155 .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
156 .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
157 .ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
158 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
159 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
160 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
161 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
162 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
163 .ds ae a\h'-(\w'a'u*4/10)'e
164 .ds Ae A\h'-(\w'A'u*4/10)'E
165 .ds oe o\h'-(\w'o'u*4/10)'e
166 .ds Oe O\h'-(\w'O'u*4/10)'E
167 .       \" corrections for vroff
168 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
169 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
170 .       \" for low resolution devices (crt and lpr)
171 .if \n(.H>23 .if \n(.V>19 \
172 \{\
173 .       ds : e
174 .       ds 8 ss
175 .       ds v \h'-1'\o'\(aa\(ga'
176 .       ds _ \h'-1'^
177 .       ds . \h'-1'.
178 .       ds 3 3
179 .       ds o a
180 .       ds d- d\h'-1'\(ga
181 .       ds D- D\h'-1'\(hy
182 .       ds th \o'bp'
183 .       ds Th \o'LP'
184 .       ds ae ae
185 .       ds Ae AE
186 .       ds oe oe
187 .       ds Oe OE
188 .\}
189 .rm #[ #] #H #V #F C
190 .SH "NAME"
191 s_server \- SSL/TLS server program
192 .SH "SYNOPSIS"
193 \fBopenssl\fR \fBs_server\fR
194 [\fB\-accept port\fR]
195 [\fB\-context id\fR]
196 [\fB\-verify depth\fR]
197 [\fB\-Verify depth\fR]
198 [\fB\-cert filename\fR]
199 [\fB\-key keyfile\fR]
200 [\fB\-dcert filename\fR]
201 [\fB\-dkey keyfile\fR]
202 [\fB\-dhparam filename\fR]
203 [\fB\-nbio\fR]
204 [\fB\-nbio_test\fR]
205 [\fB\-crlf\fR]
206 [\fB\-debug\fR]
207 [\fB\-msg\fR]
208 [\fB\-state\fR]
209 [\fB\-CApath directory\fR]
210 [\fB\-CAfile filename\fR]
211 [\fB\-nocert\fR]
212 [\fB\-cipher cipherlist\fR]
213 [\fB\-quiet\fR]
214 [\fB\-no_tmp_rsa\fR]
215 [\fB\-ssl2\fR]
216 [\fB\-ssl3\fR]
217 [\fB\-tls1\fR]
218 [\fB\-no_ssl2\fR]
219 [\fB\-no_ssl3\fR]
220 [\fB\-no_tls1\fR]
221 [\fB\-no_dhe\fR]
222 [\fB\-bugs\fR]
223 [\fB\-hack\fR]
224 [\fB\-www\fR]
225 [\fB\-WWW\fR]
226 [\fB\-HTTP\fR]
227 [\fB\-engine id\fR]
228 [\fB\-id_prefix arg\fR]
229 [\fB\-rand file(s)\fR]
230 .SH "DESCRIPTION"
231 The \fBs_server\fR command implements a generic SSL/TLS server which listens
232 for connections on a given port using SSL/TLS.
233 .SH "OPTIONS"
234 .Ip "\fB\-accept port\fR" 4
235 the \s-1TCP\s0 port to listen on for connections. If not specified 4433 is used.
236 .Ip "\fB\-context id\fR" 4
237 sets the \s-1SSL\s0 context id. It can be given any string value. If this option
238 is not present a default value will be used.
239 .Ip "\fB\-cert certname\fR" 4
240 The certificate to use, most servers cipher suites require the use of a
241 certificate and some require a certificate with a certain public key type:
242 for example the \s-1DSS\s0 cipher suites require a certificate containing a \s-1DSS\s0
243 (\s-1DSA\s0) key. If not specified then the filename \*(L"server.pem\*(R" will be used.
244 .Ip "\fB\-key keyfile\fR" 4
245 The private key to use. If not specified then the certificate file will
246 be used.
247 .Ip "\fB\-dcert filename\fR, \fB\-dkey keyname\fR" 4
248 specify an additional certificate and private key, these behave in the
249 same manner as the \fB\-cert\fR and \fB\-key\fR options except there is no default
250 if they are not specified (no additional certificate and key is used). As
251 noted above some cipher suites require a certificate containing a key of
252 a certain type. Some cipher suites need a certificate carrying an \s-1RSA\s0 key
253 and some a \s-1DSS\s0 (\s-1DSA\s0) key. By using \s-1RSA\s0 and \s-1DSS\s0 certificates and keys
254 a server can support clients which only support \s-1RSA\s0 or \s-1DSS\s0 cipher suites
255 by using an appropriate certificate.
256 .Ip "\fB\-nocert\fR" 4
257 if this option is set then no certificate is used. This restricts the
258 cipher suites available to the anonymous ones (currently just anonymous
259 \s-1DH\s0).
260 .Ip "\fB\-dhparam filename\fR" 4
261 the \s-1DH\s0 parameter file to use. The ephemeral \s-1DH\s0 cipher suites generate keys
262 using a set of \s-1DH\s0 parameters. If not specified then an attempt is made to
263 load the parameters from the server certificate file. If this fails then
264 a static set of parameters hard coded into the s_server program will be used.
265 .Ip "\fB\-no_dhe\fR" 4
266 if this option is set then no \s-1DH\s0 parameters will be loaded effectively
267 disabling the ephemeral \s-1DH\s0 cipher suites.
268 .Ip "\fB\-no_tmp_rsa\fR" 4
269 certain export cipher suites sometimes use a temporary \s-1RSA\s0 key, this option
270 disables temporary \s-1RSA\s0 key generation.
271 .Ip "\fB\-verify depth\fR, \fB\-Verify depth\fR" 4
272 The verify depth to use. This specifies the maximum length of the
273 client certificate chain and makes the server request a certificate from
274 the client. With the \fB\-verify\fR option a certificate is requested but the
275 client does not have to send one, with the \fB\-Verify\fR option the client
276 must supply a certificate or an error occurs.
277 .Ip "\fB\-CApath directory\fR" 4
278 The directory to use for client certificate verification. This directory
279 must be in \*(L"hash format\*(R", see \fBverify\fR for more information. These are
280 also used when building the server certificate chain.
281 .Ip "\fB\-CAfile file\fR" 4
282 A file containing trusted certificates to use during client authentication
283 and to use when attempting to build the server certificate chain. The list
284 is also used in the list of acceptable client CAs passed to the client when
285 a certificate is requested.
286 .Ip "\fB\-state\fR" 4
287 prints out the \s-1SSL\s0 session states.
288 .Ip "\fB\-debug\fR" 4
289 print extensive debugging information including a hex dump of all traffic.
290 .Ip "\fB\-msg\fR" 4
291 show all protocol messages with hex dump.
292 .Ip "\fB\-nbio_test\fR" 4
293 tests non blocking I/O
294 .Ip "\fB\-nbio\fR" 4
295 turns on non blocking I/O
296 .Ip "\fB\-crlf\fR" 4
297 this option translated a line feed from the terminal into \s-1CR+LF\s0.
298 .Ip "\fB\-quiet\fR" 4
299 inhibit printing of session and certificate information.
300 .Ip "\fB\-ssl2\fR, \fB\-ssl3\fR, \fB\-tls1\fR, \fB\-no_ssl2\fR, \fB\-no_ssl3\fR, \fB\-no_tls1\fR" 4
301 these options disable the use of certain \s-1SSL\s0 or \s-1TLS\s0 protocols. By default
302 the initial handshake uses a method which should be compatible with all
303 servers and permit them to use \s-1SSL\s0 v3, \s-1SSL\s0 v2 or \s-1TLS\s0 as appropriate.
304 .Ip "\fB\-bugs\fR" 4
305 there are several known bug in \s-1SSL\s0 and \s-1TLS\s0 implementations. Adding this
306 option enables various workarounds.
307 .Ip "\fB\-hack\fR" 4
308 this option enables a further workaround for some some early Netscape
309 \s-1SSL\s0 code (?).
310 .Ip "\fB\-cipher cipherlist\fR" 4
311 this allows the cipher list used by the server to be modified.  When
312 the client sends a list of supported ciphers the first client cipher
313 also included in the server list is used. Because the client specifies
314 the preference order, the order of the server cipherlist irrelevant. See
315 the \fBciphers\fR command for more information.
316 .Ip "\fB\-www\fR" 4
317 sends a status message back to the client when it connects. This includes
318 lots of information about the ciphers used and various session parameters.
319 The output is in \s-1HTML\s0 format so this option will normally be used with a
320 web browser.
321 .Ip "\fB\-\s-1WWW\s0\fR" 4
322 emulates a simple web server. Pages will be resolved relative to the
323 current directory, for example if the \s-1URL\s0 https://myhost/page.html is
324 requested the file ./page.html will be loaded.
325 .Ip "\fB\-\s-1HTTP\s0\fR" 4
326 emulates a simple web server. Pages will be resolved relative to the
327 current directory, for example if the \s-1URL\s0 https://myhost/page.html is
328 requested the file ./page.html will be loaded. The files loaded are
329 assumed to contain a complete and correct \s-1HTTP\s0 response (lines that
330 are part of the \s-1HTTP\s0 response line and headers must end with \s-1CRLF\s0).
331 .Ip "\fB\-engine id\fR" 4
332 specifying an engine (by it's unique \fBid\fR string) will cause \fBs_server\fR
333 to attempt to obtain a functional reference to the specified engine,
334 thus initialising it if needed. The engine will then be set as the default
335 for all available algorithms.
336 .Ip "\fB\-id_prefix arg\fR" 4
337 generate \s-1SSL/TLS\s0 session IDs prefixed by \fBarg\fR. This is mostly useful
338 for testing any \s-1SSL/TLS\s0 code (eg. proxies) that wish to deal with multiple
339 servers, when each of which might be generating a unique range of session
340 IDs (eg. with a certain prefix).
341 .Ip "\fB\-rand file(s)\fR" 4
342 a file or files containing random data used to seed the random number
343 generator, or an \s-1EGD\s0 socket (see RAND_egd(3)).
344 Multiple files can be specified separated by a \s-1OS\s0\-dependent character.
345 The separator is \fB;\fR for \s-1MS\s0\-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
346 all others.
347 .SH "CONNECTED COMMANDS"
348 If a connection request is established with an SSL client and neither the
349 \fB\-www\fR nor the \fB\-WWW\fR option has been used then normally any data received
350 from the client is displayed and any key presses will be sent to the client. 
351 .PP
352 Certain single letter commands are also recognized which perform special
353 operations: these are listed below.
354 .Ip "\fBq\fR" 4
355 end the current \s-1SSL\s0 connection but still accept new connections.
356 .Ip "\fBQ\fR" 4
357 end the current \s-1SSL\s0 connection and exit.
358 .Ip "\fBr\fR" 4
359 renegotiate the \s-1SSL\s0 session.
360 .Ip "\fBR\fR" 4
361 renegotiate the \s-1SSL\s0 session and request a client certificate.
362 .Ip "\fBP\fR" 4
363 send some plain text down the underlying \s-1TCP\s0 connection: this should
364 cause the client to disconnect due to a protocol violation.
365 .Ip "\fBS\fR" 4
366 print out some session cache status information.
367 .SH "NOTES"
368 \fBs_server\fR can be used to debug SSL clients. To accept connections from
369 a web browser the command:
370 .PP
371 .Vb 1
372 \& openssl s_server -accept 443 -www
373 .Ve
374 can be used for example.
375 .PP
376 Most web browsers (in particular Netscape and MSIE) only support RSA cipher
377 suites, so they cannot connect to servers which don't use a certificate
378 carrying an RSA key or a version of OpenSSL with RSA disabled.
379 .PP
380 Although specifying an empty list of CAs when requesting a client certificate
381 is strictly speaking a protocol violation, some SSL clients interpret this to
382 mean any CA is acceptable. This is useful for debugging purposes.
383 .PP
384 The session parameters can printed out using the \fBsess_id\fR program.
385 .SH "BUGS"
386 Because this program has a lot of options and also because some of
387 the techniques used are rather old, the C source of s_server is rather
388 hard to read and not a model of how things should be done. A typical
389 SSL server program would be much simpler.
390 .PP
391 The output of common ciphers is wrong: it just gives the list of ciphers that
392 OpenSSL recognizes and the client supports.
393 .PP
394 There should be a way for the \fBs_server\fR program to print out details of any
395 unknown cipher suites a client says it supports.
396 .SH "SEE ALSO"
397 sess_id(1), s_client(1), ciphers(1)
398
399 .rn }` ''
400 .IX Title "S_SERVER 1"
401 .IX Name "s_server - SSL/TLS server program"
402
403 .IX Header "NAME"
404
405 .IX Header "SYNOPSIS"
406
407 .IX Header "DESCRIPTION"
408
409 .IX Header "OPTIONS"
410
411 .IX Item "\fB\-accept port\fR"
412
413 .IX Item "\fB\-context id\fR"
414
415 .IX Item "\fB\-cert certname\fR"
416
417 .IX Item "\fB\-key keyfile\fR"
418
419 .IX Item "\fB\-dcert filename\fR, \fB\-dkey keyname\fR"
420
421 .IX Item "\fB\-nocert\fR"
422
423 .IX Item "\fB\-dhparam filename\fR"
424
425 .IX Item "\fB\-no_dhe\fR"
426
427 .IX Item "\fB\-no_tmp_rsa\fR"
428
429 .IX Item "\fB\-verify depth\fR, \fB\-Verify depth\fR"
430
431 .IX Item "\fB\-CApath directory\fR"
432
433 .IX Item "\fB\-CAfile file\fR"
434
435 .IX Item "\fB\-state\fR"
436
437 .IX Item "\fB\-debug\fR"
438
439 .IX Item "\fB\-msg\fR"
440
441 .IX Item "\fB\-nbio_test\fR"
442
443 .IX Item "\fB\-nbio\fR"
444
445 .IX Item "\fB\-crlf\fR"
446
447 .IX Item "\fB\-quiet\fR"
448
449 .IX Item "\fB\-ssl2\fR, \fB\-ssl3\fR, \fB\-tls1\fR, \fB\-no_ssl2\fR, \fB\-no_ssl3\fR, \fB\-no_tls1\fR"
450
451 .IX Item "\fB\-bugs\fR"
452
453 .IX Item "\fB\-hack\fR"
454
455 .IX Item "\fB\-cipher cipherlist\fR"
456
457 .IX Item "\fB\-www\fR"
458
459 .IX Item "\fB\-\s-1WWW\s0\fR"
460
461 .IX Item "\fB\-\s-1HTTP\s0\fR"
462
463 .IX Item "\fB\-engine id\fR"
464
465 .IX Item "\fB\-id_prefix arg\fR"
466
467 .IX Item "\fB\-rand file(s)\fR"
468
469 .IX Header "CONNECTED COMMANDS"
470
471 .IX Item "\fBq\fR"
472
473 .IX Item "\fBQ\fR"
474
475 .IX Item "\fBr\fR"
476
477 .IX Item "\fBR\fR"
478
479 .IX Item "\fBP\fR"
480
481 .IX Item "\fBS\fR"
482
483 .IX Header "NOTES"
484
485 .IX Header "BUGS"
486
487 .IX Header "SEE ALSO"
488