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