2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1999-2001 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * licensing@OpenSSL.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
58 /* ====================================================================
59 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
60 * ECDH support in OpenSSL originally developed by
61 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
64 #ifndef HEADER_ENGINE_H
65 #define HEADER_ENGINE_H
67 #include <openssl/ossl_typ.h>
68 #include <openssl/bn.h>
69 #ifndef OPENSSL_NO_RSA
70 #include <openssl/rsa.h>
72 #ifndef OPENSSL_NO_DSA
73 #include <openssl/dsa.h>
76 #include <openssl/dh.h>
78 #ifndef OPENSSL_NO_ECDH
79 #include <openssl/ecdh.h>
81 #ifndef OPENSSL_NO_ECDSA
82 #include <openssl/ecdsa.h>
84 #include <openssl/rand.h>
85 #include <openssl/ui.h>
86 #include <openssl/symhacks.h>
87 #include <openssl/err.h>
93 /* Fixups for missing algorithms */
95 typedef void RSA_METHOD;
98 typedef void DSA_METHOD;
101 typedef void DH_METHOD;
103 #ifdef OPENSSL_NO_ECDH
104 typedef void ECDH_METHOD;
106 #ifdef OPENSSL_NO_ECDSA
107 typedef void ECDSA_METHOD;
110 /* These flags are used to control combinations of algorithm (methods)
111 * by bitwise "OR"ing. */
112 #define ENGINE_METHOD_RSA (unsigned int)0x0001
113 #define ENGINE_METHOD_DSA (unsigned int)0x0002
114 #define ENGINE_METHOD_DH (unsigned int)0x0004
115 #define ENGINE_METHOD_RAND (unsigned int)0x0008
116 #define ENGINE_METHOD_ECDH (unsigned int)0x0010
117 #define ENGINE_METHOD_ECDSA (unsigned int)0x0020
118 #define ENGINE_METHOD_CIPHERS (unsigned int)0x0040
119 #define ENGINE_METHOD_DIGESTS (unsigned int)0x0080
120 /* Obvious all-or-nothing cases. */
121 #define ENGINE_METHOD_ALL (unsigned int)0xFFFF
122 #define ENGINE_METHOD_NONE (unsigned int)0x0000
124 /* This(ese) flag(s) controls behaviour of the ENGINE_TABLE mechanism used
125 * internally to control registration of ENGINE implementations, and can be set
126 * by ENGINE_set_table_flags(). The "NOINIT" flag prevents attempts to
127 * initialise registered ENGINEs if they are not already initialised. */
128 #define ENGINE_TABLE_FLAG_NOINIT (unsigned int)0x0001
130 /* ENGINE flags that can be set by ENGINE_set_flags(). */
131 /* #define ENGINE_FLAGS_MALLOCED 0x0001 */ /* Not used */
133 /* This flag is for ENGINEs that wish to handle the various 'CMD'-related
134 * control commands on their own. Without this flag, ENGINE_ctrl() handles these
135 * control commands on behalf of the ENGINE using their "cmd_defns" data. */
136 #define ENGINE_FLAGS_MANUAL_CMD_CTRL (int)0x0002
138 /* This flag is for ENGINEs who return new duplicate structures when found via
139 * "ENGINE_by_id()". When an ENGINE must store state (eg. if ENGINE_ctrl()
140 * commands are called in sequence as part of some stateful process like
141 * key-generation setup and execution), it can set this flag - then each attempt
142 * to obtain the ENGINE will result in it being copied into a new structure.
143 * Normally, ENGINEs don't declare this flag so ENGINE_by_id() just increments
144 * the existing ENGINE's structural reference count. */
145 #define ENGINE_FLAGS_BY_ID_COPY (int)0x0004
147 /* ENGINEs can support their own command types, and these flags are used in
148 * ENGINE_CTRL_GET_CMD_FLAGS to indicate to the caller what kind of input each
149 * command expects. Currently only numeric and string input is supported. If a
150 * control command supports none of the _NUMERIC, _STRING, or _NO_INPUT options,
151 * then it is regarded as an "internal" control command - and not for use in
152 * config setting situations. As such, they're not available to the
153 * ENGINE_ctrl_cmd_string() function, only raw ENGINE_ctrl() access. Changes to
154 * this list of 'command types' should be reflected carefully in
155 * ENGINE_cmd_is_executable() and ENGINE_ctrl_cmd_string(). */
157 /* accepts a 'long' input value (3rd parameter to ENGINE_ctrl) */
158 #define ENGINE_CMD_FLAG_NUMERIC (unsigned int)0x0001
159 /* accepts string input (cast from 'void*' to 'const char *', 4th parameter to
161 #define ENGINE_CMD_FLAG_STRING (unsigned int)0x0002
162 /* Indicates that the control command takes *no* input. Ie. the control command
163 * is unparameterised. */
164 #define ENGINE_CMD_FLAG_NO_INPUT (unsigned int)0x0004
165 /* Indicates that the control command is internal. This control command won't
166 * be shown in any output, and is only usable through the ENGINE_ctrl_cmd()
168 #define ENGINE_CMD_FLAG_INTERNAL (unsigned int)0x0008
170 /* NB: These 3 control commands are deprecated and should not be used. ENGINEs
171 * relying on these commands should compile conditional support for
172 * compatibility (eg. if these symbols are defined) but should also migrate the
173 * same functionality to their own ENGINE-specific control functions that can be
174 * "discovered" by calling applications. The fact these control commands
175 * wouldn't be "executable" (ie. usable by text-based config) doesn't change the
176 * fact that application code can find and use them without requiring per-ENGINE
179 /* These flags are used to tell the ctrl function what should be done.
180 * All command numbers are shared between all engines, even if some don't
181 * make sense to some engines. In such a case, they do nothing but return
182 * the error ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED. */
183 #define ENGINE_CTRL_SET_LOGSTREAM 1
184 #define ENGINE_CTRL_SET_PASSWORD_CALLBACK 2
185 #define ENGINE_CTRL_HUP 3 /* Close and reinitialise any
186 handles/connections etc. */
187 #define ENGINE_CTRL_SET_USER_INTERFACE 4 /* Alternative to callback */
188 #define ENGINE_CTRL_SET_CALLBACK_DATA 5 /* User-specific data, used
189 when calling the password
190 callback and the user
193 /* These control commands allow an application to deal with an arbitrary engine
194 * in a dynamic way. Warn: Negative return values indicate errors FOR THESE
195 * COMMANDS because zero is used to indicate 'end-of-list'. Other commands,
196 * including ENGINE-specific command types, return zero for an error.
198 * An ENGINE can choose to implement these ctrl functions, and can internally
199 * manage things however it chooses - it does so by setting the
200 * ENGINE_FLAGS_MANUAL_CMD_CTRL flag (using ENGINE_set_flags()). Otherwise the
201 * ENGINE_ctrl() code handles this on the ENGINE's behalf using the cmd_defns
202 * data (set using ENGINE_set_cmd_defns()). This means an ENGINE's ctrl()
203 * handler need only implement its own commands - the above "meta" commands will
204 * be taken care of. */
206 /* Returns non-zero if the supplied ENGINE has a ctrl() handler. If "not", then
207 * all the remaining control commands will return failure, so it is worth
208 * checking this first if the caller is trying to "discover" the engine's
209 * capabilities and doesn't want errors generated unnecessarily. */
210 #define ENGINE_CTRL_HAS_CTRL_FUNCTION 10
211 /* Returns a positive command number for the first command supported by the
212 * engine. Returns zero if no ctrl commands are supported. */
213 #define ENGINE_CTRL_GET_FIRST_CMD_TYPE 11
214 /* The 'long' argument specifies a command implemented by the engine, and the
215 * return value is the next command supported, or zero if there are no more. */
216 #define ENGINE_CTRL_GET_NEXT_CMD_TYPE 12
217 /* The 'void*' argument is a command name (cast from 'const char *'), and the
218 * return value is the command that corresponds to it. */
219 #define ENGINE_CTRL_GET_CMD_FROM_NAME 13
220 /* The next two allow a command to be converted into its corresponding string
221 * form. In each case, the 'long' argument supplies the command. In the NAME_LEN
222 * case, the return value is the length of the command name (not counting a
223 * trailing EOL). In the NAME case, the 'void*' argument must be a string buffer
224 * large enough, and it will be populated with the name of the command (WITH a
226 #define ENGINE_CTRL_GET_NAME_LEN_FROM_CMD 14
227 #define ENGINE_CTRL_GET_NAME_FROM_CMD 15
228 /* The next two are similar but give a "short description" of a command. */
229 #define ENGINE_CTRL_GET_DESC_LEN_FROM_CMD 16
230 #define ENGINE_CTRL_GET_DESC_FROM_CMD 17
231 /* With this command, the return value is the OR'd combination of
232 * ENGINE_CMD_FLAG_*** values that indicate what kind of input a given
233 * engine-specific ctrl command expects. */
234 #define ENGINE_CTRL_GET_CMD_FLAGS 18
236 /* ENGINE implementations should start the numbering of their own control
237 * commands from this value. (ie. ENGINE_CMD_BASE, ENGINE_CMD_BASE + 1, etc). */
238 #define ENGINE_CMD_BASE 200
240 /* NB: These 2 nCipher "chil" control commands are deprecated, and their
241 * functionality is now available through ENGINE-specific control commands
242 * (exposed through the above-mentioned 'CMD'-handling). Code using these 2
243 * commands should be migrated to the more general command handling before these
246 /* Flags specific to the nCipher "chil" engine */
247 #define ENGINE_CTRL_CHIL_SET_FORKCHECK 100
248 /* Depending on the value of the (long)i argument, this sets or
249 * unsets the SimpleForkCheck flag in the CHIL API to enable or
250 * disable checking and workarounds for applications that fork().
252 #define ENGINE_CTRL_CHIL_NO_LOCKING 101
253 /* This prevents the initialisation function from providing mutex
254 * callbacks to the nCipher library. */
256 /* If an ENGINE supports its own specific control commands and wishes the
257 * framework to handle the above 'ENGINE_CMD_***'-manipulation commands on its
258 * behalf, it should supply a null-terminated array of ENGINE_CMD_DEFN entries
259 * to ENGINE_set_cmd_defns(). It should also implement a ctrl() handler that
260 * supports the stated commands (ie. the "cmd_num" entries as described by the
261 * array). NB: The array must be ordered in increasing order of cmd_num.
262 * "null-terminated" means that the last ENGINE_CMD_DEFN element has cmd_num set
263 * to zero and/or cmd_name set to NULL. */
264 typedef struct ENGINE_CMD_DEFN_st
266 unsigned int cmd_num; /* The command number */
267 const char *cmd_name; /* The command name itself */
268 const char *cmd_desc; /* A short description of the command */
269 unsigned int cmd_flags; /* The input the command expects */
272 /* Generic function pointer */
273 typedef int (*ENGINE_GEN_FUNC_PTR)();
274 /* Generic function pointer taking no arguments */
275 typedef int (*ENGINE_GEN_INT_FUNC_PTR)(ENGINE *);
276 /* Specific control function pointer */
277 typedef int (*ENGINE_CTRL_FUNC_PTR)(ENGINE *, int, long, void *, void (*f)());
278 /* Generic load_key function pointer */
279 typedef EVP_PKEY * (*ENGINE_LOAD_KEY_PTR)(ENGINE *, const char *,
280 UI_METHOD *ui_method, void *callback_data);
281 /* These callback types are for an ENGINE's handler for cipher and digest logic.
282 * These handlers have these prototypes;
283 * int foo(ENGINE *e, const EVP_CIPHER **cipher, const int **nids, int nid);
284 * int foo(ENGINE *e, const EVP_MD **digest, const int **nids, int nid);
285 * Looking at how to implement these handlers in the case of cipher support, if
286 * the framework wants the EVP_CIPHER for 'nid', it will call;
287 * foo(e, &p_evp_cipher, NULL, nid); (return zero for failure)
288 * If the framework wants a list of supported 'nid's, it will call;
289 * foo(e, NULL, &p_nids, 0); (returns number of 'nids' or -1 for error)
291 /* Returns to a pointer to the array of supported cipher 'nid's. If the second
292 * parameter is non-NULL it is set to the size of the returned array. */
293 typedef int (*ENGINE_CIPHERS_PTR)(ENGINE *, const EVP_CIPHER **, const int **, int);
294 typedef int (*ENGINE_DIGESTS_PTR)(ENGINE *, const EVP_MD **, const int **, int);
296 /* STRUCTURE functions ... all of these functions deal with pointers to ENGINE
297 * structures where the pointers have a "structural reference". This means that
298 * their reference is to allowed access to the structure but it does not imply
299 * that the structure is functional. To simply increment or decrement the
300 * structural reference count, use ENGINE_by_id and ENGINE_free. NB: This is not
301 * required when iterating using ENGINE_get_next as it will automatically
302 * decrement the structural reference count of the "current" ENGINE and
303 * increment the structural reference count of the ENGINE it returns (unless it
306 /* Get the first/last "ENGINE" type available. */
307 ENGINE *ENGINE_get_first(void);
308 ENGINE *ENGINE_get_last(void);
309 /* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */
310 ENGINE *ENGINE_get_next(ENGINE *e);
311 ENGINE *ENGINE_get_prev(ENGINE *e);
312 /* Add another "ENGINE" type into the array. */
313 int ENGINE_add(ENGINE *e);
314 /* Remove an existing "ENGINE" type from the array. */
315 int ENGINE_remove(ENGINE *e);
316 /* Retrieve an engine from the list by its unique "id" value. */
317 ENGINE *ENGINE_by_id(const char *id);
318 /* Add all the built-in engines. */
319 void ENGINE_load_openssl(void);
320 void ENGINE_load_dynamic(void);
321 void ENGINE_load_cswift(void);
322 void ENGINE_load_chil(void);
323 void ENGINE_load_atalla(void);
324 void ENGINE_load_nuron(void);
325 void ENGINE_load_ubsec(void);
326 void ENGINE_load_aep(void);
327 void ENGINE_load_sureware(void);
328 void ENGINE_load_4758cca(void);
329 void ENGINE_load_openbsd_dev_crypto(void);
330 void ENGINE_load_builtin_engines(void);
332 /* Get and set global flags (ENGINE_TABLE_FLAG_***) for the implementation
333 * "registry" handling. */
334 unsigned int ENGINE_get_table_flags(void);
335 void ENGINE_set_table_flags(unsigned int flags);
337 /* Manage registration of ENGINEs per "table". For each type, there are 3
339 * ENGINE_register_***(e) - registers the implementation from 'e' (if it has one)
340 * ENGINE_unregister_***(e) - unregister the implementation from 'e'
341 * ENGINE_register_all_***() - call ENGINE_register_***() for each 'e' in the list
342 * Cleanup is automatically registered from each table when required, so
343 * ENGINE_cleanup() will reverse any "register" operations. */
345 int ENGINE_register_RSA(ENGINE *e);
346 void ENGINE_unregister_RSA(ENGINE *e);
347 void ENGINE_register_all_RSA(void);
349 int ENGINE_register_DSA(ENGINE *e);
350 void ENGINE_unregister_DSA(ENGINE *e);
351 void ENGINE_register_all_DSA(void);
353 int ENGINE_register_ECDH(ENGINE *e);
354 void ENGINE_unregister_ECDH(ENGINE *e);
355 void ENGINE_register_all_ECDH(void);
357 int ENGINE_register_ECDSA(ENGINE *e);
358 void ENGINE_unregister_ECDSA(ENGINE *e);
359 void ENGINE_register_all_ECDSA(void);
361 int ENGINE_register_DH(ENGINE *e);
362 void ENGINE_unregister_DH(ENGINE *e);
363 void ENGINE_register_all_DH(void);
365 int ENGINE_register_RAND(ENGINE *e);
366 void ENGINE_unregister_RAND(ENGINE *e);
367 void ENGINE_register_all_RAND(void);
369 int ENGINE_register_ciphers(ENGINE *e);
370 void ENGINE_unregister_ciphers(ENGINE *e);
371 void ENGINE_register_all_ciphers(void);
373 int ENGINE_register_digests(ENGINE *e);
374 void ENGINE_unregister_digests(ENGINE *e);
375 void ENGINE_register_all_digests(void);
377 /* These functions register all support from the above categories. Note, use of
378 * these functions can result in static linkage of code your application may not
379 * need. If you only need a subset of functionality, consider using more
380 * selective initialisation. */
381 int ENGINE_register_complete(ENGINE *e);
382 int ENGINE_register_all_complete(void);
384 /* Send parametrised control commands to the engine. The possibilities to send
385 * down an integer, a pointer to data or a function pointer are provided. Any of
386 * the parameters may or may not be NULL, depending on the command number. In
387 * actuality, this function only requires a structural (rather than functional)
388 * reference to an engine, but many control commands may require the engine be
389 * functional. The caller should be aware of trying commands that require an
390 * operational ENGINE, and only use functional references in such situations. */
391 int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)());
393 /* This function tests if an ENGINE-specific command is usable as a "setting".
394 * Eg. in an application's config file that gets processed through
395 * ENGINE_ctrl_cmd_string(). If this returns zero, it is not available to
396 * ENGINE_ctrl_cmd_string(), only ENGINE_ctrl(). */
397 int ENGINE_cmd_is_executable(ENGINE *e, int cmd);
399 /* This function works like ENGINE_ctrl() with the exception of taking a
400 * command name instead of a command number, and can handle optional commands.
401 * See the comment on ENGINE_ctrl_cmd_string() for an explanation on how to
402 * use the cmd_name and cmd_optional. */
403 int ENGINE_ctrl_cmd(ENGINE *e, const char *cmd_name,
404 long i, void *p, void (*f)(), int cmd_optional);
406 /* This function passes a command-name and argument to an ENGINE. The cmd_name
407 * is converted to a command number and the control command is called using
408 * 'arg' as an argument (unless the ENGINE doesn't support such a command, in
409 * which case no control command is called). The command is checked for input
410 * flags, and if necessary the argument will be converted to a numeric value. If
411 * cmd_optional is non-zero, then if the ENGINE doesn't support the given
412 * cmd_name the return value will be success anyway. This function is intended
413 * for applications to use so that users (or config files) can supply
414 * engine-specific config data to the ENGINE at run-time to control behaviour of
415 * specific engines. As such, it shouldn't be used for calling ENGINE_ctrl()
416 * functions that return data, deal with binary data, or that are otherwise
417 * supposed to be used directly through ENGINE_ctrl() in application code. Any
418 * "return" data from an ENGINE_ctrl() operation in this function will be lost -
419 * the return value is interpreted as failure if the return value is zero,
420 * success otherwise, and this function returns a boolean value as a result. In
421 * other words, vendors of 'ENGINE'-enabled devices should write ENGINE
422 * implementations with parameterisations that work in this scheme, so that
423 * compliant ENGINE-based applications can work consistently with the same
424 * configuration for the same ENGINE-enabled devices, across applications. */
425 int ENGINE_ctrl_cmd_string(ENGINE *e, const char *cmd_name, const char *arg,
428 /* These functions are useful for manufacturing new ENGINE structures. They
429 * don't address reference counting at all - one uses them to populate an ENGINE
430 * structure with personalised implementations of things prior to using it
431 * directly or adding it to the builtin ENGINE list in OpenSSL. These are also
432 * here so that the ENGINE structure doesn't have to be exposed and break binary
434 ENGINE *ENGINE_new(void);
435 int ENGINE_free(ENGINE *e);
436 int ENGINE_set_id(ENGINE *e, const char *id);
437 int ENGINE_set_name(ENGINE *e, const char *name);
438 int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth);
439 int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth);
440 int ENGINE_set_ECDH(ENGINE *e, const ECDH_METHOD *ecdh_meth);
441 int ENGINE_set_ECDSA(ENGINE *e, const ECDSA_METHOD *ecdsa_meth);
442 int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth);
443 int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth);
444 int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f);
445 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f);
446 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f);
447 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f);
448 int ENGINE_set_load_privkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpriv_f);
449 int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f);
450 int ENGINE_set_ciphers(ENGINE *e, ENGINE_CIPHERS_PTR f);
451 int ENGINE_set_digests(ENGINE *e, ENGINE_DIGESTS_PTR f);
452 int ENGINE_set_flags(ENGINE *e, int flags);
453 int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns);
454 /* These functions (and the "get" function lower down) allow control over any
455 * per-structure ENGINE data. */
456 int ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
457 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
458 int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg);
460 /* This function cleans up anything that needs it. Eg. the ENGINE_add() function
461 * automatically ensures the list cleanup function is registered to be called
462 * from ENGINE_cleanup(). Similarly, all ENGINE_register_*** functions ensure
463 * ENGINE_cleanup() will clean up after them. */
464 void ENGINE_cleanup(void);
466 /* These return values from within the ENGINE structure. These can be useful
467 * with functional references as well as structural references - it depends
468 * which you obtained. Using the result for functional purposes if you only
469 * obtained a structural reference may be problematic! */
470 const char *ENGINE_get_id(const ENGINE *e);
471 const char *ENGINE_get_name(const ENGINE *e);
472 const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e);
473 const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e);
474 const ECDH_METHOD *ENGINE_get_ECDH(const ENGINE *e);
475 const ECDSA_METHOD *ENGINE_get_ECDSA(const ENGINE *e);
476 const DH_METHOD *ENGINE_get_DH(const ENGINE *e);
477 const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e);
478 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e);
479 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e);
480 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e);
481 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e);
482 ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e);
483 ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e);
484 ENGINE_CIPHERS_PTR ENGINE_get_ciphers(const ENGINE *e);
485 ENGINE_DIGESTS_PTR ENGINE_get_digests(const ENGINE *e);
486 const EVP_CIPHER *ENGINE_get_cipher(ENGINE *e, int nid);
487 const EVP_MD *ENGINE_get_digest(ENGINE *e, int nid);
488 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e);
489 int ENGINE_get_flags(const ENGINE *e);
490 void *ENGINE_get_ex_data(const ENGINE *e, int idx);
492 /* FUNCTIONAL functions. These functions deal with ENGINE structures
493 * that have (or will) be initialised for use. Broadly speaking, the
494 * structural functions are useful for iterating the list of available
495 * engine types, creating new engine types, and other "list" operations.
496 * These functions actually deal with ENGINEs that are to be used. As
497 * such these functions can fail (if applicable) when particular
498 * engines are unavailable - eg. if a hardware accelerator is not
499 * attached or not functioning correctly. Each ENGINE has 2 reference
500 * counts; structural and functional. Every time a functional reference
501 * is obtained or released, a corresponding structural reference is
502 * automatically obtained or released too. */
504 /* Initialise a engine type for use (or up its reference count if it's
505 * already in use). This will fail if the engine is not currently
506 * operational and cannot initialise. */
507 int ENGINE_init(ENGINE *e);
508 /* Free a functional reference to a engine type. This does not require
509 * a corresponding call to ENGINE_free as it also releases a structural
511 int ENGINE_finish(ENGINE *e);
513 /* The following functions handle keys that are stored in some secondary
514 * location, handled by the engine. The storage may be on a card or
516 EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id,
517 UI_METHOD *ui_method, void *callback_data);
518 EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id,
519 UI_METHOD *ui_method, void *callback_data);
521 /* This returns a pointer for the current ENGINE structure that
522 * is (by default) performing any RSA operations. The value returned
523 * is an incremented reference, so it should be free'd (ENGINE_finish)
524 * before it is discarded. */
525 ENGINE *ENGINE_get_default_RSA(void);
526 /* Same for the other "methods" */
527 ENGINE *ENGINE_get_default_DSA(void);
528 ENGINE *ENGINE_get_default_ECDH(void);
529 ENGINE *ENGINE_get_default_ECDSA(void);
530 ENGINE *ENGINE_get_default_DH(void);
531 ENGINE *ENGINE_get_default_RAND(void);
532 /* These functions can be used to get a functional reference to perform
533 * ciphering or digesting corresponding to "nid". */
534 ENGINE *ENGINE_get_cipher_engine(int nid);
535 ENGINE *ENGINE_get_digest_engine(int nid);
537 /* This sets a new default ENGINE structure for performing RSA
538 * operations. If the result is non-zero (success) then the ENGINE
539 * structure will have had its reference count up'd so the caller
540 * should still free their own reference 'e'. */
541 int ENGINE_set_default_RSA(ENGINE *e);
542 int ENGINE_set_default_string(ENGINE *e, const char *list);
543 /* Same for the other "methods" */
544 int ENGINE_set_default_DSA(ENGINE *e);
545 int ENGINE_set_default_ECDH(ENGINE *e);
546 int ENGINE_set_default_ECDSA(ENGINE *e);
547 int ENGINE_set_default_DH(ENGINE *e);
548 int ENGINE_set_default_RAND(ENGINE *e);
549 int ENGINE_set_default_ciphers(ENGINE *e);
550 int ENGINE_set_default_digests(ENGINE *e);
552 /* The combination "set" - the flags are bitwise "OR"d from the
553 * ENGINE_METHOD_*** defines above. As with the "ENGINE_register_complete()"
554 * function, this function can result in unnecessary static linkage. If your
555 * application requires only specific functionality, consider using more
556 * selective functions. */
557 int ENGINE_set_default(ENGINE *e, unsigned int flags);
559 void ENGINE_add_conf_module(void);
561 /* Deprecated functions ... */
562 /* int ENGINE_clear_defaults(void); */
564 /**************************/
565 /* DYNAMIC ENGINE SUPPORT */
566 /**************************/
568 /* Binary/behaviour compatibility levels */
569 #define OSSL_DYNAMIC_VERSION (unsigned long)0x00010100
570 /* Binary versions older than this are too old for us (whether we're a loader or
572 #define OSSL_DYNAMIC_OLDEST (unsigned long)0x00010100
574 /* When compiling an ENGINE entirely as an external shared library, loadable by
575 * the "dynamic" ENGINE, these types are needed. The 'dynamic_fns' structure
576 * type provides the calling application's (or library's) error functionality
577 * and memory management function pointers to the loaded library. These should
578 * be used/set in the loaded library code so that the loading application's
579 * 'state' will be used/changed in all operations. */
580 typedef void *(*dyn_MEM_malloc_cb)(size_t);
581 typedef void *(*dyn_MEM_realloc_cb)(void *, size_t);
582 typedef void (*dyn_MEM_free_cb)(void *);
583 typedef struct st_dynamic_MEM_fns {
584 dyn_MEM_malloc_cb malloc_cb;
585 dyn_MEM_realloc_cb realloc_cb;
586 dyn_MEM_free_cb free_cb;
588 /* FIXME: Perhaps the memory and locking code (crypto.h) should declare and use
589 * these types so we (and any other dependant code) can simplify a bit?? */
590 typedef void (*dyn_lock_locking_cb)(int,int,const char *,int);
591 typedef int (*dyn_lock_add_lock_cb)(int*,int,int,const char *,int);
592 typedef struct CRYPTO_dynlock_value *(*dyn_dynlock_create_cb)(
594 typedef void (*dyn_dynlock_lock_cb)(int,struct CRYPTO_dynlock_value *,
596 typedef void (*dyn_dynlock_destroy_cb)(struct CRYPTO_dynlock_value *,
598 typedef struct st_dynamic_LOCK_fns {
599 dyn_lock_locking_cb lock_locking_cb;
600 dyn_lock_add_lock_cb lock_add_lock_cb;
601 dyn_dynlock_create_cb dynlock_create_cb;
602 dyn_dynlock_lock_cb dynlock_lock_cb;
603 dyn_dynlock_destroy_cb dynlock_destroy_cb;
605 /* The top-level structure */
606 typedef struct st_dynamic_fns {
607 const ERR_FNS *err_fns;
608 const CRYPTO_EX_DATA_IMPL *ex_data_fns;
609 dynamic_MEM_fns mem_fns;
610 dynamic_LOCK_fns lock_fns;
613 /* The version checking function should be of this prototype. NB: The
614 * ossl_version value passed in is the OSSL_DYNAMIC_VERSION of the loading code.
615 * If this function returns zero, it indicates a (potential) version
616 * incompatibility and the loaded library doesn't believe it can proceed.
617 * Otherwise, the returned value is the (latest) version supported by the
618 * loading library. The loader may still decide that the loaded code's version
619 * is unsatisfactory and could veto the load. The function is expected to
620 * be implemented with the symbol name "v_check", and a default implementation
621 * can be fully instantiated with IMPLEMENT_DYNAMIC_CHECK_FN(). */
622 typedef unsigned long (*dynamic_v_check_fn)(unsigned long ossl_version);
623 #define IMPLEMENT_DYNAMIC_CHECK_FN() \
624 unsigned long v_check(unsigned long v) { \
625 if(v >= OSSL_DYNAMIC_OLDEST) return OSSL_DYNAMIC_VERSION; \
628 /* This function is passed the ENGINE structure to initialise with its own
629 * function and command settings. It should not adjust the structural or
630 * functional reference counts. If this function returns zero, (a) the load will
631 * be aborted, (b) the previous ENGINE state will be memcpy'd back onto the
632 * structure, and (c) the shared library will be unloaded. So implementations
633 * should do their own internal cleanup in failure circumstances otherwise they
634 * could leak. The 'id' parameter, if non-NULL, represents the ENGINE id that
635 * the loader is looking for. If this is NULL, the shared library can choose to
636 * return failure or to initialise a 'default' ENGINE. If non-NULL, the shared
637 * library must initialise only an ENGINE matching the passed 'id'. The function
638 * is expected to be implemented with the symbol name "bind_engine". A standard
639 * implementation can be instantiated with IMPLEMENT_DYNAMIC_BIND_FN(fn) where
640 * the parameter 'fn' is a callback function that populates the ENGINE structure
641 * and returns an int value (zero for failure). 'fn' should have prototype;
642 * [static] int fn(ENGINE *e, const char *id); */
643 typedef int (*dynamic_bind_engine)(ENGINE *e, const char *id,
644 const dynamic_fns *fns);
645 #define IMPLEMENT_DYNAMIC_BIND_FN(fn) \
646 int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns) { \
647 if(!CRYPTO_set_mem_functions(fns->mem_fns.malloc_cb, \
648 fns->mem_fns.realloc_cb, fns->mem_fns.free_cb)) \
650 CRYPTO_set_locking_callback(fns->lock_fns.lock_locking_cb); \
651 CRYPTO_set_add_lock_callback(fns->lock_fns.lock_add_lock_cb); \
652 CRYPTO_set_dynlock_create_callback(fns->lock_fns.dynlock_create_cb); \
653 CRYPTO_set_dynlock_lock_callback(fns->lock_fns.dynlock_lock_cb); \
654 CRYPTO_set_dynlock_destroy_callback(fns->lock_fns.dynlock_destroy_cb); \
655 if(!CRYPTO_set_ex_data_implementation(fns->ex_data_fns)) \
657 if(!ERR_set_implementation(fns->err_fns)) return 0; \
658 if(!fn(e,id)) return 0; \
661 /* BEGIN ERROR CODES */
662 /* The following lines are auto generated by the script mkerr.pl. Any changes
663 * made after this point may be overwritten when the script is next run.
665 void ERR_load_ENGINE_strings(void);
667 /* Error codes for the ENGINE functions. */
669 /* Function codes. */
670 #define ENGINE_F_DYNAMIC_CTRL 180
671 #define ENGINE_F_DYNAMIC_GET_DATA_CTX 181
672 #define ENGINE_F_DYNAMIC_LOAD 182
673 #define ENGINE_F_ENGINE_ADD 105
674 #define ENGINE_F_ENGINE_BY_ID 106
675 #define ENGINE_F_ENGINE_CMD_IS_EXECUTABLE 170
676 #define ENGINE_F_ENGINE_CTRL 142
677 #define ENGINE_F_ENGINE_CTRL_CMD 178
678 #define ENGINE_F_ENGINE_CTRL_CMD_STRING 171
679 #define ENGINE_F_ENGINE_FINISH 107
680 #define ENGINE_F_ENGINE_FREE 108
681 #define ENGINE_F_ENGINE_GET_CIPHER 185
682 #define ENGINE_F_ENGINE_GET_DEFAULT_TYPE 177
683 #define ENGINE_F_ENGINE_GET_DIGEST 186
684 #define ENGINE_F_ENGINE_GET_NEXT 115
685 #define ENGINE_F_ENGINE_GET_PREV 116
686 #define ENGINE_F_ENGINE_INIT 119
687 #define ENGINE_F_ENGINE_LIST_ADD 120
688 #define ENGINE_F_ENGINE_LIST_REMOVE 121
689 #define ENGINE_F_ENGINE_LOAD_PRIVATE_KEY 150
690 #define ENGINE_F_ENGINE_LOAD_PUBLIC_KEY 151
691 #define ENGINE_F_ENGINE_MODULE_INIT 187
692 #define ENGINE_F_ENGINE_NEW 122
693 #define ENGINE_F_ENGINE_REMOVE 123
694 #define ENGINE_F_ENGINE_SET_DEFAULT_STRING 189
695 #define ENGINE_F_ENGINE_SET_DEFAULT_TYPE 126
696 #define ENGINE_F_ENGINE_SET_ID 129
697 #define ENGINE_F_ENGINE_SET_NAME 130
698 #define ENGINE_F_ENGINE_TABLE_REGISTER 184
699 #define ENGINE_F_ENGINE_UNLOAD_KEY 152
700 #define ENGINE_F_INT_CTRL_HELPER 172
701 #define ENGINE_F_INT_ENGINE_CONFIGURE 188
702 #define ENGINE_F_LOG_MESSAGE 141
703 #define ENGINE_F_SET_DATA_CTX 183
706 #define ENGINE_R_ALREADY_LOADED 100
707 #define ENGINE_R_ARGUMENT_IS_NOT_A_NUMBER 133
708 #define ENGINE_R_CMD_NOT_EXECUTABLE 134
709 #define ENGINE_R_COMMAND_TAKES_INPUT 135
710 #define ENGINE_R_COMMAND_TAKES_NO_INPUT 136
711 #define ENGINE_R_CONFLICTING_ENGINE_ID 103
712 #define ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED 119
713 #define ENGINE_R_DH_NOT_IMPLEMENTED 139
714 #define ENGINE_R_DSA_NOT_IMPLEMENTED 140
715 #define ENGINE_R_DSO_FAILURE 104
716 #define ENGINE_R_DSO_NOT_FOUND 132
717 #define ENGINE_R_ENGINES_SECTION_ERROR 148
718 #define ENGINE_R_ENGINE_IS_NOT_IN_LIST 105
719 #define ENGINE_R_ENGINE_SECTION_ERROR 149
720 #define ENGINE_R_FAILED_LOADING_PRIVATE_KEY 128
721 #define ENGINE_R_FAILED_LOADING_PUBLIC_KEY 129
722 #define ENGINE_R_FINISH_FAILED 106
723 #define ENGINE_R_GET_HANDLE_FAILED 107
724 #define ENGINE_R_ID_OR_NAME_MISSING 108
725 #define ENGINE_R_INIT_FAILED 109
726 #define ENGINE_R_INTERNAL_LIST_ERROR 110
727 #define ENGINE_R_INVALID_ARGUMENT 143
728 #define ENGINE_R_INVALID_CMD_NAME 137
729 #define ENGINE_R_INVALID_CMD_NUMBER 138
730 #define ENGINE_R_INVALID_INIT_VALUE 151
731 #define ENGINE_R_INVALID_STRING 150
732 #define ENGINE_R_NOT_INITIALISED 117
733 #define ENGINE_R_NOT_LOADED 112
734 #define ENGINE_R_NO_CONTROL_FUNCTION 120
735 #define ENGINE_R_NO_INDEX 144
736 #define ENGINE_R_NO_LOAD_FUNCTION 125
737 #define ENGINE_R_NO_REFERENCE 130
738 #define ENGINE_R_NO_SUCH_ENGINE 116
739 #define ENGINE_R_NO_UNLOAD_FUNCTION 126
740 #define ENGINE_R_PROVIDE_PARAMETERS 113
741 #define ENGINE_R_RSA_NOT_IMPLEMENTED 141
742 #define ENGINE_R_UNIMPLEMENTED_CIPHER 146
743 #define ENGINE_R_UNIMPLEMENTED_DIGEST 147
744 #define ENGINE_R_VERSION_INCOMPATIBILITY 145