xref: /openssl/doc/man1/openssl-engine.pod.in (revision 699caa18)
1=pod
2{- OpenSSL::safe::output_do_not_edit_headers(); -}
3
4=head1 NAME
5
6openssl-engine - load and query engines
7
8=head1 SYNOPSIS
9
10B<openssl engine>
11[B<-help>]
12[B<-v>]
13[B<-vv>]
14[B<-vvv>]
15[B<-vvvv>]
16[B<-c>]
17[B<-t>]
18[B<-tt>]
19[B<-pre> I<command>] ...
20[B<-post> I<command>] ...
21[I<engine> ...]
22
23=head1 DESCRIPTION
24
25This command has been deprecated.  Providers should be used instead of engines.
26
27This command is used to query the status and capabilities
28of the specified I<engine>s.
29Engines may be specified before and after all other command-line flags.
30Only those specified are queried.
31
32=head1 OPTIONS
33
34=over 4
35
36=item B<-help>
37
38Display an option summary.
39
40=item B<-v> B<-vv> B<-vvv> B<-vvvv>
41
42Provides information about each specified engine. The first flag lists
43all the possible run-time control commands; the second adds a
44description of each command; the third adds the input flags, and the
45final option adds the internal input flags.
46
47=item B<-c>
48
49Lists the capabilities of each engine.
50
51=item B<-t>
52
53Tests if each specified engine is available, and displays the answer.
54
55=item B<-tt>
56
57Displays an error trace for any unavailable engine.
58
59=item B<-pre> I<command>
60
61=item B<-post> I<command>
62
63Command-line configuration of engines.
64The B<-pre> command is given to the engine before it is loaded and
65the B<-post> command is given after the engine is loaded.
66The I<command> is of the form I<cmd>:I<val> where I<cmd> is the command,
67and I<val> is the value for the command.
68See the example below.
69
70These two options are cumulative, so they may be given more than once in the
71same command.
72
73=back
74
75=head1 EXAMPLES
76
77To list all the commands available to a dynamic engine:
78
79 $ openssl engine -t -tt -vvvv dynamic
80 (dynamic) Dynamic engine loading support
81      [ unavailable ]
82      SO_PATH: Specifies the path to the new ENGINE shared library
83           (input flags): STRING
84      NO_VCHECK: Specifies to continue even if version checking fails (boolean)
85           (input flags): NUMERIC
86      ID: Specifies an ENGINE id name for loading
87           (input flags): STRING
88      LIST_ADD: Whether to add a loaded ENGINE to the internal list (0=no,1=yes,2=mandatory)
89           (input flags): NUMERIC
90      DIR_LOAD: Specifies whether to load from 'DIR_ADD' directories (0=no,1=yes,2=mandatory)
91           (input flags): NUMERIC
92      DIR_ADD: Adds a directory from which ENGINEs can be loaded
93           (input flags): STRING
94      LOAD: Load up the ENGINE specified by other settings
95           (input flags): NO_INPUT
96
97To list the capabilities of the B<rsax> engine:
98
99 $ openssl engine -c
100 (rsax) RSAX engine support
101  [RSA]
102 (dynamic) Dynamic engine loading support
103
104=head1 ENVIRONMENT
105
106=over 4
107
108=item B<OPENSSL_ENGINES>
109
110The path to the engines directory.
111
112=back
113
114=head1 SEE ALSO
115
116L<openssl(1)>,
117L<config(5)>
118
119=head1 HISTORY
120
121This command was deprecated in OpenSSL 3.0.
122
123=head1 COPYRIGHT
124
125Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.
126
127Licensed under the Apache License 2.0 (the "License").  You may not use
128this file except in compliance with the License.  You can obtain a copy
129in the file LICENSE in the source distribution or at
130L<https://www.openssl.org/source/license.html>.
131
132=cut
133