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