Debian Codegraph @

upstream/debian-unstable/man1/openssl-speed.1ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "OPENSSL-SPEED 1SSL"
58 .TH OPENSSL-SPEED 1SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 openssl\-speed \- test library performance
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 \&\fBopenssl speed\fR
68 [\fB\-help\fR]
69 [\fB\-config\fR \fIfilename\fR]
70 [\fB\-elapsed\fR]
71 [\fB\-evp\fR \fIalgo\fR]
72 [\fB\-hmac\fR \fIalgo\fR]
73 [\fB\-cmac\fR \fIalgo\fR]
74 [\fB\-mb\fR]
75 [\fB\-aead\fR]
76 [\fB\-kem\-algorithms\fR]
77 [\fB\-signature\-algorithms\fR]
78 [\fB\-multi\fR \fInum\fR]
79 [\fB\-async_jobs\fR \fInum\fR]
80 [\fB\-misalign\fR \fInum\fR]
81 [\fB\-decrypt\fR]
82 [\fB\-primes\fR \fInum\fR]
83 [\fB\-seconds\fR \fInum\fR]
84 [\fB\-bytes\fR \fInum\fR]
85 [\fB\-mr\fR]
86 [\fB\-mlock\fR]
87 [\fB\-testmode\fR]
88 [\fB\-rand\fR \fIfiles\fR]
89 [\fB\-writerand\fR \fIfile\fR]
90 [\fB\-engine\fR \fIid\fR]
91 [\fB\-provider\fR \fIname\fR]
92 [\fB\-provider\-path\fR \fIpath\fR]
93 [\fB\-provparam\fR \fI[name:]key=value\fR]
94 [\fB\-propquery\fR \fIpropq\fR]
95 [\fIalgorithm\fR ...]
96 .SH DESCRIPTION
97 .IX Header "DESCRIPTION"
98 This command is used to test the performance of cryptographic algorithms.
99 .SH OPTIONS
100 .IX Header "OPTIONS"
101 .IP \fB\-help\fR 4
102 .IX Item "-help"
103 Print out a usage message.
104 .IP "\fB\-config\fR \fIfilename\fR" 4
105 .IX Item "-config filename"
106 Specifies the configuration file to use.
107 Optional; for a description of the default value,
108 see "COMMAND SUMMARY" in \fBopenssl\fR\|(1).
109 .IP \fB\-elapsed\fR 4
110 .IX Item "-elapsed"
111 When calculating operations\- or bytes-per-second, use wall-clock time
112 instead of CPU user time as divisor. It can be useful when testing speed
113 of hardware engines.
114 .IP "\fB\-evp\fR \fIalgo\fR" 4
115 .IX Item "-evp algo"
116 Use the specified cipher or message digest algorithm via the EVP interface.
117 If \fIalgo\fR is an AEAD cipher, then you can pass \fB\-aead\fR to benchmark a
118 TLS-like sequence. And if \fIalgo\fR is a multi-buffer capable cipher, e.g.
119 aes\-128\-cbc\-hmac\-sha1, then \fB\-mb\fR will time multi-buffer operation.
120 .Sp
121 To see the algorithms supported with this option, use
122 \&\f(CW\*(C`openssl list \-digest\-algorithms\*(C'\fR or \f(CW\*(C`openssl list \-cipher\-algorithms\*(C'\fR
123 command.
124 .IP "\fB\-multi\fR \fInum\fR" 4
125 .IX Item "-multi num"
126 Run multiple operations in parallel.
127 .IP "\fB\-async_jobs\fR \fInum\fR" 4
128 .IX Item "-async_jobs num"
129 Enable async mode and start specified number of jobs.
130 .IP "\fB\-misalign\fR \fInum\fR" 4
131 .IX Item "-misalign num"
132 Misalign the buffers by the specified number of bytes.
133 .IP "\fB\-hmac\fR \fIdigest\fR" 4
134 .IX Item "-hmac digest"
135 Time the HMAC algorithm using the specified message digest.
136 .IP "\fB\-cmac\fR \fIcipher\fR" 4
137 .IX Item "-cmac cipher"
138 Time the CMAC algorithm using the specified cipher e.g.
139 \&\f(CW\*(C`openssl speed \-cmac aes128\*(C'\fR.
140 .IP \fB\-decrypt\fR 4
141 .IX Item "-decrypt"
142 Time the decryption instead of encryption. Affects only the EVP testing.
143 .IP \fB\-mb\fR 4
144 .IX Item "-mb"
145 Enable multi-block mode on EVP-named cipher.
146 .IP \fB\-aead\fR 4
147 .IX Item "-aead"
148 Benchmark EVP-named AEAD cipher in TLS-like sequence.
149 .IP \fB\-kem\-algorithms\fR 4
150 .IX Item "-kem-algorithms"
151 Benchmark KEM algorithms: key generation, encapsulation, decapsulation.
152 .IP \fB\-signature\-algorithms\fR 4
153 .IX Item "-signature-algorithms"
154 Benchmark signature algorithms: key generation, signature, verification.
155 .IP "\fB\-primes\fR \fInum\fR" 4
156 .IX Item "-primes num"
157 Generate a \fInum\fR\-prime RSA key and use it to run the benchmarks. This option
158 is only effective if RSA algorithm is specified to test.
159 .IP "\fB\-seconds\fR \fInum\fR" 4
160 .IX Item "-seconds num"
161 Run benchmarks for \fInum\fR seconds.
162 .IP "\fB\-bytes\fR \fInum\fR" 4
163 .IX Item "-bytes num"
164 Run benchmarks on \fInum\fR\-byte buffers. Affects ciphers, digests and the CSPRNG.
165 The limit on the size of the buffer is INT_MAX \- 64 bytes, which for a 32\-bit
166 int would be 2147483583 bytes.
167 .IP \fB\-mr\fR 4
168 .IX Item "-mr"
169 Produce the summary in a mechanical, machine-readable, format.
170 .IP \fB\-mlock\fR 4
171 .IX Item "-mlock"
172 Lock memory into RAM for more deterministic measurements.
173 .IP \fB\-testmode\fR 4
174 .IX Item "-testmode"
175 Runs the speed command in testmode. Runs only 1 iteration of each algorithm test
176 regardless of any \fB\-seconds\fR value. In the event that any operation fails then
177 the speed command will return with a failure result.
178 .IP "\fB\-rand\fR \fIfiles\fR, \fB\-writerand\fR \fIfile\fR" 4
179 .IX Item "-rand files, -writerand file"
180 See "Random State Options" in \fBopenssl\fR\|(1) for details.
181 .IP "\fB\-engine\fR \fIid\fR" 4
182 .IX Item "-engine id"
183 See "Engine Options" in \fBopenssl\fR\|(1).
184 This option is deprecated.
185 .IP "\fB\-provider\fR \fIname\fR" 4
186 .IX Item "-provider name"
187 .PD 0
188 .IP "\fB\-provider\-path\fR \fIpath\fR" 4
189 .IX Item "-provider-path path"
190 .IP "\fB\-provparam\fR \fI[name:]key=value\fR" 4
191 .IX Item "-provparam [name:]key=value"
192 .IP "\fB\-propquery\fR \fIpropq\fR" 4
193 .IX Item "-propquery propq"
194 .PD
195 See "Provider Options" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7).
196 .IP "\fIalgorithm\fR ..." 4
197 .IX Item "algorithm ..."
198 If any \fIalgorithm\fR is given, then those algorithms are tested, otherwise a
199 pre-compiled grand selection is tested.
200 .SH BUGS
201 .IX Header "BUGS"
202 The \fIalgorithm\fR can be selected only from a pre-compiled subset of things
203 that the \f(CW\*(C`openssl speed\*(C'\fR command knows about. To test any additional digest
204 or cipher algorithm supported by OpenSSL use the \f(CW\*(C`\-evp\*(C'\fR option.
205 .PP
206 There is no way to test the speed of any additional public key algorithms
207 supported by third party providers with the \f(CW\*(C`openssl speed\*(C'\fR command.
208 .SH HISTORY
209 .IX Header "HISTORY"
210 The \fB\-engine\fR option was deprecated in OpenSSL 3.0.
211 .PP
212 DSA512 was removed in OpenSSL 3.2.
213 .PP
214 The \fB\-testmode\fR option was added in OpenSSL 3.4.
215 .SH COPYRIGHT
216 .IX Header "COPYRIGHT"
217 Copyright 2000\-2024 The OpenSSL Project Authors. All Rights Reserved.
218 .PP
219 Licensed under the Apache License 2.0 (the "License"). You may not use
220 this file except in compliance with the License. You can obtain a copy
221 in the file LICENSE in the source distribution or at
222 <https://www.openssl.org/source/license.html>.