summaryrefslogtreecommitdiffstats
path: root/doc/man1/openssl-speed.pod.in
diff options
context:
space:
mode:
authorTomas Mraz <tomas@openssl.org>2021-05-18 15:23:04 +0200
committerTomas Mraz <tomas@openssl.org>2021-05-19 16:03:28 +0200
commitb41ebb991e8bbce736cf73b9c3d6b7c3e208b2b0 (patch)
tree1ea656400cd40707e0332423b3d6b6c8f4dc2a96 /doc/man1/openssl-speed.pod.in
parentcf6cba90d53dca58cc41da59687ca7d1edf75458 (diff)
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)
Diffstat (limited to 'doc/man1/openssl-speed.pod.in')
-rw-r--r--doc/man1/openssl-speed.pod.in16
1 files changed, 13 insertions, 3 deletions
diff --git a/doc/man1/openssl-speed.pod.in b/doc/man1/openssl-speed.pod.in
index c834a74ebc..fc1a388a19 100644
--- a/doc/man1/openssl-speed.pod.in
+++ b/doc/man1/openssl-speed.pod.in
@@ -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.