]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - secure/lib/libcrypto/man/ENGINE_add.3
MFC: r340703
[FreeBSD/FreeBSD.git] / secure / lib / libcrypto / man / ENGINE_add.3
1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .if !\nF .nr F 0
58 .if \nF>0 \{\
59 .    de IX
60 .    tm Index:\\$1\t\\n%\t"\\$2"
61 ..
62 .    if !\nF==2 \{\
63 .        nr % 0
64 .        nr F 2
65 .    \}
66 .\}
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70 .    \" fudge factors for nroff and troff
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 .    \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "ENGINE_ADD 3"
132 .TH ENGINE_ADD 3 "2018-11-20" "1.1.1a" "OpenSSL"
133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
134 .\" way too many mistakes in technical documents.
135 .if n .ad l
136 .nh
137 .SH "NAME"
138 ENGINE_get_DH, ENGINE_get_DSA, ENGINE_by_id, ENGINE_get_cipher_engine, ENGINE_get_default_DH, ENGINE_get_default_DSA, ENGINE_get_default_RAND, ENGINE_get_default_RSA, ENGINE_get_digest_engine, ENGINE_get_first, ENGINE_get_last, ENGINE_get_next, ENGINE_get_prev, ENGINE_new, ENGINE_get_ciphers, ENGINE_get_ctrl_function, ENGINE_get_digests, ENGINE_get_destroy_function, ENGINE_get_finish_function, ENGINE_get_init_function, ENGINE_get_load_privkey_function, ENGINE_get_load_pubkey_function, ENGINE_load_private_key, ENGINE_load_public_key, ENGINE_get_RAND, ENGINE_get_RSA, ENGINE_get_id, ENGINE_get_name, ENGINE_get_cmd_defns, ENGINE_get_cipher, ENGINE_get_digest, ENGINE_add, ENGINE_cmd_is_executable, ENGINE_ctrl, ENGINE_ctrl_cmd, ENGINE_ctrl_cmd_string, ENGINE_finish, ENGINE_free, ENGINE_get_flags, ENGINE_init, ENGINE_register_DH, ENGINE_register_DSA, ENGINE_register_RAND, ENGINE_register_RSA, ENGINE_register_all_complete, ENGINE_register_ciphers, ENGINE_register_complete, ENGINE_register_digests, ENGINE_remove, ENGINE_set_DH, ENGINE_set_DSA, ENGINE_set_RAND, ENGINE_set_RSA, ENGINE_set_ciphers, ENGINE_set_cmd_defns, ENGINE_set_ctrl_function, ENGINE_set_default, ENGINE_set_default_DH, ENGINE_set_default_DSA, ENGINE_set_default_RAND, ENGINE_set_default_RSA, ENGINE_set_default_ciphers, ENGINE_set_default_digests, ENGINE_set_default_string, ENGINE_set_destroy_function, ENGINE_set_digests, ENGINE_set_finish_function, ENGINE_set_flags, ENGINE_set_id, ENGINE_set_init_function, ENGINE_set_load_privkey_function, ENGINE_set_load_pubkey_function, ENGINE_set_name, ENGINE_up_ref, ENGINE_get_table_flags, ENGINE_cleanup, ENGINE_load_builtin_engines, ENGINE_register_all_DH, ENGINE_register_all_DSA, ENGINE_register_all_RAND, ENGINE_register_all_RSA, ENGINE_register_all_ciphers, ENGINE_register_all_digests, ENGINE_set_table_flags, ENGINE_unregister_DH, ENGINE_unregister_DSA, ENGINE_unregister_RAND, ENGINE_unregister_RSA, ENGINE_unregister_ciphers, ENGINE_unregister_digests \&\- ENGINE cryptographic module support
139 .SH "SYNOPSIS"
140 .IX Header "SYNOPSIS"
141 .Vb 1
142 \& #include <openssl/engine.h>
143 \&
144 \& ENGINE *ENGINE_get_first(void);
145 \& ENGINE *ENGINE_get_last(void);
146 \& ENGINE *ENGINE_get_next(ENGINE *e);
147 \& ENGINE *ENGINE_get_prev(ENGINE *e);
148 \&
149 \& int ENGINE_add(ENGINE *e);
150 \& int ENGINE_remove(ENGINE *e);
151 \&
152 \& ENGINE *ENGINE_by_id(const char *id);
153 \&
154 \& int ENGINE_init(ENGINE *e);
155 \& int ENGINE_finish(ENGINE *e);
156 \&
157 \& void ENGINE_load_builtin_engines(void);
158 \&
159 \& ENGINE *ENGINE_get_default_RSA(void);
160 \& ENGINE *ENGINE_get_default_DSA(void);
161 \& ENGINE *ENGINE_get_default_DH(void);
162 \& ENGINE *ENGINE_get_default_RAND(void);
163 \& ENGINE *ENGINE_get_cipher_engine(int nid);
164 \& ENGINE *ENGINE_get_digest_engine(int nid);
165 \&
166 \& int ENGINE_set_default_RSA(ENGINE *e);
167 \& int ENGINE_set_default_DSA(ENGINE *e);
168 \& int ENGINE_set_default_DH(ENGINE *e);
169 \& int ENGINE_set_default_RAND(ENGINE *e);
170 \& int ENGINE_set_default_ciphers(ENGINE *e);
171 \& int ENGINE_set_default_digests(ENGINE *e);
172 \& int ENGINE_set_default_string(ENGINE *e, const char *list);
173 \&
174 \& int ENGINE_set_default(ENGINE *e, unsigned int flags);
175 \&
176 \& unsigned int ENGINE_get_table_flags(void);
177 \& void ENGINE_set_table_flags(unsigned int flags);
178 \&
179 \& int ENGINE_register_RSA(ENGINE *e);
180 \& void ENGINE_unregister_RSA(ENGINE *e);
181 \& void ENGINE_register_all_RSA(void);
182 \& int ENGINE_register_DSA(ENGINE *e);
183 \& void ENGINE_unregister_DSA(ENGINE *e);
184 \& void ENGINE_register_all_DSA(void);
185 \& int ENGINE_register_DH(ENGINE *e);
186 \& void ENGINE_unregister_DH(ENGINE *e);
187 \& void ENGINE_register_all_DH(void);
188 \& int ENGINE_register_RAND(ENGINE *e);
189 \& void ENGINE_unregister_RAND(ENGINE *e);
190 \& void ENGINE_register_all_RAND(void);
191 \& int ENGINE_register_ciphers(ENGINE *e);
192 \& void ENGINE_unregister_ciphers(ENGINE *e);
193 \& void ENGINE_register_all_ciphers(void);
194 \& int ENGINE_register_digests(ENGINE *e);
195 \& void ENGINE_unregister_digests(ENGINE *e);
196 \& void ENGINE_register_all_digests(void);
197 \& int ENGINE_register_complete(ENGINE *e);
198 \& int ENGINE_register_all_complete(void);
199 \&
200 \& int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)(void));
201 \& int ENGINE_cmd_is_executable(ENGINE *e, int cmd);
202 \& int ENGINE_ctrl_cmd(ENGINE *e, const char *cmd_name,
203 \&                     long i, void *p, void (*f)(void), int cmd_optional);
204 \& int ENGINE_ctrl_cmd_string(ENGINE *e, const char *cmd_name, const char *arg,
205 \&                            int cmd_optional);
206 \&
207 \& ENGINE *ENGINE_new(void);
208 \& int ENGINE_free(ENGINE *e);
209 \& int ENGINE_up_ref(ENGINE *e);
210 \&
211 \& int ENGINE_set_id(ENGINE *e, const char *id);
212 \& int ENGINE_set_name(ENGINE *e, const char *name);
213 \& int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth);
214 \& int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth);
215 \& int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth);
216 \& int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth);
217 \& int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f);
218 \& int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f);
219 \& int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f);
220 \& int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f);
221 \& int ENGINE_set_load_privkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpriv_f);
222 \& int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f);
223 \& int ENGINE_set_ciphers(ENGINE *e, ENGINE_CIPHERS_PTR f);
224 \& int ENGINE_set_digests(ENGINE *e, ENGINE_DIGESTS_PTR f);
225 \& int ENGINE_set_flags(ENGINE *e, int flags);
226 \& int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns);
227 \&
228 \& const char *ENGINE_get_id(const ENGINE *e);
229 \& const char *ENGINE_get_name(const ENGINE *e);
230 \& const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e);
231 \& const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e);
232 \& const DH_METHOD *ENGINE_get_DH(const ENGINE *e);
233 \& const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e);
234 \& ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e);
235 \& ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e);
236 \& ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e);
237 \& ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e);
238 \& ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e);
239 \& ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e);
240 \& ENGINE_CIPHERS_PTR ENGINE_get_ciphers(const ENGINE *e);
241 \& ENGINE_DIGESTS_PTR ENGINE_get_digests(const ENGINE *e);
242 \& const EVP_CIPHER *ENGINE_get_cipher(ENGINE *e, int nid);
243 \& const EVP_MD *ENGINE_get_digest(ENGINE *e, int nid);
244 \& int ENGINE_get_flags(const ENGINE *e);
245 \& const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e);
246 \&
247 \& EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id,
248 \&                                   UI_METHOD *ui_method, void *callback_data);
249 \& EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id,
250 \&                                  UI_METHOD *ui_method, void *callback_data);
251 .Ve
252 .PP
253 Deprecated:
254 .PP
255 .Vb 3
256 \& #if OPENSSL_API_COMPAT < 0x10100000L
257 \& void ENGINE_cleanup(void)
258 \& #endif
259 .Ve
260 .SH "DESCRIPTION"
261 .IX Header "DESCRIPTION"
262 These functions create, manipulate, and use cryptographic modules in the
263 form of \fB\s-1ENGINE\s0\fR objects. These objects act as containers for
264 implementations of cryptographic algorithms, and support a
265 reference-counted mechanism to allow them to be dynamically loaded in and
266 out of the running application.
267 .PP
268 The cryptographic functionality that can be provided by an \fB\s-1ENGINE\s0\fR
269 implementation includes the following abstractions;
270 .PP
271 .Vb 6
272 \& RSA_METHOD \- for providing alternative RSA implementations
273 \& DSA_METHOD, DH_METHOD, RAND_METHOD, ECDH_METHOD, ECDSA_METHOD,
274 \&       \- similarly for other OpenSSL APIs
275 \& EVP_CIPHER \- potentially multiple cipher algorithms (indexed by \*(Aqnid\*(Aq)
276 \& EVP_DIGEST \- potentially multiple hash algorithms (indexed by \*(Aqnid\*(Aq)
277 \& key\-loading \- loading public and/or private EVP_PKEY keys
278 .Ve
279 .SS "Reference counting and handles"
280 .IX Subsection "Reference counting and handles"
281 Due to the modular nature of the \s-1ENGINE API,\s0 pointers to ENGINEs need to be
282 treated as handles \- ie. not only as pointers, but also as references to
283 the underlying \s-1ENGINE\s0 object. Ie. one should obtain a new reference when
284 making copies of an \s-1ENGINE\s0 pointer if the copies will be used (and
285 released) independently.
286 .PP
287 \&\s-1ENGINE\s0 objects have two levels of reference-counting to match the way in
288 which the objects are used. At the most basic level, each \s-1ENGINE\s0 pointer is
289 inherently a \fBstructural\fR reference \- a structural reference is required
290 to use the pointer value at all, as this kind of reference is a guarantee
291 that the structure can not be deallocated until the reference is released.
292 .PP
293 However, a structural reference provides no guarantee that the \s-1ENGINE\s0 is
294 initialised and able to use any of its cryptographic
295 implementations. Indeed it's quite possible that most ENGINEs will not
296 initialise at all in typical environments, as ENGINEs are typically used to
297 support specialised hardware. To use an \s-1ENGINE\s0's functionality, you need a
298 \&\fBfunctional\fR reference. This kind of reference can be considered a
299 specialised form of structural reference, because each functional reference
300 implicitly contains a structural reference as well \- however to avoid
301 difficult-to-find programming bugs, it is recommended to treat the two
302 kinds of reference independently. If you have a functional reference to an
303 \&\s-1ENGINE,\s0 you have a guarantee that the \s-1ENGINE\s0 has been initialised and
304 is ready to perform cryptographic operations, and will remain initialised
305 until after you have released your reference.
306 .PP
307 \&\fIStructural references\fR
308 .PP
309 This basic type of reference is used for instantiating new ENGINEs,
310 iterating across OpenSSL's internal linked-list of loaded
311 ENGINEs, reading information about an \s-1ENGINE,\s0 etc. Essentially a structural
312 reference is sufficient if you only need to query or manipulate the data of
313 an \s-1ENGINE\s0 implementation rather than use its functionality.
314 .PP
315 The \fIENGINE_new()\fR function returns a structural reference to a new (empty)
316 \&\s-1ENGINE\s0 object. There are other \s-1ENGINE API\s0 functions that return structural
317 references such as; \fIENGINE_by_id()\fR, \fIENGINE_get_first()\fR, \fIENGINE_get_last()\fR,
318 \&\fIENGINE_get_next()\fR, \fIENGINE_get_prev()\fR. All structural references should be
319 released by a corresponding to call to the \fIENGINE_free()\fR function \- the
320 \&\s-1ENGINE\s0 object itself will only actually be cleaned up and deallocated when
321 the last structural reference is released.
322 .PP
323 It should also be noted that many \s-1ENGINE API\s0 function calls that accept a
324 structural reference will internally obtain another reference \- typically
325 this happens whenever the supplied \s-1ENGINE\s0 will be needed by OpenSSL after
326 the function has returned. Eg. the function to add a new \s-1ENGINE\s0 to
327 OpenSSL's internal list is \fIENGINE_add()\fR \- if this function returns success,
328 then OpenSSL will have stored a new structural reference internally so the
329 caller is still responsible for freeing their own reference with
330 \&\fIENGINE_free()\fR when they are finished with it. In a similar way, some
331 functions will automatically release the structural reference passed to it
332 if part of the function's job is to do so. Eg. the \fIENGINE_get_next()\fR and
333 \&\fIENGINE_get_prev()\fR functions are used for iterating across the internal
334 \&\s-1ENGINE\s0 list \- they will return a new structural reference to the next (or
335 previous) \s-1ENGINE\s0 in the list or \s-1NULL\s0 if at the end (or beginning) of the
336 list, but in either case the structural reference passed to the function is
337 released on behalf of the caller.
338 .PP
339 To clarify a particular function's handling of references, one should
340 always consult that function's documentation \*(L"man\*(R" page, or failing that
341 the openssl/engine.h header file includes some hints.
342 .PP
343 \&\fIFunctional references\fR
344 .PP
345 As mentioned, functional references exist when the cryptographic
346 functionality of an \s-1ENGINE\s0 is required to be available. A functional
347 reference can be obtained in one of two ways; from an existing structural
348 reference to the required \s-1ENGINE,\s0 or by asking OpenSSL for the default
349 operational \s-1ENGINE\s0 for a given cryptographic purpose.
350 .PP
351 To obtain a functional reference from an existing structural reference,
352 call the \fIENGINE_init()\fR function. This returns zero if the \s-1ENGINE\s0 was not
353 already operational and couldn't be successfully initialised (eg. lack of
354 system drivers, no special hardware attached, etc), otherwise it will
355 return non-zero to indicate that the \s-1ENGINE\s0 is now operational and will
356 have allocated a new \fBfunctional\fR reference to the \s-1ENGINE.\s0 All functional
357 references are released by calling \fIENGINE_finish()\fR (which removes the
358 implicit structural reference as well).
359 .PP
360 The second way to get a functional reference is by asking OpenSSL for a
361 default implementation for a given task, eg. by \fIENGINE_get_default_RSA()\fR,
362 \&\fIENGINE_get_default_cipher_engine()\fR, etc. These are discussed in the next
363 section, though they are not usually required by application programmers as
364 they are used automatically when creating and using the relevant
365 algorithm-specific types in OpenSSL, such as \s-1RSA, DSA, EVP_CIPHER_CTX,\s0 etc.
366 .SS "Default implementations"
367 .IX Subsection "Default implementations"
368 For each supported abstraction, the \s-1ENGINE\s0 code maintains an internal table
369 of state to control which implementations are available for a given
370 abstraction and which should be used by default. These implementations are
371 registered in the tables and indexed by an 'nid' value, because
372 abstractions like \s-1EVP_CIPHER\s0 and \s-1EVP_DIGEST\s0 support many distinct
373 algorithms and modes, and ENGINEs can support arbitrarily many of them.
374 In the case of other abstractions like \s-1RSA, DSA,\s0 etc, there is only one
375 \&\*(L"algorithm\*(R" so all implementations implicitly register using the same 'nid'
376 index.
377 .PP
378 When a default \s-1ENGINE\s0 is requested for a given abstraction/algorithm/mode, (eg.
379 when calling RSA_new_method(\s-1NULL\s0)), a \*(L"get_default\*(R" call will be made to the
380 \&\s-1ENGINE\s0 subsystem to process the corresponding state table and return a
381 functional reference to an initialised \s-1ENGINE\s0 whose implementation should be
382 used. If no \s-1ENGINE\s0 should (or can) be used, it will return \s-1NULL\s0 and the caller
383 will operate with a \s-1NULL ENGINE\s0 handle \- this usually equates to using the
384 conventional software implementation. In the latter case, OpenSSL will from
385 then on behave the way it used to before the \s-1ENGINE API\s0 existed.
386 .PP
387 Each state table has a flag to note whether it has processed this
388 \&\*(L"get_default\*(R" query since the table was last modified, because to process
389 this question it must iterate across all the registered ENGINEs in the
390 table trying to initialise each of them in turn, in case one of them is
391 operational. If it returns a functional reference to an \s-1ENGINE,\s0 it will
392 also cache another reference to speed up processing future queries (without
393 needing to iterate across the table). Likewise, it will cache a \s-1NULL\s0
394 response if no \s-1ENGINE\s0 was available so that future queries won't repeat the
395 same iteration unless the state table changes. This behaviour can also be
396 changed; if the \s-1ENGINE_TABLE_FLAG_NOINIT\s0 flag is set (using
397 \&\fIENGINE_set_table_flags()\fR), no attempted initialisations will take place,
398 instead the only way for the state table to return a non-NULL \s-1ENGINE\s0 to the
399 \&\*(L"get_default\*(R" query will be if one is expressly set in the table. Eg.
400 \&\fIENGINE_set_default_RSA()\fR does the same job as \fIENGINE_register_RSA()\fR except
401 that it also sets the state table's cached response for the \*(L"get_default\*(R"
402 query. In the case of abstractions like \s-1EVP_CIPHER,\s0 where implementations are
403 indexed by 'nid', these flags and cached-responses are distinct for each 'nid'
404 value.
405 .SS "Application requirements"
406 .IX Subsection "Application requirements"
407 This section will explain the basic things an application programmer should
408 support to make the most useful elements of the \s-1ENGINE\s0 functionality
409 available to the user. The first thing to consider is whether the
410 programmer wishes to make alternative \s-1ENGINE\s0 modules available to the
411 application and user. OpenSSL maintains an internal linked list of
412 \&\*(L"visible\*(R" ENGINEs from which it has to operate \- at start-up, this list is
413 empty and in fact if an application does not call any \s-1ENGINE API\s0 calls and
414 it uses static linking against openssl, then the resulting application
415 binary will not contain any alternative \s-1ENGINE\s0 code at all. So the first
416 consideration is whether any/all available \s-1ENGINE\s0 implementations should be
417 made visible to OpenSSL \- this is controlled by calling the various \*(L"load\*(R"
418 functions.
419 .PP
420 The fact that ENGINEs are made visible to OpenSSL (and thus are linked into
421 the program and loaded into memory at run-time) does not mean they are
422 \&\*(L"registered\*(R" or called into use by OpenSSL automatically \- that behaviour
423 is something for the application to control. Some applications
424 will want to allow the user to specify exactly which \s-1ENGINE\s0 they want used
425 if any is to be used at all. Others may prefer to load all support and have
426 OpenSSL automatically use at run-time any \s-1ENGINE\s0 that is able to
427 successfully initialise \- ie. to assume that this corresponds to
428 acceleration hardware attached to the machine or some such thing. There are
429 probably numerous other ways in which applications may prefer to handle
430 things, so we will simply illustrate the consequences as they apply to a
431 couple of simple cases and leave developers to consider these and the
432 source code to openssl's builtin utilities as guides.
433 .PP
434 If no \s-1ENGINE API\s0 functions are called within an application, then OpenSSL
435 will not allocate any internal resources.  Prior to OpenSSL 1.1.0, however,
436 if any ENGINEs are loaded, even if not registered or used, it was necessary to
437 call \fIENGINE_cleanup()\fR before the program exits.
438 .PP
439 \&\fIUsing a specific \s-1ENGINE\s0 implementation\fR
440 .PP
441 Here we'll assume an application has been configured by its user or admin
442 to want to use the \*(L"\s-1ACME\*(R" ENGINE\s0 if it is available in the version of
443 OpenSSL the application was compiled with. If it is available, it should be
444 used by default for all \s-1RSA, DSA,\s0 and symmetric cipher operations, otherwise
445 OpenSSL should use its builtin software as per usual. The following code
446 illustrates how to approach this;
447 .PP
448 .Vb 10
449 \& ENGINE *e;
450 \& const char *engine_id = "ACME";
451 \& ENGINE_load_builtin_engines();
452 \& e = ENGINE_by_id(engine_id);
453 \& if (!e)
454 \&     /* the engine isn\*(Aqt available */
455 \&     return;
456 \& if (!ENGINE_init(e)) {
457 \&     /* the engine couldn\*(Aqt initialise, release \*(Aqe\*(Aq */
458 \&     ENGINE_free(e);
459 \&     return;
460 \& }
461 \& if (!ENGINE_set_default_RSA(e))
462 \&     /*
463 \&      * This should only happen when \*(Aqe\*(Aq can\*(Aqt initialise, but the previous
464 \&      * statement suggests it did.
465 \&      */
466 \&     abort();
467 \& ENGINE_set_default_DSA(e);
468 \& ENGINE_set_default_ciphers(e);
469 \& /* Release the functional reference from ENGINE_init() */
470 \& ENGINE_finish(e);
471 \& /* Release the structural reference from ENGINE_by_id() */
472 \& ENGINE_free(e);
473 .Ve
474 .PP
475 \&\fIAutomatically using builtin \s-1ENGINE\s0 implementations\fR
476 .PP
477 Here we'll assume we want to load and register all \s-1ENGINE\s0 implementations
478 bundled with OpenSSL, such that for any cryptographic algorithm required by
479 OpenSSL \- if there is an \s-1ENGINE\s0 that implements it and can be initialised,
480 it should be used. The following code illustrates how this can work;
481 .PP
482 .Vb 4
483 \& /* Load all bundled ENGINEs into memory and make them visible */
484 \& ENGINE_load_builtin_engines();
485 \& /* Register all of them for every algorithm they collectively implement */
486 \& ENGINE_register_all_complete();
487 .Ve
488 .PP
489 That's all that's required. Eg. the next time OpenSSL tries to set up an
490 \&\s-1RSA\s0 key, any bundled ENGINEs that implement \s-1RSA_METHOD\s0 will be passed to
491 \&\fIENGINE_init()\fR and if any of those succeed, that \s-1ENGINE\s0 will be set as the
492 default for \s-1RSA\s0 use from then on.
493 .SS "Advanced configuration support"
494 .IX Subsection "Advanced configuration support"
495 There is a mechanism supported by the \s-1ENGINE\s0 framework that allows each
496 \&\s-1ENGINE\s0 implementation to define an arbitrary set of configuration
497 \&\*(L"commands\*(R" and expose them to OpenSSL and any applications based on
498 OpenSSL. This mechanism is entirely based on the use of name-value pairs
499 and assumes \s-1ASCII\s0 input (no unicode or \s-1UTF\s0 for now!), so it is ideal if
500 applications want to provide a transparent way for users to provide
501 arbitrary configuration \*(L"directives\*(R" directly to such ENGINEs. It is also
502 possible for the application to dynamically interrogate the loaded \s-1ENGINE\s0
503 implementations for the names, descriptions, and input flags of their
504 available \*(L"control commands\*(R", providing a more flexible configuration
505 scheme. However, if the user is expected to know which \s-1ENGINE\s0 device he/she
506 is using (in the case of specialised hardware, this goes without saying)
507 then applications may not need to concern themselves with discovering the
508 supported control commands and simply prefer to pass settings into ENGINEs
509 exactly as they are provided by the user.
510 .PP
511 Before illustrating how control commands work, it is worth mentioning what
512 they are typically used for. Broadly speaking there are two uses for
513 control commands; the first is to provide the necessary details to the
514 implementation (which may know nothing at all specific to the host system)
515 so that it can be initialised for use. This could include the path to any
516 driver or config files it needs to load, required network addresses,
517 smart-card identifiers, passwords to initialise protected devices,
518 logging information, etc etc. This class of commands typically needs to be
519 passed to an \s-1ENGINE\s0 \fBbefore\fR attempting to initialise it, ie. before
520 calling \fIENGINE_init()\fR. The other class of commands consist of settings or
521 operations that tweak certain behaviour or cause certain operations to take
522 place, and these commands may work either before or after \fIENGINE_init()\fR, or
523 in some cases both. \s-1ENGINE\s0 implementations should provide indications of
524 this in the descriptions attached to builtin control commands and/or in
525 external product documentation.
526 .PP
527 \&\fIIssuing control commands to an \s-1ENGINE\s0\fR
528 .PP
529 Let's illustrate by example; a function for which the caller supplies the
530 name of the \s-1ENGINE\s0 it wishes to use, a table of string-pairs for use before
531 initialisation, and another table for use after initialisation. Note that
532 the string-pairs used for control commands consist of a command \*(L"name\*(R"
533 followed by the command \*(L"parameter\*(R" \- the parameter could be \s-1NULL\s0 in some
534 cases but the name can not. This function should initialise the \s-1ENGINE\s0
535 (issuing the \*(L"pre\*(R" commands beforehand and the \*(L"post\*(R" commands afterwards)
536 and set it as the default for everything except \s-1RAND\s0 and then return a
537 boolean success or failure.
538 .PP
539 .Vb 10
540 \& int generic_load_engine_fn(const char *engine_id,
541 \&                            const char **pre_cmds, int pre_num,
542 \&                            const char **post_cmds, int post_num)
543 \& {
544 \&     ENGINE *e = ENGINE_by_id(engine_id);
545 \&     if (!e) return 0;
546 \&     while (pre_num\-\-) {
547 \&         if (!ENGINE_ctrl_cmd_string(e, pre_cmds[0], pre_cmds[1], 0)) {
548 \&             fprintf(stderr, "Failed command (%s \- %s:%s)\en", engine_id,
549 \&                     pre_cmds[0], pre_cmds[1] ? pre_cmds[1] : "(NULL)");
550 \&             ENGINE_free(e);
551 \&             return 0;
552 \&         }
553 \&         pre_cmds += 2;
554 \&     }
555 \&     if (!ENGINE_init(e)) {
556 \&         fprintf(stderr, "Failed initialisation\en");
557 \&         ENGINE_free(e);
558 \&         return 0;
559 \&     }
560 \&     /*
561 \&      * ENGINE_init() returned a functional reference, so free the structural
562 \&      * reference from ENGINE_by_id().
563 \&      */
564 \&     ENGINE_free(e);
565 \&     while (post_num\-\-) {
566 \&         if (!ENGINE_ctrl_cmd_string(e, post_cmds[0], post_cmds[1], 0)) {
567 \&             fprintf(stderr, "Failed command (%s \- %s:%s)\en", engine_id,
568 \&                     post_cmds[0], post_cmds[1] ? post_cmds[1] : "(NULL)");
569 \&             ENGINE_finish(e);
570 \&             return 0;
571 \&         }
572 \&         post_cmds += 2;
573 \&     }
574 \&     ENGINE_set_default(e, ENGINE_METHOD_ALL & ~ENGINE_METHOD_RAND);
575 \&     /* Success */
576 \&     return 1;
577 \& }
578 .Ve
579 .PP
580 Note that \fIENGINE_ctrl_cmd_string()\fR accepts a boolean argument that can
581 relax the semantics of the function \- if set non-zero it will only return
582 failure if the \s-1ENGINE\s0 supported the given command name but failed while
583 executing it, if the \s-1ENGINE\s0 doesn't support the command name it will simply
584 return success without doing anything. In this case we assume the user is
585 only supplying commands specific to the given \s-1ENGINE\s0 so we set this to
586 \&\s-1FALSE.\s0
587 .PP
588 \&\fIDiscovering supported control commands\fR
589 .PP
590 It is possible to discover at run-time the names, numerical-ids, descriptions
591 and input parameters of the control commands supported by an \s-1ENGINE\s0 using a
592 structural reference. Note that some control commands are defined by OpenSSL
593 itself and it will intercept and handle these control commands on behalf of the
594 \&\s-1ENGINE,\s0 ie. the \s-1ENGINE\s0's \fIctrl()\fR handler is not used for the control command.
595 openssl/engine.h defines an index, \s-1ENGINE_CMD_BASE,\s0 that all control commands
596 implemented by ENGINEs should be numbered from. Any command value lower than
597 this symbol is considered a \*(L"generic\*(R" command is handled directly by the
598 OpenSSL core routines.
599 .PP
600 It is using these \*(L"core\*(R" control commands that one can discover the control
601 commands implemented by a given \s-1ENGINE,\s0 specifically the commands:
602 .PP
603 .Vb 9
604 \& ENGINE_HAS_CTRL_FUNCTION
605 \& ENGINE_CTRL_GET_FIRST_CMD_TYPE
606 \& ENGINE_CTRL_GET_NEXT_CMD_TYPE
607 \& ENGINE_CTRL_GET_CMD_FROM_NAME
608 \& ENGINE_CTRL_GET_NAME_LEN_FROM_CMD
609 \& ENGINE_CTRL_GET_NAME_FROM_CMD
610 \& ENGINE_CTRL_GET_DESC_LEN_FROM_CMD
611 \& ENGINE_CTRL_GET_DESC_FROM_CMD
612 \& ENGINE_CTRL_GET_CMD_FLAGS
613 .Ve
614 .PP
615 Whilst these commands are automatically processed by the OpenSSL framework code,
616 they use various properties exposed by each \s-1ENGINE\s0 to process these
617 queries. An \s-1ENGINE\s0 has 3 properties it exposes that can affect how this behaves;
618 it can supply a \fIctrl()\fR handler, it can specify \s-1ENGINE_FLAGS_MANUAL_CMD_CTRL\s0 in
619 the \s-1ENGINE\s0's flags, and it can expose an array of control command descriptions.
620 If an \s-1ENGINE\s0 specifies the \s-1ENGINE_FLAGS_MANUAL_CMD_CTRL\s0 flag, then it will
621 simply pass all these \*(L"core\*(R" control commands directly to the \s-1ENGINE\s0's \fIctrl()\fR
622 handler (and thus, it must have supplied one), so it is up to the \s-1ENGINE\s0 to
623 reply to these \*(L"discovery\*(R" commands itself. If that flag is not set, then the
624 OpenSSL framework code will work with the following rules:
625 .PP
626 .Vb 9
627 \& if no ctrl() handler supplied;
628 \&     ENGINE_HAS_CTRL_FUNCTION returns FALSE (zero),
629 \&     all other commands fail.
630 \& if a ctrl() handler was supplied but no array of control commands;
631 \&     ENGINE_HAS_CTRL_FUNCTION returns TRUE,
632 \&     all other commands fail.
633 \& if a ctrl() handler and array of control commands was supplied;
634 \&     ENGINE_HAS_CTRL_FUNCTION returns TRUE,
635 \&     all other commands proceed processing ...
636 .Ve
637 .PP
638 If the \s-1ENGINE\s0's array of control commands is empty then all other commands will
639 fail, otherwise; \s-1ENGINE_CTRL_GET_FIRST_CMD_TYPE\s0 returns the identifier of
640 the first command supported by the \s-1ENGINE, ENGINE_GET_NEXT_CMD_TYPE\s0 takes the
641 identifier of a command supported by the \s-1ENGINE\s0 and returns the next command
642 identifier or fails if there are no more, \s-1ENGINE_CMD_FROM_NAME\s0 takes a string
643 name for a command and returns the corresponding identifier or fails if no such
644 command name exists, and the remaining commands take a command identifier and
645 return properties of the corresponding commands. All except
646 \&\s-1ENGINE_CTRL_GET_FLAGS\s0 return the string length of a command name or description,
647 or populate a supplied character buffer with a copy of the command name or
648 description. \s-1ENGINE_CTRL_GET_FLAGS\s0 returns a bitwise-OR'd mask of the following
649 possible values:
650 .PP
651 .Vb 4
652 \& ENGINE_CMD_FLAG_NUMERIC
653 \& ENGINE_CMD_FLAG_STRING
654 \& ENGINE_CMD_FLAG_NO_INPUT
655 \& ENGINE_CMD_FLAG_INTERNAL
656 .Ve
657 .PP
658 If the \s-1ENGINE_CMD_FLAG_INTERNAL\s0 flag is set, then any other flags are purely
659 informational to the caller \- this flag will prevent the command being usable
660 for any higher-level \s-1ENGINE\s0 functions such as \fIENGINE_ctrl_cmd_string()\fR.
661 \&\*(L"\s-1INTERNAL\*(R"\s0 commands are not intended to be exposed to text-based configuration
662 by applications, administrations, users, etc. These can support arbitrary
663 operations via \fIENGINE_ctrl()\fR, including passing to and/or from the control
664 commands data of any arbitrary type. These commands are supported in the
665 discovery mechanisms simply to allow applications to determine if an \s-1ENGINE\s0
666 supports certain specific commands it might want to use (eg. application \*(L"foo\*(R"
667 might query various ENGINEs to see if they implement \*(L"\s-1FOO_GET_VENDOR_LOGO_GIF\*(R"\s0 \-
668 and \s-1ENGINE\s0 could therefore decide whether or not to support this \*(L"foo\*(R"\-specific
669 extension).
670 .SH "ENVIRONMENT"
671 .IX Header "ENVIRONMENT"
672 .IP "\fB\s-1OPENSSL_ENGINES\s0\fR" 4
673 .IX Item "OPENSSL_ENGINES"
674 The path to the engines directory.
675 Ignored in set-user-ID and set-group-ID programs.
676 .SH "RETURN VALUES"
677 .IX Header "RETURN VALUES"
678 \&\fIENGINE_get_first()\fR, \fIENGINE_get_last()\fR, \fIENGINE_get_next()\fR and \fIENGINE_get_prev()\fR
679 return a valid \fB\s-1ENGINE\s0\fR structure or \s-1NULL\s0 if an error occurred.
680 .PP
681 \&\fIENGINE_add()\fR and \fIENGINE_remove()\fR return 1 on success or 0 on error.
682 .PP
683 \&\fIENGINE_by_id()\fR returns a valid \fB\s-1ENGINE\s0\fR structure or \s-1NULL\s0 if an error occurred.
684 .PP
685 \&\fIENGINE_init()\fR and \fIENGINE_finish()\fR return 1 on success or 0 on error.
686 .PP
687 All \fIENGINE_get_default_TYPE()\fR functions, \fIENGINE_get_cipher_engine()\fR and
688 \&\fIENGINE_get_digest_engine()\fR return a valid \fB\s-1ENGINE\s0\fR structure on success or \s-1NULL\s0
689 if an error occurred.
690 .PP
691 All \fIENGINE_set_default_TYPE()\fR functions return 1 on success or 0 on error.
692 .PP
693 \&\fIENGINE_set_default()\fR returns 1 on success or 0 on error.
694 .PP
695 \&\fIENGINE_get_table_flags()\fR returns an unsigned integer value representing the
696 global table flags which are used to control the registration behaviour of
697 \&\fB\s-1ENGINE\s0\fR implementations.
698 .PP
699 All \fIENGINE_register_TYPE()\fR functions return 1 on success or 0 on error.
700 .PP
701 \&\fIENGINE_register_complete()\fR and \fIENGINE_register_all_complete()\fR return 1 on success
702 or 0 on error.
703 .PP
704 \&\fIENGINE_ctrl()\fR returns a positive value on success or others on error.
705 .PP
706 \&\fIENGINE_cmd_is_executable()\fR returns 1 if \fBcmd\fR is executable or 0 otherwise.
707 .PP
708 \&\fIENGINE_ctrl_cmd()\fR and \fIENGINE_ctrl_cmd_string()\fR return 1 on success or 0 on error.
709 .PP
710 \&\fIENGINE_new()\fR returns a valid \fB\s-1ENGINE\s0\fR structure on success or \s-1NULL\s0 if an error
711 occurred.
712 .PP
713 \&\fIENGINE_free()\fR returns 1 on success or 0 on error.
714 .PP
715 \&\fIENGINE_up_ref()\fR returns 1 on success or 0 on error.
716 .PP
717 \&\fIENGINE_set_id()\fR and \fIENGINE_set_name()\fR return 1 on success or 0 on error.
718 .PP
719 All other \fBENGINE_set_*\fR functions return 1 on success or 0 on error.
720 .PP
721 \&\fIENGINE_get_id()\fR and \fIENGINE_get_name()\fR return a string representing the identifier
722 and the name of the \s-1ENGINE\s0 \fBe\fR respectively.
723 .PP
724 \&\fIENGINE_get_RSA()\fR, \fIENGINE_get_DSA()\fR, \fIENGINE_get_DH()\fR and \fIENGINE_get_RAND()\fR
725 return corresponding method structures for each algorithms.
726 .PP
727 \&\fIENGINE_get_destroy_function()\fR, \fIENGINE_get_init_function()\fR,
728 \&\fIENGINE_get_finish_function()\fR, \fIENGINE_get_ctrl_function()\fR,
729 \&\fIENGINE_get_load_privkey_function()\fR, \fIENGINE_get_load_pubkey_function()\fR,
730 \&\fIENGINE_get_ciphers()\fR and \fIENGINE_get_digests()\fR return corresponding function
731 pointers of the callbacks.
732 .PP
733 \&\fIENGINE_get_cipher()\fR returns a valid \fB\s-1EVP_CIPHER\s0\fR structure on success or \s-1NULL\s0
734 if an error occurred.
735 .PP
736 \&\fIENGINE_get_digest()\fR returns a valid \fB\s-1EVP_MD\s0\fR structure on success or \s-1NULL\s0 if an
737 error occurred.
738 .PP
739 \&\fIENGINE_get_flags()\fR returns an integer representing the \s-1ENGINE\s0 flags which are
740 used to control various behaviours of an \s-1ENGINE.\s0
741 .PP
742 \&\fIENGINE_get_cmd_defns()\fR returns an \fB\s-1ENGINE_CMD_DEFN\s0\fR structure or \s-1NULL\s0 if it's
743 not set.
744 .PP
745 \&\fIENGINE_load_private_key()\fR and \fIENGINE_load_public_key()\fR return a valid \fB\s-1EVP_PKEY\s0\fR
746 structure on success or \s-1NULL\s0 if an error occurred.
747 .SH "SEE ALSO"
748 .IX Header "SEE ALSO"
749 \&\fIOPENSSL_init_crypto\fR\|(3), \fIRSA_new_method\fR\|(3), \fIDSA_new\fR\|(3), \fIDH_new\fR\|(3),
750 \&\fIRAND_bytes\fR\|(3), \fIconfig\fR\|(5)
751 .SH "HISTORY"
752 .IX Header "HISTORY"
753 \&\fIENGINE_cleanup()\fR was deprecated in OpenSSL 1.1.0 by the automatic cleanup
754 done by \fIOPENSSL_cleanup()\fR
755 and should not be used.
756 .SH "COPYRIGHT"
757 .IX Header "COPYRIGHT"
758 Copyright 2002\-2018 The OpenSSL Project Authors. All Rights Reserved.
759 .PP
760 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
761 this file except in compliance with the License.  You can obtain a copy
762 in the file \s-1LICENSE\s0 in the source distribution or at
763 <https://www.openssl.org/source/license.html>.