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