secure/usr.bin/openssl/man/s_time.1

   1 .\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "S_TIME 1"
 132 .TH S_TIME 1 "2017-11-02" "1.0.2m" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 openssl\-s_time,
 139 s_time \- SSL/TLS performance timing program
 140 .SH "SYNOPSIS"
 141 .IX Header "SYNOPSIS"
 142 \&\fBopenssl\fR \fBs_time\fR
 143 [\fB\-connect host:port\fR]
 144 [\fB\-www page\fR]
 145 [\fB\-cert filename\fR]
 146 [\fB\-key filename\fR]
 147 [\fB\-CApath directory\fR]
 148 [\fB\-CAfile filename\fR]
 149 [\fB\-reuse\fR]
 150 [\fB\-new\fR]
 151 [\fB\-verify depth\fR]
 152 [\fB\-nbio\fR]
 153 [\fB\-time seconds\fR]
 154 [\fB\-ssl2\fR]
 155 [\fB\-ssl3\fR]
 156 [\fB\-bugs\fR]
 157 [\fB\-cipher cipherlist\fR]
 158 .SH "DESCRIPTION"
 159 .IX Header "DESCRIPTION"
 160 The \fBs_time\fR command implements a generic \s-1SSL/TLS\s0 client which connects to a
 161 remote host using \s-1SSL/TLS.\s0 It can request a page from the server and includes
 162 the time to transfer the payload data in its timing measurements. It measures
 163 the number of connections within a given timeframe, the amount of data
 164 transferred (if any), and calculates the average time spent for one connection.
 165 .SH "OPTIONS"
 166 .IX Header "OPTIONS"
 167 .IP "\fB\-connect host:port\fR" 4
 168 .IX Item "-connect host:port"
 169 This specifies the host and optional port to connect to.
 170 .IP "\fB\-www page\fR" 4
 171 .IX Item "-www page"
 172 This specifies the page to \s-1GET\s0 from the server. A value of '/' gets the
 173 index.htm[l] page. If this parameter is not specified, then \fBs_time\fR will only
 174 perform the handshake to establish \s-1SSL\s0 connections but not transfer any
 175 payload data.
 176 .IP "\fB\-cert certname\fR" 4
 177 .IX Item "-cert certname"
 178 The certificate to use, if one is requested by the server. The default is
 179 not to use a certificate. The file is in \s-1PEM\s0 format.
 180 .IP "\fB\-key keyfile\fR" 4
 181 .IX Item "-key keyfile"
 182 The private key to use. If not specified then the certificate file will
 183 be used. The file is in \s-1PEM\s0 format.
 184 .IP "\fB\-verify depth\fR" 4
 185 .IX Item "-verify depth"
 186 The verify depth to use. This specifies the maximum length of the
 187 server certificate chain and turns on server certificate verification.
 188 Currently the verify operation continues after errors so all the problems
 189 with a certificate chain can be seen. As a side effect the connection
 190 will never fail due to a server certificate verify failure.
 191 .IP "\fB\-CApath directory\fR" 4
 192 .IX Item "-CApath directory"
 193 The directory to use for server certificate verification. This directory
 194 must be in \*(L"hash format\*(R", see \fBverify\fR for more information. These are
 195 also used when building the client certificate chain.
 196 .IP "\fB\-CAfile file\fR" 4
 197 .IX Item "-CAfile file"
 198 A file containing trusted certificates to use during server authentication
 199 and to use when attempting to build the client certificate chain.
 200 .IP "\fB\-new\fR" 4
 201 .IX Item "-new"
 202 performs the timing test using a new session \s-1ID\s0 for each connection.
 203 If neither \fB\-new\fR nor \fB\-reuse\fR are specified, they are both on by default
 204 and executed in sequence.
 205 .IP "\fB\-reuse\fR" 4
 206 .IX Item "-reuse"
 207 performs the timing test using the same session \s-1ID\s0; this can be used as a test
 208 that session caching is working. If neither \fB\-new\fR nor \fB\-reuse\fR are
 209 specified, they are both on by default and executed in sequence.
 210 .IP "\fB\-nbio\fR" 4
 211 .IX Item "-nbio"
 212 turns on non-blocking I/O.
 213 .IP "\fB\-ssl2\fR, \fB\-ssl3\fR" 4
 214 .IX Item "-ssl2, -ssl3"
 215 these options disable the use of certain \s-1SSL\s0 or \s-1TLS\s0 protocols. By default
 216 the initial handshake uses a method which should be compatible with all
 217 servers and permit them to use \s-1SSL\s0 v3, \s-1SSL\s0 v2 or \s-1TLS\s0 as appropriate.
 218 The timing program is not as rich in options to turn protocols on and off as
 219 the \fIs_client\fR\|(1) program and may not connect to all servers.
 220 .Sp
 221 Unfortunately there are a lot of ancient and broken servers in use which
 222 cannot handle this technique and will fail to connect. Some servers only
 223 work if \s-1TLS\s0 is turned off with the \fB\-ssl3\fR option; others
 224 will only support \s-1SSL\s0 v2 and may need the \fB\-ssl2\fR option.
 225 .IP "\fB\-bugs\fR" 4
 226 .IX Item "-bugs"
 227 there are several known bug in \s-1SSL\s0 and \s-1TLS\s0 implementations. Adding this
 228 option enables various workarounds.
 229 .IP "\fB\-cipher cipherlist\fR" 4
 230 .IX Item "-cipher cipherlist"
 231 this allows the cipher list sent by the client to be modified. Although
 232 the server determines which cipher suite is used it should take the first
 233 supported cipher in the list sent by the client.
 234 See the \fIciphers\fR\|(1) command for more information.
 235 .IP "\fB\-time length\fR" 4
 236 .IX Item "-time length"
 237 specifies how long (in seconds) \fBs_time\fR should establish connections and
 238 optionally transfer payload data from a server. Server and client performance
 239 and the link speed determine how many connections \fBs_time\fR can establish.
 240 .SH "NOTES"
 241 .IX Header "NOTES"
 242 \&\fBs_time\fR can be used to measure the performance of an \s-1SSL\s0 connection.
 243 To connect to an \s-1SSL HTTP\s0 server and get the default page the command
 244 .PP
 245 .Vb 1
 246 \& openssl s_time \-connect servername:443 \-www / \-CApath yourdir \-CAfile yourfile.pem \-cipher commoncipher [\-ssl3]
 247 .Ve
 248 .PP
 249 would typically be used (https uses port 443). 'commoncipher' is a cipher to
 250 which both client and server can agree, see the \fIciphers\fR\|(1) command
 251 for details.
 252 .PP
 253 If the handshake fails then there are several possible causes, if it is
 254 nothing obvious like no client certificate then the \fB\-bugs\fR, \fB\-ssl2\fR,
 255 \&\fB\-ssl3\fR options can be tried
 256 in case it is a buggy server. In particular you should play with these
 257 options \fBbefore\fR submitting a bug report to an OpenSSL mailing list.
 258 .PP
 259 A frequent problem when attempting to get client certificates working
 260 is that a web client complains it has no certificates or gives an empty
 261 list to choose from. This is normally because the server is not sending
 262 the clients certificate authority in its \*(L"acceptable \s-1CA\s0 list\*(R" when it
 263 requests a certificate. By using \fIs_client\fR\|(1) the \s-1CA\s0 list can be
 264 viewed and checked. However some servers only request client authentication
 265 after a specific \s-1URL\s0 is requested. To obtain the list in this case it
 266 is necessary to use the \fB\-prexit\fR option of \fIs_client\fR\|(1) and
 267 send an \s-1HTTP\s0 request for an appropriate page.
 268 .PP
 269 If a certificate is specified on the command line using the \fB\-cert\fR
 270 option it will not be used unless the server specifically requests
 271 a client certificate. Therefor merely including a client certificate
 272 on the command line is no guarantee that the certificate works.
 273 .SH "BUGS"
 274 .IX Header "BUGS"
 275 Because this program does not have all the options of the
 276 \&\fIs_client\fR\|(1) program to turn protocols on and off, you may not be
 277 able to measure the performance of all protocols with all servers.
 278 .PP
 279 The \fB\-verify\fR option should really exit if the server verification
 280 fails.
 281 .SH "SEE ALSO"
 282 .IX Header "SEE ALSO"
 283 \&\fIs_client\fR\|(1), \fIs_server\fR\|(1), \fIciphers\fR\|(1)