doc/man1/openssl-s_server.pod.in

   1 =pod
   2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
   3
   4 =head1 NAME
   5
   6 openssl-s_server - SSL/TLS server program
   7
   8 =head1 SYNOPSIS
   9
  10 B<openssl> B<s_server>
  11 [B<-help>]
  12 [B<-port> I<+int>]
  13 [B<-accept> I<val>]
  14 [B<-unix> I<val>]
  15 [B<-4>]
  16 [B<-6>]
  17 [B<-unlink>]
  18 [B<-context> I<val>]
  19 [B<-verify> I<int>]
  20 [B<-Verify> I<int>]
  21 [B<-cert> I<infile>]
  22 [B<-naccept> I<+int>]
  23 [B<-serverinfo> I<val>]
  24 [B<-certform> B<DER>|B<PEM>]
  25 [B<-key> I<infile>]
  26 [B<-keyform> B<DER>|B<PEM>]
  27 [B<-pass> I<val>]
  28 [B<-dcert> I<infile>]
  29 [B<-dcertform> B<DER>|B<PEM>]
  30 [B<-dkey> I<infile>]
  31 [B<-dkeyform> B<DER>|B<PEM>]
  32 [B<-dpass> I<val>]
  33 [B<-nbio_test>]
  34 [B<-crlf>]
  35 [B<-debug>]
  36 [B<-msg>]
  37 [B<-msgfile> I<outfile>]
  38 [B<-state>]
  39 [B<-nocert>]
  40 [B<-quiet>]
  41 [B<-no_resume_ephemeral>]
  42 [B<-www>]
  43 [B<-WWW>]
  44 [B<-servername>]
  45 [B<-servername_fatal>]
  46 [B<-cert2> I<infile>]
  47 [B<-key2> I<infile>]
  48 [B<-tlsextdebug>]
  49 [B<-HTTP>]
  50 [B<-id_prefix> I<val>]
  51 [B<-keymatexport> I<val>]
  52 [B<-keymatexportlen> I<+int>]
  53 [B<-CRLform> B<DER>|B<PEM>]
  54 [B<-CRL> I<infile>]
  55 [B<-crl_download>]
  56 [B<-cert_chain> I<infile>]
  57 [B<-dcert_chain> I<infile>]
  58 [B<-chainCApath> I<dir>]
  59 [B<-verifyCApath> I<dir>]
  60 [B<-chainCAstore> I<uri>]
  61 [B<-verifyCAstore> I<uri>]
  62 [B<-no_cache>]
  63 [B<-ext_cache>]
  64 [B<-verify_return_error>]
  65 [B<-verify_quiet>]
  66 [B<-build_chain>]
  67 [B<-chainCAfile> I<infile>]
  68 [B<-verifyCAfile> I<infile>]
  69 [B<-ign_eof>]
  70 [B<-no_ign_eof>]
  71 [B<-status>]
  72 [B<-status_verbose>]
  73 [B<-status_timeout> I<int>]
  74 [B<-status_url> I<val>]
  75 [B<-status_file> I<infile>]
  76 [B<-trace>]
  77 [B<-security_debug>]
  78 [B<-security_debug_verbose>]
  79 [B<-brief>]
  80 [B<-rev>]
  81 [B<-async>]
  82 [B<-ssl_config> I<val>]
  83 [B<-max_send_frag> I<+int>]
  84 [B<-split_send_frag> I<+int>]
  85 [B<-max_pipelines> I<+int>]
  86 [B<-read_buf> I<+int>]
  87 [B<-bugs>]
  88 [B<-no_comp>]
  89 [B<-comp>]
  90 [B<-no_ticket>]
  91 [B<-num_tickets>]
  92 [B<-serverpref>]
  93 [B<-legacy_renegotiation>]
  94 [B<-no_renegotiation>]
  95 [B<-legacy_server_connect>]
  96 [B<-no_resumption_on_reneg>]
  97 [B<-no_legacy_server_connect>]
  98 [B<-allow_no_dhe_kex>]
  99 [B<-prioritize_chacha>]
 100 [B<-strict>]
 101 [B<-sigalgs> I<val>]
 102 [B<-client_sigalgs> I<val>]
 103 [B<-groups> I<val>]
 104 [B<-curves> I<val>]
 105 [B<-named_curve> I<val>]
 106 [B<-cipher> I<val>]
 107 [B<-ciphersuites> I<val>]
 108 [B<-dhparam> I<infile>]
 109 [B<-record_padding> I<val>]
 110 [B<-debug_broken_protocol>]
 111 [B<-nbio>]
 112 [B<-psk_identity> I<val>]
 113 [B<-psk_hint> I<val>]
 114 [B<-psk> I<val>]
 115 [B<-psk_session> I<file>]
 116 [B<-srpvfile> I<infile>]
 117 [B<-srpuserseed> I<val>]
 118 [B<-timeout>]
 119 [B<-mtu> I<+int>]
 120 [B<-listen>]
 121 [B<-sctp>]
 122 [B<-sctp_label_bug>]
 123 [B<-no_dhe>]
 124 [B<-nextprotoneg> I<val>]
 125 [B<-use_srtp> I<val>]
 126 [B<-alpn> I<val>]
 127 [B<-keylogfile> I<outfile>]
 128 [B<-max_early_data> I<int>]
 129 [B<-recv_max_early_data> I<int>]
 130 [B<-early_data>]
 131 [B<-stateless>]
 132 [B<-anti_replay>]
 133 [B<-no_anti_replay>]
 134 [B<-http_server_binmode>]
 135 {- $OpenSSL::safe::opt_name_synopsis -}
 136 {- $OpenSSL::safe::opt_version_synopsis -}
 137 {- $OpenSSL::safe::opt_v_synopsis -}
 138 {- $OpenSSL::safe::opt_x_synopsis -}
 139 {- $OpenSSL::safe::opt_trust_synopsis -}
 140 {- $OpenSSL::safe::opt_r_synopsis -}
 141 {- $OpenSSL::safe::opt_engine_synopsis -}
 142
 143 =for openssl ifdef unix 4 6 unlink no_dhe nextprotoneg use_srtp engine
 144
 145 =for openssl ifdef status status_verbose status_timeout status_url status_file
 146
 147 =for openssl ifdef psk_hint srpvfile srpuserseed sctp sctp_label_bug
 148
 149 =for openssl ifdef sctp sctp_label_bug trace mtu timeout listen
 150
 151 =for openssl ifdef ssl3 tls1 tls1_1 tls1_2 tls1_3 dtls mtu dtls1 dtls1_2
 152
 153 =head1 DESCRIPTION
 154
 155 This command implements a generic SSL/TLS server which
 156 listens for connections on a given port using SSL/TLS.
 157
 158 =head1 OPTIONS
 159
 160 In addition to the options below, this command also supports
 161 the common and server only options documented
 162 L<SSL_CONF_cmd(3)/Supported Command Line Commands>
 163
 164 =over 4
 165
 166 =item B<-help>
 167
 168 Print out a usage message.
 169
 170 =item B<-port> I<+int>
 171
 172 The TCP port to listen on for connections. If not specified 4433 is used.
 173
 174 =item B<-accept> I<val>
 175
 176 The optional TCP host and port to listen on for connections. If not specified, *:4433 is used.
 177
 178 =item B<-unix> I<val>
 179
 180 Unix domain socket to accept on.
 181
 182 =item B<-4>
 183
 184 Use IPv4 only.
 185
 186 =item B<-6>
 187
 188 Use IPv6 only.
 189
 190 =item B<-unlink>
 191
 192 For -unix, unlink any existing socket first.
 193
 194 =item B<-context> I<val>
 195
 196 Sets the SSL context id. It can be given any string value. If this option
 197 is not present a default value will be used.
 198
 199 =item B<-verify> I<int>, B<-Verify> I<int>
 200
 201 The verify depth to use. This specifies the maximum length of the
 202 client certificate chain and makes the server request a certificate from
 203 the client. With the B<-verify> option a certificate is requested but the
 204 client does not have to send one, with the B<-Verify> option the client
 205 must supply a certificate or an error occurs.
 206
 207 If the cipher suite cannot request a client certificate (for example an
 208 anonymous cipher suite or PSK) this option has no effect.
 209
 210 =item B<-cert> I<infile>
 211
 212 The certificate to use, most servers cipher suites require the use of a
 213 certificate and some require a certificate with a certain public key type:
 214 for example the DSS cipher suites require a certificate containing a DSS
 215 (DSA) key. If not specified then the filename F<server.pem> will be used.
 216
 217 =item B<-cert_chain>
 218
 219 A file containing trusted certificates to use when attempting to build the
 220 client/server certificate chain related to the certificate specified via the
 221 B<-cert> option.
 222
 223 =item B<-build_chain>
 224
 225 Specify whether the application should build the certificate chain to be
 226 provided to the client.
 227
 228 =item B<-naccept> I<+int>
 229
 230 The server will exit after receiving the specified number of connections,
 231 default unlimited.
 232
 233 =item B<-serverinfo> I<val>
 234
 235 A file containing one or more blocks of PEM data.  Each PEM block
 236 must encode a TLS ServerHello extension (2 bytes type, 2 bytes length,
 237 followed by "length" bytes of extension data).  If the client sends
 238 an empty TLS ClientHello extension matching the type, the corresponding
 239 ServerHello extension will be returned.
 240
 241 =item B<-certform> B<DER>|B<PEM>, B<-CRLForm> B<DER>|B<PEM>
 242
 243 The certificate and CRL format; the default is PEM.
 244 See L<openssl(1)/Format Options> for details.
 245
 246 =item B<-key> I<infile>
 247
 248 The private key to use. If not specified then the certificate file will
 249 be used.
 250
 251 =item B<-keyform> B<DER>|B<PEM>
 252
 253 The key format; the default is B<PEM>.
 254 See L<openssl(1)/Format Options> for details.
 255
 256 =item B<-pass> I<val>
 257
 258 The private key password source.
 259 For more information about the format of I<val>,
 260 see L<openssl(1)/Pass Phrase Options>.
 261
 262 =item B<-dcert> I<infile>, B<-dkey> I<infile>
 263
 264 Specify an additional certificate and private key, these behave in the
 265 same manner as the B<-cert> and B<-key> options except there is no default
 266 if they are not specified (no additional certificate and key is used). As
 267 noted above some cipher suites require a certificate containing a key of
 268 a certain type. Some cipher suites need a certificate carrying an RSA key
 269 and some a DSS (DSA) key. By using RSA and DSS certificates and keys
 270 a server can support clients which only support RSA or DSS cipher suites
 271 by using an appropriate certificate.
 272
 273 =item B<-dcert_chain>
 274
 275 A file containing trusted certificates to use when attempting to build the
 276 server certificate chain when a certificate specified via the B<-dcert> option
 277 is in use.
 278
 279 =item B<-dcertform> B<DER>|B<PEM>, B<-dkeyform> B<DER>|B<PEM>
 280
 281 The format of the certificate and private key; the default is B<PEM>
 282 see L<openssl(1)/Format Options>.
 283
 284 =item B<-dpass> I<val>
 285
 286 The passphrase for the additional private key.
 287 For more information about the format of I<val>,
 288 see L<openssl(1)/Pass Phrase Options>.
 289
 290 =item B<-nbio_test>
 291
 292 Tests non blocking I/O.
 293
 294 =item B<-crlf>
 295
 296 This option translated a line feed from the terminal into CR+LF.
 297
 298 =item B<-debug>
 299
 300 Print extensive debugging information including a hex dump of all traffic.
 301
 302 =item B<-msg>
 303
 304 Show all protocol messages with hex dump.
 305
 306 =item B<-msgfile> I<outfile>
 307
 308 File to send output of B<-msg> or B<-trace> to, default standard output.
 309
 310 =item B<-state>
 311
 312 Prints the SSL session states.
 313
 314 =item B<-chainCApath> I<dir>
 315
 316 The directory to use for building the chain provided to the client. This
 317 directory must be in "hash format", see L<openssl-verify(1)> for more
 318 information.
 319
 320 =item B<-chainCAfile> I<file>
 321
 322 A file containing trusted certificates to use when attempting to build the
 323 server certificate chain.
 324
 325 =item B<-chainCAstore> I<uri>
 326
 327 The URI to a store to use for building the chain provided to the client.
 328 The URI may indicate a single certificate, as well as a collection of
 329 them.
 330 With URIs in the C<file:> scheme, this acts as B<-chainCAfile> or
 331 B<-chainCApath>, depending on if the URI indicates a directory or a
 332 single file.
 333 See L<ossl_store-file(7)> for more information on the C<file:> scheme.
 334
 335 =item B<-nocert>
 336
 337 If this option is set then no certificate is used. This restricts the
 338 cipher suites available to the anonymous ones (currently just anonymous
 339 DH).
 340
 341 =item B<-quiet>
 342
 343 Inhibit printing of session and certificate information.
 344
 345 =item B<-tlsextdebug>
 346
 347 Print a hex dump of any TLS extensions received from the server.
 348
 349 =item B<-www>
 350
 351 Sends a status message back to the client when it connects. This includes
 352 information about the ciphers used and various session parameters.
 353 The output is in HTML format so this option can be used with a web browser.
 354 The special URL C</renegcert> turns on client cert validation, and C</reneg>
 355 tells the server to request renegotiation.
 356 The B<-early_data> option cannot be used with this option.
 357
 358 =item B<-WWW>, B<-HTTP>
 359
 360 Emulates a simple web server. Pages will be resolved relative to the
 361 current directory, for example if the URL C<https://myhost/page.html> is
 362 requested the file F<./page.html> will be sent.
 363 If the B<-HTTP> flag is used, the files are sent directly, and should contain
 364 any HTTP response headers (including status response line).
 365 If the B<-WWW> option is used,
 366 the response headers are generated by the server, and the file extension is
 367 examined to determine the B<Content-Type> header.
 368 Extensions of C<html>, C<htm>, and C<php> are C<text/html> and all others are
 369 C<text/plain>.
 370 In addition, the special URL C</stats> will return status
 371 information like the B<-www> option.
 372 Neither of these options can be used in conjunction with B<-early_data>.
 373
 374 =item B<-id_prefix> I<val>
 375
 376 Generate SSL/TLS session IDs prefixed by I<val>. This is mostly useful
 377 for testing any SSL/TLS code (eg. proxies) that wish to deal with multiple
 378 servers, when each of which might be generating a unique range of session
 379 IDs (eg. with a certain prefix).
 380
 381 =item B<-verify_return_error>
 382
 383 Verification errors normally just print a message but allow the
 384 connection to continue, for debugging purposes.
 385 If this option is used, then verification errors close the connection.
 386
 387 =item B<-status>
 388
 389 Enables certificate status request support (aka OCSP stapling).
 390
 391 =item B<-status_verbose>
 392
 393 Enables certificate status request support (aka OCSP stapling) and gives
 394 a verbose printout of the OCSP response.
 395
 396 =item B<-status_timeout> I<int>
 397
 398 Sets the timeout for OCSP response to I<int> seconds.
 399
 400 =item B<-status_url> I<val>
 401
 402 Sets a fallback responder URL to use if no responder URL is present in the
 403 server certificate. Without this option an error is returned if the server
 404 certificate does not contain a responder address.
 405
 406 =item B<-status_file> I<infile>
 407
 408 Overrides any OCSP responder URLs from the certificate and always provides the
 409 OCSP Response stored in the file. The file must be in DER format.
 410
 411 =item B<-trace>
 412
 413 Show verbose trace output of protocol messages. OpenSSL needs to be compiled
 414 with B<enable-ssl-trace> for this option to work.
 415
 416 =item B<-brief>
 417
 418 Provide a brief summary of connection parameters instead of the normal verbose
 419 output.
 420
 421 =item B<-rev>
 422
 423 Simple test server which just reverses the text received from the client
 424 and sends it back to the server. Also sets B<-brief>. Cannot be used in
 425 conjunction with B<-early_data>.
 426
 427 =item B<-async>
 428
 429 Switch on asynchronous mode. Cryptographic operations will be performed
 430 asynchronously. This will only have an effect if an asynchronous capable engine
 431 is also used via the B<-engine> option. For test purposes the dummy async engine
 432 (dasync) can be used (if available).
 433
 434 =item B<-max_send_frag> I<+int>
 435
 436 The maximum size of data fragment to send.
 437 See L<SSL_CTX_set_max_send_fragment(3)> for further information.
 438
 439 =item B<-split_send_frag> I<+int>
 440
 441 The size used to split data for encrypt pipelines. If more data is written in
 442 one go than this value then it will be split into multiple pipelines, up to the
 443 maximum number of pipelines defined by max_pipelines. This only has an effect if
 444 a suitable cipher suite has been negotiated, an engine that supports pipelining
 445 has been loaded, and max_pipelines is greater than 1. See
 446 L<SSL_CTX_set_split_send_fragment(3)> for further information.
 447
 448 =item B<-max_pipelines> I<+int>
 449
 450 The maximum number of encrypt/decrypt pipelines to be used. This will only have
 451 an effect if an engine has been loaded that supports pipelining (e.g. the dasync
 452 engine) and a suitable cipher suite has been negotiated. The default value is 1.
 453 See L<SSL_CTX_set_max_pipelines(3)> for further information.
 454
 455 =item B<-read_buf> I<+int>
 456
 457 The default read buffer size to be used for connections. This will only have an
 458 effect if the buffer size is larger than the size that would otherwise be used
 459 and pipelining is in use (see L<SSL_CTX_set_default_read_buffer_len(3)> for
 460 further information).
 461
 462 =item B<-bugs>
 463
 464 There are several known bugs in SSL and TLS implementations. Adding this
 465 option enables various workarounds.
 466
 467 =item B<-no_comp>
 468
 469 Disable negotiation of TLS compression.
 470 TLS compression is not recommended and is off by default as of
 471 OpenSSL 1.1.0.
 472
 473 =item B<-comp>
 474
 475 Enable negotiation of TLS compression.
 476 This option was introduced in OpenSSL 1.1.0.
 477 TLS compression is not recommended and is off by default as of
 478 OpenSSL 1.1.0.
 479
 480 =item B<-no_ticket>
 481
 482 Disable RFC4507bis session ticket support. This option has no effect if TLSv1.3
 483 is negotiated. See B<-num_tickets>.
 484
 485 =item B<-num_tickets>
 486
 487 Control the number of tickets that will be sent to the client after a full
 488 handshake in TLSv1.3. The default number of tickets is 2. This option does not
 489 affect the number of tickets sent after a resumption handshake.
 490
 491 =item B<-serverpref>
 492
 493 Use the server's cipher preferences, rather than the client's preferences.
 494
 495 =item B<-prioritize_chacha>
 496
 497 Prioritize ChaCha ciphers when preferred by clients. Requires B<-serverpref>.
 498
 499 =item B<-no_resumption_on_reneg>
 500
 501 Set the B<SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION> option.
 502
 503 =item B<-client_sigalgs> I<val>
 504
 505 Signature algorithms to support for client certificate authentication
 506 (colon-separated list).
 507
 508 =item B<-named_curve> I<val>
 509
 510 Specifies the elliptic curve to use. NOTE: this is single curve, not a list.
 511 For a list of all possible curves, use:
 512
 513     $ openssl ecparam -list_curves
 514
 515 =item B<-cipher> I<val>
 516
 517 This allows the list of TLSv1.2 and below ciphersuites used by the server to be
 518 modified. This list is combined with any TLSv1.3 ciphersuites that have been
 519 configured. When the client sends a list of supported ciphers the first client
 520 cipher also included in the server list is used. Because the client specifies
 521 the preference order, the order of the server cipherlist is irrelevant. See
 522 L<openssl-ciphers(1)> for more information.
 523
 524 =item B<-ciphersuites> I<val>
 525
 526 This allows the list of TLSv1.3 ciphersuites used by the server to be modified.
 527 This list is combined with any TLSv1.2 and below ciphersuites that have been
 528 configured. When the client sends a list of supported ciphers the first client
 529 cipher also included in the server list is used. Because the client specifies
 530 the preference order, the order of the server cipherlist is irrelevant. See
 531 L<openssl-ciphers(1)> command for more information. The format for this list is
 532 a simple colon (":") separated list of TLSv1.3 ciphersuite names.
 533
 534 =item B<-dhparam> I<infile>
 535
 536 The DH parameter file to use. The ephemeral DH cipher suites generate keys
 537 using a set of DH parameters. If not specified then an attempt is made to
 538 load the parameters from the server certificate file.
 539 If this fails then a static set of parameters hard coded into this command
 540 will be used.
 541
 542 =item B<-nbio>
 543
 544 Turns on non blocking I/O.
 545
 546 =item B<-psk_identity> I<val>
 547
 548 Expect the client to send PSK identity I<val> when using a PSK
 549 cipher suite, and warn if they do not.  By default, the expected PSK
 550 identity is the string "Client_identity".
 551
 552 =item B<-psk_hint> I<val>
 553
 554 Use the PSK identity hint I<val> when using a PSK cipher suite.
 555
 556 =item B<-psk> I<val>
 557
 558 Use the PSK key I<val> when using a PSK cipher suite. The key is
 559 given as a hexadecimal number without leading 0x, for example -psk
 560 1a2b3c4d.
 561 This option must be provided in order to use a PSK cipher.
 562
 563 =item B<-psk_session> I<file>
 564
 565 Use the pem encoded SSL_SESSION data stored in I<file> as the basis of a PSK.
 566 Note that this will only work if TLSv1.3 is negotiated.
 567
 568 =item B<-listen>
 569
 570 This option can only be used in conjunction with one of the DTLS options above.
 571 With this option, this command will listen on a UDP port for incoming
 572 connections.
 573 Any ClientHellos that arrive will be checked to see if they have a cookie in
 574 them or not.
 575 Any without a cookie will be responded to with a HelloVerifyRequest.
 576 If a ClientHello with a cookie is received then this command will
 577 connect to that peer and complete the handshake.
 578
 579 =item B<-sctp>
 580
 581 Use SCTP for the transport protocol instead of UDP in DTLS. Must be used in
 582 conjunction with B<-dtls>, B<-dtls1> or B<-dtls1_2>. This option is only
 583 available where OpenSSL has support for SCTP enabled.
 584
 585 =item B<-sctp_label_bug>
 586
 587 Use the incorrect behaviour of older OpenSSL implementations when computing
 588 endpoint-pair shared secrets for DTLS/SCTP. This allows communication with
 589 older broken implementations but breaks interoperability with correct
 590 implementations. Must be used in conjunction with B<-sctp>. This option is only
 591 available where OpenSSL has support for SCTP enabled.
 592
 593 =item B<-no_dhe>
 594
 595 If this option is set then no DH parameters will be loaded effectively
 596 disabling the ephemeral DH cipher suites.
 597
 598 =item B<-alpn> I<val>, B<-nextprotoneg> I<val>
 599
 600 These flags enable the Enable the Application-Layer Protocol Negotiation
 601 or Next Protocol Negotiation (NPN) extension, respectively. ALPN is the
 602 IETF standard and replaces NPN.
 603 The I<val> list is a comma-separated list of supported protocol
 604 names.  The list should contain the most desirable protocols first.
 605 Protocol names are printable ASCII strings, for example "http/1.1" or
 606 "spdy/3".
 607 The flag B<-nextprotoneg> cannot be specified if B<-tls1_3> is used.
 608
 609 =item B<-keylogfile> I<outfile>
 610
 611 Appends TLS secrets to the specified keylog file such that external programs
 612 (like Wireshark) can decrypt TLS connections.
 613
 614 =item B<-max_early_data> I<int>
 615
 616 Change the default maximum early data bytes that are specified for new sessions
 617 and any incoming early data (when used in conjunction with the B<-early_data>
 618 flag). The default value is approximately 16k. The argument must be an integer
 619 greater than or equal to 0.
 620
 621 =item B<-recv_max_early_data> I<int>
 622
 623 Specify the hard limit on the maximum number of early data bytes that will
 624 be accepted.
 625
 626 =item B<-early_data>
 627
 628 Accept early data where possible. Cannot be used in conjunction with B<-www>,
 629 B<-WWW>, B<-HTTP> or B<-rev>.
 630
 631 =item B<-stateless>
 632
 633 Require TLSv1.3 cookies.
 634
 635 =item B<-anti_replay>, B<-no_anti_replay>
 636
 637 Switches replay protection on or off, respectively. Replay protection is on by
 638 default unless overridden by a configuration file. When it is on, OpenSSL will
 639 automatically detect if a session ticket has been used more than once, TLSv1.3
 640 has been negotiated, and early data is enabled on the server. A full handshake
 641 is forced if a session ticket is used a second or subsequent time. Any early
 642 data that was sent will be rejected.
 643
 644 =item B<-http_server_binmode>
 645
 646 When acting as web-server (using option B<-WWW> or B<-HTTP>) open files requested
 647 by the client in binary mode.
 648
 649 {- $OpenSSL::safe::opt_name_item -}
 650
 651 {- $OpenSSL::safe::opt_version_item -}
 652
 653 {- $OpenSSL::safe::opt_x_item -}
 654
 655 {- $OpenSSL::safe::opt_trust_item -}
 656
 657 {- $OpenSSL::safe::opt_r_item -}
 658
 659 {- $OpenSSL::safe::opt_engine_item -}
 660
 661 {- $OpenSSL::safe::opt_v_item -}
 662
 663 If the server requests a client certificate, then
 664 verification errors are displayed, for debugging, but the command will
 665 proceed unless the B<-verify_return_error> option is used.
 666
 667 =back
 668
 669 =head1 CONNECTED COMMANDS
 670
 671 If a connection request is established with an SSL client and neither the
 672 B<-www> nor the B<-WWW> option has been used then normally any data received
 673 from the client is displayed and any key presses will be sent to the client.
 674
 675 Certain commands are also recognized which perform special operations. These
 676 commands are a letter which must appear at the start of a line. They are listed
 677 below.
 678
 679 =over 4
 680
 681 =item B<q>
 682
 683 End the current SSL connection but still accept new connections.
 684
 685 =item B<Q>
 686
 687 End the current SSL connection and exit.
 688
 689 =item B<r>
 690
 691 Renegotiate the SSL session (TLSv1.2 and below only).
 692
 693 =item B<R>
 694
 695 Renegotiate the SSL session and request a client certificate (TLSv1.2 and below
 696 only).
 697
 698 =item B<P>
 699
 700 Send some plain text down the underlying TCP connection: this should
 701 cause the client to disconnect due to a protocol violation.
 702
 703 =item B<S>
 704
 705 Print out some session cache status information.
 706
 707 =item B<k>
 708
 709 Send a key update message to the client (TLSv1.3 only)
 710
 711 =item B<K>
 712
 713 Send a key update message to the client and request one back (TLSv1.3 only)
 714
 715 =item B<c>
 716
 717 Send a certificate request to the client (TLSv1.3 only)
 718
 719 =back
 720
 721 =head1 NOTES
 722
 723 This command can be used to debug SSL clients. To accept connections
 724 from a web browser the command:
 725
 726  openssl s_server -accept 443 -www
 727
 728 can be used for example.
 729
 730 Although specifying an empty list of CAs when requesting a client certificate
 731 is strictly speaking a protocol violation, some SSL clients interpret this to
 732 mean any CA is acceptable. This is useful for debugging purposes.
 733
 734 The session parameters can printed out using the L<openssl-sess_id(1)> command.
 735
 736 =head1 BUGS
 737
 738 Because this program has a lot of options and also because some of the
 739 techniques used are rather old, the C source for this command is rather
 740 hard to read and not a model of how things should be done.
 741 A typical SSL server program would be much simpler.
 742
 743 The output of common ciphers is wrong: it just gives the list of ciphers that
 744 OpenSSL recognizes and the client supports.
 745
 746 There should be a way for this command to print out details
 747 of any unknown cipher suites a client says it supports.
 748
 749 =head1 SEE ALSO
 750
 751 L<openssl(1)>,
 752 L<openssl-sess_id(1)>,
 753 L<openssl-s_client(1)>,
 754 L<openssl-ciphers(1)>,
 755 L<SSL_CONF_cmd(3)>,
 756 L<SSL_CTX_set_max_send_fragment(3)>,
 757 L<SSL_CTX_set_split_send_fragment(3)>,
 758 L<SSL_CTX_set_max_pipelines(3)>,
 759 L<ossl_store-file(7)>
 760
 761 =head1 HISTORY
 762
 763 The -no_alt_chains option was added in OpenSSL 1.1.0.
 764
 765 The
 766 -allow-no-dhe-kex and -prioritize_chacha options were added in OpenSSL 1.1.1.
 767
 768 =head1 COPYRIGHT
 769
 770 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
 771
 772 Licensed under the Apache License 2.0 (the "License").  You may not use
 773 this file except in compliance with the License.  You can obtain a copy
 774 in the file LICENSE in the source distribution or at
 775 L<https://www.openssl.org/source/license.html>.
 776
 777 =cut