Document certificate status request options.

[openssl.git] / doc / apps / s_server.pod

diff --git a/doc/apps/s_server.pod b/doc/apps/s_server.pod
index c59aed5c8e6bed7b572fbd22ea97e28937128c6e..0ba7588ac728a1e49231f732c726a71408242df2 100644 (file)
--- a/doc/apps/s_server.pod
+++ b/doc/apps/s_server.pod
@@ -9,23 +9,58 @@ s_server - SSL/TLS server program
 
 B<openssl> B<s_server>
 [B<-accept port>]
 
 B<openssl> B<s_server>
 [B<-accept port>]

+[B<-naccept count>]

 [B<-context id>]
 [B<-verify depth>]
 [B<-Verify depth>]
 [B<-context id>]
 [B<-verify depth>]
 [B<-Verify depth>]

+[B<-crl_check>]
+[B<-crl_check_all>]

 [B<-cert filename>]
 [B<-cert filename>]

+[B<-certform DER|PEM>]

 [B<-key keyfile>]
 [B<-key keyfile>]

+[B<-keyform DER|PEM>]
+[B<-pass arg>]

 [B<-dcert filename>]
 [B<-dcert filename>]

+[B<-dcertform DER|PEM>]

 [B<-dkey keyfile>]
 [B<-dkey keyfile>]

+[B<-dkeyform DER|PEM>]
+[B<-dpass arg>]

 [B<-dhparam filename>]
 [B<-nbio>]
 [B<-nbio_test>]
 [B<-crlf>]
 [B<-debug>]
 [B<-dhparam filename>]
 [B<-nbio>]
 [B<-nbio_test>]
 [B<-crlf>]
 [B<-debug>]

+[B<-msg>]

 [B<-state>]
 [B<-CApath directory>]
 [B<-CAfile filename>]
 [B<-state>]
 [B<-CApath directory>]
 [B<-CAfile filename>]

+[B<-attime timestamp>]
+[B<-check_ss_sig>]
+[B<-explicit_policy>]
+[B<-extended_crl>]
+[B<-ignore_critical>]
+[B<-inhibit_any>]
+[B<-inhibit_map>]
+[B<-issuer_checks>]
+[B<-partial_chain>]
+[B<-policy arg>]
+[B<-policy_check>]
+[B<-policy_print>]
+[B<-purpose purpose>]
+[B<-suiteB_128>]
+[B<-suiteB_128_only>]
+[B<-suiteB_192>]
+[B<-trusted_first>]
+[B<-use_deltas>]
+[B<-verify_depth num>]
+[B<-verify_email email>]
+[B<-verify_hostname hostname>]
+[B<-verify_ip ip>]
+[B<-verify_name name>]
+[B<-x509_strict>]

 [B<-nocert>]
 [B<-cipher cipherlist>]
 [B<-nocert>]
 [B<-cipher cipherlist>]

+[B<-serverpref>]

 [B<-quiet>]
 [B<-no_tmp_rsa>]
 [B<-ssl2>]
 [B<-quiet>]
 [B<-no_tmp_rsa>]
 [B<-ssl2>]


@@ -35,13 +70,24 @@ B<openssl> B<s_server>
 [B<-no_ssl3>]
 [B<-no_tls1>]
 [B<-no_dhe>]
 [B<-no_ssl3>]
 [B<-no_tls1>]
 [B<-no_dhe>]

+[B<-no_ecdhe>]

 [B<-bugs>]
 [B<-bugs>]

+[B<-brief>]

 [B<-hack>]
 [B<-www>]
 [B<-WWW>]
 [B<-hack>]
 [B<-www>]
 [B<-WWW>]

+[B<-HTTP>]

 [B<-engine id>]
 [B<-engine id>]

+[B<-tlsextdebug>]
+[B<-no_ticket>]
+[B<-id_prefix arg>]

 [B<-rand file(s)>]
 [B<-rand file(s)>]

