doc/man1/speed.pod

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