1cb4494e760dfa95437a0258eae168ad6a15755b
[openssl.git] / doc / man1 / speed.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-speed,
6 speed - test library performance
7
8 =head1 SYNOPSIS
9
10 B<openssl speed>
11 [B<-help>]
12 [B<-engine id>]
13 [B<-elapsed>]
14 [B<-evp algo>]
15 [B<-hmac algo>]
16 [B<-cmac algo>]
17 [B<-decrypt>]
18 [B<-rand file...>]
19 [B<-writerand file>]
20 [B<-primes num>]
21 [B<-seconds num>]
22 [B<-bytes num>]
23 [B<algorithm...>]
24
25 =head1 DESCRIPTION
26
27 This command is used to test the performance of cryptographic algorithms.
28 To see the list of supported algorithms, use the I<list --digest-commands>
29 or I<list --cipher-commands> command. The global CSPRNG is denoted by
30 the I<rand> algorithm name.
31
32 =head1 OPTIONS
33
34 =over 4
35
36 =item B<-help>
37
38 Print out a usage message.
39
40 =item B<-engine id>
41
42 Specifying an engine (by its unique B<id> string) will cause B<speed>
43 to attempt to obtain a functional reference to the specified engine,
44 thus initialising it if needed. The engine will then be set as the default
45 for all available algorithms.
46
47 =item B<-elapsed>
48
49 When calculating operations- or bytes-per-second, use wall-clock time
50 instead of CPU user time as divisor. It can be useful when testing speed
51 of hardware engines.
52
53 =item B<-evp algo>
54
55 Use the specified cipher or message digest algorithm via the EVP interface.
56 If B<algo> is an AEAD cipher, then you can pass <-aead> to benchmark a
57 TLS-like sequence. And if B<algo> is a multi-buffer capable cipher, e.g.
58 aes-128-cbc-hmac-sha1, then B<-mb> will time multi-buffer operation.
59
60 =item B<-hmac digest>
61
62 Time the HMAC algorithm using the specified message digest.
63
64 =item B<-cmac cipher>
65
66 Time the CMAC algorithm using the specified cipher e.g. B<speed -cmac aes128>.
67
68 =item B<-decrypt>
69
70 Time the decryption instead of encryption. Affects only the EVP testing.
71
72 =item B<-rand file...>
73
74 A file or files containing random data used to seed the random number
75 generator.
76 Multiple files can be specified separated by an OS-dependent character.
77 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
78 all others.
79
80 =item [B<-writerand file>]
81
82 Writes random data to the specified I<file> upon exit.
83 This can be used with a subsequent B<-rand> flag.
84
85 =item B<-primes num>
86
87 Generate a B<num>-prime RSA key and use it to run the benchmarks. This option
88 is only effective if RSA algorithm is specified to test.
89
90 =item B<-seconds num>
91
92 Run benchmarks for B<num> seconds.
93
94 =item B<-bytes num>
95
96 Run benchmarks on B<num>-byte buffers. Affects ciphers, digests and the CSPRNG.
97
98 =item B<[zero or more test algorithms]>
99
100 If any options are given, B<speed> tests those algorithms, otherwise a
101 pre-compiled grand selection is tested.
102
103 =back
104
105 =head1 COPYRIGHT
106
107 Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
108
109 Licensed under the Apache License 2.0 (the "License").  You may not use
110 this file except in compliance with the License.  You can obtain a copy
111 in the file LICENSE in the source distribution or at
112 L<https://www.openssl.org/source/license.html>.
113
114 =cut