Admin Control Panel v2.0

✎ Editing: openssl-engine.html ← Back

<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>engine</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>

<ul id="index">
 <li><a href="#NAME">NAME</a></li>
 <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
 <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
 <li><a href="#OPTIONS">OPTIONS</a></li>
 <li><a href="#EXAMPLES">EXAMPLES</a></li>
 <li><a href="#ENVIRONMENT">ENVIRONMENT</a></li>
 <li><a href="#SEE-ALSO">SEE ALSO</a></li>
 <li><a href="#COPYRIGHT">COPYRIGHT</a></li>
</ul>

openssl-engine, engine - load and query engines

<h1 id="SYNOPSIS">SYNOPSIS</h1>

openssl engine [ engine... ] [-v] [-vv] [-vvv] [-vvv] [-vvv] [-c] [-t] [-tt] [-pre command] [-post command] [ engine... ]

<h1 id="DESCRIPTION">DESCRIPTION</h1>

The engine command is used to query the status and capabilities of the specified engine&#39;s. Engines may be specified before and after all other command-line flags. Only those specified are queried.

<h1 id="OPTIONS">OPTIONS</h1>

<dl>

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.

</dd>
<dt id="c">-c</dt>
<dd>

Lists the capabilities of each engine.

</dd>
<dt id="t">-t</dt>
<dd>

Tests if each specified engine is available, and displays the answer.

</dd>
<dt id="tt">-tt</dt>
<dd>

Displays an error trace for any unavailable engine.

</dd>
<dt id="pre-command">-pre command</dt>
<dd>

</dd>
<dt id="post-command">-post command</dt>
<dd>

Command-line configuration of engines. The -pre command is given to the engine before it is loaded and the -post command is given after the engine is loaded. The command is of the form cmd:val where cmd is the command, and val is the value for the command. See the example below.

</dd>
</dl>

<h1 id="EXAMPLES">EXAMPLES</h1>

To list all the commands available to a dynamic engine:

<pre><code> $ openssl engine -t -tt -vvvv dynamic
 (dynamic) Dynamic engine loading support
 [ unavailable ]
 SO_PATH: Specifies the path to the new ENGINE shared library
 (input flags): STRING
 NO_VCHECK: Specifies to continue even if version checking fails (boolean)
 (input flags): NUMERIC
 ID: Specifies an ENGINE id name for loading
 (input flags): STRING
 LIST_ADD: Whether to add a loaded ENGINE to the internal list (0=no,1=yes,2=mandatory)
 (input flags): NUMERIC
 DIR_LOAD: Specifies whether to load from &#39;DIR_ADD&#39; directories (0=no,1=yes,2=mandatory)
 (input flags): NUMERIC
 DIR_ADD: Adds a directory from which ENGINEs can be loaded
 (input flags): STRING
 LOAD: Load up the ENGINE specified by other settings
 (input flags): NO_INPUT</code></pre>

To list the capabilities of the rsax engine:

<pre><code> $ openssl engine -c
 (rsax) RSAX engine support
 [RSA]
 (dynamic) Dynamic engine loading support</code></pre>

<h1 id="ENVIRONMENT">ENVIRONMENT</h1>

<dl>

<dt id="OPENSSL_ENGINES">OPENSSL_ENGINES</dt>
<dd>

The path to the engines directory.

</dd>
</dl>

<a href="../man5/config.html">config(5)</a>

<h1 id="COPYRIGHT">COPYRIGHT</h1>

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>.

</body>

</html>

Cancel