2 * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project
5 /* ====================================================================
6 * Copyright (c) 1999-2004 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/opensslconf.h>
69 # ifdef OPENSSL_NO_ENGINE
70 # error ENGINE is disabled.
73 # if OPENSSL_API_COMPAT < 0x10100000L
74 # include <openssl/bn.h>
75 # ifndef OPENSSL_NO_RSA
76 # include <openssl/rsa.h>
78 # ifndef OPENSSL_NO_DSA
79 # include <openssl/dsa.h>
81 # ifndef OPENSSL_NO_DH
82 # include <openssl/dh.h>
84 # ifndef OPENSSL_NO_EC
85 # include <openssl/ec.h>
87 # include <openssl/rand.h>
88 # include <openssl/ui.h>
89 # include <openssl/err.h>
92 # include <openssl/ossl_typ.h>
93 # include <openssl/symhacks.h>
95 # include <openssl/x509.h>
102 * These flags are used to control combinations of algorithm (methods) by
105 # define ENGINE_METHOD_RSA (unsigned int)0x0001
106 # define ENGINE_METHOD_DSA (unsigned int)0x0002
107 # define ENGINE_METHOD_DH (unsigned int)0x0004
108 # define ENGINE_METHOD_RAND (unsigned int)0x0008
109 # define ENGINE_METHOD_CIPHERS (unsigned int)0x0040
110 # define ENGINE_METHOD_DIGESTS (unsigned int)0x0080
111 # define ENGINE_METHOD_PKEY_METHS (unsigned int)0x0200
112 # define ENGINE_METHOD_PKEY_ASN1_METHS (unsigned int)0x0400
113 # define ENGINE_METHOD_EC (unsigned int)0x0800
114 /* Obvious all-or-nothing cases. */
115 # define ENGINE_METHOD_ALL (unsigned int)0xFFFF
116 # define ENGINE_METHOD_NONE (unsigned int)0x0000
119 * This(ese) flag(s) controls behaviour of the ENGINE_TABLE mechanism used
120 * internally to control registration of ENGINE implementations, and can be
121 * set by ENGINE_set_table_flags(). The "NOINIT" flag prevents attempts to
122 * initialise registered ENGINEs if they are not already initialised.
124 # define ENGINE_TABLE_FLAG_NOINIT (unsigned int)0x0001
126 /* ENGINE flags that can be set by ENGINE_set_flags(). */
128 /* #define ENGINE_FLAGS_MALLOCED 0x0001 */
131 * This flag is for ENGINEs that wish to handle the various 'CMD'-related
132 * control commands on their own. Without this flag, ENGINE_ctrl() handles
133 * these control commands on behalf of the ENGINE using their "cmd_defns"
136 # define ENGINE_FLAGS_MANUAL_CMD_CTRL (int)0x0002
139 * This flag is for ENGINEs who return new duplicate structures when found
140 * via "ENGINE_by_id()". When an ENGINE must store state (eg. if
141 * ENGINE_ctrl() commands are called in sequence as part of some stateful
142 * process like key-generation setup and execution), it can set this flag -
143 * then each attempt to obtain the ENGINE will result in it being copied into
144 * a new structure. Normally, ENGINEs don't declare this flag so
145 * ENGINE_by_id() just increments the existing ENGINE's structural reference
148 # define ENGINE_FLAGS_BY_ID_COPY (int)0x0004
151 * This flag if for an ENGINE that does not want its methods registered as
152 * part of ENGINE_register_all_complete() for example if the methods are not
153 * usable as default methods.
156 # define ENGINE_FLAGS_NO_REGISTER_ALL (int)0x0008
159 * ENGINEs can support their own command types, and these flags are used in
160 * ENGINE_CTRL_GET_CMD_FLAGS to indicate to the caller what kind of input
161 * each command expects. Currently only numeric and string input is
162 * supported. If a control command supports none of the _NUMERIC, _STRING, or
163 * _NO_INPUT options, then it is regarded as an "internal" control command -
164 * and not for use in config setting situations. As such, they're not
165 * available to the ENGINE_ctrl_cmd_string() function, only raw ENGINE_ctrl()
166 * access. Changes to this list of 'command types' should be reflected
167 * carefully in ENGINE_cmd_is_executable() and ENGINE_ctrl_cmd_string().
170 /* accepts a 'long' input value (3rd parameter to ENGINE_ctrl) */
171 # define ENGINE_CMD_FLAG_NUMERIC (unsigned int)0x0001
173 * accepts string input (cast from 'void*' to 'const char *', 4th parameter
176 # define ENGINE_CMD_FLAG_STRING (unsigned int)0x0002
178 * Indicates that the control command takes *no* input. Ie. the control
179 * command is unparameterised.
181 # define ENGINE_CMD_FLAG_NO_INPUT (unsigned int)0x0004
183 * Indicates that the control command is internal. This control command won't
184 * be shown in any output, and is only usable through the ENGINE_ctrl_cmd()
187 # define ENGINE_CMD_FLAG_INTERNAL (unsigned int)0x0008
190 * NB: These 3 control commands are deprecated and should not be used.
191 * ENGINEs relying on these commands should compile conditional support for
192 * compatibility (eg. if these symbols are defined) but should also migrate
193 * the same functionality to their own ENGINE-specific control functions that
194 * can be "discovered" by calling applications. The fact these control
195 * commands wouldn't be "executable" (ie. usable by text-based config)
196 * doesn't change the fact that application code can find and use them
197 * without requiring per-ENGINE hacking.
201 * These flags are used to tell the ctrl function what should be done. All
202 * command numbers are shared between all engines, even if some don't make
203 * sense to some engines. In such a case, they do nothing but return the
204 * error ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED.
206 # define ENGINE_CTRL_SET_LOGSTREAM 1
207 # define ENGINE_CTRL_SET_PASSWORD_CALLBACK 2
208 # define ENGINE_CTRL_HUP 3/* Close and reinitialise
209 * any handles/connections
211 # define ENGINE_CTRL_SET_USER_INTERFACE 4/* Alternative to callback */
212 # define ENGINE_CTRL_SET_CALLBACK_DATA 5/* User-specific data, used
213 * when calling the password
214 * callback and the user
216 # define ENGINE_CTRL_LOAD_CONFIGURATION 6/* Load a configuration,
217 * given a string that
218 * represents a file name
220 # define ENGINE_CTRL_LOAD_SECTION 7/* Load data from a given
221 * section in the already
222 * loaded configuration */
225 * These control commands allow an application to deal with an arbitrary
226 * engine in a dynamic way. Warn: Negative return values indicate errors FOR
227 * THESE COMMANDS because zero is used to indicate 'end-of-list'. Other
228 * commands, including ENGINE-specific command types, return zero for an
229 * error. An ENGINE can choose to implement these ctrl functions, and can
230 * internally manage things however it chooses - it does so by setting the
231 * ENGINE_FLAGS_MANUAL_CMD_CTRL flag (using ENGINE_set_flags()). Otherwise
232 * the ENGINE_ctrl() code handles this on the ENGINE's behalf using the
233 * cmd_defns data (set using ENGINE_set_cmd_defns()). This means an ENGINE's
234 * ctrl() handler need only implement its own commands - the above "meta"
235 * commands will be taken care of.
239 * Returns non-zero if the supplied ENGINE has a ctrl() handler. If "not",
240 * then all the remaining control commands will return failure, so it is
241 * worth checking this first if the caller is trying to "discover" the
242 * engine's capabilities and doesn't want errors generated unnecessarily.
244 # define ENGINE_CTRL_HAS_CTRL_FUNCTION 10
246 * Returns a positive command number for the first command supported by the
247 * engine. Returns zero if no ctrl commands are supported.
249 # define ENGINE_CTRL_GET_FIRST_CMD_TYPE 11
251 * The 'long' argument specifies a command implemented by the engine, and the
252 * return value is the next command supported, or zero if there are no more.
254 # define ENGINE_CTRL_GET_NEXT_CMD_TYPE 12
256 * The 'void*' argument is a command name (cast from 'const char *'), and the
257 * return value is the command that corresponds to it.
259 # define ENGINE_CTRL_GET_CMD_FROM_NAME 13
261 * The next two allow a command to be converted into its corresponding string
262 * form. In each case, the 'long' argument supplies the command. In the
263 * NAME_LEN case, the return value is the length of the command name (not
264 * counting a trailing EOL). In the NAME case, the 'void*' argument must be a
265 * string buffer large enough, and it will be populated with the name of the
266 * command (WITH a trailing EOL).
268 # define ENGINE_CTRL_GET_NAME_LEN_FROM_CMD 14
269 # define ENGINE_CTRL_GET_NAME_FROM_CMD 15
270 /* The next two are similar but give a "short description" of a command. */
271 # define ENGINE_CTRL_GET_DESC_LEN_FROM_CMD 16
272 # define ENGINE_CTRL_GET_DESC_FROM_CMD 17
274 * With this command, the return value is the OR'd combination of
275 * ENGINE_CMD_FLAG_*** values that indicate what kind of input a given
276 * engine-specific ctrl command expects.
278 # define ENGINE_CTRL_GET_CMD_FLAGS 18
281 * ENGINE implementations should start the numbering of their own control
282 * commands from this value. (ie. ENGINE_CMD_BASE, ENGINE_CMD_BASE + 1, etc).
284 # define ENGINE_CMD_BASE 200
287 * NB: These 2 nCipher "chil" control commands are deprecated, and their
288 * functionality is now available through ENGINE-specific control commands
289 * (exposed through the above-mentioned 'CMD'-handling). Code using these 2
290 * commands should be migrated to the more general command handling before
294 /* Flags specific to the nCipher "chil" engine */
295 # define ENGINE_CTRL_CHIL_SET_FORKCHECK 100
297 * Depending on the value of the (long)i argument, this sets or
298 * unsets the SimpleForkCheck flag in the CHIL API to enable or
299 * disable checking and workarounds for applications that fork().
301 # define ENGINE_CTRL_CHIL_NO_LOCKING 101
303 * This prevents the initialisation function from providing mutex
304 * callbacks to the nCipher library.
308 * If an ENGINE supports its own specific control commands and wishes the
309 * framework to handle the above 'ENGINE_CMD_***'-manipulation commands on
310 * its behalf, it should supply a null-terminated array of ENGINE_CMD_DEFN
311 * entries to ENGINE_set_cmd_defns(). It should also implement a ctrl()
312 * handler that supports the stated commands (ie. the "cmd_num" entries as
313 * described by the array). NB: The array must be ordered in increasing order
314 * of cmd_num. "null-terminated" means that the last ENGINE_CMD_DEFN element
315 * has cmd_num set to zero and/or cmd_name set to NULL.
317 typedef struct ENGINE_CMD_DEFN_st {
318 unsigned int cmd_num; /* The command number */
319 const char *cmd_name; /* The command name itself */
320 const char *cmd_desc; /* A short description of the command */
321 unsigned int cmd_flags; /* The input the command expects */
324 /* Generic function pointer */
325 typedef int (*ENGINE_GEN_FUNC_PTR) (void);
326 /* Generic function pointer taking no arguments */
327 typedef int (*ENGINE_GEN_INT_FUNC_PTR) (ENGINE *);
328 /* Specific control function pointer */
329 typedef int (*ENGINE_CTRL_FUNC_PTR) (ENGINE *, int, long, void *,
331 /* Generic load_key function pointer */
332 typedef EVP_PKEY *(*ENGINE_LOAD_KEY_PTR)(ENGINE *, const char *,
333 UI_METHOD *ui_method,
334 void *callback_data);
335 typedef int (*ENGINE_SSL_CLIENT_CERT_PTR) (ENGINE *, SSL *ssl,
336 STACK_OF(X509_NAME) *ca_dn,
337 X509 **pcert, EVP_PKEY **pkey,
338 STACK_OF(X509) **pother,
339 UI_METHOD *ui_method,
340 void *callback_data);
342 * These callback types are for an ENGINE's handler for cipher and digest logic.
343 * These handlers have these prototypes;
344 * int foo(ENGINE *e, const EVP_CIPHER **cipher, const int **nids, int nid);
345 * int foo(ENGINE *e, const EVP_MD **digest, const int **nids, int nid);
346 * Looking at how to implement these handlers in the case of cipher support, if
347 * the framework wants the EVP_CIPHER for 'nid', it will call;
348 * foo(e, &p_evp_cipher, NULL, nid); (return zero for failure)
349 * If the framework wants a list of supported 'nid's, it will call;
350 * foo(e, NULL, &p_nids, 0); (returns number of 'nids' or -1 for error)
353 * Returns to a pointer to the array of supported cipher 'nid's. If the
354 * second parameter is non-NULL it is set to the size of the returned array.
356 typedef int (*ENGINE_CIPHERS_PTR) (ENGINE *, const EVP_CIPHER **,
358 typedef int (*ENGINE_DIGESTS_PTR) (ENGINE *, const EVP_MD **, const int **,
360 typedef int (*ENGINE_PKEY_METHS_PTR) (ENGINE *, EVP_PKEY_METHOD **,
362 typedef int (*ENGINE_PKEY_ASN1_METHS_PTR) (ENGINE *, EVP_PKEY_ASN1_METHOD **,
365 * STRUCTURE functions ... all of these functions deal with pointers to
366 * ENGINE structures where the pointers have a "structural reference". This
367 * means that their reference is to allowed access to the structure but it
368 * does not imply that the structure is functional. To simply increment or
369 * decrement the structural reference count, use ENGINE_by_id and
370 * ENGINE_free. NB: This is not required when iterating using ENGINE_get_next
371 * as it will automatically decrement the structural reference count of the
372 * "current" ENGINE and increment the structural reference count of the
373 * ENGINE it returns (unless it is NULL).
376 /* Get the first/last "ENGINE" type available. */
377 ENGINE *ENGINE_get_first(void);
378 ENGINE *ENGINE_get_last(void);
379 /* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */
380 ENGINE *ENGINE_get_next(ENGINE *e);
381 ENGINE *ENGINE_get_prev(ENGINE *e);
382 /* Add another "ENGINE" type into the array. */
383 int ENGINE_add(ENGINE *e);
384 /* Remove an existing "ENGINE" type from the array. */
385 int ENGINE_remove(ENGINE *e);
386 /* Retrieve an engine from the list by its unique "id" value. */
387 ENGINE *ENGINE_by_id(const char *id);
389 #if OPENSSL_API_COMPAT < 0x10100000L
390 # define ENGINE_load_openssl() \
391 OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_OPENSSL, NULL)
392 # define ENGINE_load_dynamic() \
393 OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_DYNAMIC, NULL)
394 # ifndef OPENSSL_NO_STATIC_ENGINE
395 # define ENGINE_load_padlock() \
396 OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_PADLOCK, NULL)
397 # define ENGINE_load_capi() \
398 OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_CAPI, NULL)
399 # define ENGINE_load_dasync() \
400 OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_DASYNC, NULL)
401 # define ENGINE_load_afalg() \
402 OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_AFALG, NULL)
404 # define ENGINE_load_cryptodev() \
405 OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_CRYPTODEV, NULL)
406 # define ENGINE_load_rdrand() \
407 OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_RDRAND, NULL)
409 void ENGINE_load_builtin_engines(void);
412 * Get and set global flags (ENGINE_TABLE_FLAG_***) for the implementation
413 * "registry" handling.
415 unsigned int ENGINE_get_table_flags(void);
416 void ENGINE_set_table_flags(unsigned int flags);
418 /*- Manage registration of ENGINEs per "table". For each type, there are 3
420 * ENGINE_register_***(e) - registers the implementation from 'e' (if it has one)
421 * ENGINE_unregister_***(e) - unregister the implementation from 'e'
422 * ENGINE_register_all_***() - call ENGINE_register_***() for each 'e' in the list
423 * Cleanup is automatically registered from each table when required, so
424 * ENGINE_cleanup() will reverse any "register" operations.
427 int ENGINE_register_RSA(ENGINE *e);
428 void ENGINE_unregister_RSA(ENGINE *e);
429 void ENGINE_register_all_RSA(void);
431 int ENGINE_register_DSA(ENGINE *e);
432 void ENGINE_unregister_DSA(ENGINE *e);
433 void ENGINE_register_all_DSA(void);
435 int ENGINE_register_EC(ENGINE *e);
436 void ENGINE_unregister_EC(ENGINE *e);
437 void ENGINE_register_all_EC(void);
439 int ENGINE_register_DH(ENGINE *e);
440 void ENGINE_unregister_DH(ENGINE *e);
441 void ENGINE_register_all_DH(void);
443 int ENGINE_register_RAND(ENGINE *e);
444 void ENGINE_unregister_RAND(ENGINE *e);
445 void ENGINE_register_all_RAND(void);
447 int ENGINE_register_ciphers(ENGINE *e);
448 void ENGINE_unregister_ciphers(ENGINE *e);
449 void ENGINE_register_all_ciphers(void);
451 int ENGINE_register_digests(ENGINE *e);
452 void ENGINE_unregister_digests(ENGINE *e);
453 void ENGINE_register_all_digests(void);
455 int ENGINE_register_pkey_meths(ENGINE *e);
456 void ENGINE_unregister_pkey_meths(ENGINE *e);
457 void ENGINE_register_all_pkey_meths(void);
459 int ENGINE_register_pkey_asn1_meths(ENGINE *e);
460 void ENGINE_unregister_pkey_asn1_meths(ENGINE *e);
461 void ENGINE_register_all_pkey_asn1_meths(void);
464 * These functions register all support from the above categories. Note, use
465 * of these functions can result in static linkage of code your application
466 * may not need. If you only need a subset of functionality, consider using
467 * more selective initialisation.
469 int ENGINE_register_complete(ENGINE *e);
470 int ENGINE_register_all_complete(void);
473 * Send parametrised control commands to the engine. The possibilities to
474 * send down an integer, a pointer to data or a function pointer are
475 * provided. Any of the parameters may or may not be NULL, depending on the
476 * command number. In actuality, this function only requires a structural
477 * (rather than functional) reference to an engine, but many control commands
478 * may require the engine be functional. The caller should be aware of trying
479 * commands that require an operational ENGINE, and only use functional
480 * references in such situations.
482 int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void));
485 * This function tests if an ENGINE-specific command is usable as a
486 * "setting". Eg. in an application's config file that gets processed through
487 * ENGINE_ctrl_cmd_string(). If this returns zero, it is not available to
488 * ENGINE_ctrl_cmd_string(), only ENGINE_ctrl().
490 int ENGINE_cmd_is_executable(ENGINE *e, int cmd);
493 * This function works like ENGINE_ctrl() with the exception of taking a
494 * command name instead of a command number, and can handle optional
495 * commands. See the comment on ENGINE_ctrl_cmd_string() for an explanation
496 * on how to use the cmd_name and cmd_optional.
498 int ENGINE_ctrl_cmd(ENGINE *e, const char *cmd_name,
499 long i, void *p, void (*f) (void), int cmd_optional);
502 * This function passes a command-name and argument to an ENGINE. The
503 * cmd_name is converted to a command number and the control command is
504 * called using 'arg' as an argument (unless the ENGINE doesn't support such
505 * a command, in which case no control command is called). The command is
506 * checked for input flags, and if necessary the argument will be converted
507 * to a numeric value. If cmd_optional is non-zero, then if the ENGINE
508 * doesn't support the given cmd_name the return value will be success
509 * anyway. This function is intended for applications to use so that users
510 * (or config files) can supply engine-specific config data to the ENGINE at
511 * run-time to control behaviour of specific engines. As such, it shouldn't
512 * be used for calling ENGINE_ctrl() functions that return data, deal with
513 * binary data, or that are otherwise supposed to be used directly through
514 * ENGINE_ctrl() in application code. Any "return" data from an ENGINE_ctrl()
515 * operation in this function will be lost - the return value is interpreted
516 * as failure if the return value is zero, success otherwise, and this
517 * function returns a boolean value as a result. In other words, vendors of
518 * 'ENGINE'-enabled devices should write ENGINE implementations with
519 * parameterisations that work in this scheme, so that compliant ENGINE-based
520 * applications can work consistently with the same configuration for the
521 * same ENGINE-enabled devices, across applications.
523 int ENGINE_ctrl_cmd_string(ENGINE *e, const char *cmd_name, const char *arg,
527 * These functions are useful for manufacturing new ENGINE structures. They
528 * don't address reference counting at all - one uses them to populate an
529 * ENGINE structure with personalised implementations of things prior to
530 * using it directly or adding it to the builtin ENGINE list in OpenSSL.
531 * These are also here so that the ENGINE structure doesn't have to be
532 * exposed and break binary compatibility!
534 ENGINE *ENGINE_new(void);
535 int ENGINE_free(ENGINE *e);
536 int ENGINE_up_ref(ENGINE *e);
537 int ENGINE_set_id(ENGINE *e, const char *id);
538 int ENGINE_set_name(ENGINE *e, const char *name);
539 int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth);
540 int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth);
541 int ENGINE_set_EC(ENGINE *e, const EC_KEY_METHOD *ecdsa_meth);
542 int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth);
543 int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth);
544 int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f);
545 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f);
546 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f);
547 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f);
548 int ENGINE_set_load_privkey_function(ENGINE *e,
549 ENGINE_LOAD_KEY_PTR loadpriv_f);
550 int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f);
551 int ENGINE_set_load_ssl_client_cert_function(ENGINE *e,
552 ENGINE_SSL_CLIENT_CERT_PTR
554 int ENGINE_set_ciphers(ENGINE *e, ENGINE_CIPHERS_PTR f);
555 int ENGINE_set_digests(ENGINE *e, ENGINE_DIGESTS_PTR f);
556 int ENGINE_set_pkey_meths(ENGINE *e, ENGINE_PKEY_METHS_PTR f);
557 int ENGINE_set_pkey_asn1_meths(ENGINE *e, ENGINE_PKEY_ASN1_METHS_PTR f);
558 int ENGINE_set_flags(ENGINE *e, int flags);
559 int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns);
560 /* These functions allow control over any per-structure ENGINE data. */
561 #define ENGINE_get_ex_new_index(l, p, newf, dupf, freef) \
562 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_ENGINE, l, p, newf, dupf, freef)
563 int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg);
564 void *ENGINE_get_ex_data(const ENGINE *e, int idx);
567 * This function cleans up anything that needs it. Eg. the ENGINE_add()
568 * function automatically ensures the list cleanup function is registered to
569 * be called from ENGINE_cleanup(). Similarly, all ENGINE_register_***
570 * functions ensure ENGINE_cleanup() will clean up after them.
572 void ENGINE_cleanup(void);
575 * These return values from within the ENGINE structure. These can be useful
576 * with functional references as well as structural references - it depends
577 * which you obtained. Using the result for functional purposes if you only
578 * obtained a structural reference may be problematic!
580 const char *ENGINE_get_id(const ENGINE *e);
581 const char *ENGINE_get_name(const ENGINE *e);
582 const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e);
583 const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e);
584 const EC_KEY_METHOD *ENGINE_get_EC(const ENGINE *e);
585 const DH_METHOD *ENGINE_get_DH(const ENGINE *e);
586 const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e);
587 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e);
588 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e);
589 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e);
590 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e);
591 ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e);
592 ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e);
593 ENGINE_SSL_CLIENT_CERT_PTR ENGINE_get_ssl_client_cert_function(const ENGINE
595 ENGINE_CIPHERS_PTR ENGINE_get_ciphers(const ENGINE *e);
596 ENGINE_DIGESTS_PTR ENGINE_get_digests(const ENGINE *e);
597 ENGINE_PKEY_METHS_PTR ENGINE_get_pkey_meths(const ENGINE *e);
598 ENGINE_PKEY_ASN1_METHS_PTR ENGINE_get_pkey_asn1_meths(const ENGINE *e);
599 const EVP_CIPHER *ENGINE_get_cipher(ENGINE *e, int nid);
600 const EVP_MD *ENGINE_get_digest(ENGINE *e, int nid);
601 const EVP_PKEY_METHOD *ENGINE_get_pkey_meth(ENGINE *e, int nid);
602 const EVP_PKEY_ASN1_METHOD *ENGINE_get_pkey_asn1_meth(ENGINE *e, int nid);
603 const EVP_PKEY_ASN1_METHOD *ENGINE_get_pkey_asn1_meth_str(ENGINE *e,
606 const EVP_PKEY_ASN1_METHOD *ENGINE_pkey_asn1_find_str(ENGINE **pe,
609 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e);
610 int ENGINE_get_flags(const ENGINE *e);
613 * FUNCTIONAL functions. These functions deal with ENGINE structures that
614 * have (or will) be initialised for use. Broadly speaking, the structural
615 * functions are useful for iterating the list of available engine types,
616 * creating new engine types, and other "list" operations. These functions
617 * actually deal with ENGINEs that are to be used. As such these functions
618 * can fail (if applicable) when particular engines are unavailable - eg. if
619 * a hardware accelerator is not attached or not functioning correctly. Each
620 * ENGINE has 2 reference counts; structural and functional. Every time a
621 * functional reference is obtained or released, a corresponding structural
622 * reference is automatically obtained or released too.
626 * Initialise a engine type for use (or up its reference count if it's
627 * already in use). This will fail if the engine is not currently operational
628 * and cannot initialise.
630 int ENGINE_init(ENGINE *e);
632 * Free a functional reference to a engine type. This does not require a
633 * corresponding call to ENGINE_free as it also releases a structural
636 int ENGINE_finish(ENGINE *e);
639 * The following functions handle keys that are stored in some secondary
640 * location, handled by the engine. The storage may be on a card or
643 EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id,
644 UI_METHOD *ui_method, void *callback_data);
645 EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id,
646 UI_METHOD *ui_method, void *callback_data);
647 int ENGINE_load_ssl_client_cert(ENGINE *e, SSL *s,
648 STACK_OF(X509_NAME) *ca_dn, X509 **pcert,
649 EVP_PKEY **ppkey, STACK_OF(X509) **pother,
650 UI_METHOD *ui_method, void *callback_data);
653 * This returns a pointer for the current ENGINE structure that is (by
654 * default) performing any RSA operations. The value returned is an
655 * incremented reference, so it should be free'd (ENGINE_finish) before it is
658 ENGINE *ENGINE_get_default_RSA(void);
659 /* Same for the other "methods" */
660 ENGINE *ENGINE_get_default_DSA(void);
661 ENGINE *ENGINE_get_default_EC(void);
662 ENGINE *ENGINE_get_default_DH(void);
663 ENGINE *ENGINE_get_default_RAND(void);
665 * These functions can be used to get a functional reference to perform
666 * ciphering or digesting corresponding to "nid".
668 ENGINE *ENGINE_get_cipher_engine(int nid);
669 ENGINE *ENGINE_get_digest_engine(int nid);
670 ENGINE *ENGINE_get_pkey_meth_engine(int nid);
671 ENGINE *ENGINE_get_pkey_asn1_meth_engine(int nid);
674 * This sets a new default ENGINE structure for performing RSA operations. If
675 * the result is non-zero (success) then the ENGINE structure will have had
676 * its reference count up'd so the caller should still free their own
679 int ENGINE_set_default_RSA(ENGINE *e);
680 int ENGINE_set_default_string(ENGINE *e, const char *def_list);
681 /* Same for the other "methods" */
682 int ENGINE_set_default_DSA(ENGINE *e);
683 int ENGINE_set_default_EC(ENGINE *e);
684 int ENGINE_set_default_DH(ENGINE *e);
685 int ENGINE_set_default_RAND(ENGINE *e);
686 int ENGINE_set_default_ciphers(ENGINE *e);
687 int ENGINE_set_default_digests(ENGINE *e);
688 int ENGINE_set_default_pkey_meths(ENGINE *e);
689 int ENGINE_set_default_pkey_asn1_meths(ENGINE *e);
692 * The combination "set" - the flags are bitwise "OR"d from the
693 * ENGINE_METHOD_*** defines above. As with the "ENGINE_register_complete()"
694 * function, this function can result in unnecessary static linkage. If your
695 * application requires only specific functionality, consider using more
696 * selective functions.
698 int ENGINE_set_default(ENGINE *e, unsigned int flags);
700 void ENGINE_add_conf_module(void);
702 /* Deprecated functions ... */
703 /* int ENGINE_clear_defaults(void); */
705 /**************************/
706 /* DYNAMIC ENGINE SUPPORT */
707 /**************************/
709 /* Binary/behaviour compatibility levels */
710 # define OSSL_DYNAMIC_VERSION (unsigned long)0x00030000
712 * Binary versions older than this are too old for us (whether we're a loader
715 # define OSSL_DYNAMIC_OLDEST (unsigned long)0x00030000
718 * When compiling an ENGINE entirely as an external shared library, loadable
719 * by the "dynamic" ENGINE, these types are needed. The 'dynamic_fns'
720 * structure type provides the calling application's (or library's) error
721 * functionality and memory management function pointers to the loaded
722 * library. These should be used/set in the loaded library code so that the
723 * loading application's 'state' will be used/changed in all operations. The
724 * 'static_state' pointer allows the loaded library to know if it shares the
725 * same static data as the calling application (or library), and thus whether
726 * these callbacks need to be set or not.
728 typedef void *(*dyn_MEM_malloc_fn) (size_t, const char *, int);
729 typedef void *(*dyn_MEM_realloc_fn) (void *, size_t, const char *, int);
730 typedef void (*dyn_MEM_free_fn) (void *, const char *, int);
731 typedef struct st_dynamic_MEM_fns {
732 dyn_MEM_malloc_fn malloc_fn;
733 dyn_MEM_realloc_fn realloc_fn;
734 dyn_MEM_free_fn free_fn;
737 * FIXME: Perhaps the memory and locking code (crypto.h) should declare and
738 * use these types so we (and any other dependant code) can simplify a bit??
740 /* The top-level structure */
741 typedef struct st_dynamic_fns {
743 dynamic_MEM_fns mem_fns;
747 * The version checking function should be of this prototype. NB: The
748 * ossl_version value passed in is the OSSL_DYNAMIC_VERSION of the loading
749 * code. If this function returns zero, it indicates a (potential) version
750 * incompatibility and the loaded library doesn't believe it can proceed.
751 * Otherwise, the returned value is the (latest) version supported by the
752 * loading library. The loader may still decide that the loaded code's
753 * version is unsatisfactory and could veto the load. The function is
754 * expected to be implemented with the symbol name "v_check", and a default
755 * implementation can be fully instantiated with
756 * IMPLEMENT_DYNAMIC_CHECK_FN().
758 typedef unsigned long (*dynamic_v_check_fn) (unsigned long ossl_version);
759 # define IMPLEMENT_DYNAMIC_CHECK_FN() \
760 OPENSSL_EXPORT unsigned long v_check(unsigned long v); \
761 OPENSSL_EXPORT unsigned long v_check(unsigned long v) { \
762 if(v >= OSSL_DYNAMIC_OLDEST) return OSSL_DYNAMIC_VERSION; \
766 * This function is passed the ENGINE structure to initialise with its own
767 * function and command settings. It should not adjust the structural or
768 * functional reference counts. If this function returns zero, (a) the load
769 * will be aborted, (b) the previous ENGINE state will be memcpy'd back onto
770 * the structure, and (c) the shared library will be unloaded. So
771 * implementations should do their own internal cleanup in failure
772 * circumstances otherwise they could leak. The 'id' parameter, if non-NULL,
773 * represents the ENGINE id that the loader is looking for. If this is NULL,
774 * the shared library can choose to return failure or to initialise a
775 * 'default' ENGINE. If non-NULL, the shared library must initialise only an
776 * ENGINE matching the passed 'id'. The function is expected to be
777 * implemented with the symbol name "bind_engine". A standard implementation
778 * can be instantiated with IMPLEMENT_DYNAMIC_BIND_FN(fn) where the parameter
779 * 'fn' is a callback function that populates the ENGINE structure and
780 * returns an int value (zero for failure). 'fn' should have prototype;
781 * [static] int fn(ENGINE *e, const char *id);
783 typedef int (*dynamic_bind_engine) (ENGINE *e, const char *id,
784 const dynamic_fns *fns);
785 # define IMPLEMENT_DYNAMIC_BIND_FN(fn) \
787 int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns); \
789 int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns) { \
790 if(ENGINE_get_static_state() == fns->static_state) goto skip_cbs; \
791 CRYPTO_set_mem_functions(fns->mem_fns.malloc_fn, \
792 fns->mem_fns.realloc_fn, \
793 fns->mem_fns.free_fn); \
795 if(!fn(e,id)) return 0; \
799 * If the loading application (or library) and the loaded ENGINE library
800 * share the same static data (eg. they're both dynamically linked to the
801 * same libcrypto.so) we need a way to avoid trying to set system callbacks -
802 * this would fail, and for the same reason that it's unnecessary to try. If
803 * the loaded ENGINE has (or gets from through the loader) its own copy of
804 * the libcrypto static data, we will need to set the callbacks. The easiest
805 * way to detect this is to have a function that returns a pointer to some
806 * static data and let the loading application and loaded ENGINE compare
807 * their respective values.
809 void *ENGINE_get_static_state(void);
811 # if defined(__OpenBSD__) || defined(__FreeBSD__) || defined(HAVE_CRYPTODEV)
812 void ENGINE_setup_bsd_cryptodev(void);
815 /* BEGIN ERROR CODES */
817 * The following lines are auto generated by the script mkerr.pl. Any changes
818 * made after this point may be overwritten when the script is next run.
820 void ERR_load_ENGINE_strings(void);
822 /* Error codes for the ENGINE functions. */
824 /* Function codes. */
825 # define ENGINE_F_DYNAMIC_CTRL 180
826 # define ENGINE_F_DYNAMIC_GET_DATA_CTX 181
827 # define ENGINE_F_DYNAMIC_LOAD 182
828 # define ENGINE_F_DYNAMIC_SET_DATA_CTX 183
829 # define ENGINE_F_ENGINE_ADD 105
830 # define ENGINE_F_ENGINE_BY_ID 106
831 # define ENGINE_F_ENGINE_CMD_IS_EXECUTABLE 170
832 # define ENGINE_F_ENGINE_CTRL 142
833 # define ENGINE_F_ENGINE_CTRL_CMD 178
834 # define ENGINE_F_ENGINE_CTRL_CMD_STRING 171
835 # define ENGINE_F_ENGINE_FINISH 107
836 # define ENGINE_F_ENGINE_FREE_UTIL 108
837 # define ENGINE_F_ENGINE_GET_CIPHER 185
838 # define ENGINE_F_ENGINE_GET_DEFAULT_TYPE 177
839 # define ENGINE_F_ENGINE_GET_DIGEST 186
840 # define ENGINE_F_ENGINE_GET_NEXT 115
841 # define ENGINE_F_ENGINE_GET_PKEY_ASN1_METH 193
842 # define ENGINE_F_ENGINE_GET_PKEY_METH 192
843 # define ENGINE_F_ENGINE_GET_PREV 116
844 # define ENGINE_F_ENGINE_INIT 119
845 # define ENGINE_F_ENGINE_LIST_ADD 120
846 # define ENGINE_F_ENGINE_LIST_REMOVE 121
847 # define ENGINE_F_ENGINE_LOAD_PRIVATE_KEY 150
848 # define ENGINE_F_ENGINE_LOAD_PUBLIC_KEY 151
849 # define ENGINE_F_ENGINE_LOAD_SSL_CLIENT_CERT 194
850 # define ENGINE_F_ENGINE_NEW 122
851 # define ENGINE_F_ENGINE_REMOVE 123
852 # define ENGINE_F_ENGINE_SET_DEFAULT_STRING 189
853 # define ENGINE_F_ENGINE_SET_DEFAULT_TYPE 126
854 # define ENGINE_F_ENGINE_SET_ID 129
855 # define ENGINE_F_ENGINE_SET_NAME 130
856 # define ENGINE_F_ENGINE_TABLE_REGISTER 184
857 # define ENGINE_F_ENGINE_UNLOAD_KEY 152
858 # define ENGINE_F_ENGINE_UNLOCKED_FINISH 191
859 # define ENGINE_F_ENGINE_UP_REF 190
860 # define ENGINE_F_INT_CTRL_HELPER 172
861 # define ENGINE_F_INT_ENGINE_CONFIGURE 188
862 # define ENGINE_F_INT_ENGINE_MODULE_INIT 187
863 # define ENGINE_F_LOG_MESSAGE 141
866 # define ENGINE_R_ALREADY_LOADED 100
867 # define ENGINE_R_ARGUMENT_IS_NOT_A_NUMBER 133
868 # define ENGINE_R_CMD_NOT_EXECUTABLE 134
869 # define ENGINE_R_COMMAND_TAKES_INPUT 135
870 # define ENGINE_R_COMMAND_TAKES_NO_INPUT 136
871 # define ENGINE_R_CONFLICTING_ENGINE_ID 103
872 # define ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED 119
873 # define ENGINE_R_DH_NOT_IMPLEMENTED 139
874 # define ENGINE_R_DSA_NOT_IMPLEMENTED 140
875 # define ENGINE_R_DSO_FAILURE 104
876 # define ENGINE_R_DSO_NOT_FOUND 132
877 # define ENGINE_R_ENGINES_SECTION_ERROR 148
878 # define ENGINE_R_ENGINE_CONFIGURATION_ERROR 102
879 # define ENGINE_R_ENGINE_IS_NOT_IN_LIST 105
880 # define ENGINE_R_ENGINE_SECTION_ERROR 149
881 # define ENGINE_R_FAILED_LOADING_PRIVATE_KEY 128
882 # define ENGINE_R_FAILED_LOADING_PUBLIC_KEY 129
883 # define ENGINE_R_FINISH_FAILED 106
884 # define ENGINE_R_GET_HANDLE_FAILED 107
885 # define ENGINE_R_ID_OR_NAME_MISSING 108
886 # define ENGINE_R_INIT_FAILED 109
887 # define ENGINE_R_INTERNAL_LIST_ERROR 110
888 # define ENGINE_R_INVALID_ARGUMENT 143
889 # define ENGINE_R_INVALID_CMD_NAME 137
890 # define ENGINE_R_INVALID_CMD_NUMBER 138
891 # define ENGINE_R_INVALID_INIT_VALUE 151
892 # define ENGINE_R_INVALID_STRING 150
893 # define ENGINE_R_NOT_INITIALISED 117
894 # define ENGINE_R_NOT_LOADED 112
895 # define ENGINE_R_NO_CONTROL_FUNCTION 120
896 # define ENGINE_R_NO_INDEX 144
897 # define ENGINE_R_NO_LOAD_FUNCTION 125
898 # define ENGINE_R_NO_REFERENCE 130
899 # define ENGINE_R_NO_SUCH_ENGINE 116
900 # define ENGINE_R_NO_UNLOAD_FUNCTION 126
901 # define ENGINE_R_PROVIDE_PARAMETERS 113
902 # define ENGINE_R_RSA_NOT_IMPLEMENTED 141
903 # define ENGINE_R_UNIMPLEMENTED_CIPHER 146
904 # define ENGINE_R_UNIMPLEMENTED_DIGEST 147
905 # define ENGINE_R_UNIMPLEMENTED_PUBLIC_KEY_METHOD 101
906 # define ENGINE_R_VERSION_INCOMPATIBILITY 145