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

   1 .\" Automatically generated by Pod::Man 4.09 (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 "SPEED 1"
 132 .TH SPEED 1 "2018-11-20" "1.1.1a" "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\-speed, speed \- test library performance
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 \&\fBopenssl speed\fR
 142 [\fB\-help\fR]
 143 [\fB\-engine id\fR]
 144 [\fB\-elapsed\fR]
 145 [\fB\-evp algo\fR]
 146 [\fB\-decrypt\fR]
 147 [\fB\-rand file...\fR]
 148 [\fB\-writerand file\fR]
 149 [\fB\-primes num\fR]
 150 [\fB\-seconds num\fR]
 151 [\fB\-bytes num\fR]
 152 [\fBalgorithm...\fR]
 153 .SH "DESCRIPTION"
 154 .IX Header "DESCRIPTION"
 155 This command is used to test the performance of cryptographic algorithms.
 156 To see the list of supported algorithms, use the \fIlist \-\-digest\-commands\fR
 157 or \fIlist \-\-cipher\-commands\fR command. The global \s-1CSPRNG\s0 is denoted by
 158 the \fIrand\fR algorithm name.
 159 .SH "OPTIONS"
 160 .IX Header "OPTIONS"
 161 .IP "\fB\-help\fR" 4
 162 .IX Item "-help"
 163 Print out a usage message.
 164 .IP "\fB\-engine id\fR" 4
 165 .IX Item "-engine id"
 166 Specifying an engine (by its unique \fBid\fR string) will cause \fBspeed\fR
 167 to attempt to obtain a functional reference to the specified engine,
 168 thus initialising it if needed. The engine will then be set as the default
 169 for all available algorithms.
 170 .IP "\fB\-elapsed\fR" 4
 171 .IX Item "-elapsed"
 172 When calculating operations\- or bytes-per-second, use wall-clock time
 173 instead of \s-1CPU\s0 user time as divisor. It can be useful when testing speed
 174 of hardware engines.
 175 .IP "\fB\-evp algo\fR" 4
 176 .IX Item "-evp algo"
 177 Use the specified cipher or message digest algorithm via the \s-1EVP\s0 interface.
 178 If \fBalgo\fR is an \s-1AEAD\s0 cipher, then you can pass <\-aead> to benchmark a
 179 TLS-like sequence. And if \fBalgo\fR is a multi-buffer capable cipher, e.g.
 180 aes\-128\-cbc\-hmac\-sha1, then \fB\-mb\fR will time multi-buffer operation.
 181 .IP "\fB\-decrypt\fR" 4
 182 .IX Item "-decrypt"
 183 Time the decryption instead of encryption. Affects only the \s-1EVP\s0 testing.
 184 .IP "\fB\-rand file...\fR" 4
 185 .IX Item "-rand file..."
 186 A file or files containing random data used to seed the random number
 187 generator.
 188 Multiple files can be specified separated by an OS-dependent character.
 189 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 190 all others.
 191 .IP "[\fB\-writerand file\fR]" 4
 192 .IX Item "[-writerand file]"
 193 Writes random data to the specified \fIfile\fR upon exit.
 194 This can be used with a subsequent \fB\-rand\fR flag.
 195 .IP "\fB\-primes num\fR" 4
 196 .IX Item "-primes num"
 197 Generate a \fBnum\fR\-prime \s-1RSA\s0 key and use it to run the benchmarks. This option
 198 is only effective if \s-1RSA\s0 algorithm is specified to test.
 199 .IP "\fB\-seconds num\fR" 4
 200 .IX Item "-seconds num"
 201 Run benchmarks for \fBnum\fR seconds.
 202 .IP "\fB\-bytes num\fR" 4
 203 .IX Item "-bytes num"
 204 Run benchmarks on \fBnum\fR\-byte buffers. Affects ciphers, digests and the \s-1CSPRNG.\s0
 205 .IP "\fB[zero or more test algorithms]\fR" 4
 206 .IX Item "[zero or more test algorithms]"
 207 If any options are given, \fBspeed\fR tests those algorithms, otherwise a
 208 pre-compiled grand selection is tested.
 209 .SH "COPYRIGHT"
 210 .IX Header "COPYRIGHT"
 211 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 212 .PP
 213 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 214 this file except in compliance with the License.  You can obtain a copy
 215 in the file \s-1LICENSE\s0 in the source distribution or at
 216 <https://www.openssl.org/source/license.html>.