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