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