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