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<-config> I<filename>]
  13 [B<-elapsed>]
  14 [B<-evp> I<algo>]
  15 [B<-hmac> I<algo>]
  16 [B<-cmac> I<algo>]
  17 [B<-mb>]
  18 [B<-aead>]
  19 [B<-kem-algorithms>]
  20 [B<-signature-algorithms>]
  21 [B<-multi> I<num>]
  22 [B<-async_jobs> I<num>]
  23 [B<-misalign> I<num>]
  24 [B<-decrypt>]
  25 [B<-primes> I<num>]
  26 [B<-seconds> I<num>]
  27 [B<-bytes> I<num>]
  28 [B<-mr>]
  29 [B<-mlock>]
  30 {- $OpenSSL::safe::opt_r_synopsis -}
  31 {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
  32 [I<algorithm> ...]
  33
  34 =head1 DESCRIPTION
  35
  36 This command is used to test the performance of cryptographic algorithms.
  37
  38 =head1 OPTIONS
  39
  40 =over 4
  41
  42 =item B<-help>
  43
  44 Print out a usage message.
  45
  46 =item B<-config> I<filename>
  47
  48 Specifies the configuration file to use.
  49 Optional; for a description of the default value,
  50 see L<openssl(1)/COMMAND SUMMARY>.
  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 To see the algorithms supported with this option, use
  66 C<openssl list -digest-algorithms> or C<openssl list -cipher-algorithms>
  67 command.
  68
  69 =item B<-multi> I<num>
  70
  71 Run multiple operations in parallel.
  72
  73 =item B<-async_jobs> I<num>
  74
  75 Enable async mode and start specified number of jobs.
  76
  77 =item B<-misalign> I<num>
  78
  79 Misalign the buffers by the specified number of bytes.
  80
  81 =item B<-hmac> I<digest>
  82
  83 Time the HMAC algorithm using the specified message digest.
  84
  85 =item B<-cmac> I<cipher>
  86
  87 Time the CMAC algorithm using the specified cipher e.g.
  88 C<openssl speed -cmac aes128>.
  89
  90 =item B<-decrypt>
  91
  92 Time the decryption instead of encryption. Affects only the EVP testing.
  93
  94 =item B<-mb>
  95
  96 Enable multi-block mode on EVP-named cipher.
  97
  98 =item B<-aead>
  99
 100 Benchmark EVP-named AEAD cipher in TLS-like sequence.
 101
 102 =item B<-kem-algorithms>
 103
 104 Benchmark KEM algorithms: key generation, encapsulation, decapsulation.
 105
 106 =item B<-signature-algorithms>
 107
 108 Benchmark signature algorithms: key generation, signature, verification.
 109
 110 =item B<-primes> I<num>
 111
 112 Generate a I<num>-prime RSA key and use it to run the benchmarks. This option
 113 is only effective if RSA algorithm is specified to test.
 114
 115 =item B<-seconds> I<num>
 116
 117 Run benchmarks for I<num> seconds.
 118
 119 =item B<-bytes> I<num>
 120
 121 Run benchmarks on I<num>-byte buffers. Affects ciphers, digests and the CSPRNG.
 122 The limit on the size of the buffer is INT_MAX - 64 bytes, which for a 32-bit
 123 int would be 2147483583 bytes.
 124
 125 =item B<-mr>
 126
 127 Produce the summary in a mechanical, machine-readable, format.
 128
 129 =item B<-mlock>
 130
 131 Lock memory into RAM for more deterministic measurements.
 132
 133 {- $OpenSSL::safe::opt_r_item -}
 134
 135 {- $OpenSSL::safe::opt_engine_item -}
 136
 137 {- $OpenSSL::safe::opt_provider_item -}
 138
 139 =item I<algorithm> ...
 140
 141 If any I<algorithm> is given, then those algorithms are tested, otherwise a
 142 pre-compiled grand selection is tested.
 143
 144 =back
 145
 146 =head1 BUGS
 147
 148 The I<algorithm> can be selected only from a pre-compiled subset of things
 149 that the C<openssl speed> command knows about. To test any additional digest
 150 or cipher algorithm supported by OpenSSL use the C<-evp> option.
 151
 152 There is no way to test the speed of any additional public key algorithms
 153 supported by third party providers with the C<openssl speed> command.
 154
 155 =head1 HISTORY
 156
 157 The B<-engine> option was deprecated in OpenSSL 3.0.
 158
 159 DSA512 was removed in OpenSSL 3.2.
 160
 161 =head1 COPYRIGHT
 162
 163 Copyright 2000-2023 The OpenSSL Project Authors. All Rights Reserved.
 164
 165 Licensed under the Apache License 2.0 (the "License").  You may not use
 166 this file except in compliance with the License.  You can obtain a copy
 167 in the file LICENSE in the source distribution or at
 168 L<https://www.openssl.org/source/license.html>.
 169
 170 =cut