openssl-engine.html 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  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-engine</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="#EXAMPLES">EXAMPLES</a></li>
  16. <li><a href="#ENVIRONMENT">ENVIRONMENT</a></li>
  17. <li><a href="#SEE-ALSO">SEE ALSO</a></li>
  18. <li><a href="#HISTORY">HISTORY</a></li>
  19. <li><a href="#COPYRIGHT">COPYRIGHT</a></li>
  20. </ul>
  21. <h1 id="NAME">NAME</h1>
  22. <p>openssl-engine - load and query engines</p>
  23. <h1 id="SYNOPSIS">SYNOPSIS</h1>
  24. <p><b>openssl engine</b> [<b>-help</b>] [<b>-v</b>] [<b>-vv</b>] [<b>-vvv</b>] [<b>-vvvv</b>] [<b>-c</b>] [<b>-t</b>] [<b>-tt</b>] [<b>-pre</b> <i>command</i>] ... [<b>-post</b> <i>command</i>] ... [<i>engine</i> ...]</p>
  25. <h1 id="DESCRIPTION">DESCRIPTION</h1>
  26. <p>This command has been deprecated. Providers should be used instead of engines.</p>
  27. <p>This command is used to query the status and capabilities of the specified <i>engine</i>s. Engines may be specified before and after all other command-line flags. Only those specified are queried.</p>
  28. <h1 id="OPTIONS">OPTIONS</h1>
  29. <dl>
  30. <dt id="help"><b>-help</b></dt>
  31. <dd>
  32. <p>Display an option summary.</p>
  33. </dd>
  34. <dt id="v--vv--vvv--vvvv"><b>-v</b> <b>-vv</b> <b>-vvv</b> <b>-vvvv</b></dt>
  35. <dd>
  36. <p>Provides information about each specified engine. The first flag lists all the possible run-time control commands; the second adds a description of each command; the third adds the input flags, and the final option adds the internal input flags.</p>
  37. </dd>
  38. <dt id="c"><b>-c</b></dt>
  39. <dd>
  40. <p>Lists the capabilities of each engine.</p>
  41. </dd>
  42. <dt id="t"><b>-t</b></dt>
  43. <dd>
  44. <p>Tests if each specified engine is available, and displays the answer.</p>
  45. </dd>
  46. <dt id="tt"><b>-tt</b></dt>
  47. <dd>
  48. <p>Displays an error trace for any unavailable engine.</p>
  49. </dd>
  50. <dt id="pre-command"><b>-pre</b> <i>command</i></dt>
  51. <dd>
  52. </dd>
  53. <dt id="post-command"><b>-post</b> <i>command</i></dt>
  54. <dd>
  55. <p>Command-line configuration of engines. The <b>-pre</b> command is given to the engine before it is loaded and the <b>-post</b> command is given after the engine is loaded. The <i>command</i> is of the form <i>cmd</i>:<i>val</i> where <i>cmd</i> is the command, and <i>val</i> is the value for the command. See the example below.</p>
  56. <p>These two options are cumulative, so they may be given more than once in the same command.</p>
  57. </dd>
  58. </dl>
  59. <h1 id="EXAMPLES">EXAMPLES</h1>
  60. <p>To list all the commands available to a dynamic engine:</p>
  61. <pre><code>$ openssl engine -t -tt -vvvv dynamic
  62. (dynamic) Dynamic engine loading support
  63. [ unavailable ]
  64. SO_PATH: Specifies the path to the new ENGINE shared library
  65. (input flags): STRING
  66. NO_VCHECK: Specifies to continue even if version checking fails (boolean)
  67. (input flags): NUMERIC
  68. ID: Specifies an ENGINE id name for loading
  69. (input flags): STRING
  70. LIST_ADD: Whether to add a loaded ENGINE to the internal list (0=no,1=yes,2=mandatory)
  71. (input flags): NUMERIC
  72. DIR_LOAD: Specifies whether to load from &#39;DIR_ADD&#39; directories (0=no,1=yes,2=mandatory)
  73. (input flags): NUMERIC
  74. DIR_ADD: Adds a directory from which ENGINEs can be loaded
  75. (input flags): STRING
  76. LOAD: Load up the ENGINE specified by other settings
  77. (input flags): NO_INPUT</code></pre>
  78. <p>To list the capabilities of the <b>rsax</b> engine:</p>
  79. <pre><code>$ openssl engine -c
  80. (rsax) RSAX engine support
  81. [RSA]
  82. (dynamic) Dynamic engine loading support</code></pre>
  83. <h1 id="ENVIRONMENT">ENVIRONMENT</h1>
  84. <dl>
  85. <dt id="OPENSSL_ENGINES"><b>OPENSSL_ENGINES</b></dt>
  86. <dd>
  87. <p>The path to the engines directory.</p>
  88. </dd>
  89. </dl>
  90. <h1 id="SEE-ALSO">SEE ALSO</h1>
  91. <p><a href="../man1/openssl.html">openssl(1)</a>, <a href="../man5/config.html">config(5)</a></p>
  92. <h1 id="HISTORY">HISTORY</h1>
  93. <p>This command was deprecated in OpenSSL 3.0.</p>
  94. <h1 id="COPYRIGHT">COPYRIGHT</h1>
  95. <p>Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.</p>
  96. <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>
  97. </body>
  98. </html>