speed: Document the deficiencies of the command

Fixes #7032

Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/15330)
This commit is contained in:
Tomas Mraz 2021-05-18 15:23:04 +02:00
parent cf6cba90d5
commit b41ebb991e

View File

@ -30,9 +30,6 @@ B<openssl speed>
=head1 DESCRIPTION
This command is used to test the performance of cryptographic algorithms.
To see the list of supported algorithms, use C<openssl list -digest-commands>
or C<openssl list -cipher-commands> command. The global CSPRNG is denoted by
the B<rand> algorithm name.
=head1 OPTIONS
@ -55,6 +52,10 @@ If I<algo> is an AEAD cipher, then you can pass B<-aead> to benchmark a
TLS-like sequence. And if I<algo> is a multi-buffer capable cipher, e.g.
aes-128-cbc-hmac-sha1, then B<-mb> will time multi-buffer operation.
To see the algorithms supported with this option, use
C<openssl list -digest-algorithms> or C<openssl list -cipher-algorithms>
command.
=item B<-multi> I<num>
Run multiple operations in parallel.
@ -110,6 +111,15 @@ pre-compiled grand selection is tested.
=back
=head1 BUGS
The I<algorithm> can be selected only from a pre-compiled subset of things
that the C<openssl speed> command knows about. To test any additional digest
or cipher algorithm supported by OpenSSL use the C<-evp> option.
There is no way to test the speed of any additional public key algorithms
supported by third party providers with the C<openssl speed> command.
=head1 HISTORY
The B<-engine> option was deprecated in OpenSSL 3.0.