-
+[B<-serverinfo file>]
+[B<-no_resumption_on_reneg>]
+[B<-status>]
+[B<-status_verbose>]
+[B<-status_timeout nsec>]
+[B<-status_url url>]

 =head1 DESCRIPTION
 
 The B<s_server> command implements a generic SSL/TLS server which listens
 =head1 DESCRIPTION
 
 The B<s_server> command implements a generic SSL/TLS server which listens


@@ -49,12 +95,21 @@ for connections on a given port using SSL/TLS.
 
 =head1 OPTIONS
 
 
 =head1 OPTIONS
 

+In addition to the options below the B<s_server> utility also supports the
+common and server only options documented in the
+L<SSL_CONF_cmd(3)|SSL_CONF_cmd(3)/SUPPORTED COMMAND LINE COMMANDS> manual
+page.
+

 =over 4
 
 =item B<-accept port>
 
 the TCP port to listen on for connections. If not specified 4433 is used.
 
 =over 4
 
 =item B<-accept port>
 
 the TCP port to listen on for connections. If not specified 4433 is used.
 

+=item B<-naccept count>
+
+The server will exit after receiving B<number> connections, default unlimited. 
+

 =item B<-context id>
 
 sets the SSL context id. It can be given any string value. If this option
 =item B<-context id>
 
 sets the SSL context id. It can be given any string value. If this option


@@ -67,11 +122,24 @@ certificate and some require a certificate with a certain public key type:
 for example the DSS cipher suites require a certificate containing a DSS
 (DSA) key. If not specified then the filename "server.pem" will be used.
 
 for example the DSS cipher suites require a certificate containing a DSS
 (DSA) key. If not specified then the filename "server.pem" will be used.
 

+=item B<-certform format>
+
+The certificate format to use: DER or PEM. PEM is the default.
+

 =item B<-key keyfile>
 
 The private key to use. If not specified then the certificate file will
 be used.
 
 =item B<-key keyfile>
 
 The private key to use. If not specified then the certificate file will
 be used.
 

+=item B<-keyform format>
+
+The private format to use: DER or PEM. PEM is the default.
+
+=item B<-pass arg>
+
+the private key password source. For more information about the format of B<arg>
+see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)|openssl(1)>.
+

 =item B<-dcert filename>, B<-dkey keyname>
 
 specify an additional certificate and private key, these behave in the
 =item B<-dcert filename>, B<-dkey keyname>
 
 specify an additional certificate and private key, these behave in the


@@ -83,6 +151,10 @@ and some a DSS (DSA) key. By using RSA and DSS certificates and keys
 a server can support clients which only support RSA or DSS cipher suites
 by using an appropriate certificate.
 
 a server can support clients which only support RSA or DSS cipher suites
 by using an appropriate certificate.
 

+=item B<-dcertform format>, B<-dkeyform format>, B<-dpass arg>
+
+additional certificate and private key format and passphrase respectively.
+

 =item B<-nocert>
 
 if this option is set then no certificate is used. This restricts the
 =item B<-nocert>
 
 if this option is set then no certificate is used. This restricts the


@@ -96,11 +168,16 @@ using a set of DH parameters. If not specified then an attempt is made to
 load the parameters from the server certificate file. If this fails then
 a static set of parameters hard coded into the s_server program will be used.
 
 load the parameters from the server certificate file. If this fails then
 a static set of parameters hard coded into the s_server program will be used.
 

-=item B<-nodhe>
+=item B<-no_dhe>

 
 if this option is set then no DH parameters will be loaded effectively
 disabling the ephemeral DH cipher suites.
 
 
 if this option is set then no DH parameters will be loaded effectively
 disabling the ephemeral DH cipher suites.
 

+=item B<-no_ecdhe>
+
+if this option is set then no ECDH parameters will be loaded effectively
+disabling the ephemeral ECDH cipher suites.
+

 =item B<-no_tmp_rsa>
 
 certain export cipher suites sometimes use a temporary RSA key, this option
 =item B<-no_tmp_rsa>
 
 certain export cipher suites sometimes use a temporary RSA key, this option


