Merge from vendor branch GCC:
[dragonfly.git] / secure / usr.bin / openssl / man / s_server.1
1 .\" Automatically generated by Pod::Man 2.12 (Pod::Simple 3.05)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "S_SERVER 1"
127 .TH S_SERVER 1 "2007-10-24" "0.9.8g" "OpenSSL"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 s_server \- SSL/TLS server program
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 \&\fBopenssl\fR \fBs_server\fR
137 [\fB\-accept port\fR]
138 [\fB\-context id\fR]
139 [\fB\-verify depth\fR]
140 [\fB\-Verify depth\fR]
141 [\fB\-cert filename\fR]
142 [\fB\-certform DER|PEM\fR]
143 [\fB\-key keyfile\fR]
144 [\fB\-keyform DER|PEM\fR]
145 [\fB\-pass arg\fR]
146 [\fB\-dcert filename\fR]
147 [\fB\-dcertform DER|PEM\fR]
148 [\fB\-dkey keyfile\fR]
149 [\fB\-dkeyform DER|PEM\fR]
150 [\fB\-dpass arg\fR]
151 [\fB\-dhparam filename\fR]
152 [\fB\-nbio\fR]
153 [\fB\-nbio_test\fR]
154 [\fB\-crlf\fR]
155 [\fB\-debug\fR]
156 [\fB\-msg\fR]
157 [\fB\-state\fR]
158 [\fB\-CApath directory\fR]
159 [\fB\-CAfile filename\fR]
160 [\fB\-nocert\fR]
161 [\fB\-cipher cipherlist\fR]
162 [\fB\-quiet\fR]
163 [\fB\-no_tmp_rsa\fR]
164 [\fB\-ssl2\fR]
165 [\fB\-ssl3\fR]
166 [\fB\-tls1\fR]
167 [\fB\-no_ssl2\fR]
168 [\fB\-no_ssl3\fR]
169 [\fB\-no_tls1\fR]
170 [\fB\-no_dhe\fR]
171 [\fB\-bugs\fR]
172 [\fB\-hack\fR]
173 [\fB\-www\fR]
174 [\fB\-WWW\fR]
175 [\fB\-HTTP\fR]
176 [\fB\-engine id\fR]
177 [\fB\-tlsextdebug\fR]
178 [\fB\-no_ticket\fR]
179 [\fB\-id_prefix arg\fR]
180 [\fB\-rand file(s)\fR]
181 .SH "DESCRIPTION"
182 .IX Header "DESCRIPTION"
183 The \fBs_server\fR command implements a generic \s-1SSL/TLS\s0 server which listens
184 for connections on a given port using \s-1SSL/TLS\s0.
185 .SH "OPTIONS"
186 .IX Header "OPTIONS"
187 .IP "\fB\-accept port\fR" 4
188 .IX Item "-accept port"
189 the \s-1TCP\s0 port to listen on for connections. If not specified 4433 is used.
190 .IP "\fB\-context id\fR" 4
191 .IX Item "-context id"
192 sets the \s-1SSL\s0 context id. It can be given any string value. If this option
193 is not present a default value will be used.
194 .IP "\fB\-cert certname\fR" 4
195 .IX Item "-cert certname"
196 The certificate to use, most servers cipher suites require the use of a
197 certificate and some require a certificate with a certain public key type:
198 for example the \s-1DSS\s0 cipher suites require a certificate containing a \s-1DSS\s0
199 (\s-1DSA\s0) key. If not specified then the filename \*(L"server.pem\*(R" will be used.
200 .IP "\fB\-certform format\fR" 4
201 .IX Item "-certform format"
202 The certificate format to use: \s-1DER\s0 or \s-1PEM\s0. \s-1PEM\s0 is the default.
203 .IP "\fB\-key keyfile\fR" 4
204 .IX Item "-key keyfile"
205 The private key to use. If not specified then the certificate file will
206 be used.
207 .IP "\fB\-keyform format\fR" 4
208 .IX Item "-keyform format"
209 The private format to use: \s-1DER\s0 or \s-1PEM\s0. \s-1PEM\s0 is the default.
210 .IP "\fB\-pass arg\fR" 4
211 .IX Item "-pass arg"
212 the private key password source. For more information about the format of \fBarg\fR
213 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
214 .IP "\fB\-dcert filename\fR, \fB\-dkey keyname\fR" 4
215 .IX Item "-dcert filename, -dkey keyname"
216 specify an additional certificate and private key, these behave in the
217 same manner as the \fB\-cert\fR and \fB\-key\fR options except there is no default
218 if they are not specified (no additional certificate and key is used). As
219 noted above some cipher suites require a certificate containing a key of
220 a certain type. Some cipher suites need a certificate carrying an \s-1RSA\s0 key
221 and some a \s-1DSS\s0 (\s-1DSA\s0) key. By using \s-1RSA\s0 and \s-1DSS\s0 certificates and keys
222 a server can support clients which only support \s-1RSA\s0 or \s-1DSS\s0 cipher suites
223 by using an appropriate certificate.
224 .IP "\fB\-dcertform format\fR, \fB\-dkeyform format\fR, \fB\-dpass arg\fR" 4
225 .IX Item "-dcertform format, -dkeyform format, -dpass arg"
226 addtional certificate and private key format and passphrase respectively.
227 .IP "\fB\-nocert\fR" 4
228 .IX Item "-nocert"
229 if this option is set then no certificate is used. This restricts the
230 cipher suites available to the anonymous ones (currently just anonymous
231 \&\s-1DH\s0).
232 .IP "\fB\-dhparam filename\fR" 4
233 .IX Item "-dhparam filename"
234 the \s-1DH\s0 parameter file to use. The ephemeral \s-1DH\s0 cipher suites generate keys
235 using a set of \s-1DH\s0 parameters. If not specified then an attempt is made to
236 load the parameters from the server certificate file. If this fails then
237 a static set of parameters hard coded into the s_server program will be used.
238 .IP "\fB\-no_dhe\fR" 4
239 .IX Item "-no_dhe"
240 if this option is set then no \s-1DH\s0 parameters will be loaded effectively
241 disabling the ephemeral \s-1DH\s0 cipher suites.
242 .IP "\fB\-no_tmp_rsa\fR" 4
243 .IX Item "-no_tmp_rsa"
244 certain export cipher suites sometimes use a temporary \s-1RSA\s0 key, this option
245 disables temporary \s-1RSA\s0 key generation.
246 .IP "\fB\-verify depth\fR, \fB\-Verify depth\fR" 4
247 .IX Item "-verify depth, -Verify depth"
248 The verify depth to use. This specifies the maximum length of the
249 client certificate chain and makes the server request a certificate from
250 the client. With the \fB\-verify\fR option a certificate is requested but the
251 client does not have to send one, with the \fB\-Verify\fR option the client
252 must supply a certificate or an error occurs.
253 .IP "\fB\-CApath directory\fR" 4
254 .IX Item "-CApath directory"
255 The directory to use for client certificate verification. This directory
256 must be in \*(L"hash format\*(R", see \fBverify\fR for more information. These are
257 also used when building the server certificate chain.
258 .IP "\fB\-CAfile file\fR" 4
259 .IX Item "-CAfile file"
260 A file containing trusted certificates to use during client authentication
261 and to use when attempting to build the server certificate chain. The list
262 is also used in the list of acceptable client CAs passed to the client when
263 a certificate is requested.
264 .IP "\fB\-state\fR" 4
265 .IX Item "-state"
266 prints out the \s-1SSL\s0 session states.
267 .IP "\fB\-debug\fR" 4
268 .IX Item "-debug"
269 print extensive debugging information including a hex dump of all traffic.
270 .IP "\fB\-msg\fR" 4
271 .IX Item "-msg"
272 show all protocol messages with hex dump.
273 .IP "\fB\-nbio_test\fR" 4
274 .IX Item "-nbio_test"
275 tests non blocking I/O
276 .IP "\fB\-nbio\fR" 4
277 .IX Item "-nbio"
278 turns on non blocking I/O
279 .IP "\fB\-crlf\fR" 4
280 .IX Item "-crlf"
281 this option translated a line feed from the terminal into \s-1CR+LF\s0.
282 .IP "\fB\-quiet\fR" 4
283 .IX Item "-quiet"
284 inhibit printing of session and certificate information.
285 .IP "\fB\-ssl2\fR, \fB\-ssl3\fR, \fB\-tls1\fR, \fB\-no_ssl2\fR, \fB\-no_ssl3\fR, \fB\-no_tls1\fR" 4
286 .IX Item "-ssl2, -ssl3, -tls1, -no_ssl2, -no_ssl3, -no_tls1"
287 these options disable the use of certain \s-1SSL\s0 or \s-1TLS\s0 protocols. By default
288 the initial handshake uses a method which should be compatible with all
289 servers and permit them to use \s-1SSL\s0 v3, \s-1SSL\s0 v2 or \s-1TLS\s0 as appropriate.
290 .IP "\fB\-bugs\fR" 4
291 .IX Item "-bugs"
292 there are several known bug in \s-1SSL\s0 and \s-1TLS\s0 implementations. Adding this
293 option enables various workarounds.
294 .IP "\fB\-hack\fR" 4
295 .IX Item "-hack"
296 this option enables a further workaround for some some early Netscape
297 \&\s-1SSL\s0 code (?).
298 .IP "\fB\-cipher cipherlist\fR" 4
299 .IX Item "-cipher cipherlist"
300 this allows the cipher list used by the server to be modified.  When
301 the client sends a list of supported ciphers the first client cipher
302 also included in the server list is used. Because the client specifies
303 the preference order, the order of the server cipherlist irrelevant. See
304 the \fBciphers\fR command for more information.
305 .IP "\fB\-tlsextdebug\fR" 4
306 .IX Item "-tlsextdebug"
307 print out a hex dump of any \s-1TLS\s0 extensions received from the server.
308 .IP "\fB\-no_ticket\fR" 4
309 .IX Item "-no_ticket"
310 disable RFC4507bis session ticket support.
311 .IP "\fB\-www\fR" 4
312 .IX Item "-www"
313 sends a status message back to the client when it connects. This includes
314 lots of information about the ciphers used and various session parameters.
315 The output is in \s-1HTML\s0 format so this option will normally be used with a
316 web browser.
317 .IP "\fB\-WWW\fR" 4
318 .IX Item "-WWW"
319 emulates a simple web server. Pages will be resolved relative to the
320 current directory, for example if the \s-1URL\s0 https://myhost/page.html is
321 requested the file ./page.html will be loaded.
322 .IP "\fB\-HTTP\fR" 4
323 .IX Item "-HTTP"
324 emulates a simple web server. Pages will be resolved relative to the
325 current directory, for example if the \s-1URL\s0 https://myhost/page.html is
326 requested the file ./page.html will be loaded. The files loaded are
327 assumed to contain a complete and correct \s-1HTTP\s0 response (lines that
328 are part of the \s-1HTTP\s0 response line and headers must end with \s-1CRLF\s0).
329 .IP "\fB\-engine id\fR" 4
330 .IX Item "-engine id"
331 specifying an engine (by it's unique \fBid\fR string) will cause \fBs_server\fR
332 to attempt to obtain a functional reference to the specified engine,
333 thus initialising it if needed. The engine will then be set as the default
334 for all available algorithms.
335 .IP "\fB\-id_prefix arg\fR" 4
336 .IX Item "-id_prefix arg"
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 .IX Item "-rand file(s)"
343 a file or files containing random data used to seed the random number
344 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
345 Multiple files can be specified separated by a OS-dependent character.
346 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
347 all others.
348 .SH "CONNECTED COMMANDS"
349 .IX Header "CONNECTED COMMANDS"
350 If a connection request is established with an \s-1SSL\s0 client and neither the
351 \&\fB\-www\fR nor the \fB\-WWW\fR option has been used then normally any data received
352 from the client is displayed and any key presses will be sent to the client.
353 .PP
354 Certain single letter commands are also recognized which perform special
355 operations: these are listed below.
356 .IP "\fBq\fR" 4
357 .IX Item "q"
358 end the current \s-1SSL\s0 connection but still accept new connections.
359 .IP "\fBQ\fR" 4
360 .IX Item "Q"
361 end the current \s-1SSL\s0 connection and exit.
362 .IP "\fBr\fR" 4
363 .IX Item "r"
364 renegotiate the \s-1SSL\s0 session.
365 .IP "\fBR\fR" 4
366 .IX Item "R"
367 renegotiate the \s-1SSL\s0 session and request a client certificate.
368 .IP "\fBP\fR" 4
369 .IX Item "P"
370 send some plain text down the underlying \s-1TCP\s0 connection: this should
371 cause the client to disconnect due to a protocol violation.
372 .IP "\fBS\fR" 4
373 .IX Item "S"
374 print out some session cache status information.
375 .SH "NOTES"
376 .IX Header "NOTES"
377 \&\fBs_server\fR can be used to debug \s-1SSL\s0 clients. To accept connections from
378 a web browser the command:
379 .PP
380 .Vb 1
381 \& openssl s_server \-accept 443 \-www
382 .Ve
383 .PP
384 can be used for example.
385 .PP
386 Most web browsers (in particular Netscape and \s-1MSIE\s0) only support \s-1RSA\s0 cipher
387 suites, so they cannot connect to servers which don't use a certificate
388 carrying an \s-1RSA\s0 key or a version of OpenSSL with \s-1RSA\s0 disabled.
389 .PP
390 Although specifying an empty list of CAs when requesting a client certificate
391 is strictly speaking a protocol violation, some \s-1SSL\s0 clients interpret this to
392 mean any \s-1CA\s0 is acceptable. This is useful for debugging purposes.
393 .PP
394 The session parameters can printed out using the \fBsess_id\fR program.
395 .PP
396 \&\s-1TLS\s0 extensions are only supported in OpenSSL 0.9.8 if they are explictly
397 enabled at compile time using for example the \fBenable-tlsext\fR switch.
398 .SH "BUGS"
399 .IX Header "BUGS"
400 Because this program has a lot of options and also because some of
401 the techniques used are rather old, the C source of s_server is rather
402 hard to read and not a model of how things should be done. A typical
403 \&\s-1SSL\s0 server program would be much simpler.
404 .PP
405 The output of common ciphers is wrong: it just gives the list of ciphers that
406 OpenSSL recognizes and the client supports.
407 .PP
408 There should be a way for the \fBs_server\fR program to print out details of any
409 unknown cipher suites a client says it supports.
410 .SH "SEE ALSO"
411 .IX Header "SEE ALSO"
412 \&\fIsess_id\fR\|(1), \fIs_client\fR\|(1), \fIciphers\fR\|(1)