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

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   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 "2020-03-31" "1.1.1f" "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, s_time \- SSL/TLS performance timing program
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 \&\fBopenssl\fR \fBs_time\fR
 146 [\fB\-help\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\-no\-CAfile\fR]
 154 [\fB\-no\-CApath\fR]
 155 [\fB\-reuse\fR]
 156 [\fB\-new\fR]
 157 [\fB\-verify depth\fR]
 158 [\fB\-nameopt option\fR]
 159 [\fB\-time seconds\fR]
 160 [\fB\-ssl3\fR]
 161 [\fB\-bugs\fR]
 162 [\fB\-cipher cipherlist\fR]
 163 [\fB\-ciphersuites val\fR]
 164 .SH "DESCRIPTION"
 165 .IX Header "DESCRIPTION"
 166 The \fBs_time\fR command implements a generic \s-1SSL/TLS\s0 client which connects to a
 167 remote host using \s-1SSL/TLS.\s0 It can request a page from the server and includes
 168 the time to transfer the payload data in its timing measurements. It measures
 169 the number of connections within a given timeframe, the amount of data
 170 transferred (if any), and calculates the average time spent for one connection.
 171 .SH "OPTIONS"
 172 .IX Header "OPTIONS"
 173 .IP "\fB\-help\fR" 4
 174 .IX Item "-help"
 175 Print out a usage message.
 176 .IP "\fB\-connect host:port\fR" 4
 177 .IX Item "-connect host:port"
 178 This specifies the host and optional port to connect to.
 179 .IP "\fB\-www page\fR" 4
 180 .IX Item "-www page"
 181 This specifies the page to \s-1GET\s0 from the server. A value of '/' gets the
 182 index.htm[l] page. If this parameter is not specified, then \fBs_time\fR will only
 183 perform the handshake to establish \s-1SSL\s0 connections but not transfer any
 184 payload data.
 185 .IP "\fB\-cert certname\fR" 4
 186 .IX Item "-cert certname"
 187 The certificate to use, if one is requested by the server. The default is
 188 not to use a certificate. The file is in \s-1PEM\s0 format.
 189 .IP "\fB\-key keyfile\fR" 4
 190 .IX Item "-key keyfile"
 191 The private key to use. If not specified then the certificate file will
 192 be used. The file is in \s-1PEM\s0 format.
 193 .IP "\fB\-verify depth\fR" 4
 194 .IX Item "-verify depth"
 195 The verify depth to use. This specifies the maximum length of the
 196 server certificate chain and turns on server certificate verification.
 197 Currently the verify operation continues after errors so all the problems
 198 with a certificate chain can be seen. As a side effect the connection
 199 will never fail due to a server certificate verify failure.
 200 .IP "\fB\-nameopt option\fR" 4
 201 .IX Item "-nameopt option"
 202 Option which determines how the subject or issuer names are displayed. The
 203 \&\fBoption\fR argument can be a single option or multiple options separated by
 204 commas.  Alternatively the \fB\-nameopt\fR switch may be used more than once to
 205 set multiple options. See the \fBx509\fR\|(1) manual page for details.
 206 .IP "\fB\-CApath directory\fR" 4
 207 .IX Item "-CApath directory"
 208 The directory to use for server certificate verification. This directory
 209 must be in \*(L"hash format\*(R", see \fBverify\fR for more information. These are
 210 also used when building the client certificate chain.
 211 .IP "\fB\-CAfile file\fR" 4
 212 .IX Item "-CAfile file"
 213 A file containing trusted certificates to use during server authentication
 214 and to use when attempting to build the client certificate chain.
 215 .IP "\fB\-no\-CAfile\fR" 4
 216 .IX Item "-no-CAfile"
 217 Do not load the trusted \s-1CA\s0 certificates from the default file location
 218 .IP "\fB\-no\-CApath\fR" 4
 219 .IX Item "-no-CApath"
 220 Do not load the trusted \s-1CA\s0 certificates from the default directory location
 221 .IP "\fB\-new\fR" 4
 222 .IX Item "-new"
 223 Performs the timing test using a new session \s-1ID\s0 for each connection.
 224 If neither \fB\-new\fR nor \fB\-reuse\fR are specified, they are both on by default
 225 and executed in sequence.
 226 .IP "\fB\-reuse\fR" 4
 227 .IX Item "-reuse"
 228 Performs the timing test using the same session \s-1ID\s0; this can be used as a test
 229 that session caching is working. If neither \fB\-new\fR nor \fB\-reuse\fR are
 230 specified, they are both on by default and executed in sequence.
 231 .IP "\fB\-ssl3\fR" 4
 232 .IX Item "-ssl3"
 233 This option disables the use of \s-1SSL\s0 version 3. By default
 234 the initial handshake uses a method which should be compatible with all
 235 servers and permit them to use \s-1SSL\s0 v3 or \s-1TLS\s0 as appropriate.
 236 .Sp
 237 The timing program is not as rich in options to turn protocols on and off as
 238 the \fBs_client\fR\|(1) program and may not connect to all servers.
 239 Unfortunately there are a lot of ancient and broken servers in use which
 240 cannot handle this technique and will fail to connect. Some servers only
 241 work if \s-1TLS\s0 is turned off with the \fB\-ssl3\fR option.
 242 .Sp
 243 Note that this option may not be available, depending on how
 244 OpenSSL was built.
 245 .IP "\fB\-bugs\fR" 4
 246 .IX Item "-bugs"
 247 There are several known bugs in \s-1SSL\s0 and \s-1TLS\s0 implementations. Adding this
 248 option enables various workarounds.
 249 .IP "\fB\-cipher cipherlist\fR" 4
 250 .IX Item "-cipher cipherlist"
 251 This allows the TLSv1.2 and below cipher list sent by the client to be modified.
 252 This list will be combined with any TLSv1.3 ciphersuites that have been
 253 configured. Although the server determines which cipher suite is used it should
 254 take the first supported cipher in the list sent by the client. See
 255 \&\fBciphers\fR\|(1) for more information.
 256 .IP "\fB\-ciphersuites val\fR" 4
 257 .IX Item "-ciphersuites val"
 258 This allows the TLSv1.3 ciphersuites sent by the client to be modified. This
 259 list will be combined with any TLSv1.2 and below ciphersuites that have been
 260 configured. Although the server determines which cipher suite is used it should
 261 take the first supported cipher in the list sent by the client. See
 262 \&\fBciphers\fR\|(1) for more information. The format for this list is a simple
 263 colon (\*(L":\*(R") separated list of TLSv1.3 ciphersuite names.
 264 .IP "\fB\-time length\fR" 4
 265 .IX Item "-time length"
 266 Specifies how long (in seconds) \fBs_time\fR should establish connections and
 267 optionally transfer payload data from a server. Server and client performance
 268 and the link speed determine how many connections \fBs_time\fR can establish.
 269 .SH "NOTES"
 270 .IX Header "NOTES"
 271 \&\fBs_time\fR can be used to measure the performance of an \s-1SSL\s0 connection.
 272 To connect to an \s-1SSL HTTP\s0 server and get the default page the command
 273 .PP
 274 .Vb 1
 275 \& openssl s_time \-connect servername:443 \-www / \-CApath yourdir \-CAfile yourfile.pem \-cipher commoncipher [\-ssl3]
 276 .Ve
 277 .PP
 278 would typically be used (https uses port 443). 'commoncipher' is a cipher to
 279 which both client and server can agree, see the \fBciphers\fR\|(1) command
 280 for details.
 281 .PP
 282 If the handshake fails then there are several possible causes, if it is
 283 nothing obvious like no client certificate then the \fB\-bugs\fR and
 284 \&\fB\-ssl3\fR options can be tried
 285 in case it is a buggy server. In particular you should play with these
 286 options \fBbefore\fR submitting a bug report to an OpenSSL mailing list.
 287 .PP
 288 A frequent problem when attempting to get client certificates working
 289 is that a web client complains it has no certificates or gives an empty
 290 list to choose from. This is normally because the server is not sending
 291 the clients certificate authority in its \*(L"acceptable \s-1CA\s0 list\*(R" when it
 292 requests a certificate. By using \fBs_client\fR\|(1) the \s-1CA\s0 list can be
 293 viewed and checked. However some servers only request client authentication
 294 after a specific \s-1URL\s0 is requested. To obtain the list in this case it
 295 is necessary to use the \fB\-prexit\fR option of \fBs_client\fR\|(1) and
 296 send an \s-1HTTP\s0 request for an appropriate page.
 297 .PP
 298 If a certificate is specified on the command line using the \fB\-cert\fR
 299 option it will not be used unless the server specifically requests
 300 a client certificate. Therefor merely including a client certificate
 301 on the command line is no guarantee that the certificate works.
 302 .SH "BUGS"
 303 .IX Header "BUGS"
 304 Because this program does not have all the options of the
 305 \&\fBs_client\fR\|(1) program to turn protocols on and off, you may not be
 306 able to measure the performance of all protocols with all servers.
 307 .PP
 308 The \fB\-verify\fR option should really exit if the server verification
 309 fails.
 310 .SH "SEE ALSO"
 311 .IX Header "SEE ALSO"
 312 \&\fBs_client\fR\|(1), \fBs_server\fR\|(1), \fBciphers\fR\|(1)
 313 .SH "COPYRIGHT"
 314 .IX Header "COPYRIGHT"
 315 Copyright 2004\-2019 The OpenSSL Project Authors. All Rights Reserved.
 316 .PP
 317 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 318 this file except in compliance with the License.  You can obtain a copy
 319 in the file \s-1LICENSE\s0 in the source distribution or at
 320 <https://www.openssl.org/source/license.html>.