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