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