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

183 lines
4.3 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of ENGINE</TITLE>
</HEAD><BODY>
<H1>ENGINE</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-engine, engine - load and query engines
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<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> ]
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
The <B>engine</B> command is used to query the status and capabilities
of the specified <B>engine</B>'s.
Engines may be specified before and after all other command-line flags.
Only those specified are queried.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<DL COMPACT>
<DT id="1"><B>-v</B> <B>-vv</B> <B>-vvv</B> <B>-vvvv</B><DD>
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.
<DT id="2"><B>-c</B><DD>
Lists the capabilities of each engine.
<DT id="3"><B>-t</B><DD>
Tests if each specified engine is available, and displays the answer.
<DT id="4"><B>-tt</B><DD>
Displays an error trace for any unavailable engine.
<DT id="5"><B>-pre</B> <I>command</I><DD>
<DT id="6"><B>-post</B> <I>command</I><DD>
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.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>EXAMPLES</H2>
To list all the commands available to a dynamic engine:
<P>
<PRE>
$ 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 'DIR_ADD' 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
</PRE>
<P>
To list the capabilities of the <I>rsax</I> engine:
<P>
<PRE>
$ openssl engine -c
(rsax) RSAX engine support
[RSA]
(dynamic) Dynamic engine loading support
</PRE>
<A NAME="lbAG">&nbsp;</A>
<H2>ENVIRONMENT</H2>
<DL COMPACT>
<DT id="7"><B></B><FONT SIZE="-1"><B>OPENSSL_ENGINES</B></FONT><B></B><DD>
The path to the engines directory.
</DL>
<A NAME="lbAH">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?5+config">config</A></B>(5)
<A NAME="lbAI">&nbsp;</A>
<H2>COPYRIGHT</H2>
Copyright 2016-2019 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="8"><A HREF="#lbAB">NAME</A><DD>
<DT id="9"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="10"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="11"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="12"><A HREF="#lbAF">EXAMPLES</A><DD>
<DT id="13"><A HREF="#lbAG">ENVIRONMENT</A><DD>
<DT id="14"><A HREF="#lbAH">SEE ALSO</A><DD>
<DT id="15"><A HREF="#lbAI">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:11 GMT, March 31, 2021
</BODY>
</HTML>