@@ -114,6 +191,12 @@ the client. With the B<-verify> option a certificate is requested but the
 client does not have to send one, with the B<-Verify> option the client
 must supply a certificate or an error occurs.
 
 client does not have to send one, with the B<-Verify> option the client
 must supply a certificate or an error occurs.
 

+=item B<-crl_check>, B<-crl_check_all>
+
+Check the peer certificate has not been revoked by its CA.
+The CRL(s) are appended to the certificate file. With the B<-crl_check_all>
+option all CRLs of all CAs in the chain are checked.
+

 =item B<-CApath directory>
 
 The directory to use for client certificate verification. This directory
 =item B<-CApath directory>
 
 The directory to use for client certificate verification. This directory


@@ -127,6 +210,16 @@ and to use when attempting to build the server certificate chain. The list
 is also used in the list of acceptable client CAs passed to the client when
 a certificate is requested.
 
 is also used in the list of acceptable client CAs passed to the client when
 a certificate is requested.
 

+=item B<-attime>, B<-check_ss_sig>, B<explicit_policy>, B<-extended_crl>,
+B<-ignore_critical>, B<-inhibit_any>, B<-inhibit_map>, B<-issuer_checks>,
+B<-partial_chain>, B<-policy>, B<-policy_check>, B<-policy_print>, B<-purpose>,
+B<-suiteB_128>, B<-suiteB_128_only>, B<-suiteB_192>, B<-trusted_first>,
+B<-use_deltas>, B<-verify_depth>, B<-verify_email>, B<-verify_hostname>,
+B<-verify_ip>, B<-verify_name>, B<-x509_strict>
+
+Set different peer certificate verification options.
+See the L<B<verify>|verify(1)> manual page for details.
+

 =item B<-state>
 
 prints out the SSL session states.
 =item B<-state>
 
 prints out the SSL session states.


@@ -135,6 +228,19 @@ prints out the SSL session states.
 
 print extensive debugging information including a hex dump of all traffic.
 
 
 print extensive debugging information including a hex dump of all traffic.
 

+=item B<-msg>
+
+show all protocol messages with hex dump.
+
+=item B<-trace>
+
+show verbose trace output of protocol messages. OpenSSL needs to be compiled
+with B<enable-ssl-trace> for this option to work.
+
+=item B<-msgfile>
+
+file to send output of B<-msg> or B<-trace> to, default standard output.
+

 =item B<-nbio_test>
 
 tests non blocking I/O
 =item B<-nbio_test>
 
 tests non blocking I/O


@@ -151,6 +257,16 @@ this option translated a line feed from the terminal into CR+LF.
 
 inhibit printing of session and certificate information.
 
 
 inhibit printing of session and certificate information.
 

+=item B<-psk_hint hint>
+
+Use the PSK identity hint B<hint> when using a PSK cipher suite.
+
+=item B<-psk key>
+
+Use the PSK key B<key> when using a PSK cipher suite. The key is
+given as a hexadecimal number without leading 0x, for example -psk
+1a2b3c4d.
+

 =item B<-ssl2>, B<-ssl3>, B<-tls1>, B<-no_ssl2>, B<-no_ssl3>, B<-no_tls1>
 
 these options disable the use of certain SSL or TLS protocols. By default
 =item B<-ssl2>, B<-ssl3>, B<-tls1>, B<-no_ssl2>, B<-no_ssl3>, B<-no_tls1>
 
 these options disable the use of certain SSL or TLS protocols. By default


@@ -162,6 +278,11 @@ servers and permit them to use SSL v3, SSL v2 or TLS as appropriate.
 there are several known bug in SSL and TLS implementations. Adding this
 option enables various workarounds.
 
 there are several known bug in SSL and TLS implementations. Adding this
 option enables various workarounds.
 

