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