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