306 lines
11 KiB
Groff
Executable File
306 lines
11 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "OPENSSL-S_TIME 1"
|
|
.TH OPENSSL-S_TIME 1 "2020-03-02" "3.0.0-dev" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
openssl\-s_time \- SSL/TLS performance timing program
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
\&\fBopenssl\fR \fBs_time\fR
|
|
[\fB\-help\fR]
|
|
[\fB\-connect\fR \fIhost\fR:\fIport\fR]
|
|
[\fB\-www\fR \fIpage\fR]
|
|
[\fB\-cert\fR \fIfilename\fR]
|
|
[\fB\-key\fR \fIfilename\fR]
|
|
[\fB\-reuse\fR]
|
|
[\fB\-new\fR]
|
|
[\fB\-verify\fR \fIdepth\fR]
|
|
[\fB\-time\fR \fIseconds\fR]
|
|
[\fB\-ssl3\fR]
|
|
[\fB\-tls1\fR]
|
|
[\fB\-tls1_1\fR]
|
|
[\fB\-tls1_2\fR]
|
|
[\fB\-tls1_3\fR]
|
|
[\fB\-bugs\fR]
|
|
[\fB\-cipher\fR \fIcipherlist\fR]
|
|
[\fB\-ciphersuites\fR \fIval\fR]
|
|
[\fB\-nameopt\fR \fIoption\fR]
|
|
[\fB\-cafile\fR \fIfile\fR]
|
|
[\fB\-CAfile\fR \fIfile\fR]
|
|
[\fB\-no\-CAfile\fR]
|
|
[\fB\-CApath\fR \fIdir\fR]
|
|
[\fB\-no\-CApath\fR]
|
|
[\fB\-CAstore\fR \fIuri\fR]
|
|
[\fB\-no\-CAstore\fR]
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
This command implements a generic \s-1SSL/TLS\s0 client which
|
|
connects to a remote host using \s-1SSL/TLS\s0. It can request a page from the server
|
|
and includes the time to transfer the payload data in its timing measurements.
|
|
It measures the number of connections within a given timeframe, the amount of
|
|
data transferred (if any), and calculates the average time spent for one
|
|
connection.
|
|
.SH "OPTIONS"
|
|
.IX Header "OPTIONS"
|
|
.IP "\fB\-help\fR" 4
|
|
.IX Item "-help"
|
|
Print out a usage message.
|
|
.IP "\fB\-connect\fR \fIhost\fR:\fIport\fR" 4
|
|
.IX Item "-connect host:port"
|
|
This specifies the host and optional port to connect to.
|
|
.IP "\fB\-www\fR \fIpage\fR" 4
|
|
.IX Item "-www page"
|
|
This specifies the page to \s-1GET\s0 from the server. A value of '/' gets the
|
|
\&\fIindex.html\fR page. If this parameter is not specified, then this command
|
|
will only perform the handshake to establish \s-1SSL\s0 connections but not transfer
|
|
any payload data.
|
|
.IP "\fB\-cert\fR \fIcertname\fR" 4
|
|
.IX Item "-cert certname"
|
|
The certificate to use, if one is requested by the server. The default is
|
|
not to use a certificate. The file is in \s-1PEM\s0 format.
|
|
.IP "\fB\-key\fR \fIkeyfile\fR" 4
|
|
.IX Item "-key keyfile"
|
|
The private key to use. If not specified then the certificate file will
|
|
be used. The file is in \s-1PEM\s0 format.
|
|
.IP "\fB\-verify\fR \fIdepth\fR" 4
|
|
.IX Item "-verify depth"
|
|
The verify depth to use. This specifies the maximum length of the
|
|
server certificate chain and turns on server certificate verification.
|
|
Currently the verify operation continues after errors so all the problems
|
|
with a certificate chain can be seen. As a side effect the connection
|
|
will never fail due to a server certificate verify failure.
|
|
.IP "\fB\-new\fR" 4
|
|
.IX Item "-new"
|
|
Performs the timing test using a new session \s-1ID\s0 for each connection.
|
|
If neither \fB\-new\fR nor \fB\-reuse\fR are specified, they are both on by default
|
|
and executed in sequence.
|
|
.IP "\fB\-reuse\fR" 4
|
|
.IX Item "-reuse"
|
|
Performs the timing test using the same session \s-1ID\s0; this can be used as a test
|
|
that session caching is working. If neither \fB\-new\fR nor \fB\-reuse\fR are
|
|
specified, they are both on by default and executed in sequence.
|
|
.IP "\fB\-bugs\fR" 4
|
|
.IX Item "-bugs"
|
|
There are several known bugs in \s-1SSL\s0 and \s-1TLS\s0 implementations. Adding this
|
|
option enables various workarounds.
|
|
.IP "\fB\-cipher\fR \fIcipherlist\fR" 4
|
|
.IX Item "-cipher cipherlist"
|
|
This allows the TLSv1.2 and below cipher list sent by the client to be modified.
|
|
This list will be combined with any TLSv1.3 ciphersuites that have been
|
|
configured. Although the server determines which cipher suite is used it should
|
|
take the first supported cipher in the list sent by the client. See
|
|
\&\fIopenssl\-ciphers\fR\|(1) for more information.
|
|
.IP "\fB\-ciphersuites\fR \fIval\fR" 4
|
|
.IX Item "-ciphersuites val"
|
|
This allows the TLSv1.3 ciphersuites sent by the client to be modified. This
|
|
list will be combined with any TLSv1.2 and below ciphersuites that have been
|
|
configured. Although the server determines which cipher suite is used it should
|
|
take the first supported cipher in the list sent by the client. See
|
|
\&\fIopenssl\-ciphers\fR\|(1) for more information. The format for this list is a
|
|
simple colon (\*(L":\*(R") separated list of TLSv1.3 ciphersuite names.
|
|
.IP "\fB\-time\fR \fIlength\fR" 4
|
|
.IX Item "-time length"
|
|
Specifies how long (in seconds) this command should establish connections
|
|
and optionally transfer payload data from a server. Server and client
|
|
performance and the link speed determine how many connections it
|
|
can establish.
|
|
.IP "\fB\-nameopt\fR \fIoption\fR" 4
|
|
.IX Item "-nameopt option"
|
|
This specifies how the subject or issuer names are displayed.
|
|
See \*(L"Name Format Options\*(R" in \fIopenssl\fR\|(1) for details.
|
|
.IP "\fB\-CAfile\fR \fIfile\fR, \fB\-no\-CAfile\fR, \fB\-CApath\fR \fIdir\fR, \fB\-no\-CApath\fR, \fB\-CAstore\fR \fIuri\fR, \fB\-no\-CAstore\fR" 4
|
|
.IX Item "-CAfile file, -no-CAfile, -CApath dir, -no-CApath, -CAstore uri, -no-CAstore"
|
|
See \*(L"Trusted Certificate Options\*(R" in \fIopenssl\fR\|(1) for details.
|
|
.IP "\fB\-cafile\fR \fIfile\fR" 4
|
|
.IX Item "-cafile file"
|
|
This is an obsolete synonym for \fB\-CAfile\fR.
|
|
.IP "\fB\-ssl3\fR, \fB\-tls1\fR, \fB\-tls1_1\fR, \fB\-tls1_2\fR, \fB\-tls1_3\fR" 4
|
|
.IX Item "-ssl3, -tls1, -tls1_1, -tls1_2, -tls1_3"
|
|
See \*(L"\s-1TLS\s0 Version Options\*(R" in \fIopenssl\fR\|(1).
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
This command can be used to measure the performance of an \s-1SSL\s0 connection.
|
|
To connect to an \s-1SSL\s0 \s-1HTTP\s0 server and get the default page the command
|
|
.PP
|
|
.Vb 1
|
|
\& openssl s_time \-connect servername:443 \-www / \-CApath yourdir \-CAfile yourfile.pem \-cipher commoncipher [\-ssl3]
|
|
.Ve
|
|
.PP
|
|
would typically be used (https uses port 443). \fIcommoncipher\fR is a cipher to
|
|
which both client and server can agree, see the \fIopenssl\-ciphers\fR\|(1) command
|
|
for details.
|
|
.PP
|
|
If the handshake fails then there are several possible causes, if it is
|
|
nothing obvious like no client certificate then the \fB\-bugs\fR and
|
|
\&\fB\-ssl3\fR options can be tried
|
|
in case it is a buggy server. In particular you should play with these
|
|
options \fBbefore\fR submitting a bug report to an OpenSSL mailing list.
|
|
.PP
|
|
A frequent problem when attempting to get client certificates working
|
|
is that a web client complains it has no certificates or gives an empty
|
|
list to choose from. This is normally because the server is not sending
|
|
the clients certificate authority in its \*(L"acceptable \s-1CA\s0 list\*(R" when it
|
|
requests a certificate. By using \fIopenssl\-s_client\fR\|(1) the \s-1CA\s0 list can be
|
|
viewed and checked. However some servers only request client authentication
|
|
after a specific \s-1URL\s0 is requested. To obtain the list in this case it
|
|
is necessary to use the \fB\-prexit\fR option of \fIopenssl\-s_client\fR\|(1) and
|
|
send an \s-1HTTP\s0 request for an appropriate page.
|
|
.PP
|
|
If a certificate is specified on the command line using the \fB\-cert\fR
|
|
option it will not be used unless the server specifically requests
|
|
a client certificate. Therefor merely including a client certificate
|
|
on the command line is no guarantee that the certificate works.
|
|
.SH "BUGS"
|
|
.IX Header "BUGS"
|
|
Because this program does not have all the options of the
|
|
\&\fIopenssl\-s_client\fR\|(1) program to turn protocols on and off, you may not
|
|
be able to measure the performance of all protocols with all servers.
|
|
.PP
|
|
The \fB\-verify\fR option should really exit if the server verification
|
|
fails.
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
The \fB\-cafile\fR option was deprecated in OpenSSL 3.0.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIopenssl\fR\|(1),
|
|
\&\fIopenssl\-s_client\fR\|(1),
|
|
\&\fIopenssl\-s_server\fR\|(1),
|
|
\&\fIopenssl\-ciphers\fR\|(1),
|
|
\&\fIossl_store\-file\fR\|(7)
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2004\-2019 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
|
<https://www.openssl.org/source/license.html>.
|