openssl-speed.html 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213
  1. <?xml version="1.0" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <title>openssl-speed</title>
  6. <meta http-equiv="content-type" content="text/html; charset=utf-8" />
  7. <link rev="made" href="mailto:root@localhost" />
  8. </head>
  9. <body>
  10. <ul id="index">
  11. <li><a href="#NAME">NAME</a></li>
  12. <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
  13. <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
  14. <li><a href="#OPTIONS">OPTIONS</a></li>
  15. <li><a href="#BUGS">BUGS</a></li>
  16. <li><a href="#HISTORY">HISTORY</a></li>
  17. <li><a href="#COPYRIGHT">COPYRIGHT</a></li>
  18. </ul>
  19. <h1 id="NAME">NAME</h1>
  20. <p>openssl-speed - test library performance</p>
  21. <h1 id="SYNOPSIS">SYNOPSIS</h1>
  22. <p><b>openssl speed</b> [<b>-help</b>] [<b>-config</b> <i>filename</i>] [<b>-elapsed</b>] [<b>-evp</b> <i>algo</i>] [<b>-hmac</b> <i>algo</i>] [<b>-cmac</b> <i>algo</i>] [<b>-mb</b>] [<b>-aead</b>] [<b>-kem-algorithms</b>] [<b>-signature-algorithms</b>] [<b>-multi</b> <i>num</i>] [<b>-async_jobs</b> <i>num</i>] [<b>-misalign</b> <i>num</i>] [<b>-decrypt</b>] [<b>-primes</b> <i>num</i>] [<b>-seconds</b> <i>num</i>] [<b>-bytes</b> <i>num</i>] [<b>-mr</b>] [<b>-mlock</b>] [<b>-rand</b> <i>files</i>] [<b>-writerand</b> <i>file</i>] [<b>-engine</b> <i>id</i>] [<b>-provider</b> <i>name</i>] [<b>-provider-path</b> <i>path</i>] [<b>-propquery</b> <i>propq</i>] [<i>algorithm</i> ...]</p>
  23. <h1 id="DESCRIPTION">DESCRIPTION</h1>
  24. <p>This command is used to test the performance of cryptographic algorithms.</p>
  25. <h1 id="OPTIONS">OPTIONS</h1>
  26. <dl>
  27. <dt id="help"><b>-help</b></dt>
  28. <dd>
  29. <p>Print out a usage message.</p>
  30. </dd>
  31. <dt id="config-filename"><b>-config</b> <i>filename</i></dt>
  32. <dd>
  33. <p>Specifies the configuration file to use. Optional; for a description of the default value, see <a href="../man1/openssl.html">&quot;COMMAND SUMMARY&quot; in openssl(1)</a>.</p>
  34. </dd>
  35. <dt id="elapsed"><b>-elapsed</b></dt>
  36. <dd>
  37. <p>When calculating operations- or bytes-per-second, use wall-clock time instead of CPU user time as divisor. It can be useful when testing speed of hardware engines.</p>
  38. </dd>
  39. <dt id="evp-algo"><b>-evp</b> <i>algo</i></dt>
  40. <dd>
  41. <p>Use the specified cipher or message digest algorithm via the EVP interface. If <i>algo</i> is an AEAD cipher, then you can pass <b>-aead</b> to benchmark a TLS-like sequence. And if <i>algo</i> is a multi-buffer capable cipher, e.g. aes-128-cbc-hmac-sha1, then <b>-mb</b> will time multi-buffer operation.</p>
  42. <p>To see the algorithms supported with this option, use <code>openssl list -digest-algorithms</code> or <code>openssl list -cipher-algorithms</code> command.</p>
  43. </dd>
  44. <dt id="multi-num"><b>-multi</b> <i>num</i></dt>
  45. <dd>
  46. <p>Run multiple operations in parallel.</p>
  47. </dd>
  48. <dt id="async_jobs-num"><b>-async_jobs</b> <i>num</i></dt>
  49. <dd>
  50. <p>Enable async mode and start specified number of jobs.</p>
  51. </dd>
  52. <dt id="misalign-num"><b>-misalign</b> <i>num</i></dt>
  53. <dd>
  54. <p>Misalign the buffers by the specified number of bytes.</p>
  55. </dd>
  56. <dt id="hmac-digest"><b>-hmac</b> <i>digest</i></dt>
  57. <dd>
  58. <p>Time the HMAC algorithm using the specified message digest.</p>
  59. </dd>
  60. <dt id="cmac-cipher"><b>-cmac</b> <i>cipher</i></dt>
  61. <dd>
  62. <p>Time the CMAC algorithm using the specified cipher e.g. <code>openssl speed -cmac aes128</code>.</p>
  63. </dd>
  64. <dt id="decrypt"><b>-decrypt</b></dt>
  65. <dd>
  66. <p>Time the decryption instead of encryption. Affects only the EVP testing.</p>
  67. </dd>
  68. <dt id="mb"><b>-mb</b></dt>
  69. <dd>
  70. <p>Enable multi-block mode on EVP-named cipher.</p>
  71. </dd>
  72. <dt id="aead"><b>-aead</b></dt>
  73. <dd>
  74. <p>Benchmark EVP-named AEAD cipher in TLS-like sequence.</p>
  75. </dd>
  76. <dt id="kem-algorithms"><b>-kem-algorithms</b></dt>
  77. <dd>
  78. <p>Benchmark KEM algorithms: key generation, encapsulation, decapsulation.</p>
  79. </dd>
  80. <dt id="signature-algorithms"><b>-signature-algorithms</b></dt>
  81. <dd>
  82. <p>Benchmark signature algorithms: key generation, signature, verification.</p>
  83. </dd>
  84. <dt id="primes-num"><b>-primes</b> <i>num</i></dt>
  85. <dd>
  86. <p>Generate a <i>num</i>-prime RSA key and use it to run the benchmarks. This option is only effective if RSA algorithm is specified to test.</p>
  87. </dd>
  88. <dt id="seconds-num"><b>-seconds</b> <i>num</i></dt>
  89. <dd>
  90. <p>Run benchmarks for <i>num</i> seconds.</p>
  91. </dd>
  92. <dt id="bytes-num"><b>-bytes</b> <i>num</i></dt>
  93. <dd>
  94. <p>Run benchmarks on <i>num</i>-byte buffers. Affects ciphers, digests and the CSPRNG. The limit on the size of the buffer is INT_MAX - 64 bytes, which for a 32-bit int would be 2147483583 bytes.</p>
  95. </dd>
  96. <dt id="mr"><b>-mr</b></dt>
  97. <dd>
  98. <p>Produce the summary in a mechanical, machine-readable, format.</p>
  99. </dd>
  100. <dt id="mlock"><b>-mlock</b></dt>
  101. <dd>
  102. <p>Lock memory into RAM for more deterministic measurements.</p>
  103. </dd>
  104. <dt id="rand-files--writerand-file"><b>-rand</b> <i>files</i>, <b>-writerand</b> <i>file</i></dt>
  105. <dd>
  106. <p>See <a href="../man1/openssl.html">&quot;Random State Options&quot; in openssl(1)</a> for details.</p>
  107. </dd>
  108. <dt id="engine-id"><b>-engine</b> <i>id</i></dt>
  109. <dd>
  110. <p>See <a href="../man1/openssl.html">&quot;Engine Options&quot; in openssl(1)</a>. This option is deprecated.</p>
  111. </dd>
  112. <dt id="provider-name"><b>-provider</b> <i>name</i></dt>
  113. <dd>
  114. </dd>
  115. <dt id="provider-path-path"><b>-provider-path</b> <i>path</i></dt>
  116. <dd>
  117. </dd>
  118. <dt id="propquery-propq"><b>-propquery</b> <i>propq</i></dt>
  119. <dd>
  120. <p>See <a href="../man1/openssl.html">&quot;Provider Options&quot; in openssl(1)</a>, <a href="../man7/provider.html">provider(7)</a>, and <a href="../man7/property.html">property(7)</a>.</p>
  121. </dd>
  122. <dt id="algorithm"><i>algorithm</i> ...</dt>
  123. <dd>
  124. <p>If any <i>algorithm</i> is given, then those algorithms are tested, otherwise a pre-compiled grand selection is tested.</p>
  125. </dd>
  126. </dl>
  127. <h1 id="BUGS">BUGS</h1>
  128. <p>The <i>algorithm</i> can be selected only from a pre-compiled subset of things that the <code>openssl speed</code> command knows about. To test any additional digest or cipher algorithm supported by OpenSSL use the <code>-evp</code> option.</p>
  129. <p>There is no way to test the speed of any additional public key algorithms supported by third party providers with the <code>openssl speed</code> command.</p>
  130. <h1 id="HISTORY">HISTORY</h1>
  131. <p>The <b>-engine</b> option was deprecated in OpenSSL 3.0.</p>
  132. <p>DSA512 was removed in OpenSSL 3.2.</p>
  133. <h1 id="COPYRIGHT">COPYRIGHT</h1>
  134. <p>Copyright 2000-2023 The OpenSSL Project Authors. All Rights Reserved.</p>
  135. <p>Licensed under the Apache License 2.0 (the &quot;License&quot;). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <a href="https://www.openssl.org/source/license.html">https://www.openssl.org/source/license.html</a>.</p>
  136. </body>
  137. </html>