summaryrefslogtreecommitdiff
path: root/secure/usr.bin/openssl/man/speed.1
diff options
context:
space:
mode:
Diffstat (limited to 'secure/usr.bin/openssl/man/speed.1')
-rw-r--r--secure/usr.bin/openssl/man/speed.195
1 files changed, 64 insertions, 31 deletions
diff --git a/secure/usr.bin/openssl/man/speed.1 b/secure/usr.bin/openssl/man/speed.1
index d249db4ab7e1..1a20ee8b9c07 100644
--- a/secure/usr.bin/openssl/man/speed.1
+++ b/secure/usr.bin/openssl/man/speed.1
@@ -129,55 +129,88 @@
.\" ========================================================================
.\"
.IX Title "SPEED 1"
-.TH SPEED 1 "2018-08-14" "1.0.2p" "OpenSSL"
+.TH SPEED 1 "2018-09-11" "1.1.1" "OpenSSL"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
-openssl\-speed,
-speed \- test library performance
+openssl\-speed, speed \- test library performance
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBopenssl speed\fR
+[\fB\-help\fR]
[\fB\-engine id\fR]
-[\fBmd2\fR]
-[\fBmdc2\fR]
-[\fBmd5\fR]
-[\fBhmac\fR]
-[\fBsha1\fR]
-[\fBrmd160\fR]
-[\fBidea-cbc\fR]
-[\fBrc2\-cbc\fR]
-[\fBrc5\-cbc\fR]
-[\fBbf-cbc\fR]
-[\fBdes-cbc\fR]
-[\fBdes\-ede3\fR]
-[\fBrc4\fR]
-[\fBrsa512\fR]
-[\fBrsa1024\fR]
-[\fBrsa2048\fR]
-[\fBrsa4096\fR]
-[\fBdsa512\fR]
-[\fBdsa1024\fR]
-[\fBdsa2048\fR]
-[\fBidea\fR]
-[\fBrc2\fR]
-[\fBdes\fR]
-[\fBrsa\fR]
-[\fBblowfish\fR]
+[\fB\-elapsed\fR]
+[\fB\-evp algo\fR]
+[\fB\-decrypt\fR]
+[\fB\-rand file...\fR]
+[\fB\-writerand file\fR]
+[\fB\-primes num\fR]
+[\fB\-seconds num\fR]
+[\fB\-bytes num\fR]
+[\fBalgorithm...\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This command is used to test the performance of cryptographic algorithms.
+To see the list of supported algorithms, use the \fIlist \-\-digest\-commands\fR
+or \fIlist \-\-cipher\-commands\fR command. The global \s-1CSPRNG\s0 is denoted by
+the \fIrand\fR algorithm name.
.SH "OPTIONS"
.IX Header "OPTIONS"
+.IP "\fB\-help\fR" 4
+.IX Item "-help"
+Print out a usage message.
.IP "\fB\-engine id\fR" 4
.IX Item "-engine id"
-specifying an engine (by its unique \fBid\fR string) will cause \fBspeed\fR
+Specifying an engine (by its unique \fBid\fR string) will cause \fBspeed\fR
to attempt to obtain a functional reference to the specified engine,
thus initialising it if needed. The engine will then be set as the default
for all available algorithms.
+.IP "\fB\-elapsed\fR" 4
+.IX Item "-elapsed"
+When calculating operations\- or bytes-per-second, use wall-clock time
+instead of \s-1CPU\s0 user time as divisor. It can be useful when testing speed
+of hardware engines.
+.IP "\fB\-evp algo\fR" 4
+.IX Item "-evp algo"
+Use the specified cipher or message digest algorithm via the \s-1EVP\s0 interface.
+If \fBalgo\fR is an \s-1AEAD\s0 cipher, then you can pass <\-aead> to benchmark a
+TLS-like sequence. And if \fBalgo\fR is a multi-buffer capable cipher, e.g.
+aes\-128\-cbc\-hmac\-sha1, then \fB\-mb\fR will time multi-buffer operation.
+.IP "\fB\-decrypt\fR" 4
+.IX Item "-decrypt"
+Time the decryption instead of encryption. Affects only the \s-1EVP\s0 testing.
+.IP "\fB\-rand file...\fR" 4
+.IX Item "-rand file..."
+A file or files containing random data used to seed the random number
+generator.
+Multiple files can be specified separated by an OS-dependent character.
+The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
+all others.
+.IP "[\fB\-writerand file\fR]" 4
+.IX Item "[-writerand file]"
+Writes random data to the specified \fIfile\fR upon exit.
+This can be used with a subsequent \fB\-rand\fR flag.
+.IP "\fB\-primes num\fR" 4
+.IX Item "-primes num"
+Generate a \fBnum\fR\-prime \s-1RSA\s0 key and use it to run the benchmarks. This option
+is only effective if \s-1RSA\s0 algorithm is specified to test.
+.IP "\fB\-seconds num\fR" 4
+.IX Item "-seconds num"
+Run benchmarks for \fBnum\fR seconds.
+.IP "\fB\-bytes num\fR" 4
+.IX Item "-bytes num"
+Run benchmarks on \fBnum\fR\-byte buffers. Affects ciphers, digests and the \s-1CSPRNG.\s0
.IP "\fB[zero or more test algorithms]\fR" 4
.IX Item "[zero or more test algorithms]"
-If any options are given, \fBspeed\fR tests those algorithms, otherwise all of
-the above are tested.
+If any options are given, \fBspeed\fR tests those algorithms, otherwise a
+pre-compiled grand selection is tested.
+.SH "COPYRIGHT"
+.IX Header "COPYRIGHT"
+Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
+.PP
+Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
+this file except in compliance with the License. You can obtain a copy
+in the file \s-1LICENSE\s0 in the source distribution or at
+<https://www.openssl.org/source/license.html>.