doc/man1/s_time.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 s_time - SSL/TLS performance timing program
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl> B<s_time>
  10 [B<-help>]
  11 [B<-connect host:port>]
  12 [B<-www page>]
  13 [B<-cert filename>]
  14 [B<-key filename>]
  15 [B<-CApath directory>]
  16 [B<-cafile filename>]
  17 [B<-no-CAfile>]
  18 [B<-no-CApath>]
  19 [B<-reuse>]
  20 [B<-new>]
  21 [B<-verify depth>]
  22 [B<-nameopt option>]
  23 [B<-time seconds>]
  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<-help>
  41
  42 Print out a usage message.
  43
  44 =item B<-connect host:port>
  45
  46 This specifies the host and optional port to connect to.
  47
  48 =item B<-www page>
  49
  50 This specifies the page to GET from the server. A value of '/' gets the
  51 index.htm[l] page. If this parameter is not specified, then B<s_time> will only
  52 perform the handshake to establish SSL connections but not transfer any
  53 payload data.
  54
  55 =item B<-cert certname>
  56
  57 The certificate to use, if one is requested by the server. The default is
  58 not to use a certificate. The file is in PEM format.
  59
  60 =item B<-key keyfile>
  61
  62 The private key to use. If not specified then the certificate file will
  63 be used. The file is in PEM format.
  64
  65 =item B<-verify depth>
  66
  67 The verify depth to use. This specifies the maximum length of the
  68 server certificate chain and turns on server certificate verification.
  69 Currently the verify operation continues after errors so all the problems
  70 with a certificate chain can be seen. As a side effect the connection
  71 will never fail due to a server certificate verify failure.
  72
  73 =item B<-nameopt option>
  74
  75 Option which determines how the subject or issuer names are displayed. The
  76 B<option> argument can be a single option or multiple options separated by
  77 commas.  Alternatively the B<-nameopt> switch may be used more than once to
  78 set multiple options. See the L<x509(1)> manual page for details.
  79
  80 =item B<-CApath directory>
  81
  82 The directory to use for server certificate verification. This directory
  83 must be in "hash format", see B<verify> for more information. These are
  84 also used when building the client certificate chain.
  85
  86 =item B<-CAfile file>
  87
  88 A file containing trusted certificates to use during server authentication
  89 and to use when attempting to build the client certificate chain.
  90
  91 =item B<-no-CAfile>
  92
  93 Do not load the trusted CA certificates from the default file location
  94
  95 =item B<-no-CApath>
  96
  97 Do not load the trusted CA certificates from the default directory location
  98
  99 =item B<-new>
 100
 101 Performs the timing test using a new session ID for each connection.
 102 If neither B<-new> nor B<-reuse> are specified, they are both on by default
 103 and executed in sequence.
 104
 105 =item B<-reuse>
 106
 107 Performs the timing test using the same session ID; this can be used as a test
 108 that session caching is working. If neither B<-new> nor B<-reuse> are
 109 specified, they are both on by default and executed in sequence.
 110
 111 =item B<-ssl3>
 112
 113 These options disable the use of certain SSL or TLS protocols. By default
 114 the initial handshake uses a method which should be compatible with all
 115 servers and permit them to use SSL v3 or TLS as appropriate.
 116 The timing program is not as rich in options to turn protocols on and off as
 117 the L<s_client(1)> program and may not connect to all servers.
 118
 119 Unfortunately there are a lot of ancient and broken servers in use which
 120 cannot handle this technique and will fail to connect. Some servers only
 121 work if TLS is turned off with the B<-ssl3> option.
 122
 123 =item B<-bugs>
 124
 125 There are several known bug in SSL and TLS implementations. Adding this
 126 option enables various workarounds.
 127
 128 =item B<-cipher cipherlist>
 129
 130 This allows the cipher list sent by the client to be modified. Although
 131 the server determines which cipher suite is used it should take the first
 132 supported cipher in the list sent by the client.
 133 See the L<ciphers(1)> command for more information.
 134
 135 =item B<-time length>
 136
 137 Specifies how long (in seconds) B<s_time> should establish connections and
 138 optionally transfer payload data from a server. Server and client performance
 139 and the link speed determine how many connections B<s_time> can establish.
 140
 141 =back
 142
 143 =head1 NOTES
 144
 145 B<s_time> can be used to measure the performance of an SSL connection.
 146 To connect to an SSL HTTP server and get the default page the command
 147
 148  openssl s_time -connect servername:443 -www / -CApath yourdir -CAfile yourfile.pem -cipher commoncipher [-ssl3]
 149
 150 would typically be used (https uses port 443). 'commoncipher' is a cipher to
 151 which both client and server can agree, see the L<ciphers(1)> command
 152 for details.
 153
 154 If the handshake fails then there are several possible causes, if it is
 155 nothing obvious like no client certificate then the B<-bugs> and
 156 B<-ssl3> options can be tried
 157 in case it is a buggy server. In particular you should play with these
 158 options B<before> submitting a bug report to an OpenSSL mailing list.
 159
 160 A frequent problem when attempting to get client certificates working
 161 is that a web client complains it has no certificates or gives an empty
 162 list to choose from. This is normally because the server is not sending
 163 the clients certificate authority in its "acceptable CA list" when it
 164 requests a certificate. By using L<s_client(1)> the CA list can be
 165 viewed and checked. However some servers only request client authentication
 166 after a specific URL is requested. To obtain the list in this case it
 167 is necessary to use the B<-prexit> option of L<s_client(1)> and
 168 send an HTTP request for an appropriate page.
 169
 170 If a certificate is specified on the command line using the B<-cert>
 171 option it will not be used unless the server specifically requests
 172 a client certificate. Therefor merely including a client certificate
 173 on the command line is no guarantee that the certificate works.
 174
 175 =head1 BUGS
 176
 177 Because this program does not have all the options of the
 178 L<s_client(1)> program to turn protocols on and off, you may not be
 179 able to measure the performance of all protocols with all servers.
 180
 181 The B<-verify> option should really exit if the server verification
 182 fails.
 183
 184 =head1 SEE ALSO
 185
 186 L<s_client(1)>, L<s_server(1)>, L<ciphers(1)>
 187
 188 =head1 COPYRIGHT
 189
 190 Copyright 2004-2017 The OpenSSL Project Authors. All Rights Reserved.
 191
 192 Licensed under the OpenSSL license (the "License").  You may not use
 193 this file except in compliance with the License.  You can obtain a copy
 194 in the file LICENSE in the source distribution or at
 195 L<https://www.openssl.org/source/license.html>.
 196
 197 =cut