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