man-pages/man1/speed.1ssl.html
2021-03-31 01:06:50 +01:00

140 lines
4.0 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of SPEED</TITLE>
</HEAD><BODY>
<H1>SPEED</H1>
Section: OpenSSL (1SSL)<BR>Updated: 2021-03-22<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
openssl-speed, speed - test library performance
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>openssl speed</B>
[<B>-help</B>]
[<B>-engine id</B>]
[<B>-elapsed</B>]
[<B>-evp algo</B>]
[<B>-decrypt</B>]
[<B>-rand file...</B>]
[<B>-writerand file</B>]
[<B>-primes num</B>]
[<B>-seconds num</B>]
[<B>-bytes num</B>]
[<B>algorithm...</B>]
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
This command is used to test the performance of cryptographic algorithms.
To see the list of supported algorithms, use the <I>list --digest-commands</I>
or <I>list --cipher-commands</I> command. The global <FONT SIZE="-1">CSPRNG</FONT> is denoted by
the <I>rand</I> algorithm name.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<DL COMPACT>
<DT id="1"><B>-help</B><DD>
Print out a usage message.
<DT id="2"><B>-engine id</B><DD>
Specifying an engine (by its unique <B>id</B> string) will cause <B>speed</B>
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.
<DT id="3"><B>-elapsed</B><DD>
When calculating operations- or bytes-per-second, use wall-clock time
instead of <FONT SIZE="-1">CPU</FONT> user time as divisor. It can be useful when testing speed
of hardware engines.
<DT id="4"><B>-evp algo</B><DD>
Use the specified cipher or message digest algorithm via the <FONT SIZE="-1">EVP</FONT> interface.
If <B>algo</B> is an <FONT SIZE="-1">AEAD</FONT> cipher, then you can pass &lt;-aead&gt; to benchmark a
TLS-like sequence. And if <B>algo</B> is a multi-buffer capable cipher, e.g.
aes-128-cbc-hmac-sha1, then <B>-mb</B> will time multi-buffer operation.
<DT id="5"><B>-decrypt</B><DD>
Time the decryption instead of encryption. Affects only the <FONT SIZE="-1">EVP</FONT> testing.
<DT id="6"><B>-rand file...</B><DD>
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 <B>;</B> for MS-Windows, <B>,</B> for OpenVMS, and <B>:</B> for
all others.
<DT id="7">[<B>-writerand file</B>]<DD>
Writes random data to the specified <I>file</I> upon exit.
This can be used with a subsequent <B>-rand</B> flag.
<DT id="8"><B>-primes num</B><DD>
Generate a <B>num</B>-prime <FONT SIZE="-1">RSA</FONT> key and use it to run the benchmarks. This option
is only effective if <FONT SIZE="-1">RSA</FONT> algorithm is specified to test.
<DT id="9"><B>-seconds num</B><DD>
Run benchmarks for <B>num</B> seconds.
<DT id="10"><B>-bytes num</B><DD>
Run benchmarks on <B>num</B>-byte buffers. Affects ciphers, digests and the <FONT SIZE="-1">CSPRNG.</FONT>
<DT id="11"><B>[zero or more test algorithms]</B><DD>
If any options are given, <B>speed</B> tests those algorithms, otherwise a
pre-compiled grand selection is tested.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>COPYRIGHT</H2>
Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
<P>
Licensed under the OpenSSL license (the ``License''). You may not use
this file except in compliance with the License. You can obtain a copy
in the file <FONT SIZE="-1">LICENSE</FONT> in the source distribution or at
&lt;<A HREF="https://www.openssl.org/source/license.html">https://www.openssl.org/source/license.html</A>&gt;.
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="12"><A HREF="#lbAB">NAME</A><DD>
<DT id="13"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="14"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="15"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="16"><A HREF="#lbAF">COPYRIGHT</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:27 GMT, March 31, 2021
</BODY>
</HTML>