]>
Commit | Line | Data |
---|---|---|
b20b78b7 UM |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
3f2181e6 | 5 | openssl-speed, |
b20b78b7 UM |
6 | speed - test library performance |
7 | ||
8 | =head1 SYNOPSIS | |
9 | ||
10 | B<openssl speed> | |
0ae9e292 | 11 | [B<-help>] |
5270e702 | 12 | [B<-engine id>] |
a0474357 RS |
13 | [B<-elapsed>] |
14 | [B<-evp algo>] | |
15 | [B<-decrypt>] | |
3ee1eac2 RS |
16 | [B<-rand file...>] |
17 | [B<-writerand file>] | |
665d899f | 18 | [B<-primes num>] |
1a627771 | 19 | [B<algorithm...>] |
b20b78b7 UM |
20 | |
21 | =head1 DESCRIPTION | |
22 | ||
23 | This command is used to test the performance of cryptographic algorithms. | |
1a627771 | 24 | To see the list of supported algorithms, use the I<list --digest-commands> |
65e6b9a4 PS |
25 | or I<list --cipher-commands> command. The global CSPRNG is denoted by |
26 | the I<rand> algorithm name. | |
b20b78b7 UM |
27 | |
28 | =head1 OPTIONS | |
29 | ||
5270e702 RL |
30 | =over 4 |
31 | ||
0ae9e292 RS |
32 | =item B<-help> |
33 | ||
34 | Print out a usage message. | |
35 | ||
5270e702 RL |
36 | =item B<-engine id> |
37 | ||
c4de074e | 38 | Specifying an engine (by its unique B<id> string) will cause B<speed> |
5270e702 RL |
39 | to attempt to obtain a functional reference to the specified engine, |
40 | thus initialising it if needed. The engine will then be set as the default | |
41 | for all available algorithms. | |
42 | ||
a0474357 RS |
43 | =item B<-elapsed> |
44 | ||
45 | Measure time in real time instead of CPU time. It can be useful when testing | |
46 | speed of hardware engines. | |
47 | ||
48 | =item B<-evp algo> | |
49 | ||
50 | Use the specified cipher or message digest algorithm via the EVP interface. | |
51 | ||
52 | =item B<-decrypt> | |
53 | ||
54 | Time the decryption instead of encryption. Affects only the EVP testing. | |
55 | ||
3ee1eac2 RS |
56 | =item B<-rand file...> |
57 | ||
58 | A file or files containing random data used to seed the random number | |
59 | generator. | |
60 | Multiple files can be specified separated by an OS-dependent character. | |
61 | The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for | |
62 | all others. | |
63 | ||
64 | =item [B<-writerand file>] | |
65 | ||
66 | Writes random data to the specified I<file> upon exit. | |
67 | This can be used with a subsequent B<-rand> flag. | |
68 | ||
665d899f PY |
69 | =item B<-primes num> |
70 | ||
71 | Generate a B<num>-prime RSA key and use it to run the benchmarks. This option | |
72 | is only effective if RSA algorithm is specified to test. | |
73 | ||
64daf14d PS |
74 | =item B<-seconds num> |
75 | ||
dd07e68b | 76 | Run benchmarks for B<num> seconds. |
64daf14d PS |
77 | |
78 | =item B<-bytes num> | |
79 | ||
dd07e68b | 80 | Run benchmarks on B<num>-byte buffers. Affects ciphers, digests and the CSPRNG. |
64daf14d | 81 | |
5270e702 RL |
82 | =item B<[zero or more test algorithms]> |
83 | ||
4c0aee5a | 84 | If any options are given, B<speed> tests those algorithms, otherwise all of |
b20b78b7 UM |
85 | the above are tested. |
86 | ||
eaad02a7 LJ |
87 | =back |
88 | ||
e2f92610 RS |
89 | =head1 COPYRIGHT |
90 | ||
b0edda11 | 91 | Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved. |
e2f92610 RS |
92 | |
93 | Licensed under the OpenSSL license (the "License"). You may not use | |
94 | this file except in compliance with the License. You can obtain a copy | |
95 | in the file LICENSE in the source distribution or at | |
96 | L<https://www.openssl.org/source/license.html>. | |
97 | ||
98 | =cut |