Debian Codegraph @

upstream/debian-unstable/man1/openssl-engine.1ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "OPENSSL-ENGINE 1SSL"
58 .TH OPENSSL-ENGINE 1SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 openssl\-engine \- load and query engines
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 \&\fBopenssl engine\fR
68 [\fB\-help\fR]
69 [\fB\-v\fR]
70 [\fB\-vv\fR]
71 [\fB\-vvv\fR]
72 [\fB\-vvvv\fR]
73 [\fB\-c\fR]
74 [\fB\-t\fR]
75 [\fB\-tt\fR]
76 [\fB\-pre\fR \fIcommand\fR] ...
77 [\fB\-post\fR \fIcommand\fR] ...
78 [\fIengine\fR ...]
79 .SH DESCRIPTION
80 .IX Header "DESCRIPTION"
81 This command has been deprecated. Providers should be used instead of engines.
82 .PP
83 This command is used to query the status and capabilities
84 of the specified \fIengine\fRs.
85 Engines may be specified before and after all other command-line flags.
86 Only those specified are queried.
87 .SH OPTIONS
88 .IX Header "OPTIONS"
89 .IP \fB\-help\fR 4
90 .IX Item "-help"
91 Display an option summary.
92 .IP "\fB\-v\fR \fB\-vv\fR \fB\-vvv\fR \fB\-vvvv\fR" 4
93 .IX Item "-v -vv -vvv -vvvv"
94 Provides information about each specified engine. The first flag lists
95 all the possible run-time control commands; the second adds a
96 description of each command; the third adds the input flags, and the
97 final option adds the internal input flags.
98 .IP \fB\-c\fR 4
99 .IX Item "-c"
100 Lists the capabilities of each engine.
101 .IP \fB\-t\fR 4
102 .IX Item "-t"
103 Tests if each specified engine is available, and displays the answer.
104 .IP \fB\-tt\fR 4
105 .IX Item "-tt"
106 Displays an error trace for any unavailable engine.
107 .IP "\fB\-pre\fR \fIcommand\fR" 4
108 .IX Item "-pre command"
109 .PD 0
110 .IP "\fB\-post\fR \fIcommand\fR" 4
111 .IX Item "-post command"
112 .PD
113 Command-line configuration of engines.
114 The \fB\-pre\fR command is given to the engine before it is loaded and
115 the \fB\-post\fR command is given after the engine is loaded.
116 The \fIcommand\fR is of the form \fIcmd\fR:\fIval\fR where \fIcmd\fR is the command,
117 and \fIval\fR is the value for the command.
118 See the example below.
119 .Sp
120 These two options are cumulative, so they may be given more than once in the
121 same command.
122 .SH EXAMPLES
123 .IX Header "EXAMPLES"
124 To list all the commands available to a dynamic engine:
125 .PP
126 .Vb 10
127 \& $ openssl engine \-t \-tt \-vvvv dynamic
128 \& (dynamic) Dynamic engine loading support
129 \& [ unavailable ]
130 \& SO_PATH: Specifies the path to the new ENGINE shared library
131 \& (input flags): STRING
132 \& NO_VCHECK: Specifies to continue even if version checking fails (boolean)
133 \& (input flags): NUMERIC
134 \& ID: Specifies an ENGINE id name for loading
135 \& (input flags): STRING
136 \& LIST_ADD: Whether to add a loaded ENGINE to the internal list (0=no,1=yes,2=mandatory)
137 \& (input flags): NUMERIC
138 \& DIR_LOAD: Specifies whether to load from \*(AqDIR_ADD\*(Aq directories (0=no,1=yes,2=mandatory)
139 \& (input flags): NUMERIC
140 \& DIR_ADD: Adds a directory from which ENGINEs can be loaded
141 \& (input flags): STRING
142 \& LOAD: Load up the ENGINE specified by other settings
143 \& (input flags): NO_INPUT
144 .Ve
145 .PP
146 To list the capabilities of the \fBrsax\fR engine:
147 .PP
148 .Vb 4
149 \& $ openssl engine \-c
150 \& (rsax) RSAX engine support
151 \& [RSA]
152 \& (dynamic) Dynamic engine loading support
153 .Ve
154 .SH ENVIRONMENT
155 .IX Header "ENVIRONMENT"
156 .IP \fBOPENSSL_ENGINES\fR 4
157 .IX Item "OPENSSL_ENGINES"
158 The path to the engines directory.
159 .SH "SEE ALSO"
160 .IX Header "SEE ALSO"
161 \&\fBopenssl\fR\|(1),
162 \&\fBconfig\fR\|(5)
163 .SH HISTORY
164 .IX Header "HISTORY"
165 This command was deprecated in OpenSSL 3.0.
166 .SH COPYRIGHT
167 .IX Header "COPYRIGHT"
168 Copyright 2016\-2020 The OpenSSL Project Authors. All Rights Reserved.
169 .PP
170 Licensed under the Apache License 2.0 (the "License"). You may not use
171 this file except in compliance with the License. You can obtain a copy
172 in the file LICENSE in the source distribution or at
173 <https://www.openssl.org/source/license.html>.