apps/speed.c: add 'rand' algo to enable DRBG performance measurements.
[openssl.git] / doc / man1 / speed.pod
1 =pod
2
3 =head1 NAME
4
5 speed - test library performance
6
7 =head1 SYNOPSIS
8
9 B<openssl speed>
10 [B<-help>]
11 [B<-engine id>]
12 [B<-elapsed>]
13 [B<-evp algo>]
14 [B<-decrypt>]
15 [B<-rand file...>]
16 [B<-writerand file>]
17 [B<algorithm...>]
18
19 =head1 DESCRIPTION
20
21 This command is used to test the performance of cryptographic algorithms.
22 To see the list of supported algorithms, use the I<list --digest-commands>
23 or I<list --cipher-commands> command. The global CSPRNG is denoted by
24 the I<rand> algorithm name.
25
26 =head1 OPTIONS
27
28 =over 4
29
30 =item B<-help>
31
32 Print out a usage message.
33
34 =item B<-engine id>
35
36 Specifying an engine (by its unique B<id> string) will cause B<speed>
37 to attempt to obtain a functional reference to the specified engine,
38 thus initialising it if needed. The engine will then be set as the default
39 for all available algorithms.
40
41 =item B<-elapsed>
42
43 Measure time in real time instead of CPU time. It can be useful when testing
44 speed of hardware engines.
45
46 =item B<-evp algo>
47
48 Use the specified cipher or message digest algorithm via the EVP interface.
49
50 =item B<-decrypt>
51
52 Time the decryption instead of encryption. Affects only the EVP testing.
53
54 =item B<-rand file...>
55
56 A file or files containing random data used to seed the random number
57 generator.
58 Multiple files can be specified separated by an OS-dependent character.
59 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
60 all others.
61
62 =item [B<-writerand file>]
63
64 Writes random data to the specified I<file> upon exit.
65 This can be used with a subsequent B<-rand> flag.
66
67 =item B<[zero or more test algorithms]>
68
69 If any options are given, B<speed> tests those algorithms, otherwise all of
70 the above are tested.
71
72 =back
73
74 =head1 COPYRIGHT
75
76 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
77
78 Licensed under the OpenSSL license (the "License").  You may not use
79 this file except in compliance with the License.  You can obtain a copy
80 in the file LICENSE in the source distribution or at
81 L<https://www.openssl.org/source/license.html>.
82
83 =cut