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