2 * Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 /* ====================================================================
11 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
12 * ECDH support in OpenSSL originally developed by
13 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
16 #ifndef HEADER_ENGINE_H
17 # define HEADER_ENGINE_H
19 # include <openssl/opensslconf.h>
21 # ifndef OPENSSL_NO_ENGINE
22 # if OPENSSL_API_COMPAT < 0x10100000L
23 # include <openssl/bn.h>
24 # include <openssl/rsa.h>
25 # include <openssl/dsa.h>
26 # include <openssl/dh.h>
27 # include <openssl/ec.h>
28 # include <openssl/rand.h>
29 # include <openssl/ui.h>
30 # include <openssl/err.h>
32 # include <openssl/ossl_typ.h>
33 # include <openssl/symhacks.h>
34 # include <openssl/x509.h>
40 * These flags are used to control combinations of algorithm (methods) by
43 # define ENGINE_METHOD_RSA (unsigned int)0x0001
44 # define ENGINE_METHOD_DSA (unsigned int)0x0002
45 # define ENGINE_METHOD_DH (unsigned int)0x0004
46 # define ENGINE_METHOD_RAND (unsigned int)0x0008
47 # define ENGINE_METHOD_CIPHERS (unsigned int)0x0040
48 # define ENGINE_METHOD_DIGESTS (unsigned int)0x0080
49 # define ENGINE_METHOD_PKEY_METHS (unsigned int)0x0200
50 # define ENGINE_METHOD_PKEY_ASN1_METHS (unsigned int)0x0400
51 # define ENGINE_METHOD_EC (unsigned int)0x0800
52 /* Obvious all-or-nothing cases. */
53 # define ENGINE_METHOD_ALL (unsigned int)0xFFFF
54 # define ENGINE_METHOD_NONE (unsigned int)0x0000
57 * This(ese) flag(s) controls behaviour of the ENGINE_TABLE mechanism used
58 * internally to control registration of ENGINE implementations, and can be
59 * set by ENGINE_set_table_flags(). The "NOINIT" flag prevents attempts to
60 * initialise registered ENGINEs if they are not already initialised.
62 # define ENGINE_TABLE_FLAG_NOINIT (unsigned int)0x0001
64 /* ENGINE flags that can be set by ENGINE_set_flags(). */
66 /* #define ENGINE_FLAGS_MALLOCED 0x0001 */
69 * This flag is for ENGINEs that wish to handle the various 'CMD'-related
70 * control commands on their own. Without this flag, ENGINE_ctrl() handles
71 * these control commands on behalf of the ENGINE using their "cmd_defns"
74 # define ENGINE_FLAGS_MANUAL_CMD_CTRL (int)0x0002
77 * This flag is for ENGINEs who return new duplicate structures when found
78 * via "ENGINE_by_id()". When an ENGINE must store state (eg. if
79 * ENGINE_ctrl() commands are called in sequence as part of some stateful
80 * process like key-generation setup and execution), it can set this flag -
81 * then each attempt to obtain the ENGINE will result in it being copied into
82 * a new structure. Normally, ENGINEs don't declare this flag so
83 * ENGINE_by_id() just increments the existing ENGINE's structural reference
86 # define ENGINE_FLAGS_BY_ID_COPY (int)0x0004
89 * This flag if for an ENGINE that does not want its methods registered as
90 * part of ENGINE_register_all_complete() for example if the methods are not
91 * usable as default methods.
94 # define ENGINE_FLAGS_NO_REGISTER_ALL (int)0x0008
97 * ENGINEs can support their own command types, and these flags are used in
98 * ENGINE_CTRL_GET_CMD_FLAGS to indicate to the caller what kind of input
99 * each command expects. Currently only numeric and string input is
100 * supported. If a control command supports none of the _NUMERIC, _STRING, or
101 * _NO_INPUT options, then it is regarded as an "internal" control command -
102 * and not for use in config setting situations. As such, they're not
103 * available to the ENGINE_ctrl_cmd_string() function, only raw ENGINE_ctrl()
104 * access. Changes to this list of 'command types' should be reflected
105 * carefully in ENGINE_cmd_is_executable() and ENGINE_ctrl_cmd_string().
108 /* accepts a 'long' input value (3rd parameter to ENGINE_ctrl) */
109 # define ENGINE_CMD_FLAG_NUMERIC (unsigned int)0x0001
111 * accepts string input (cast from 'void*' to 'const char *', 4th parameter
114 # define ENGINE_CMD_FLAG_STRING (unsigned int)0x0002
116 * Indicates that the control command takes *no* input. Ie. the control
117 * command is unparameterised.
119 # define ENGINE_CMD_FLAG_NO_INPUT (unsigned int)0x0004
121 * Indicates that the control command is internal. This control command won't
122 * be shown in any output, and is only usable through the ENGINE_ctrl_cmd()
125 # define ENGINE_CMD_FLAG_INTERNAL (unsigned int)0x0008
128 * NB: These 3 control commands are deprecated and should not be used.
129 * ENGINEs relying on these commands should compile conditional support for
130 * compatibility (eg. if these symbols are defined) but should also migrate
131 * the same functionality to their own ENGINE-specific control functions that
132 * can be "discovered" by calling applications. The fact these control
133 * commands wouldn't be "executable" (ie. usable by text-based config)
134 * doesn't change the fact that application code can find and use them
135 * without requiring per-ENGINE hacking.
139 * These flags are used to tell the ctrl function what should be done. All
140 * command numbers are shared between all engines, even if some don't make
141 * sense to some engines. In such a case, they do nothing but return the
142 * error ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED.
144 # define ENGINE_CTRL_SET_LOGSTREAM 1
145 # define ENGINE_CTRL_SET_PASSWORD_CALLBACK 2
146 # define ENGINE_CTRL_HUP 3/* Close and reinitialise
147 * any handles/connections
149 # define ENGINE_CTRL_SET_USER_INTERFACE 4/* Alternative to callback */
150 # define ENGINE_CTRL_SET_CALLBACK_DATA 5/* User-specific data, used
151 * when calling the password
152 * callback and the user
154 # define ENGINE_CTRL_LOAD_CONFIGURATION 6/* Load a configuration,
155 * given a string that
156 * represents a file name
158 # define ENGINE_CTRL_LOAD_SECTION 7/* Load data from a given
159 * section in the already
160 * loaded configuration */
163 * These control commands allow an application to deal with an arbitrary
164 * engine in a dynamic way. Warn: Negative return values indicate errors FOR
165 * THESE COMMANDS because zero is used to indicate 'end-of-list'. Other
166 * commands, including ENGINE-specific command types, return zero for an
167 * error. An ENGINE can choose to implement these ctrl functions, and can
168 * internally manage things however it chooses - it does so by setting the
169 * ENGINE_FLAGS_MANUAL_CMD_CTRL flag (using ENGINE_set_flags()). Otherwise
170 * the ENGINE_ctrl() code handles this on the ENGINE's behalf using the
171 * cmd_defns data (set using ENGINE_set_cmd_defns()). This means an ENGINE's
172 * ctrl() handler need only implement its own commands - the above "meta"
173 * commands will be taken care of.
177 * Returns non-zero if the supplied ENGINE has a ctrl() handler. If "not",
178 * then all the remaining control commands will return failure, so it is
179 * worth checking this first if the caller is trying to "discover" the
180 * engine's capabilities and doesn't want errors generated unnecessarily.
182 # define ENGINE_CTRL_HAS_CTRL_FUNCTION 10
184 * Returns a positive command number for the first command supported by the
185 * engine. Returns zero if no ctrl commands are supported.
187 # define ENGINE_CTRL_GET_FIRST_CMD_TYPE 11
189 * The 'long' argument specifies a command implemented by the engine, and the
190 * return value is the next command supported, or zero if there are no more.
192 # define ENGINE_CTRL_GET_NEXT_CMD_TYPE 12
194 * The 'void*' argument is a command name (cast from 'const char *'), and the
195 * return value is the command that corresponds to it.
197 # define ENGINE_CTRL_GET_CMD_FROM_NAME 13
199 * The next two allow a command to be converted into its corresponding string
200 * form. In each case, the 'long' argument supplies the command. In the
201 * NAME_LEN case, the return value is the length of the command name (not
202 * counting a trailing EOL). In the NAME case, the 'void*' argument must be a
203 * string buffer large enough, and it will be populated with the name of the
204 * command (WITH a trailing EOL).
206 # define ENGINE_CTRL_GET_NAME_LEN_FROM_CMD 14
207 # define ENGINE_CTRL_GET_NAME_FROM_CMD 15
208 /* The next two are similar but give a "short description" of a command. */
209 # define ENGINE_CTRL_GET_DESC_LEN_FROM_CMD 16
210 # define ENGINE_CTRL_GET_DESC_FROM_CMD 17
212 * With this command, the return value is the OR'd combination of
213 * ENGINE_CMD_FLAG_*** values that indicate what kind of input a given
214 * engine-specific ctrl command expects.
216 # define ENGINE_CTRL_GET_CMD_FLAGS 18
219 * ENGINE implementations should start the numbering of their own control
220 * commands from this value. (ie. ENGINE_CMD_BASE, ENGINE_CMD_BASE + 1, etc).
222 # define ENGINE_CMD_BASE 200
225 * NB: These 2 nCipher "chil" control commands are deprecated, and their
226 * functionality is now available through ENGINE-specific control commands
227 * (exposed through the above-mentioned 'CMD'-handling). Code using these 2
228 * commands should be migrated to the more general command handling before
232 /* Flags specific to the nCipher "chil" engine */
233 # define ENGINE_CTRL_CHIL_SET_FORKCHECK 100
235 * Depending on the value of the (long)i argument, this sets or
236 * unsets the SimpleForkCheck flag in the CHIL API to enable or
237 * disable checking and workarounds for applications that fork().
239 # define ENGINE_CTRL_CHIL_NO_LOCKING 101
241 * This prevents the initialisation function from providing mutex
242 * callbacks to the nCipher library.
246 * If an ENGINE supports its own specific control commands and wishes the
247 * framework to handle the above 'ENGINE_CMD_***'-manipulation commands on
248 * its behalf, it should supply a null-terminated array of ENGINE_CMD_DEFN
249 * entries to ENGINE_set_cmd_defns(). It should also implement a ctrl()
250 * handler that supports the stated commands (ie. the "cmd_num" entries as
251 * described by the array). NB: The array must be ordered in increasing order
252 * of cmd_num. "null-terminated" means that the last ENGINE_CMD_DEFN element
253 * has cmd_num set to zero and/or cmd_name set to NULL.
255 typedef struct ENGINE_CMD_DEFN_st {
256 unsigned int cmd_num; /* The command number */
257 const char *cmd_name; /* The command name itself */
258 const char *cmd_desc; /* A short description of the command */
259 unsigned int cmd_flags; /* The input the command expects */
262 /* Generic function pointer */
263 typedef int (*ENGINE_GEN_FUNC_PTR) (void);
264 /* Generic function pointer taking no arguments */
265 typedef int (*ENGINE_GEN_INT_FUNC_PTR) (ENGINE *);
266 /* Specific control function pointer */
267 typedef int (*ENGINE_CTRL_FUNC_PTR) (ENGINE *, int, long, void *,
269 /* Generic load_key function pointer */
270 typedef EVP_PKEY *(*ENGINE_LOAD_KEY_PTR)(ENGINE *, const char *,
271 UI_METHOD *ui_method,
272 void *callback_data);
273 typedef int (*ENGINE_SSL_CLIENT_CERT_PTR) (ENGINE *, SSL *ssl,
274 STACK_OF(X509_NAME) *ca_dn,
275 X509 **pcert, EVP_PKEY **pkey,
276 STACK_OF(X509) **pother,
277 UI_METHOD *ui_method,
278 void *callback_data);
280 * These callback types are for an ENGINE's handler for cipher and digest logic.
281 * These handlers have these prototypes;
282 * int foo(ENGINE *e, const EVP_CIPHER **cipher, const int **nids, int nid);
283 * int foo(ENGINE *e, const EVP_MD **digest, const int **nids, int nid);
284 * Looking at how to implement these handlers in the case of cipher support, if
285 * the framework wants the EVP_CIPHER for 'nid', it will call;
286 * foo(e, &p_evp_cipher, NULL, nid); (return zero for failure)
287 * If the framework wants a list of supported 'nid's, it will call;
288 * 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
292 * second parameter is non-NULL it is set to the size of the returned array.
294 typedef int (*ENGINE_CIPHERS_PTR) (ENGINE *, const EVP_CIPHER **,
296 typedef int (*ENGINE_DIGESTS_PTR) (ENGINE *, const EVP_MD **, const int **,
298 typedef int (*ENGINE_PKEY_METHS_PTR) (ENGINE *, EVP_PKEY_METHOD **,
300 typedef int (*ENGINE_PKEY_ASN1_METHS_PTR) (ENGINE *, EVP_PKEY_ASN1_METHOD **,
303 * STRUCTURE functions ... all of these functions deal with pointers to
304 * ENGINE structures where the pointers have a "structural reference". This
305 * means that their reference is to allowed access to the structure but it
306 * does not imply that the structure is functional. To simply increment or
307 * decrement the structural reference count, use ENGINE_by_id and
308 * ENGINE_free. NB: This is not required when iterating using ENGINE_get_next
309 * as it will automatically decrement the structural reference count of the
310 * "current" ENGINE and increment the structural reference count of the
311 * ENGINE it returns (unless it is NULL).
314 /* Get the first/last "ENGINE" type available. */
315 ENGINE *ENGINE_get_first(void);
316 ENGINE *ENGINE_get_last(void);
317 /* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */
318 ENGINE *ENGINE_get_next(ENGINE *e);
319 ENGINE *ENGINE_get_prev(ENGINE *e);
320 /* Add another "ENGINE" type into the array. */
321 int ENGINE_add(ENGINE *e);
322 /* Remove an existing "ENGINE" type from the array. */
323 int ENGINE_remove(ENGINE *e);
324 /* Retrieve an engine from the list by its unique "id" value. */
325 ENGINE *ENGINE_by_id(const char *id);
327 #if OPENSSL_API_COMPAT < 0x10100000L
328 # define ENGINE_load_openssl() \
329 OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_OPENSSL, NULL)
330 # define ENGINE_load_dynamic() \
331 OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_DYNAMIC, NULL)
332 # ifndef OPENSSL_NO_STATIC_ENGINE
333 # define ENGINE_load_padlock() \
334 OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_PADLOCK, NULL)
335 # define ENGINE_load_capi() \
336 OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_CAPI, NULL)
337 # define ENGINE_load_afalg() \
338 OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_AFALG, NULL)
340 # define ENGINE_load_cryptodev() \
341 OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_CRYPTODEV, NULL)
342 # define ENGINE_load_rdrand() \
343 OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_RDRAND, NULL)
345 void ENGINE_load_builtin_engines(void);
348 * Get and set global flags (ENGINE_TABLE_FLAG_***) for the implementation
349 * "registry" handling.
351 unsigned int ENGINE_get_table_flags(void);
352 void ENGINE_set_table_flags(unsigned int flags);
354 /*- Manage registration of ENGINEs per "table". For each type, there are 3
356 * ENGINE_register_***(e) - registers the implementation from 'e' (if it has one)
357 * ENGINE_unregister_***(e) - unregister the implementation from 'e'
358 * ENGINE_register_all_***() - call ENGINE_register_***() for each 'e' in the list
359 * Cleanup is automatically registered from each table when required.
362 int ENGINE_register_RSA(ENGINE *e);
363 void ENGINE_unregister_RSA(ENGINE *e);
364 void ENGINE_register_all_RSA(void);
366 int ENGINE_register_DSA(ENGINE *e);
367 void ENGINE_unregister_DSA(ENGINE *e);
368 void ENGINE_register_all_DSA(void);
370 int ENGINE_register_EC(ENGINE *e);
371 void ENGINE_unregister_EC(ENGINE *e);
372 void ENGINE_register_all_EC(void);
374 int ENGINE_register_DH(ENGINE *e);
375 void ENGINE_unregister_DH(ENGINE *e);
376 void ENGINE_register_all_DH(void);
378 int ENGINE_register_RAND(ENGINE *e);
379 void ENGINE_unregister_RAND(ENGINE *e);
380 void ENGINE_register_all_RAND(void);
382 int ENGINE_register_ciphers(ENGINE *e);
383 void ENGINE_unregister_ciphers(ENGINE *e);
384 void ENGINE_register_all_ciphers(void);
386 int ENGINE_register_digests(ENGINE *e);
387 void ENGINE_unregister_digests(ENGINE *e);
388 void ENGINE_register_all_digests(void);
390 int ENGINE_register_pkey_meths(ENGINE *e);
391 void ENGINE_unregister_pkey_meths(ENGINE *e);
392 void ENGINE_register_all_pkey_meths(void);
394 int ENGINE_register_pkey_asn1_meths(ENGINE *e);
395 void ENGINE_unregister_pkey_asn1_meths(ENGINE *e);
396 void ENGINE_register_all_pkey_asn1_meths(void);
399 * These functions register all support from the above categories. Note, use
400 * of these functions can result in static linkage of code your application
401 * may not need. If you only need a subset of functionality, consider using
402 * more selective initialisation.
404 int ENGINE_register_complete(ENGINE *e);
405 int ENGINE_register_all_complete(void);
408 * Send parametrised control commands to the engine. The possibilities to
409 * send down an integer, a pointer to data or a function pointer are
410 * provided. Any of the parameters may or may not be NULL, depending on the
411 * command number. In actuality, this function only requires a structural
412 * (rather than functional) reference to an engine, but many control commands
413 * may require the engine be functional. The caller should be aware of trying
414 * commands that require an operational ENGINE, and only use functional
415 * references in such situations.
417 int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void));
420 * This function tests if an ENGINE-specific command is usable as a
421 * "setting". Eg. in an application's config file that gets processed through
422 * ENGINE_ctrl_cmd_string(). If this returns zero, it is not available to
423 * ENGINE_ctrl_cmd_string(), only ENGINE_ctrl().
425 int ENGINE_cmd_is_executable(ENGINE *e, int cmd);
428 * This function works like ENGINE_ctrl() with the exception of taking a
429 * command name instead of a command number, and can handle optional
430 * commands. See the comment on ENGINE_ctrl_cmd_string() for an explanation
431 * on how to use the cmd_name and cmd_optional.
433 int ENGINE_ctrl_cmd(ENGINE *e, const char *cmd_name,
434 long i, void *p, void (*f) (void), int cmd_optional);
437 * This function passes a command-name and argument to an ENGINE. The
438 * cmd_name is converted to a command number and the control command is
439 * called using 'arg' as an argument (unless the ENGINE doesn't support such
440 * a command, in which case no control command is called). The command is
441 * checked for input flags, and if necessary the argument will be converted
442 * to a numeric value. If cmd_optional is non-zero, then if the ENGINE
443 * doesn't support the given cmd_name the return value will be success
444 * anyway. This function is intended for applications to use so that users
445 * (or config files) can supply engine-specific config data to the ENGINE at
446 * run-time to control behaviour of specific engines. As such, it shouldn't
447 * be used for calling ENGINE_ctrl() functions that return data, deal with
448 * binary data, or that are otherwise supposed to be used directly through
449 * ENGINE_ctrl() in application code. Any "return" data from an ENGINE_ctrl()
450 * operation in this function will be lost - the return value is interpreted
451 * as failure if the return value is zero, success otherwise, and this
452 * function returns a boolean value as a result. In other words, vendors of
453 * 'ENGINE'-enabled devices should write ENGINE implementations with
454 * parameterisations that work in this scheme, so that compliant ENGINE-based
455 * applications can work consistently with the same configuration for the
456 * same ENGINE-enabled devices, across applications.
458 int ENGINE_ctrl_cmd_string(ENGINE *e, const char *cmd_name, const char *arg,
462 * These functions are useful for manufacturing new ENGINE structures. They
463 * don't address reference counting at all - one uses them to populate an
464 * ENGINE structure with personalised implementations of things prior to
465 * using it directly or adding it to the builtin ENGINE list in OpenSSL.
466 * These are also here so that the ENGINE structure doesn't have to be
467 * exposed and break binary compatibility!
469 ENGINE *ENGINE_new(void);
470 int ENGINE_free(ENGINE *e);
471 int ENGINE_up_ref(ENGINE *e);
472 int ENGINE_set_id(ENGINE *e, const char *id);
473 int ENGINE_set_name(ENGINE *e, const char *name);
474 int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth);
475 int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth);
476 int ENGINE_set_EC(ENGINE *e, const EC_KEY_METHOD *ecdsa_meth);
477 int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth);
478 int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth);
479 int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f);
480 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f);
481 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f);
482 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f);
483 int ENGINE_set_load_privkey_function(ENGINE *e,
484 ENGINE_LOAD_KEY_PTR loadpriv_f);
485 int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f);
486 int ENGINE_set_load_ssl_client_cert_function(ENGINE *e,
487 ENGINE_SSL_CLIENT_CERT_PTR
489 int ENGINE_set_ciphers(ENGINE *e, ENGINE_CIPHERS_PTR f);
490 int ENGINE_set_digests(ENGINE *e, ENGINE_DIGESTS_PTR f);
491 int ENGINE_set_pkey_meths(ENGINE *e, ENGINE_PKEY_METHS_PTR f);
492 int ENGINE_set_pkey_asn1_meths(ENGINE *e, ENGINE_PKEY_ASN1_METHS_PTR f);
493 int ENGINE_set_flags(ENGINE *e, int flags);
494 int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns);
495 /* These functions allow control over any per-structure ENGINE data. */
496 #define ENGINE_get_ex_new_index(l, p, newf, dupf, freef) \
497 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_ENGINE, l, p, newf, dupf, freef)
498 int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg);
499 void *ENGINE_get_ex_data(const ENGINE *e, int idx);
501 #if OPENSSL_API_COMPAT < 0x10100000L
503 * This function previously cleaned up anything that needs it. Auto-deinit will
504 * now take care of it so it is no longer required to call this function.
506 # define ENGINE_cleanup() while(0) continue
510 * These return values from within the ENGINE structure. These can be useful
511 * with functional references as well as structural references - it depends
512 * which you obtained. Using the result for functional purposes if you only
513 * obtained a structural reference may be problematic!
515 const char *ENGINE_get_id(const ENGINE *e);
516 const char *ENGINE_get_name(const ENGINE *e);
517 const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e);
518 const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e);
519 const EC_KEY_METHOD *ENGINE_get_EC(const ENGINE *e);
520 const DH_METHOD *ENGINE_get_DH(const ENGINE *e);
521 const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e);
522 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e);
523 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e);
524 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e);
525 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e);
526 ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e);
527 ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e);
528 ENGINE_SSL_CLIENT_CERT_PTR ENGINE_get_ssl_client_cert_function(const ENGINE
530 ENGINE_CIPHERS_PTR ENGINE_get_ciphers(const ENGINE *e);
531 ENGINE_DIGESTS_PTR ENGINE_get_digests(const ENGINE *e);
532 ENGINE_PKEY_METHS_PTR ENGINE_get_pkey_meths(const ENGINE *e);
533 ENGINE_PKEY_ASN1_METHS_PTR ENGINE_get_pkey_asn1_meths(const ENGINE *e);
534 const EVP_CIPHER *ENGINE_get_cipher(ENGINE *e, int nid);
535 const EVP_MD *ENGINE_get_digest(ENGINE *e, int nid);
536 const EVP_PKEY_METHOD *ENGINE_get_pkey_meth(ENGINE *e, int nid);
537 const EVP_PKEY_ASN1_METHOD *ENGINE_get_pkey_asn1_meth(ENGINE *e, int nid);
538 const EVP_PKEY_ASN1_METHOD *ENGINE_get_pkey_asn1_meth_str(ENGINE *e,
541 const EVP_PKEY_ASN1_METHOD *ENGINE_pkey_asn1_find_str(ENGINE **pe,
544 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e);
545 int ENGINE_get_flags(const ENGINE *e);
548 * FUNCTIONAL functions. These functions deal with ENGINE structures that
549 * have (or will) be initialised for use. Broadly speaking, the structural
550 * functions are useful for iterating the list of available engine types,
551 * creating new engine types, and other "list" operations. These functions
552 * actually deal with ENGINEs that are to be used. As such these functions
553 * can fail (if applicable) when particular engines are unavailable - eg. if
554 * a hardware accelerator is not attached or not functioning correctly. Each
555 * ENGINE has 2 reference counts; structural and functional. Every time a
556 * functional reference is obtained or released, a corresponding structural
557 * reference is automatically obtained or released too.
561 * Initialise a engine type for use (or up its reference count if it's
562 * already in use). This will fail if the engine is not currently operational
563 * and cannot initialise.
565 int ENGINE_init(ENGINE *e);
567 * Free a functional reference to a engine type. This does not require a
568 * corresponding call to ENGINE_free as it also releases a structural
571 int ENGINE_finish(ENGINE *e);
574 * The following functions handle keys that are stored in some secondary
575 * location, handled by the engine. The storage may be on a card or
578 EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id,
579 UI_METHOD *ui_method, void *callback_data);
580 EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id,
581 UI_METHOD *ui_method, void *callback_data);
582 int ENGINE_load_ssl_client_cert(ENGINE *e, SSL *s,
583 STACK_OF(X509_NAME) *ca_dn, X509 **pcert,
584 EVP_PKEY **ppkey, STACK_OF(X509) **pother,
585 UI_METHOD *ui_method, void *callback_data);
588 * This returns a pointer for the current ENGINE structure that is (by
589 * default) performing any RSA operations. The value returned is an
590 * incremented reference, so it should be free'd (ENGINE_finish) before it is
593 ENGINE *ENGINE_get_default_RSA(void);
594 /* Same for the other "methods" */
595 ENGINE *ENGINE_get_default_DSA(void);
596 ENGINE *ENGINE_get_default_EC(void);
597 ENGINE *ENGINE_get_default_DH(void);
598 ENGINE *ENGINE_get_default_RAND(void);
600 * These functions can be used to get a functional reference to perform
601 * ciphering or digesting corresponding to "nid".
603 ENGINE *ENGINE_get_cipher_engine(int nid);
604 ENGINE *ENGINE_get_digest_engine(int nid);
605 ENGINE *ENGINE_get_pkey_meth_engine(int nid);
606 ENGINE *ENGINE_get_pkey_asn1_meth_engine(int nid);
609 * This sets a new default ENGINE structure for performing RSA operations. If
610 * the result is non-zero (success) then the ENGINE structure will have had
611 * its reference count up'd so the caller should still free their own
614 int ENGINE_set_default_RSA(ENGINE *e);
615 int ENGINE_set_default_string(ENGINE *e, const char *def_list);
616 /* Same for the other "methods" */
617 int ENGINE_set_default_DSA(ENGINE *e);
618 int ENGINE_set_default_EC(ENGINE *e);
619 int ENGINE_set_default_DH(ENGINE *e);
620 int ENGINE_set_default_RAND(ENGINE *e);
621 int ENGINE_set_default_ciphers(ENGINE *e);
622 int ENGINE_set_default_digests(ENGINE *e);
623 int ENGINE_set_default_pkey_meths(ENGINE *e);
624 int ENGINE_set_default_pkey_asn1_meths(ENGINE *e);
627 * The combination "set" - the flags are bitwise "OR"d from the
628 * ENGINE_METHOD_*** defines above. As with the "ENGINE_register_complete()"
629 * function, this function can result in unnecessary static linkage. If your
630 * application requires only specific functionality, consider using more
631 * selective functions.
633 int ENGINE_set_default(ENGINE *e, unsigned int flags);
635 void ENGINE_add_conf_module(void);
637 /* Deprecated functions ... */
638 /* int ENGINE_clear_defaults(void); */
640 /**************************/
641 /* DYNAMIC ENGINE SUPPORT */
642 /**************************/
644 /* Binary/behaviour compatibility levels */
645 # define OSSL_DYNAMIC_VERSION (unsigned long)0x00030000
647 * Binary versions older than this are too old for us (whether we're a loader
650 # define OSSL_DYNAMIC_OLDEST (unsigned long)0x00030000
653 * When compiling an ENGINE entirely as an external shared library, loadable
654 * by the "dynamic" ENGINE, these types are needed. The 'dynamic_fns'
655 * structure type provides the calling application's (or library's) error
656 * functionality and memory management function pointers to the loaded
657 * library. These should be used/set in the loaded library code so that the
658 * loading application's 'state' will be used/changed in all operations. The
659 * 'static_state' pointer allows the loaded library to know if it shares the
660 * same static data as the calling application (or library), and thus whether
661 * these callbacks need to be set or not.
663 typedef void *(*dyn_MEM_malloc_fn) (size_t, const char *, int);
664 typedef void *(*dyn_MEM_realloc_fn) (void *, size_t, const char *, int);
665 typedef void (*dyn_MEM_free_fn) (void *, const char *, int);
666 typedef struct st_dynamic_MEM_fns {
667 dyn_MEM_malloc_fn malloc_fn;
668 dyn_MEM_realloc_fn realloc_fn;
669 dyn_MEM_free_fn free_fn;
672 * FIXME: Perhaps the memory and locking code (crypto.h) should declare and
673 * use these types so we (and any other dependent code) can simplify a bit??
675 /* The top-level structure */
676 typedef struct st_dynamic_fns {
678 dynamic_MEM_fns mem_fns;
682 * The version checking function should be of this prototype. NB: The
683 * ossl_version value passed in is the OSSL_DYNAMIC_VERSION of the loading
684 * code. If this function returns zero, it indicates a (potential) version
685 * incompatibility and the loaded library doesn't believe it can proceed.
686 * Otherwise, the returned value is the (latest) version supported by the
687 * loading library. The loader may still decide that the loaded code's
688 * version is unsatisfactory and could veto the load. The function is
689 * expected to be implemented with the symbol name "v_check", and a default
690 * implementation can be fully instantiated with
691 * IMPLEMENT_DYNAMIC_CHECK_FN().
693 typedef unsigned long (*dynamic_v_check_fn) (unsigned long ossl_version);
694 # define IMPLEMENT_DYNAMIC_CHECK_FN() \
695 OPENSSL_EXPORT unsigned long v_check(unsigned long v); \
696 OPENSSL_EXPORT unsigned long v_check(unsigned long v) { \
697 if (v >= OSSL_DYNAMIC_OLDEST) return OSSL_DYNAMIC_VERSION; \
701 * This function is passed the ENGINE structure to initialise with its own
702 * function and command settings. It should not adjust the structural or
703 * functional reference counts. If this function returns zero, (a) the load
704 * will be aborted, (b) the previous ENGINE state will be memcpy'd back onto
705 * the structure, and (c) the shared library will be unloaded. So
706 * implementations should do their own internal cleanup in failure
707 * circumstances otherwise they could leak. The 'id' parameter, if non-NULL,
708 * represents the ENGINE id that the loader is looking for. If this is NULL,
709 * the shared library can choose to return failure or to initialise a
710 * 'default' ENGINE. If non-NULL, the shared library must initialise only an
711 * ENGINE matching the passed 'id'. The function is expected to be
712 * implemented with the symbol name "bind_engine". A standard implementation
713 * can be instantiated with IMPLEMENT_DYNAMIC_BIND_FN(fn) where the parameter
714 * 'fn' is a callback function that populates the ENGINE structure and
715 * returns an int value (zero for failure). 'fn' should have prototype;
716 * [static] int fn(ENGINE *e, const char *id);
718 typedef int (*dynamic_bind_engine) (ENGINE *e, const char *id,
719 const dynamic_fns *fns);
720 # define IMPLEMENT_DYNAMIC_BIND_FN(fn) \
722 int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns); \
724 int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns) { \
725 if (ENGINE_get_static_state() == fns->static_state) goto skip_cbs; \
726 CRYPTO_set_mem_functions(fns->mem_fns.malloc_fn, \
727 fns->mem_fns.realloc_fn, \
728 fns->mem_fns.free_fn); \
730 if (!fn(e, id)) return 0; \
734 * If the loading application (or library) and the loaded ENGINE library
735 * share the same static data (eg. they're both dynamically linked to the
736 * same libcrypto.so) we need a way to avoid trying to set system callbacks -
737 * this would fail, and for the same reason that it's unnecessary to try. If
738 * the loaded ENGINE has (or gets from through the loader) its own copy of
739 * the libcrypto static data, we will need to set the callbacks. The easiest
740 * way to detect this is to have a function that returns a pointer to some
741 * static data and let the loading application and loaded ENGINE compare
742 * their respective values.
744 void *ENGINE_get_static_state(void);
746 # if defined(__OpenBSD__) || defined(__FreeBSD__) || defined(__DragonFly__) || defined(HAVE_CRYPTODEV)
747 DEPRECATEDIN_1_1_0(void ENGINE_setup_bsd_cryptodev(void))
750 /* BEGIN ERROR CODES */
752 * The following lines are auto generated by the script mkerr.pl. Any changes
753 * made after this point may be overwritten when the script is next run.
756 int ERR_load_ENGINE_strings(void);
758 /* Error codes for the ENGINE functions. */
760 /* Function codes. */
761 # define ENGINE_F_DYNAMIC_CTRL 180
762 # define ENGINE_F_DYNAMIC_GET_DATA_CTX 181
763 # define ENGINE_F_DYNAMIC_LOAD 182
764 # define ENGINE_F_DYNAMIC_SET_DATA_CTX 183
765 # define ENGINE_F_ENGINE_ADD 105
766 # define ENGINE_F_ENGINE_BY_ID 106
767 # define ENGINE_F_ENGINE_CMD_IS_EXECUTABLE 170
768 # define ENGINE_F_ENGINE_CTRL 142
769 # define ENGINE_F_ENGINE_CTRL_CMD 178
770 # define ENGINE_F_ENGINE_CTRL_CMD_STRING 171
771 # define ENGINE_F_ENGINE_FINISH 107
772 # define ENGINE_F_ENGINE_GET_CIPHER 185
773 # define ENGINE_F_ENGINE_GET_DIGEST 186
774 # define ENGINE_F_ENGINE_GET_FIRST 195
775 # define ENGINE_F_ENGINE_GET_LAST 196
776 # define ENGINE_F_ENGINE_GET_NEXT 115
777 # define ENGINE_F_ENGINE_GET_PKEY_ASN1_METH 193
778 # define ENGINE_F_ENGINE_GET_PKEY_METH 192
779 # define ENGINE_F_ENGINE_GET_PREV 116
780 # define ENGINE_F_ENGINE_INIT 119
781 # define ENGINE_F_ENGINE_LIST_ADD 120
782 # define ENGINE_F_ENGINE_LIST_REMOVE 121
783 # define ENGINE_F_ENGINE_LOAD_PRIVATE_KEY 150
784 # define ENGINE_F_ENGINE_LOAD_PUBLIC_KEY 151
785 # define ENGINE_F_ENGINE_LOAD_SSL_CLIENT_CERT 194
786 # define ENGINE_F_ENGINE_NEW 122
787 # define ENGINE_F_ENGINE_PKEY_ASN1_FIND_STR 197
788 # define ENGINE_F_ENGINE_REMOVE 123
789 # define ENGINE_F_ENGINE_SET_DEFAULT_STRING 189
790 # define ENGINE_F_ENGINE_SET_ID 129
791 # define ENGINE_F_ENGINE_SET_NAME 130
792 # define ENGINE_F_ENGINE_TABLE_REGISTER 184
793 # define ENGINE_F_ENGINE_UNLOCKED_FINISH 191
794 # define ENGINE_F_ENGINE_UP_REF 190
795 # define ENGINE_F_INT_CTRL_HELPER 172
796 # define ENGINE_F_INT_ENGINE_CONFIGURE 188
797 # define ENGINE_F_INT_ENGINE_MODULE_INIT 187
800 # define ENGINE_R_ALREADY_LOADED 100
801 # define ENGINE_R_ARGUMENT_IS_NOT_A_NUMBER 133
802 # define ENGINE_R_CMD_NOT_EXECUTABLE 134
803 # define ENGINE_R_COMMAND_TAKES_INPUT 135
804 # define ENGINE_R_COMMAND_TAKES_NO_INPUT 136
805 # define ENGINE_R_CONFLICTING_ENGINE_ID 103
806 # define ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED 119
807 # define ENGINE_R_DSO_FAILURE 104
808 # define ENGINE_R_DSO_NOT_FOUND 132
809 # define ENGINE_R_ENGINES_SECTION_ERROR 148
810 # define ENGINE_R_ENGINE_CONFIGURATION_ERROR 102
811 # define ENGINE_R_ENGINE_IS_NOT_IN_LIST 105
812 # define ENGINE_R_ENGINE_SECTION_ERROR 149
813 # define ENGINE_R_FAILED_LOADING_PRIVATE_KEY 128
814 # define ENGINE_R_FAILED_LOADING_PUBLIC_KEY 129
815 # define ENGINE_R_FINISH_FAILED 106
816 # define ENGINE_R_ID_OR_NAME_MISSING 108
817 # define ENGINE_R_INIT_FAILED 109
818 # define ENGINE_R_INTERNAL_LIST_ERROR 110
819 # define ENGINE_R_INVALID_ARGUMENT 143
820 # define ENGINE_R_INVALID_CMD_NAME 137
821 # define ENGINE_R_INVALID_CMD_NUMBER 138
822 # define ENGINE_R_INVALID_INIT_VALUE 151
823 # define ENGINE_R_INVALID_STRING 150
824 # define ENGINE_R_NOT_INITIALISED 117
825 # define ENGINE_R_NOT_LOADED 112
826 # define ENGINE_R_NO_CONTROL_FUNCTION 120
827 # define ENGINE_R_NO_INDEX 144
828 # define ENGINE_R_NO_LOAD_FUNCTION 125
829 # define ENGINE_R_NO_REFERENCE 130
830 # define ENGINE_R_NO_SUCH_ENGINE 116
831 # define ENGINE_R_UNIMPLEMENTED_CIPHER 146
832 # define ENGINE_R_UNIMPLEMENTED_DIGEST 147
833 # define ENGINE_R_UNIMPLEMENTED_PUBLIC_KEY_METHOD 101
834 # define ENGINE_R_VERSION_INCOMPATIBILITY 145