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