xref: /freebsd/secure/usr.bin/openssl/man/openssl-speed.1 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "OPENSSL-SPEED 1ossl"
OPENSSL-SPEED 1ossl "2023-09-22" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
openssl-speed - test library performance
"SYNOPSIS"
Header "SYNOPSIS" \fBopenssl speed [-help] [-elapsed] [-evp algo] [-hmac algo] [-cmac algo] [-mb] [-aead] [-multi num] [-async_jobs num] [-misalign num] [-decrypt] [-primes num] [-seconds num] [-bytes num] [-mr] [-rand files] [-writerand file] [-engine id] [-provider name] [-provider-path path] [-propquery propq] [algorithm ...]
"DESCRIPTION"
Header "DESCRIPTION" This command is used to test the performance of cryptographic algorithms.
"OPTIONS"
Header "OPTIONS"
"-help" 4
Item "-help" Print out a usage message.
"-elapsed" 4
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.
"-evp algo" 4
Item "-evp algo" Use the specified cipher or message digest algorithm via the \s-1EVP\s0 interface. If algo is an \s-1AEAD\s0 cipher, then you can pass -aead to benchmark a TLS-like sequence. And if algo is a multi-buffer capable cipher, e.g. aes-128-cbc-hmac-sha1, then -mb will time multi-buffer operation. .Sp To see the algorithms supported with this option, use \f(CW\*(C`openssl list -digest-algorithms\*(C' or \*(C`openssl list -cipher-algorithms\*(C' command.
"-multi num" 4
Item "-multi num" Run multiple operations in parallel.
"-async_jobs num" 4
Item "-async_jobs num" Enable async mode and start specified number of jobs.
"-misalign num" 4
Item "-misalign num" Misalign the buffers by the specified number of bytes.
"-hmac digest" 4
Item "-hmac digest" Time the \s-1HMAC\s0 algorithm using the specified message digest.
"-cmac cipher" 4
Item "-cmac cipher" Time the \s-1CMAC\s0 algorithm using the specified cipher e.g. \f(CW\*(C`openssl speed -cmac aes128\*(C'.
"-decrypt" 4
Item "-decrypt" Time the decryption instead of encryption. Affects only the \s-1EVP\s0 testing.
"-mb" 4
Item "-mb" Enable multi-block mode on EVP-named cipher.
"-aead" 4
Item "-aead" Benchmark EVP-named \s-1AEAD\s0 cipher in TLS-like sequence.
"-primes num" 4
Item "-primes num" Generate a num-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.
"-seconds num" 4
Item "-seconds num" Run benchmarks for num seconds.
"-bytes num" 4
Item "-bytes num" Run benchmarks on num-byte buffers. Affects ciphers, digests and the \s-1CSPRNG.\s0 The limit on the size of the buffer is \s-1INT_MAX\s0 - 64 bytes, which for a 32-bit int would be 2147483583 bytes.
"-mr" 4
Item "-mr" Produce the summary in a mechanical, machine-readable, format.
"-rand files, -writerand file" 4
Item "-rand files, -writerand file" See \*(L"Random State Options\*(R" in openssl\|(1) for details.
"-engine id" 4
Item "-engine id" See \*(L"Engine Options\*(R" in openssl\|(1). This option is deprecated.
"-provider name" 4
Item "-provider name"

0

"-provider-path path" 4
Item "-provider-path path"
"-propquery propq" 4
Item "-propquery propq"

See \*(L"Provider Options\*(R" in openssl\|(1), provider\|(7), and property\|(7).

"algorithm ..." 4
Item "algorithm ..." If any algorithm is given, then those algorithms are tested, otherwise a pre-compiled grand selection is tested.
"BUGS"
Header "BUGS" The algorithm can be selected only from a pre-compiled subset of things that the \*(C`openssl speed\*(C' command knows about. To test any additional digest or cipher algorithm supported by OpenSSL use the \*(C`-evp\*(C' 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\*(C' command.

"HISTORY"
Header "HISTORY" The -engine option was deprecated in OpenSSL 3.0.
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (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>.