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