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<-elapsed>]
  13 [B<-evp> I<algo>]
  14 [B<-hmac> I<algo>]
  15 [B<-cmac> I<algo>]
  16 [B<-mb>]
  17 [B<-aead>]
  18 [B<-multi> I<num>]
  19 [B<-async_jobs> I<num>]
  20 [B<-misalign> I<num>]
  21 [B<-decrypt>]
  22 [B<-primes> I<num>]
  23 [B<-seconds> I<num>]
  24 [B<-bytes> I<num>]
  25 [B<-mr>]
  26 {- $OpenSSL::safe::opt_r_synopsis -}
  27 {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
  28 [I<algorithm> ...]
  29
  30 =head1 DESCRIPTION
  31
  32 This command is used to test the performance of cryptographic algorithms.
  33
  34 =head1 OPTIONS
  35
  36 =over 4
  37
  38 =item B<-help>
  39
  40 Print out a usage message.
  41
  42 =item B<-elapsed>
  43
  44 When calculating operations- or bytes-per-second, use wall-clock time
  45 instead of CPU user time as divisor. It can be useful when testing speed
  46 of hardware engines.
  47
  48 =item B<-evp> I<algo>
  49
  50 Use the specified cipher or message digest algorithm via the EVP interface.
  51 If I<algo> is an AEAD cipher, then you can pass B<-aead> to benchmark a
  52 TLS-like sequence. And if I<algo> is a multi-buffer capable cipher, e.g.
  53 aes-128-cbc-hmac-sha1, then B<-mb> will time multi-buffer operation.
  54
  55 To see the algorithms supported with this option, use
  56 C<openssl list -digest-algorithms> or C<openssl list -cipher-algorithms>
  57 command.
  58
  59 =item B<-multi> I<num>
  60
  61 Run multiple operations in parallel.
  62
  63 =item B<-async_jobs> I<num>
  64
  65 Enable async mode and start specified number of jobs.
  66
  67 =item B<-misalign> I<num>
  68
  69 Misalign the buffers by the specified number of bytes.
  70
  71 =item B<-hmac> I<digest>
  72
  73 Time the HMAC algorithm using the specified message digest.
  74
  75 =item B<-cmac> I<cipher>
  76
  77 Time the CMAC algorithm using the specified cipher e.g.
  78 C<openssl speed -cmac aes128>.
  79
  80 =item B<-decrypt>
  81
  82 Time the decryption instead of encryption. Affects only the EVP testing.
  83
  84 =item B<-primes> I<num>
  85
  86 Generate a I<num>-prime RSA key and use it to run the benchmarks. This option
  87 is only effective if RSA algorithm is specified to test.
  88
  89 =item B<-seconds> I<num>
  90
  91 Run benchmarks for I<num> seconds.
  92
  93 =item B<-bytes> I<num>
  94
  95 Run benchmarks on I<num>-byte buffers. Affects ciphers, digests and the CSPRNG.
  96
  97 =item B<-mr>
  98
  99 Produce the summary in a mechanical, machine-readable, format.
 100
 101 {- $OpenSSL::safe::opt_r_item -}
 102
 103 {- $OpenSSL::safe::opt_engine_item -}
 104
 105 {- $OpenSSL::safe::opt_provider_item -}
 106
 107 =item I<algorithm> ...
 108
 109 If any I<algorithm> is given, then those algorithms are tested, otherwise a
 110 pre-compiled grand selection is tested.
 111
 112 =back
 113
 114 =head1 BUGS
 115
 116 The I<algorithm> can be selected only from a pre-compiled subset of things
 117 that the C<openssl speed> command knows about. To test any additional digest
 118 or cipher algorithm supported by OpenSSL use the C<-evp> option.
 119
 120 There is no way to test the speed of any additional public key algorithms
 121 supported by third party providers with the C<openssl speed> command.
 122
 123 =head1 HISTORY
 124
 125 The B<-engine> option was deprecated in OpenSSL 3.0.
 126
 127 =head1 COPYRIGHT
 128
 129 Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
 130
 131 Licensed under the Apache License 2.0 (the "License").  You may not use
 132 this file except in compliance with the License.  You can obtain a copy
 133 in the file LICENSE in the source distribution or at
 134 L<https://www.openssl.org/source/license.html>.
 135
 136 =cut