engine.html 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  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>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="#COPYRIGHT">COPYRIGHT</a></li>
  19. </ul>
  20. <h1 id="NAME">NAME</h1>
  21. <p>openssl-engine, engine - load and query engines</p>
  22. <h1 id="SYNOPSIS">SYNOPSIS</h1>
  23. <p><b>openssl engine</b> [ <i>engine...</i> ] [<b>-v</b>] [<b>-vv</b>] [<b>-vvv</b>] [<b>-vvv</b>] [<b>-vvv</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>
  24. <h1 id="DESCRIPTION">DESCRIPTION</h1>
  25. <p>The <b>engine</b> command is used to query the status and capabilities of the specified <b>engine</b>&#39;s. Engines may be specified before and after all other command-line flags. Only those specified are queried.</p>
  26. <h1 id="OPTIONS">OPTIONS</h1>
  27. <dl>
  28. <dt id="v--vv--vvv--vvvv"><b>-v</b> <b>-vv</b> <b>-vvv</b> <b>-vvvv</b></dt>
  29. <dd>
  30. <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>
  31. </dd>
  32. <dt id="c"><b>-c</b></dt>
  33. <dd>
  34. <p>Lists the capabilities of each engine.</p>
  35. </dd>
  36. <dt id="t"><b>-t</b></dt>
  37. <dd>
  38. <p>Tests if each specified engine is available, and displays the answer.</p>
  39. </dd>
  40. <dt id="tt"><b>-tt</b></dt>
  41. <dd>
  42. <p>Displays an error trace for any unavailable engine.</p>
  43. </dd>
  44. <dt id="pre-command"><b>-pre</b> <i>command</i></dt>
  45. <dd>
  46. </dd>
  47. <dt id="post-command"><b>-post</b> <i>command</i></dt>
  48. <dd>
  49. <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:val</i> where <i>cmd</i> is the command, and <i>val</i> is the value for the command. See the example below.</p>
  50. </dd>
  51. </dl>
  52. <h1 id="EXAMPLES">EXAMPLES</h1>
  53. <p>To list all the commands available to a dynamic engine:</p>
  54. <pre><code> $ openssl engine -t -tt -vvvv dynamic
  55. (dynamic) Dynamic engine loading support
  56. [ unavailable ]
  57. SO_PATH: Specifies the path to the new ENGINE shared library
  58. (input flags): STRING
  59. NO_VCHECK: Specifies to continue even if version checking fails (boolean)
  60. (input flags): NUMERIC
  61. ID: Specifies an ENGINE id name for loading
  62. (input flags): STRING
  63. LIST_ADD: Whether to add a loaded ENGINE to the internal list (0=no,1=yes,2=mandatory)
  64. (input flags): NUMERIC
  65. DIR_LOAD: Specifies whether to load from &#39;DIR_ADD&#39; directories (0=no,1=yes,2=mandatory)
  66. (input flags): NUMERIC
  67. DIR_ADD: Adds a directory from which ENGINEs can be loaded
  68. (input flags): STRING
  69. LOAD: Load up the ENGINE specified by other settings
  70. (input flags): NO_INPUT</code></pre>
  71. <p>To list the capabilities of the <i>rsax</i> engine:</p>
  72. <pre><code> $ openssl engine -c
  73. (rsax) RSAX engine support
  74. [RSA]
  75. (dynamic) Dynamic engine loading support</code></pre>
  76. <h1 id="ENVIRONMENT">ENVIRONMENT</h1>
  77. <dl>
  78. <dt id="OPENSSL_ENGINES"><b>OPENSSL_ENGINES</b></dt>
  79. <dd>
  80. <p>The path to the engines directory.</p>
  81. </dd>
  82. </dl>
  83. <h1 id="SEE-ALSO">SEE ALSO</h1>
  84. <p><a href="../man5/config.html">config(5)</a></p>
  85. <h1 id="COPYRIGHT">COPYRIGHT</h1>
  86. <p>Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved.</p>
  87. <p>Licensed under the OpenSSL license (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>
  88. </body>
  89. </html>