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