doc/apps/s_time.pod

   1
   2 =pod
   3
   4 =head1 NAME
   5
   6 openssl-s_time,
   7 s_time - SSL/TLS performance timing program
   8
   9 =head1 SYNOPSIS
  10
  11 B<openssl> B<s_time>
  12 [B<-connect host:port>]
  13 [B<-www page>]
  14 [B<-cert filename>]
  15 [B<-key filename>]
  16 [B<-CApath directory>]
  17 [B<-CAfile filename>]
  18 [B<-reuse>]
  19 [B<-new>]
  20 [B<-verify depth>]
  21 [B<-nbio>]
  22 [B<-time seconds>]
  23 [B<-ssl2>]
  24 [B<-ssl3>]
  25 [B<-bugs>]
  26 [B<-cipher cipherlist>]
  27
  28 =head1 DESCRIPTION
  29
  30 The B<s_time> command implements a generic SSL/TLS client which connects to a
  31 remote host using SSL/TLS. It can request a page from the server and includes
  32 the time to transfer the payload data in its timing measurements. It measures
  33 the number of connections within a given timeframe, the amount of data
  34 transferred (if any), and calculates the average time spent for one connection.
  35
  36 =head1 OPTIONS
  37
  38 =over 4
  39
  40 =item B<-connect host:port>
  41
  42 This specifies the host and optional port to connect to.
  43
  44 =item B<-www page>
  45
  46 This specifies the page to GET from the server. A value of '/' gets the
  47 index.htm[l] page. If this parameter is not specified, then B<s_time> will only
  48 perform the handshake to establish SSL connections but not transfer any
  49 payload data.
  50
  51 =item B<-cert certname>
  52
  53 The certificate to use, if one is requested by the server. The default is
  54 not to use a certificate. The file is in PEM format.
  55
  56 =item B<-key keyfile>
  57
  58 The private key to use. If not specified then the certificate file will
  59 be used. The file is in PEM format.
  60
  61 =item B<-verify depth>
  62
  63 The verify depth to use. This specifies the maximum length of the
  64 server certificate chain and turns on server certificate verification.
  65 Currently the verify operation continues after errors so all the problems
  66 with a certificate chain can be seen. As a side effect the connection
  67 will never fail due to a server certificate verify failure.
  68
  69 =item B<-CApath directory>
  70
  71 The directory to use for server certificate verification. This directory
  72 must be in "hash format", see B<verify> for more information. These are
  73 also used when building the client certificate chain.
  74
  75 =item B<-CAfile file>
  76
  77 A file containing trusted certificates to use during server authentication
  78 and to use when attempting to build the client certificate chain.
  79
  80 =item B<-new>
  81
  82 performs the timing test using a new session ID for each connection.
  83 If neither B<-new> nor B<-reuse> are specified, they are both on by default
  84 and executed in sequence.
  85
  86 =item B<-reuse>
  87
  88 performs the timing test using the same session ID; this can be used as a test
  89 that session caching is working. If neither B<-new> nor B<-reuse> are
  90 specified, they are both on by default and executed in sequence.
  91
  92 =item B<-nbio>
  93
  94 turns on non-blocking I/O.
  95
  96 =item B<-ssl2>, B<-ssl3>
  97
  98 these options disable the use of certain SSL or TLS protocols. By default
  99 the initial handshake uses a method which should be compatible with all
 100 servers and permit them to use SSL v3, SSL v2 or TLS as appropriate.
 101 The timing program is not as rich in options to turn protocols on and off as
 102 the L<s_client(1)|s_client(1)> program and may not connect to all servers.
 103
 104 Unfortunately there are a lot of ancient and broken servers in use which
 105 cannot handle this technique and will fail to connect. Some servers only
 106 work if TLS is turned off with the B<-ssl3> option; others
 107 will only support SSL v2 and may need the B<-ssl2> option.
 108
 109 =item B<-bugs>
 110
 111 there are several known bug in SSL and TLS implementations. Adding this
 112 option enables various workarounds.
 113
 114 =item B<-cipher cipherlist>
 115
 116 this allows the cipher list sent by the client to be modified. Although
 117 the server determines which cipher suite is used it should take the first
 118 supported cipher in the list sent by the client.
 119 See the L<ciphers(1)|ciphers(1)> command for more information.
 120
 121 =item B<-time length>
 122
 123 specifies how long (in seconds) B<s_time> should establish connections and
 124 optionally transfer payload data from a server. Server and client performance
 125 and the link speed determine how many connections B<s_time> can establish.
 126
 127 =back
 128
 129 =head1 NOTES
 130
 131 B<s_time> can be used to measure the performance of an SSL connection.
 132 To connect to an SSL HTTP server and get the default page the command
 133
 134  openssl s_time -connect servername:443 -www / -CApath yourdir -CAfile yourfile.pem -cipher commoncipher [-ssl3]
 135
 136 would typically be used (https uses port 443). 'commoncipher' is a cipher to
 137 which both client and server can agree, see the L<ciphers(1)|ciphers(1)> command
 138 for details.
 139
 140 If the handshake fails then there are several possible causes, if it is
 141 nothing obvious like no client certificate then the B<-bugs>, B<-ssl2>,
 142 B<-ssl3> options can be tried
 143 in case it is a buggy server. In particular you should play with these
 144 options B<before> submitting a bug report to an OpenSSL mailing list.
 145
 146 A frequent problem when attempting to get client certificates working
 147 is that a web client complains it has no certificates or gives an empty
 148 list to choose from. This is normally because the server is not sending
 149 the clients certificate authority in its "acceptable CA list" when it
 150 requests a certificate. By using L<s_client(1)|s_client(1)> the CA list can be
 151 viewed and checked. However some servers only request client authentication
 152 after a specific URL is requested. To obtain the list in this case it
 153 is necessary to use the B<-prexit> option of L<s_client(1)|s_client(1)> and
 154 send an HTTP request for an appropriate page.
 155
 156 If a certificate is specified on the command line using the B<-cert>
 157 option it will not be used unless the server specifically requests
 158 a client certificate. Therefor merely including a client certificate
 159 on the command line is no guarantee that the certificate works.
 160
 161 =head1 BUGS
 162
 163 Because this program does not have all the options of the
 164 L<s_client(1)|s_client(1)> program to turn protocols on and off, you may not be
 165 able to measure the performance of all protocols with all servers.
 166
 167 The B<-verify> option should really exit if the server verification
 168 fails.
 169
 170 =head1 SEE ALSO
 171
 172 L<s_client(1)|s_client(1)>, L<s_server(1)|s_server(1)>, L<ciphers(1)|ciphers(1)>
 173
 174 =cut