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