doc/man1/s_server.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 s_server - SSL/TLS server program
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl> B<s_server>
  10 [B<-help>]
  11 [B<-port port>]
  12 [B<-accept val>]
  13 [B<-naccept count>]
  14 [B<-unix val>]
  15 [B<-unlink>]
  16 [B<-4>]
  17 [B<-6>]
  18 [B<-context id>]
  19 [B<-verify depth>]
  20 [B<-Verify depth>]
  21 [B<-crl_check>]
  22 [B<-crl_check_all>]
  23 [B<-cert filename>]
  24 [B<-certform DER|PEM>]
  25 [B<-key keyfile>]
  26 [B<-keyform DER|PEM>]
  27 [B<-pass arg>]
  28 [B<-dcert filename>]
  29 [B<-dcertform DER|PEM>]
  30 [B<-dkey keyfile>]
  31 [B<-dkeyform DER|PEM>]
  32 [B<-dpass arg>]
  33 [B<-dhparam filename>]
  34 [B<-nbio>]
  35 [B<-nbio_test>]
  36 [B<-crlf>]
  37 [B<-debug>]
  38 [B<-msg>]
  39 [B<-state>]
  40 [B<-CApath directory>]
  41 [B<-CAfile filename>]
  42 [B<-no-CAfile>]
  43 [B<-no-CApath>]
  44 [B<-attime timestamp>]
  45 [B<-check_ss_sig>]
  46 [B<-explicit_policy>]
  47 [B<-extended_crl>]
  48 [B<-ignore_critical>]
  49 [B<-inhibit_any>]
  50 [B<-inhibit_map>]
  51 [B<-no_check_time>]
  52 [B<-partial_chain>]
  53 [B<-policy arg>]
  54 [B<-policy_check>]
  55 [B<-policy_print>]
  56 [B<-purpose purpose>]
  57 [B<-suiteB_128>]
  58 [B<-suiteB_128_only>]
  59 [B<-suiteB_192>]
  60 [B<-trusted_first>]
  61 [B<-no_alt_chains>]
  62 [B<-use_deltas>]
  63 [B<-auth_level num>]
  64 [B<-verify_depth num>]
  65 [B<-verify_return_error>]
  66 [B<-verify_email email>]
  67 [B<-verify_hostname hostname>]
  68 [B<-verify_ip ip>]
  69 [B<-verify_name name>]
  70 [B<-x509_strict>]
  71 [B<-nocert>]
  72 [B<-cipher cipherlist>]
  73 [B<-serverpref>]
  74 [B<-quiet>]
  75 [B<-ssl3>]
  76 [B<-tls1>]
  77 [B<-tls1_1>]
  78 [B<-tls1_2>]
  79 [B<-tls1_3>]
  80 [B<-dtls>]
  81 [B<-dtls1>]
  82 [B<-dtls1_2>]
  83 [B<-listen>]
  84 [B<-async>]
  85 [B<-split_send_frag>]
  86 [B<-max_pipelines>]
  87 [B<-read_buf>]
  88 [B<-no_ssl3>]
  89 [B<-no_tls1>]
  90 [B<-no_tls1_1>]
  91 [B<-no_tls1_2>]
  92 [B<-no_tls1_3>]
  93 [B<-no_dhe>]
  94 [B<-bugs>]
  95 [B<-comp>]
  96 [B<-no_comp>]
  97 [B<-brief>]
  98 [B<-www>]
  99 [B<-WWW>]
 100 [B<-HTTP>]
 101 [B<-engine id>]
 102 [B<-tlsextdebug>]
 103 [B<-no_ticket>]
 104 [B<-id_prefix arg>]
 105 [B<-rand file(s)>]
 106 [B<-serverinfo file>]
 107 [B<-no_resumption_on_reneg>]
 108 [B<-status>]
 109 [B<-status_verbose>]
 110 [B<-status_timeout nsec>]
 111 [B<-status_url url>]
 112 [B<-status_file file>]
 113 [B<-alpn protocols>]
 114 [B<-nextprotoneg protocols>]
 115
 116 =head1 DESCRIPTION
 117
 118 The B<s_server> command implements a generic SSL/TLS server which listens
 119 for connections on a given port using SSL/TLS.
 120
 121 =head1 OPTIONS
 122
 123 In addition to the options below the B<s_server> utility also supports the
 124 common and server only options documented in the
 125 in the "Supported Command Line Commands" section of the L<SSL_CONF_cmd(3)>
 126 manual page.
 127
 128 =over 4
 129
 130 =item B<-help>
 131
 132 Print out a usage message.
 133
 134 =item B<-port port>
 135
 136 The TCP port to listen on for connections. If not specified 4433 is used.
 137
 138 =item B<-accept val>
 139
 140 The optional TCP host and port to listen on for connections. If not specified, *:4433 is used.
 141
 142 =item B<-naccept count>
 143
 144 The server will exit after receiving B<number> connections, default unlimited.
 145
 146 =item B<-unix val>
 147
 148 Unix domain socket to accept on.
 149
 150 =item B<-unlink>
 151
 152 For -unix, unlink existing socket first.
 153
 154 =item B<-4>
 155
 156 Use IPv4 only.
 157
 158 =item B<-6>
 159
 160 Use IPv6 only.
 161
 162 =item B<-context id>
 163
 164 Sets the SSL context id. It can be given any string value. If this option
 165 is not present a default value will be used.
 166
 167 =item B<-cert certname>
 168
 169 The certificate to use, most servers cipher suites require the use of a
 170 certificate and some require a certificate with a certain public key type:
 171 for example the DSS cipher suites require a certificate containing a DSS
 172 (DSA) key. If not specified then the filename "server.pem" will be used.
 173
 174 =item B<-certform format>
 175
 176 The certificate format to use: DER or PEM. PEM is the default.
 177
 178 =item B<-key keyfile>
 179
 180 The private key to use. If not specified then the certificate file will
 181 be used.
 182
 183 =item B<-keyform format>
 184
 185 The private format to use: DER or PEM. PEM is the default.
 186
 187 =item B<-pass arg>
 188
 189 The private key password source. For more information about the format of B<arg>
 190 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
 191
 192 =item B<-dcert filename>, B<-dkey keyname>
 193
 194 Specify an additional certificate and private key, these behave in the
 195 same manner as the B<-cert> and B<-key> options except there is no default
 196 if they are not specified (no additional certificate and key is used). As
 197 noted above some cipher suites require a certificate containing a key of
 198 a certain type. Some cipher suites need a certificate carrying an RSA key
 199 and some a DSS (DSA) key. By using RSA and DSS certificates and keys
 200 a server can support clients which only support RSA or DSS cipher suites
 201 by using an appropriate certificate.
 202
 203 =item B<-dcertform format>, B<-dkeyform format>, B<-dpass arg>
 204
 205 Additional certificate and private key format and passphrase respectively.
 206
 207 =item B<-nocert>
 208
 209 If this option is set then no certificate is used. This restricts the
 210 cipher suites available to the anonymous ones (currently just anonymous
 211 DH).
 212
 213 =item B<-dhparam filename>
 214
 215 The DH parameter file to use. The ephemeral DH cipher suites generate keys
 216 using a set of DH parameters. If not specified then an attempt is made to
 217 load the parameters from the server certificate file.
 218 If this fails then a static set of parameters hard coded into the B<s_server>
 219 program will be used.
 220
 221 =item B<-no_dhe>
 222
 223 If this option is set then no DH parameters will be loaded effectively
 224 disabling the ephemeral DH cipher suites.
 225
 226 =item B<-crl_check>, B<-crl_check_all>
 227
 228 Check the peer certificate has not been revoked by its CA.
 229 The CRL(s) are appended to the certificate file. With the B<-crl_check_all>
 230 option all CRLs of all CAs in the chain are checked.
 231
 232 =item B<-CApath directory>
 233
 234 The directory to use for client certificate verification. This directory
 235 must be in "hash format", see B<verify> for more information. These are
 236 also used when building the server certificate chain.
 237
 238 =item B<-CAfile file>
 239
 240 A file containing trusted certificates to use during client authentication
 241 and to use when attempting to build the server certificate chain. The list
 242 is also used in the list of acceptable client CAs passed to the client when
 243 a certificate is requested.
 244
 245 =item B<-no-CAfile>
 246
 247 Do not load the trusted CA certificates from the default file location
 248
 249 =item B<-no-CApath>
 250
 251 Do not load the trusted CA certificates from the default directory location
 252
 253 =item B<-verify depth>, B<-Verify depth>
 254
 255 The verify depth to use. This specifies the maximum length of the
 256 client certificate chain and makes the server request a certificate from
 257 the client. With the B<-verify> option a certificate is requested but the
 258 client does not have to send one, with the B<-Verify> option the client
 259 must supply a certificate or an error occurs.
 260
 261 If the ciphersuite cannot request a client certificate (for example an
 262 anonymous ciphersuite or PSK) this option has no effect.
 263
 264 =item B<-attime>, B<-check_ss_sig>, B<-crl_check>, B<-crl_check_all>,
 265 B<-explicit_policy>, B<-extended_crl>, B<-ignore_critical>, B<-inhibit_any>,
 266 B<-inhibit_map>, B<-no_alt_chains>, B<-no_check_time>, B<-partial_chain>, B<-policy>,
 267 B<-policy_check>, B<-policy_print>, B<-purpose>, B<-suiteB_128>,
 268 B<-suiteB_128_only>, B<-suiteB_192>, B<-trusted_first>, B<-use_deltas>,
 269 B<-auth_level>, B<-verify_depth>, B<-verify_email>, B<-verify_hostname>,
 270 B<-verify_ip>, B<-verify_name>, B<-x509_strict>
 271
 272 Set different peer certificate verification options.
 273 See the L<verify(1)> manual page for details.
 274
 275 =item B<-verify_return_error>
 276
 277 Verification errors normally just print a message but allow the
 278 connection to continue, for debugging purposes.
 279 If this option is used, then verification errors close the connection.
 280
 281 =item B<-state>
 282
 283 Prints the SSL session states.
 284
 285 =item B<-debug>
 286
 287 Print extensive debugging information including a hex dump of all traffic.
 288
 289 =item B<-msg>
 290
 291 Show all protocol messages with hex dump.
 292
 293 =item B<-trace>
 294
 295 Show verbose trace output of protocol messages. OpenSSL needs to be compiled
 296 with B<enable-ssl-trace> for this option to work.
 297
 298 =item B<-msgfile>
 299
 300 File to send output of B<-msg> or B<-trace> to, default standard output.
 301
 302 =item B<-nbio_test>
 303
 304 Tests non blocking I/O
 305
 306 =item B<-nbio>
 307
 308 Turns on non blocking I/O
 309
 310 =item B<-crlf>
 311
 312 This option translated a line feed from the terminal into CR+LF.
 313
 314 =item B<-quiet>
 315
 316 Inhibit printing of session and certificate information.
 317
 318 =item B<-psk_hint hint>
 319
 320 Use the PSK identity hint B<hint> when using a PSK cipher suite.
 321
 322 =item B<-psk key>
 323
 324 Use the PSK key B<key> when using a PSK cipher suite. The key is
 325 given as a hexadecimal number without leading 0x, for example -psk
 326 1a2b3c4d.
 327
 328 =item B<-ssl2>, B<-ssl3>, B<-tls1>, B<-tls1_1>, B<-tls1_2>, B<-tls1_3>, B<-no_ssl2>, B<-no_ssl3>, B<-no_tls1>, B<-no_tls1_1>, B<-no_tls1_2>, B<-no_tls1_3>
 329
 330 These options require or disable the use of the specified SSL or TLS protocols.
 331 By default B<s_server> will negotiate the highest mutually supported protocol
 332 version.
 333 When a specific TLS version is required, only that version will be accepted
 334 from the client.
 335
 336 =item B<-dtls>, B<-dtls1>, B<-dtls1_2>
 337
 338 These options make B<s_server> use DTLS protocols instead of TLS.
 339 With B<-dtls>, B<s_server> will negotiate any supported DTLS protocol version,
 340 whilst B<-dtls1> and B<-dtls1_2> will only support DTLSv1.0 and DTLSv1.2
 341 respectively.
 342
 343 =item B<-listen>
 344
 345 This option can only be used in conjunction with one of the DTLS options above.
 346 With this option B<s_server> will listen on a UDP port for incoming connections.
 347 Any ClientHellos that arrive will be checked to see if they have a cookie in
 348 them or not.
 349 Any without a cookie will be responded to with a HelloVerifyRequest.
 350 If a ClientHello with a cookie is received then B<s_server> will connect to
 351 that peer and complete the handshake.
 352
 353 =item B<-async>
 354
 355 Switch on asynchronous mode. Cryptographic operations will be performed
 356 asynchronously. This will only have an effect if an asynchronous capable engine
 357 is also used via the B<-engine> option. For test purposes the dummy async engine
 358 (dasync) can be used (if available).
 359
 360 =item B<-split_send_frag int>
 361
 362 The size used to split data for encrypt pipelines. If more data is written in
 363 one go than this value then it will be split into multiple pipelines, up to the
 364 maximum number of pipelines defined by max_pipelines. This only has an effect if
 365 a suitable ciphersuite has been negotiated, an engine that supports pipelining
 366 has been loaded, and max_pipelines is greater than 1. See
 367 L<SSL_CTX_set_split_send_fragment(3)> for further information.
 368
 369 =item B<-max_pipelines int>
 370
 371 The maximum number of encrypt/decrypt pipelines to be used. This will only have
 372 an effect if an engine has been loaded that supports pipelining (e.g. the dasync
 373 engine) and a suitable ciphersuite has been negotiated. The default value is 1.
 374 See L<SSL_CTX_set_max_pipelines(3)> for further information.
 375
 376 =item B<-read_buf int>
 377
 378 The default read buffer size to be used for connections. This will only have an
 379 effect if the buffer size is larger than the size that would otherwise be used
 380 and pipelining is in use (see L<SSL_CTX_set_default_read_buffer_len(3)> for
 381 further information).
 382
 383 =item B<-bugs>
 384
 385 There are several known bug in SSL and TLS implementations. Adding this
 386 option enables various workarounds.
 387
 388 =item B<-comp>
 389
 390 Enable negotiation of TLS compression.
 391 This option was introduced in OpenSSL 1.1.0.
 392 TLS compression is not recommended and is off by default as of
 393 OpenSSL 1.1.0.
 394
 395 =item B<-no_comp>
 396
 397 Disable negotiation of TLS compression.
 398 TLS compression is not recommended and is off by default as of
 399 OpenSSL 1.1.0.
 400
 401 =item B<-brief>
 402
 403 Provide a brief summary of connection parameters instead of the normal verbose
 404 output.
 405
 406 =item B<-cipher cipherlist>
 407
 408 This allows the cipher list used by the server to be modified.  When
 409 the client sends a list of supported ciphers the first client cipher
 410 also included in the server list is used. Because the client specifies
 411 the preference order, the order of the server cipherlist irrelevant. See
 412 the B<ciphers> command for more information.
 413
 414 =item B<-serverpref>
 415
 416 Use the server's cipher preferences, rather than the client's preferences.
 417
 418 =item B<-tlsextdebug>
 419
 420 Print a hex dump of any TLS extensions received from the server.
 421
 422 =item B<-no_ticket>
 423
 424 Disable RFC4507bis session ticket support.
 425
 426 =item B<-www>
 427
 428 Sends a status message back to the client when it connects. This includes
 429 information about the ciphers used and various session parameters.
 430 The output is in HTML format so this option will normally be used with a
 431 web browser.
 432
 433 =item B<-WWW>
 434
 435 Emulates a simple web server. Pages will be resolved relative to the
 436 current directory, for example if the URL https://myhost/page.html is
 437 requested the file ./page.html will be loaded.
 438
 439 =item B<-HTTP>
 440
 441 Emulates a simple web server. Pages will be resolved relative to the
 442 current directory, for example if the URL https://myhost/page.html is
 443 requested the file ./page.html will be loaded. The files loaded are
 444 assumed to contain a complete and correct HTTP response (lines that
 445 are part of the HTTP response line and headers must end with CRLF).
 446
 447 =item B<-rev>
 448
 449 Simple test server which just reverses the text received from the client
 450 and sends it back to the server. Also sets B<-brief>.
 451
 452 =item B<-engine id>
 453
 454 Specifying an engine (by its unique B<id> string) will cause B<s_server>
 455 to attempt to obtain a functional reference to the specified engine,
 456 thus initialising it if needed. The engine will then be set as the default
 457 for all available algorithms.
 458
 459 =item B<-id_prefix arg>
 460
 461 Generate SSL/TLS session IDs prefixed by B<arg>. This is mostly useful
 462 for testing any SSL/TLS code (eg. proxies) that wish to deal with multiple
 463 servers, when each of which might be generating a unique range of session
 464 IDs (eg. with a certain prefix).
 465
 466 =item B<-rand file(s)>
 467
 468 A file or files containing random data used to seed the random number
 469 generator, or an EGD socket (see L<RAND_egd(3)>).
 470 Multiple files can be specified separated by an OS-dependent character.
 471 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
 472 all others.
 473
 474 =item B<-serverinfo file>
 475
 476 A file containing one or more blocks of PEM data.  Each PEM block
 477 must encode a TLS ServerHello extension (2 bytes type, 2 bytes length,
 478 followed by "length" bytes of extension data).  If the client sends
 479 an empty TLS ClientHello extension matching the type, the corresponding
 480 ServerHello extension will be returned.
 481
 482 =item B<-no_resumption_on_reneg>
 483
 484 Set the B<SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION> option.
 485
 486 =item B<-status>
 487
 488 Enables certificate status request support (aka OCSP stapling).
 489
 490 =item B<-status_verbose>
 491
 492 Enables certificate status request support (aka OCSP stapling) and gives
 493 a verbose printout of the OCSP response.
 494
 495 =item B<-status_timeout nsec>
 496
 497 Sets the timeout for OCSP response to B<nsec> seconds.
 498
 499 =item B<-status_url url>
 500
 501 Sets a fallback responder URL to use if no responder URL is present in the
 502 server certificate. Without this option an error is returned if the server
 503 certificate does not contain a responder address.
 504
 505 =item B<-status_file file>
 506
 507 Overrides any OCSP responder URLs from the certificate and always provides the
 508 OCSP Response stored in the file. The file must be in DER format.
 509
 510 =item B<-alpn protocols>, B<-nextprotoneg protocols>
 511
 512 these flags enable the
 513 Enable the Application-Layer Protocol Negotiation or Next Protocol
 514 Negotiation extension, respectively. ALPN is the IETF standard and
 515 replaces NPN.
 516 The B<protocols> list is a
 517 comma-separated list of supported protocol names.
 518 The list should contain most wanted protocols first.
 519 Protocol names are printable ASCII strings, for example "http/1.1" or
 520 "spdy/3".
 521
 522 =back
 523
 524 =head1 CONNECTED COMMANDS
 525
 526 If a connection request is established with an SSL client and neither the
 527 B<-www> nor the B<-WWW> option has been used then normally any data received
 528 from the client is displayed and any key presses will be sent to the client.
 529
 530 Certain single letter commands are also recognized which perform special
 531 operations: these are listed below.
 532
 533 =over 4
 534
 535 =item B<q>
 536
 537 end the current SSL connection but still accept new connections.
 538
 539 =item B<Q>
 540
 541 end the current SSL connection and exit.
 542
 543 =item B<r>
 544
 545 renegotiate the SSL session.
 546
 547 =item B<R>
 548
 549 renegotiate the SSL session and request a client certificate.
 550
 551 =item B<P>
 552
 553 send some plain text down the underlying TCP connection: this should
 554 cause the client to disconnect due to a protocol violation.
 555
 556 =item B<S>
 557
 558 print out some session cache status information.
 559
 560 =back
 561
 562 =head1 NOTES
 563
 564 B<s_server> can be used to debug SSL clients. To accept connections from
 565 a web browser the command:
 566
 567  openssl s_server -accept 443 -www
 568
 569 can be used for example.
 570
 571 Most web browsers (in particular Netscape and MSIE) only support RSA cipher
 572 suites, so they cannot connect to servers which don't use a certificate
 573 carrying an RSA key or a version of OpenSSL with RSA disabled.
 574
 575 Although specifying an empty list of CAs when requesting a client certificate
 576 is strictly speaking a protocol violation, some SSL clients interpret this to
 577 mean any CA is acceptable. This is useful for debugging purposes.
 578
 579 The session parameters can printed out using the B<sess_id> program.
 580
 581 =head1 BUGS
 582
 583 Because this program has a lot of options and also because some of the
 584 techniques used are rather old, the C source of B<s_server> is rather hard to
 585 read and not a model of how things should be done.
 586 A typical SSL server program would be much simpler.
 587
 588 The output of common ciphers is wrong: it just gives the list of ciphers that
 589 OpenSSL recognizes and the client supports.
 590
 591 There should be a way for the B<s_server> program to print out details of any
 592 unknown cipher suites a client says it supports.
 593
 594 =head1 SEE ALSO
 595
 596 L<SSL_CONF_cmd(3)>,
 597 L<sess_id(1)>, L<s_client(1)>, L<ciphers(1)>
 598
 599 =head1 HISTORY
 600
 601 The -no_alt_chains options was first added to OpenSSL 1.1.0.
 602
 603 =head1 COPYRIGHT
 604
 605 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
 606
 607 Licensed under the OpenSSL license (the "License").  You may not use
 608 this file except in compliance with the License.  You can obtain a copy
 609 in the file LICENSE in the source distribution or at
 610 L<https://www.openssl.org/source/license.html>.
 611
 612 =cut