284 lines
10 KiB
Groff
284 lines
10 KiB
Groff
.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
|
|
.\"
|
|
.\" 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" ''
|
|
. ds C`
|
|
. ds C'
|
|
'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 >0, 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.
|
|
.\"
|
|
.\" Avoid warning from groff about undefined register 'F'.
|
|
.de IX
|
|
..
|
|
.if !\nF .nr F 0
|
|
.if \nF>0 \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. if !\nF==2 \{\
|
|
. nr % 0
|
|
. nr F 2
|
|
. \}
|
|
.\}
|
|
.\"
|
|
.\" 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 "S_TIME 1"
|
|
.TH S_TIME 1 "2018-03-27" "1.0.2o" "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,
|
|
s_time \- SSL/TLS performance timing program
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
\&\fBopenssl\fR \fBs_time\fR
|
|
[\fB\-connect host:port\fR]
|
|
[\fB\-www page\fR]
|
|
[\fB\-cert filename\fR]
|
|
[\fB\-key filename\fR]
|
|
[\fB\-CApath directory\fR]
|
|
[\fB\-CAfile filename\fR]
|
|
[\fB\-reuse\fR]
|
|
[\fB\-new\fR]
|
|
[\fB\-verify depth\fR]
|
|
[\fB\-nbio\fR]
|
|
[\fB\-time seconds\fR]
|
|
[\fB\-ssl2\fR]
|
|
[\fB\-ssl3\fR]
|
|
[\fB\-bugs\fR]
|
|
[\fB\-cipher cipherlist\fR]
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
The \fBs_time\fR 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\-connect host:port\fR" 4
|
|
.IX Item "-connect host:port"
|
|
This specifies the host and optional port to connect to.
|
|
.IP "\fB\-www page\fR" 4
|
|
.IX Item "-www page"
|
|
This specifies the page to \s-1GET\s0 from the server. A value of '/' gets the
|
|
index.htm[l] page. If this parameter is not specified, then \fBs_time\fR will only
|
|
perform the handshake to establish \s-1SSL\s0 connections but not transfer any
|
|
payload data.
|
|
.IP "\fB\-cert certname\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 keyfile\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 depth\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\-CApath directory\fR" 4
|
|
.IX Item "-CApath directory"
|
|
The directory to use for server certificate verification. This directory
|
|
must be in \*(L"hash format\*(R", see \fBverify\fR for more information. These are
|
|
also used when building the client certificate chain.
|
|
.IP "\fB\-CAfile file\fR" 4
|
|
.IX Item "-CAfile file"
|
|
A file containing trusted certificates to use during server authentication
|
|
and to use when attempting to build the client certificate chain.
|
|
.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\-nbio\fR" 4
|
|
.IX Item "-nbio"
|
|
turns on non-blocking I/O.
|
|
.IP "\fB\-ssl2\fR, \fB\-ssl3\fR" 4
|
|
.IX Item "-ssl2, -ssl3"
|
|
these options disable the use of certain \s-1SSL\s0 or \s-1TLS\s0 protocols. By default
|
|
the initial handshake uses a method which should be compatible with all
|
|
servers and permit them to use \s-1SSL\s0 v3, \s-1SSL\s0 v2 or \s-1TLS\s0 as appropriate.
|
|
The timing program is not as rich in options to turn protocols on and off as
|
|
the \fIs_client\fR\|(1) program and may not connect to all servers.
|
|
.Sp
|
|
Unfortunately there are a lot of ancient and broken servers in use which
|
|
cannot handle this technique and will fail to connect. Some servers only
|
|
work if \s-1TLS\s0 is turned off with the \fB\-ssl3\fR option; others
|
|
will only support \s-1SSL\s0 v2 and may need the \fB\-ssl2\fR option.
|
|
.IP "\fB\-bugs\fR" 4
|
|
.IX Item "-bugs"
|
|
there are several known bug in \s-1SSL\s0 and \s-1TLS\s0 implementations. Adding this
|
|
option enables various workarounds.
|
|
.IP "\fB\-cipher cipherlist\fR" 4
|
|
.IX Item "-cipher cipherlist"
|
|
this allows the cipher list sent by the client to be modified. Although
|
|
the server determines which cipher suite is used it should take the first
|
|
supported cipher in the list sent by the client.
|
|
See the \fIciphers\fR\|(1) command for more information.
|
|
.IP "\fB\-time length\fR" 4
|
|
.IX Item "-time length"
|
|
specifies how long (in seconds) \fBs_time\fR should establish connections and
|
|
optionally transfer payload data from a server. Server and client performance
|
|
and the link speed determine how many connections \fBs_time\fR can establish.
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
\&\fBs_time\fR can be used to measure the performance of an \s-1SSL\s0 connection.
|
|
To connect to an \s-1SSL HTTP\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). 'commoncipher' is a cipher to
|
|
which both client and server can agree, see the \fIciphers\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, \fB\-ssl2\fR,
|
|
\&\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 \fIs_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 \fIs_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
|
|
\&\fIs_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 "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIs_client\fR\|(1), \fIs_server\fR\|(1), \fIciphers\fR\|(1)
|