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