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

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