+=item B<-brief>
+
+only provide a brief summary of connection parameters instead of the
+normal verbose output.
+

 =item B<-hack>
 
 this option enables a further workaround for some some early Netscape
 =item B<-hack>
 
 this option enables a further workaround for some some early Netscape


@@ -175,6 +296,18 @@ also included in the server list is used. Because the client specifies
 the preference order, the order of the server cipherlist irrelevant. See
 the B<ciphers> command for more information.
 
 the preference order, the order of the server cipherlist irrelevant. See
 the B<ciphers> command for more information.
 

+=item B<-serverpref>
+
+use the server's cipher preferences, rather than the client's preferences.
+
+=item B<-tlsextdebug>
+
+print out a hex dump of any TLS extensions received from the server.
+
+=item B<-no_ticket>
+
+disable RFC4507bis session ticket support. 
+

 =item B<-www>
 
 sends a status message back to the client when it connects. This includes
 =item B<-www>
 
 sends a status message back to the client when it connects. This includes


@@ -188,13 +321,33 @@ emulates a simple web server. Pages will be resolved relative to the
 current directory, for example if the URL https://myhost/page.html is
 requested the file ./page.html will be loaded.
 
 current directory, for example if the URL https://myhost/page.html is
 requested the file ./page.html will be loaded.
 

+=item B<-HTTP>
+
+emulates a simple web server. Pages will be resolved relative to the
+current directory, for example if the URL https://myhost/page.html is
+requested the file ./page.html will be loaded. The files loaded are
+assumed to contain a complete and correct HTTP response (lines that
+are part of the HTTP response line and headers must end with CRLF).
+
+=item B<-rev>
+
+simple test server which just reverses the text received from the client
+and sends it back to the server. Also sets B<-brief>.
+

 =item B<-engine id>
 
 =item B<-engine id>
 

-specifying an engine (by it's unique B<id> string) will cause B<s_server>
+specifying an engine (by its unique B<id> string) will cause B<s_server>

 to attempt to obtain a functional reference to the specified engine,
 thus initialising it if needed. The engine will then be set as the default
 for all available algorithms.
 
 to attempt to obtain a functional reference to the specified engine,
 thus initialising it if needed. The engine will then be set as the default
 for all available algorithms.
 

+=item B<-id_prefix arg>
+
+generate SSL/TLS session IDs prefixed by B<arg>. This is mostly useful
+for testing any SSL/TLS code (eg. proxies) that wish to deal with multiple
+servers, when each of which might be generating a unique range of session
+IDs (eg. with a certain prefix).
+

 =item B<-rand file(s)>
 
 a file or files containing random data used to seed the random number
 =item B<-rand file(s)>
 
 a file or files containing random data used to seed the random number


@@ -203,6 +356,37 @@ Multiple files can be specified separated by a OS-dependent character.
 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
 all others.
 
 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
 all others.
 

+=item B<-serverinfo file>
+
+a file containing one or more blocks of PEM data.  Each PEM block
+must encode a TLS ServerHello extension (2 bytes type, 2 bytes length,
+followed by "length" bytes of extension data).  If the client sends
+an empty TLS ClientHello extension matching the type, the corresponding
+ServerHello extension will be returned.
+
+=item B<-no_resumption_on_reneg>
+
+set SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION flag.
+
+=item B<-status>
+
+enables certificate status request support (aka OCSP stapling).
+
+=item B<-status_verbose>
+
+enables certificate status request support (aka OCSP stapling) and gives
+a verbose printout of the OCSP response.
+
+=item B<-status_timeout nsec>
+
+sets the timeout for OCSP response to B<nsec> seconds.
+
+=item B<-status_url url>
+
+sets a fallback responder URL to use if no responder URL is present in the
+server certificate. Without this option an error is returned if the server
+certificate does not contain a responder address.
+

 =back
 
 =head1 CONNECTED COMMANDS
 =back
 
 =head1 CONNECTED COMMANDS