doc/man1/openssl-s_time.pod.in

   1 =pod
   2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
   3
   4 =head1 NAME
   5
   6 openssl-s_time - SSL/TLS performance timing program
   7
   8 =head1 SYNOPSIS
   9
  10 B<openssl> B<s_time>
  11 [B<-help>]
  12 [B<-connect> I<host>:I<port>]
  13 [B<-www> I<page>]
  14 [B<-cert> I<filename>]
  15 [B<-key> I<filename>]
  16 [B<-reuse>]
  17 [B<-new>]
  18 [B<-verify> I<depth>]
  19 [B<-time> I<seconds>]
  20 [B<-ssl3>]
  21 [B<-tls1>]
  22 [B<-tls1_1>]
  23 [B<-tls1_2>]
  24 [B<-tls1_3>]
  25 [B<-bugs>]
  26 [B<-cipher> I<cipherlist>]
  27 [B<-ciphersuites> I<val>]
  28 {- $OpenSSL::safe::opt_name_synopsis -}
  29 [B<-cafile> I<file>]
  30 {- $OpenSSL::safe::opt_trust_synopsis -}
  31 {- $OpenSSL::safe::opt_provider_synopsis -}
  32
  33 =for openssl ifdef ssl3 tls1 tls1_1 tls1_2 tls1_3
  34
  35 =head1 DESCRIPTION
  36
  37 This command implements a generic SSL/TLS client which
  38 connects to a remote host using SSL/TLS. It can request a page from the server
  39 and includes the time to transfer the payload data in its timing measurements.
  40 It measures the number of connections within a given timeframe, the amount of
  41 data transferred (if any), and calculates the average time spent for one
  42 connection.
  43
  44 =head1 OPTIONS
  45
  46 =over 4
  47
  48 =item B<-help>
  49
  50 Print out a usage message.
  51
  52 =item B<-connect> I<host>:I<port>
  53
  54 This specifies the host and optional port to connect to.
  55
  56 =item B<-www> I<page>
  57
  58 This specifies the page to GET from the server. A value of '/' gets the
  59 F<index.html> page. If this parameter is not specified, then this command
  60 will only perform the handshake to establish SSL connections but not transfer
  61 any payload data.
  62
  63 =item B<-cert> I<certname>
  64
  65 The certificate to use, if one is requested by the server. The default is
  66 not to use a certificate. The file is in PEM format.
  67
  68 =item B<-key> I<keyfile>
  69
  70 The private key to use. If not specified then the certificate file will
  71 be used. The file is in PEM format.
  72
  73 =item B<-verify> I<depth>
  74
  75 The verify depth to use. This specifies the maximum length of the
  76 server certificate chain and turns on server certificate verification.
  77 Currently the verify operation continues after errors so all the problems
  78 with a certificate chain can be seen. As a side effect the connection
  79 will never fail due to a server certificate verify failure.
  80
  81 =item B<-new>
  82
  83 Performs the timing test using a new session ID for each connection.
  84 If neither B<-new> nor B<-reuse> are specified, they are both on by default
  85 and executed in sequence.
  86
  87 =item B<-reuse>
  88
  89 Performs the timing test using the same session ID; this can be used as a test
  90 that session caching is working. If neither B<-new> nor B<-reuse> are
  91 specified, they are both on by default and executed in sequence.
  92
  93 =item B<-bugs>
  94
  95 There are several known bugs in SSL and TLS implementations. Adding this
  96 option enables various workarounds.
  97
  98 =item B<-cipher> I<cipherlist>
  99
 100 This allows the TLSv1.2 and below cipher list sent by the client to be modified.
 101 This list will be combined with any TLSv1.3 ciphersuites that have been
 102 configured. Although the server determines which cipher suite is used it should
 103 take the first supported cipher in the list sent by the client. See
 104 L<openssl-ciphers(1)> for more information.
 105
 106 =item B<-ciphersuites> I<val>
 107
 108 This allows the TLSv1.3 ciphersuites sent by the client to be modified. This
 109 list will be combined with any TLSv1.2 and below ciphersuites that have been
 110 configured. Although the server determines which cipher suite is used it should
 111 take the first supported cipher in the list sent by the client. See
 112 L<openssl-ciphers(1)> for more information. The format for this list is a
 113 simple colon (":") separated list of TLSv1.3 ciphersuite names.
 114
 115 =item B<-time> I<length>
 116
 117 Specifies how long (in seconds) this command should establish connections
 118 and optionally transfer payload data from a server. Server and client
 119 performance and the link speed determine how many connections it
 120 can establish.
 121
 122 {- $OpenSSL::safe::opt_name_item -}
 123
 124 {- $OpenSSL::safe::opt_trust_item -}
 125
 126 {- $OpenSSL::safe::opt_provider_item -}
 127
 128 =item B<-cafile> I<file>
 129
 130 This is an obsolete synonym for B<-CAfile>.
 131
 132 =item B<-ssl3>, B<-tls1>, B<-tls1_1>, B<-tls1_2>, B<-tls1_3>
 133
 134 See L<openssl(1)/TLS Version Options>.
 135
 136 =back
 137
 138 =head1 NOTES
 139
 140 This command can be used to measure the performance of an SSL connection.
 141 To connect to an SSL HTTP server and get the default page the command
 142
 143  openssl s_time -connect servername:443 -www / -CApath yourdir -CAfile yourfile.pem -cipher commoncipher [-ssl3]
 144
 145 would typically be used (https uses port 443). I<commoncipher> is a cipher to
 146 which both client and server can agree, see the L<openssl-ciphers(1)> command
 147 for details.
 148
 149 If the handshake fails then there are several possible causes, if it is
 150 nothing obvious like no client certificate then the B<-bugs> and
 151 B<-ssl3> options can be tried
 152 in case it is a buggy server. In particular you should play with these
 153 options B<before> submitting a bug report to an OpenSSL mailing list.
 154
 155 A frequent problem when attempting to get client certificates working
 156 is that a web client complains it has no certificates or gives an empty
 157 list to choose from. This is normally because the server is not sending
 158 the clients certificate authority in its "acceptable CA list" when it
 159 requests a certificate. By using L<openssl-s_client(1)> the CA list can be
 160 viewed and checked. However some servers only request client authentication
 161 after a specific URL is requested. To obtain the list in this case it
 162 is necessary to use the B<-prexit> option of L<openssl-s_client(1)> and
 163 send an HTTP request for an appropriate page.
 164
 165 If a certificate is specified on the command line using the B<-cert>
 166 option it will not be used unless the server specifically requests
 167 a client certificate. Therefor merely including a client certificate
 168 on the command line is no guarantee that the certificate works.
 169
 170 =head1 BUGS
 171
 172 Because this program does not have all the options of the
 173 L<openssl-s_client(1)> program to turn protocols on and off, you may not
 174 be able to measure the performance of all protocols with all servers.
 175
 176 The B<-verify> option should really exit if the server verification
 177 fails.
 178
 179 =head1 HISTORY
 180
 181 The B<-cafile> option was deprecated in OpenSSL 3.0.
 182
 183 =head1 SEE ALSO
 184
 185 L<openssl(1)>,
 186 L<openssl-s_client(1)>,
 187 L<openssl-s_server(1)>,
 188 L<openssl-ciphers(1)>,
 189 L<ossl_store-file(7)>
 190
 191 =head1 COPYRIGHT
 192
 193 Copyright 2004-2019 The OpenSSL Project Authors. All Rights Reserved.
 194
 195 Licensed under the Apache License 2.0 (the "License").  You may not use
 196 this file except in compliance with the License.  You can obtain a copy
 197 in the file LICENSE in the source distribution or at
 198 L<https://www.openssl.org/source/license.html>.
 199
 200 =cut