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

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