Make -CAcreateserial start from 1 instead of 0 for
[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_client>
11 [B<-accept port>]
12 [B<-context id>]
13 [B<-verify depth>]
14 [B<-Verify depth>]
15 [B<-cert filename>]
16 [B<-key keyfile>]
17 [B<-dcert filename>]
18 [B<-dkey keyfile>]
19 [B<-dhparam filename>]
20 [B<-nbio>]
21 [B<-nbio_test>]
22 [B<-crlf>]
23 [B<-debug>]
24 [B<-state>]
25 [B<-CApath directory>]
26 [B<-CAfile filename>]
27 [B<-nocert>]
28 [B<-cipher cipherlist>]
29 [B<-quiet>]
30 [B<-no_tmp_rsa>]
31 [B<-ssl2>]
32 [B<-ssl3>]
33 [B<-tls1>]
34 [B<-no_ssl2>]
35 [B<-no_ssl3>]
36 [B<-no_tls1>]
37 [B<-no_dhe>]
38 [B<-bugs>]
39 [B<-hack>]
40 [B<-www>]
41 [B<-WWW>]
42
43 =head1 DESCRIPTION
44
45 The B<s_server> command implements a generic SSL/TLS server which listens
46 for connections on a given port using SSL/TLS.
47
48 =head1 OPTIONS
49
50 =over 4
51
52 =item B<-accept port>
53
54 the TCP port to listen on for connections. If not specified 4433 is used.
55
56 =item B<-context id>
57
58 sets the SSL context id. If a client certificate is being requested then
59 this option must be set. It can be given any string value.
60
61 =item B<-cert certname>
62
63 The certificate to use, most servers cipher suites require the use of a
64 certificate and some require a certificate with a certain public key type:
65 for example the DSS cipher suites require a certificate containing a DSS
66 (DSA) key. If not specified then the filename "server.pem" will be used.
67
68 =item B<-key keyfile>
69
70 The private key to use. If not specified then the certificate file will
71 be used.
72
73 =item B<-dcert filename>, B<-dkey keyname>
74
75 specify an additional certificate and private key, these behave in the
76 same manner as the B<-cert> and B<-key> options except there is no default
77 if they are not specified (no additional certificate and key is used). As
78 noted above some cipher suites require a certificate containing a key of
79 a certain type. Some cipher suites need a certificate carrying an RSA key
80 and some a DSS (DSA) key. By using RSA and DSS certificates and keys
81 a server can support clients which only support RSA or DSS cipher suites
82 by using an appropriate certificate.
83
84 =item B<-nocert>
85
86 if this option is set then no certificate is used. This restricts the
87 cipher suites available to the anonymous ones (currently just anonymous
88 DH).
89
90 =item B<-dhparam filename>
91
92 the DH parameter file to use. The ephemeral DH cipher suites generate keys
93 using a set of DH parameters. If not specified then an attempt is made to
94 load the parameters from the server certificate file. If this fails then
95 a static set of parameters hard coded into the s_server program will be used.
96
97 =item B<-nodhe>
98
99 if this option is set then no DH parameters will be loaded effectively
100 disabling the ephemeral DH cipher suites.
101
102 =item B<-no_tmp_rsa>
103
104 certain export cipher suites sometimes use a temporary RSA key, this option
105 disables temporary RSA key generation.
106
107 =item B<-verify depth>, B<-Verify depth>
108
109 The verify depth to use. This specifies the maximum length of the
110 client certificate chain and makes the server request a certificate from
111 the client. With the B<-verify> option a certificate is requested but the
112 client does not have to send one, with the B<-Verify> option the client
113 must supply a certificate or an error occurs.
114
115 =item B<-CApath directory>
116
117 The directory to use for client certificate verification. This directory
118 must be in "hash format", see B<verify> for more information. These are
119 also used when building the server certificate chain.
120
121 =item B<-CAfile file>
122
123 A file containing trusted certificates to use during client authentication
124 and to use when attempting to build the server certificate chain. The list
125 is also used in the list of acceptable client CAs passed to the client when
126 a certificate is requested.
127
128 =item B<-state>
129
130 prints out the SSL session states.
131
132 =item B<-debug>
133
134 print extensive debugging information including a hex dump of all traffic.
135
136 =item B<-nbio_test>
137
138 tests non blocking I/O
139
140 =item B<-nbio>
141
142 turns on non blocking I/O
143
144 =item B<-crlf>
145
146 this option translated a line feed from the terminal into CR+LF.
147
148 =item B<-quiet>
149
150 inhibit printing of session and certificate information.
151
152 =item B<-ssl2>, B<-ssl3>, B<-tls1>, B<-no_ssl2>, B<-no_ssl3>, B<-no_tls1>
153
154 these options disable the use of certain SSL or TLS protocols. By default
155 the initial handshake uses a method which should be compatible with all
156 servers and permit them to use SSL v3, SSL v2 or TLS as appropriate.
157
158 =item B<-bugs>
159
160 there are several known bug in SSL and TLS implementations. Adding this
161 option enables various workarounds.
162
163 =item B<-hack>
164
165 this option enables a further workaround for some some early Netscape
166 SSL code (?).
167
168 =item B<-cipher cipherlist>
169
170 this allows the cipher list sent by the client to be modified. See the
171 B<ciphers> command for more information.
172
173 =item B<-www>
174
175 sends a status message back to the client when it connects. This includes
176 lots of information about the ciphers used and various session parameters.
177 The output is in HTML format so this option will normally be used with a
178 web browser.
179
180 =item B<-WWW>
181
182 emulates a simple web server. Pages will be resolved relative to the
183 current directory, for example if the URL https://myhost/page.html is
184 requested the file ./page.html will be loaded.
185
186 =back
187
188 =head1 CONNECTED COMMANDS
189
190 If a connection request is established with an SSL client and neither the
191 B<-www> nor the B<-WWW> option has been used then normally any data received
192 from the client is displayed and any key presses will be sent to the client. 
193
194 Certain single letter commands are also recognised which perform special
195 operations: these are listed below.
196
197 =over 4
198
199 =item B<q>
200
201 end the current SSL connection but still accept new connections.
202
203 =item B<Q>
204
205 end the current SSL connection and exit.
206
207 =item B<r>
208
209 renegotiate the SSL session.
210
211 =item B<R>
212
213 renegotiate the SSL session and request a client certificate.
214
215 =item B<P>
216
217 send some plain text down the underlying TCP connection: this should
218 cause the client to disconnect due to a protocol violation.
219
220 =item B<S>
221
222 print out some session cache status information.
223
224 =back
225
226 =head1 NOTES
227
228 B<s_server> can be used to debug SSL clients. To accept connections from
229 a web browser the command:
230
231  openssl s_server -accept 443 -www
232
233 can be used for example.
234
235 Most web browsers (in particular Netscape and MSIE) only support RSA cipher
236 suites, so they cannot connect to servers which don't use a certificate
237 carrying an RSA key or a version of OpenSSL with RSA disabled.
238
239 Although specifying an empty list of CAs when requesting a client certificate
240 is strictly speaking a protocol violation, some SSL clients interpret this to
241 mean any CA is acceptable. This is useful for debugging purposes.
242
243 The session parameters can printed out using the B<sess_id> program.
244
245 =head1 BUGS
246
247 Because this program has a lot of options and also because some of
248 the techniques used are rather old, the C source of s_server is rather
249 hard to read and not a model of how things should be done. A typical
250 SSL server program would be much simpler.
251
252 The output of common ciphers is wrong: it just gives the list of ciphers that
253 OpenSSL recognizes and the client supports.
254
255 There should be a way for the B<s_server> program to print out details of any
256 unknown cipher suites a client says it supports.
257
258 =head1 SEE ALSO
259
260 sess_id(1), s_client(1), ciphers(1)
261
262 =cut