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

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