2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1999 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).
59 #ifndef HEADER_ENGINE_H
60 #define HEADER_ENGINE_H
62 #include <openssl/types.h>
63 #include <openssl/bn.h>
64 #ifndef OPENSSL_NO_RSA
65 #include <openssl/rsa.h>
67 #ifndef OPENSSL_NO_DSA
68 #include <openssl/dsa.h>
71 #include <openssl/dh.h>
73 #include <openssl/rand.h>
74 #include <openssl/ui.h>
75 #include <openssl/symhacks.h>
76 #include <openssl/err.h>
82 /* Fixups for missing algorithms */
84 typedef void RSA_METHOD;
87 typedef void DSA_METHOD;
90 typedef void DH_METHOD;
93 /* These flags are used to control combinations of algorithm (methods)
94 * by bitwise "OR"ing. */
95 #define ENGINE_METHOD_RSA (unsigned int)0x0001
96 #define ENGINE_METHOD_DSA (unsigned int)0x0002
97 #define ENGINE_METHOD_DH (unsigned int)0x0004
98 #define ENGINE_METHOD_RAND (unsigned int)0x0008
99 #define ENGINE_METHOD_BN_MOD_EXP (unsigned int)0x0010
100 #define ENGINE_METHOD_BN_MOD_EXP_CRT (unsigned int)0x0020
101 /* Obvious all-or-nothing cases. */
102 #define ENGINE_METHOD_ALL (unsigned int)0xFFFF
103 #define ENGINE_METHOD_NONE (unsigned int)0x0000
105 /* ENGINE flags that can be set by ENGINE_set_flags(). */
106 /* #define ENGINE_FLAGS_MALLOCED 0x0001 */ /* Not used */
108 /* This flag is for ENGINEs that wish to handle the various 'CMD'-related
109 * control commands on their own. Without this flag, ENGINE_ctrl() handles these
110 * control commands on behalf of the ENGINE using their "cmd_defns" data. */
111 #define ENGINE_FLAGS_MANUAL_CMD_CTRL (int)0x0002
113 /* This flag is for ENGINEs who return new duplicate structures when found via
114 * "ENGINE_by_id()". When an ENGINE must store state (eg. if ENGINE_ctrl()
115 * commands are called in sequence as part of some stateful process like
116 * key-generation setup and execution), it can set this flag - then each attempt
117 * to obtain the ENGINE will result in it being copied into a new structure.
118 * Normally, ENGINEs don't declare this flag so ENGINE_by_id() just increments
119 * the existing ENGINE's structural reference count. */
120 #define ENGINE_FLAGS_BY_ID_COPY (int)0x0004
122 /* ENGINEs can support their own command types, and these flags are used in
123 * ENGINE_CTRL_GET_CMD_FLAGS to indicate to the caller what kind of input each
124 * command expects. Currently only numeric and string input is supported. If a
125 * control command supports none of the _NUMERIC, _STRING, or _NO_INPUT options,
126 * then it is regarded as an "internal" control command - and not for use in
127 * config setting situations. As such, they're not available to the
128 * ENGINE_ctrl_cmd_string() function, only raw ENGINE_ctrl() access. Changes to
129 * this list of 'command types' should be reflected carefully in
130 * ENGINE_cmd_is_executable() and ENGINE_ctrl_cmd_string(). */
132 /* accepts a 'long' input value (3rd parameter to ENGINE_ctrl) */
133 #define ENGINE_CMD_FLAG_NUMERIC (unsigned int)0x0001
134 /* accepts string input (cast from 'void*' to 'const char *', 4th parameter to
136 #define ENGINE_CMD_FLAG_STRING (unsigned int)0x0002
137 /* Indicates that the control command takes *no* input. Ie. the control command
138 * is unparameterised. */
139 #define ENGINE_CMD_FLAG_NO_INPUT (unsigned int)0x0004
140 /* Indicates that the control command is internal. This control command won't
141 * be shown in any output, and is only usable through the ENGINE_ctrl_cmd()
143 #define ENGINE_CMD_FLAG_INTERNAL (unsigned int)0x0008
145 /* NB: These 3 control commands are deprecated and should not be used. ENGINEs
146 * relying on these commands should compile conditional support for
147 * compatibility (eg. if these symbols are defined) but should also migrate the
148 * same functionality to their own ENGINE-specific control functions that can be
149 * "discovered" by calling applications. The fact these control commands
150 * wouldn't be "executable" (ie. usable by text-based config) doesn't change the
151 * fact that application code can find and use them without requiring per-ENGINE
154 /* These flags are used to tell the ctrl function what should be done.
155 * All command numbers are shared between all engines, even if some don't
156 * make sense to some engines. In such a case, they do nothing but return
157 * the error ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED. */
158 #define ENGINE_CTRL_SET_LOGSTREAM 1
159 #define ENGINE_CTRL_SET_PASSWORD_CALLBACK 2
160 #define ENGINE_CTRL_HUP 3 /* Close and reinitialise any
161 handles/connections etc. */
162 #define ENGINE_CTRL_SET_USER_INTERFACE 4 /* Alternative to callback */
163 #define ENGINE_CTRL_SET_CALLBACK_DATA 5 /* User-specific data, used
164 when calling the password
165 callback and the user
168 /* These control commands allow an application to deal with an arbitrary engine
169 * in a dynamic way. Warn: Negative return values indicate errors FOR THESE
170 * COMMANDS because zero is used to indicate 'end-of-list'. Other commands,
171 * including ENGINE-specific command types, return zero for an error.
173 * An ENGINE can choose to implement these ctrl functions, and can internally
174 * manage things however it chooses - it does so by setting the
175 * ENGINE_FLAGS_MANUAL_CMD_CTRL flag (using ENGINE_set_flags()). Otherwise the
176 * ENGINE_ctrl() code handles this on the ENGINE's behalf using the cmd_defns
177 * data (set using ENGINE_set_cmd_defns()). This means an ENGINE's ctrl()
178 * handler need only implement its own commands - the above "meta" commands will
179 * be taken care of. */
181 /* Returns non-zero if the supplied ENGINE has a ctrl() handler. If "not", then
182 * all the remaining control commands will return failure, so it is worth
183 * checking this first if the caller is trying to "discover" the engine's
184 * capabilities and doesn't want errors generated unnecessarily. */
185 #define ENGINE_CTRL_HAS_CTRL_FUNCTION 10
186 /* Returns a positive command number for the first command supported by the
187 * engine. Returns zero if no ctrl commands are supported. */
188 #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. */
191 #define ENGINE_CTRL_GET_NEXT_CMD_TYPE 12
192 /* The 'void*' argument is a command name (cast from 'const char *'), and the
193 * return value is the command that corresponds to it. */
194 #define ENGINE_CTRL_GET_CMD_FROM_NAME 13
195 /* The next two allow a command to be converted into its corresponding string
196 * form. In each case, the 'long' argument supplies the command. In the NAME_LEN
197 * case, the return value is the length of the command name (not counting a
198 * trailing EOL). In the NAME case, the 'void*' argument must be a string buffer
199 * large enough, and it will be populated with the name of the command (WITH a
201 #define ENGINE_CTRL_GET_NAME_LEN_FROM_CMD 14
202 #define ENGINE_CTRL_GET_NAME_FROM_CMD 15
203 /* The next two are similar but give a "short description" of a command. */
204 #define ENGINE_CTRL_GET_DESC_LEN_FROM_CMD 16
205 #define ENGINE_CTRL_GET_DESC_FROM_CMD 17
206 /* With this command, the return value is the OR'd combination of
207 * ENGINE_CMD_FLAG_*** values that indicate what kind of input a given
208 * engine-specific ctrl command expects. */
209 #define ENGINE_CTRL_GET_CMD_FLAGS 18
211 /* ENGINE implementations should start the numbering of their own control
212 * commands from this value. (ie. ENGINE_CMD_BASE, ENGINE_CMD_BASE + 1, etc). */
213 #define ENGINE_CMD_BASE 200
215 /* NB: These 2 nCipher "chil" control commands are deprecated, and their
216 * functionality is now available through ENGINE-specific control commands
217 * (exposed through the above-mentioned 'CMD'-handling). Code using these 2
218 * commands should be migrated to the more general command handling before these
221 /* Flags specific to the nCipher "chil" engine */
222 #define ENGINE_CTRL_CHIL_SET_FORKCHECK 100
223 /* Depending on the value of the (long)i argument, this sets or
224 * unsets the SimpleForkCheck flag in the CHIL API to enable or
225 * disable checking and workarounds for applications that fork().
227 #define ENGINE_CTRL_CHIL_NO_LOCKING 101
228 /* This prevents the initialisation function from providing mutex
229 * callbacks to the nCipher library. */
231 /* If an ENGINE supports its own specific control commands and wishes the
232 * framework to handle the above 'ENGINE_CMD_***'-manipulation commands on its
233 * behalf, it should supply a null-terminated array of ENGINE_CMD_DEFN entries
234 * to ENGINE_set_cmd_defns(). It should also implement a ctrl() handler that
235 * supports the stated commands (ie. the "cmd_num" entries as described by the
236 * array). NB: The array must be ordered in increasing order of cmd_num.
237 * "null-terminated" means that the last ENGINE_CMD_DEFN element has cmd_num set
238 * to zero and/or cmd_name set to NULL. */
239 typedef struct ENGINE_CMD_DEFN_st
241 unsigned int cmd_num; /* The command number */
242 const char *cmd_name; /* The command name itself */
243 const char *cmd_desc; /* A short description of the command */
244 unsigned int cmd_flags; /* The input the command expects */
247 /* As we're missing a BIGNUM_METHOD, we need a couple of locally
248 * defined function types that engines can implement. */
250 /* mod_exp operation, calculates; r = a ^ p mod m
251 * NB: ctx can be NULL, but if supplied, the implementation may use
252 * it if it wishes. */
253 typedef int (*BN_MOD_EXP)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
254 const BIGNUM *m, BN_CTX *ctx);
256 /* private key operation for RSA, provided seperately in case other
257 * RSA implementations wish to use it. */
258 typedef int (*BN_MOD_EXP_CRT)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
259 const BIGNUM *q, const BIGNUM *dmp1, const BIGNUM *dmq1,
260 const BIGNUM *iqmp, BN_CTX *ctx);
262 /* Generic function pointer */
263 typedef int (*ENGINE_GEN_FUNC_PTR)();
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 *, void (*f)());
268 /* Generic load_key function pointer */
269 typedef EVP_PKEY * (*ENGINE_LOAD_KEY_PTR)(ENGINE *, const char *,
270 UI_METHOD *ui_method, void *callback_data);
272 /* STRUCTURE functions ... all of these functions deal with pointers to ENGINE
273 * structures where the pointers have a "structural reference". This means that
274 * their reference is to allowed access to the structure but it does not imply
275 * that the structure is functional. To simply increment or decrement the
276 * structural reference count, use ENGINE_by_id and ENGINE_free. NB: This is not
277 * required when iterating using ENGINE_get_next as it will automatically
278 * decrement the structural reference count of the "current" ENGINE and
279 * increment the structural reference count of the ENGINE it returns (unless it
282 /* Get the first/last "ENGINE" type available. */
283 ENGINE *ENGINE_get_first(void);
284 ENGINE *ENGINE_get_last(void);
285 /* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */
286 ENGINE *ENGINE_get_next(ENGINE *e);
287 ENGINE *ENGINE_get_prev(ENGINE *e);
288 /* Add another "ENGINE" type into the array. */
289 int ENGINE_add(ENGINE *e);
290 /* Remove an existing "ENGINE" type from the array. */
291 int ENGINE_remove(ENGINE *e);
292 /* Retrieve an engine from the list by its unique "id" value. */
293 ENGINE *ENGINE_by_id(const char *id);
294 /* Add all the built-in engines. By default, only the OpenSSL software
296 void ENGINE_load_cswift(void);
297 void ENGINE_load_chil(void);
298 void ENGINE_load_atalla(void);
299 void ENGINE_load_nuron(void);
300 void ENGINE_load_ubsec(void);
301 void ENGINE_load_openbsd_dev_crypto(void);
302 void ENGINE_load_builtin_engines(void);
304 /* Load all the currently known ciphers from all engines */
305 void ENGINE_load_ciphers(void);
307 /* Send parametrised control commands to the engine. The possibilities to send
308 * down an integer, a pointer to data or a function pointer are provided. Any of
309 * the parameters may or may not be NULL, depending on the command number. In
310 * actuality, this function only requires a structural (rather than functional)
311 * reference to an engine, but many control commands may require the engine be
312 * functional. The caller should be aware of trying commands that require an
313 * operational ENGINE, and only use functional references in such situations. */
314 int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)());
316 /* This function tests if an ENGINE-specific command is usable as a "setting".
317 * Eg. in an application's config file that gets processed through
318 * ENGINE_ctrl_cmd_string(). If this returns zero, it is not available to
319 * ENGINE_ctrl_cmd_string(), only ENGINE_ctrl(). */
320 int ENGINE_cmd_is_executable(ENGINE *e, int cmd);
322 /* This function works like ENGINE_ctrl() with the exception of taking a
323 * command name instead of a command number, and can handle optional commands.
324 * See the comment on ENGINE_ctrl_cmd_string() for an explanation on how to
325 * use the cmd_name and cmd_optional. */
326 int ENGINE_ctrl_cmd(ENGINE *e, const char *cmd_name,
327 long i, void *p, void (*f)(), int cmd_optional);
329 /* This function passes a command-name and argument to an ENGINE. The cmd_name
330 * is converted to a command number and the control command is called using
331 * 'arg' as an argument (unless the ENGINE doesn't support such a command, in
332 * which case no control command is called). The command is checked for input
333 * flags, and if necessary the argument will be converted to a numeric value. If
334 * cmd_optional is non-zero, then if the ENGINE doesn't support the given
335 * cmd_name the return value will be success anyway. This function is intended
336 * for applications to use so that users (or config files) can supply
337 * engine-specific config data to the ENGINE at run-time to control behaviour of
338 * specific engines. As such, it shouldn't be used for calling ENGINE_ctrl()
339 * functions that return data, deal with binary data, or that are otherwise
340 * supposed to be used directly through ENGINE_ctrl() in application code. Any
341 * "return" data from an ENGINE_ctrl() operation in this function will be lost -
342 * the return value is interpreted as failure if the return value is zero,
343 * success otherwise, and this function returns a boolean value as a result. In
344 * other words, vendors of 'ENGINE'-enabled devices should write ENGINE
345 * implementations with parameterisations that work in this scheme, so that
346 * compliant ENGINE-based applications can work consistently with the same
347 * configuration for the same ENGINE-enabled devices, across applications. */
348 int ENGINE_ctrl_cmd_string(ENGINE *e, const char *cmd_name, const char *arg,
351 /* These functions are useful for manufacturing new ENGINE structures. They
352 * don't address reference counting at all - one uses them to populate an ENGINE
353 * structure with personalised implementations of things prior to using it
354 * directly or adding it to the builtin ENGINE list in OpenSSL. These are also
355 * here so that the ENGINE structure doesn't have to be exposed and break binary
357 ENGINE *ENGINE_new(void);
358 int ENGINE_free(ENGINE *e);
359 int ENGINE_set_id(ENGINE *e, const char *id);
360 int ENGINE_set_name(ENGINE *e, const char *name);
361 int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth);
362 int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth);
363 int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth);
364 int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth);
365 int ENGINE_set_BN_mod_exp(ENGINE *e, BN_MOD_EXP bn_mod_exp);
366 int ENGINE_set_BN_mod_exp_crt(ENGINE *e, BN_MOD_EXP_CRT bn_mod_exp_crt);
367 int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f);
368 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f);
369 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f);
370 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f);
371 int ENGINE_set_load_privkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpriv_f);
372 int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f);
373 int ENGINE_set_flags(ENGINE *e, int flags);
374 int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns);
375 int ENGINE_add_cipher(ENGINE *e,const EVP_CIPHER *c);
376 /* Copies across all ENGINE methods and pointers. NB: This does *not* change
377 * reference counts however. */
378 int ENGINE_cpy(ENGINE *dest, const ENGINE *src);
379 /* These functions (and the "get" function lower down) allow control over any
380 * per-structure ENGINE data. */
381 int ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
382 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
383 int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg);
384 /* Cleans the internal engine list. This should only be used when the
385 * application is about to exit or restart operation (the next operation
386 * requiring the ENGINE list will re-initialise it with defaults). NB: Dynamic
387 * ENGINEs will only truly unload (including any allocated data or loaded
388 * shared-libraries) if all remaining references are released too - so keys,
389 * certificates, etc all need to be released for an in-use ENGINE to unload. */
390 void ENGINE_cleanup(void);
392 /* These return values from within the ENGINE structure. These can be useful
393 * with functional references as well as structural references - it depends
394 * which you obtained. Using the result for functional purposes if you only
395 * obtained a structural reference may be problematic! */
396 const char *ENGINE_get_id(const ENGINE *e);
397 const char *ENGINE_get_name(const ENGINE *e);
398 const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e);
399 const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e);
400 const DH_METHOD *ENGINE_get_DH(const ENGINE *e);
401 const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e);
402 int ENGINE_cipher_num(const ENGINE *e);
403 const EVP_CIPHER *ENGINE_get_cipher(const ENGINE *e, int n);
404 BN_MOD_EXP ENGINE_get_BN_mod_exp(const ENGINE *e);
405 BN_MOD_EXP_CRT ENGINE_get_BN_mod_exp_crt(const ENGINE *e);
406 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e);
407 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e);
408 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e);
409 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e);
410 ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e);
411 ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e);
412 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e);
413 int ENGINE_get_flags(const ENGINE *e);
414 void *ENGINE_get_ex_data(const ENGINE *e, int idx);
416 /* FUNCTIONAL functions. These functions deal with ENGINE structures
417 * that have (or will) be initialised for use. Broadly speaking, the
418 * structural functions are useful for iterating the list of available
419 * engine types, creating new engine types, and other "list" operations.
420 * These functions actually deal with ENGINEs that are to be used. As
421 * such these functions can fail (if applicable) when particular
422 * engines are unavailable - eg. if a hardware accelerator is not
423 * attached or not functioning correctly. Each ENGINE has 2 reference
424 * counts; structural and functional. Every time a functional reference
425 * is obtained or released, a corresponding structural reference is
426 * automatically obtained or released too. */
428 /* Initialise a engine type for use (or up its reference count if it's
429 * already in use). This will fail if the engine is not currently
430 * operational and cannot initialise. */
431 int ENGINE_init(ENGINE *e);
432 /* Free a functional reference to a engine type. This does not require
433 * a corresponding call to ENGINE_free as it also releases a structural
435 int ENGINE_finish(ENGINE *e);
437 /* The following functions handle keys that are stored in some secondary
438 * location, handled by the engine. The storage may be on a card or
440 EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id,
441 UI_METHOD *ui_method, void *callback_data);
442 EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id,
443 UI_METHOD *ui_method, void *callback_data);
445 /* This returns a pointer for the current ENGINE structure that
446 * is (by default) performing any RSA operations. The value returned
447 * is an incremented reference, so it should be free'd (ENGINE_finish)
448 * before it is discarded. */
449 ENGINE *ENGINE_get_default_RSA(void);
450 /* Same for the other "methods" */
451 ENGINE *ENGINE_get_default_DSA(void);
452 ENGINE *ENGINE_get_default_DH(void);
453 ENGINE *ENGINE_get_default_RAND(void);
454 ENGINE *ENGINE_get_default_BN_mod_exp(void);
455 ENGINE *ENGINE_get_default_BN_mod_exp_crt(void);
457 /* This sets a new default ENGINE structure for performing RSA
458 * operations. If the result is non-zero (success) then the ENGINE
459 * structure will have had its reference count up'd so the caller
460 * should still free their own reference 'e'. */
461 int ENGINE_set_default_RSA(ENGINE *e);
462 /* Same for the other "methods" */
463 int ENGINE_set_default_DSA(ENGINE *e);
464 int ENGINE_set_default_DH(ENGINE *e);
465 int ENGINE_set_default_RAND(ENGINE *e);
466 int ENGINE_set_default_BN_mod_exp(ENGINE *e);
467 int ENGINE_set_default_BN_mod_exp_crt(ENGINE *e);
469 /* The combination "set" - the flags are bitwise "OR"d from the
470 * ENGINE_METHOD_*** defines above. */
471 int ENGINE_set_default(ENGINE *e, unsigned int flags);
473 /* This function resets all the internal "default" ENGINEs (there's one for each
474 * of the various algorithms) to NULL, releasing any references as appropriate.
475 * This function is called as part of the ENGINE_cleanup() function, so there's
476 * no need to call both (although no harm is done). */
477 int ENGINE_clear_defaults(void);
479 /* Instruct an engine to load any EVP ciphers it knows of */
480 /* XXX make this work via defaults? */
481 void ENGINE_load_engine_ciphers(ENGINE *e);
482 /* Get a particular cipher from a particular engine - NULL if the engine
484 const EVP_CIPHER *ENGINE_get_cipher_by_name(ENGINE *e,const char *name);
486 /**************************/
487 /* DYNAMIC ENGINE SUPPORT */
488 /**************************/
490 /* Binary/behaviour compatibility levels */
491 #define OSSL_DYNAMIC_VERSION (unsigned long)0x00010100
492 /* Binary versions older than this are too old for us (whether we're a loader or
494 #define OSSL_DYNAMIC_OLDEST (unsigned long)0x00010100
496 /* When compiling an ENGINE entirely as an external shared library, loadable by
497 * the "dynamic" ENGINE, these types are needed. The 'dynamic_fns' structure
498 * type provides the calling application's (or library's) error functionality
499 * and memory management function pointers to the loaded library. These should
500 * be used/set in the loaded library code so that the loading application's
501 * 'state' will be used/changed in all operations. */
502 typedef void *(*dyn_MEM_malloc_cb)(size_t);
503 typedef void *(*dyn_MEM_realloc_cb)(void *, size_t);
504 typedef void (*dyn_MEM_free_cb)(void *);
505 typedef struct st_dynamic_MEM_fns {
506 dyn_MEM_malloc_cb malloc_cb;
507 dyn_MEM_realloc_cb realloc_cb;
508 dyn_MEM_free_cb free_cb;
510 /* FIXME: Perhaps the memory and locking code (crypto.h) should declare and use
511 * these types so we (and any other dependant code) can simplify a bit?? */
512 typedef void (*dyn_lock_locking_cb)(int,int,const char *,int);
513 typedef int (*dyn_lock_add_lock_cb)(int*,int,int,const char *,int);
514 typedef struct CRYPTO_dynlock_value *(*dyn_dynlock_create_cb)(
516 typedef void (*dyn_dynlock_lock_cb)(int,struct CRYPTO_dynlock_value *,
518 typedef void (*dyn_dynlock_destroy_cb)(struct CRYPTO_dynlock_value *,
520 typedef struct st_dynamic_LOCK_fns {
521 dyn_lock_locking_cb lock_locking_cb;
522 dyn_lock_add_lock_cb lock_add_lock_cb;
523 dyn_dynlock_create_cb dynlock_create_cb;
524 dyn_dynlock_lock_cb dynlock_lock_cb;
525 dyn_dynlock_destroy_cb dynlock_destroy_cb;
527 /* The top-level structure */
528 typedef struct st_dynamic_fns {
529 const ERR_FNS *err_fns;
530 const CRYPTO_EX_DATA_IMPL *ex_data_fns;
531 dynamic_MEM_fns mem_fns;
532 dynamic_LOCK_fns lock_fns;
535 /* The version checking function should be of this prototype. NB: The
536 * ossl_version value passed in is the OSSL_DYNAMIC_VERSION of the loading code.
537 * If this function returns zero, it indicates a (potential) version
538 * incompatibility and the loaded library doesn't believe it can proceed.
539 * Otherwise, the returned value is the (latest) version supported by the
540 * loading library. The loader may still decide that the loaded code's version
541 * is unsatisfactory and could veto the load. The function is expected to
542 * be implemented with the symbol name "v_check", and a default implementation
543 * can be fully instantiated with IMPLEMENT_DYNAMIC_CHECK_FN(). */
544 typedef unsigned long (*dynamic_v_check_fn)(unsigned long ossl_version);
545 #define IMPLEMENT_DYNAMIC_CHECK_FN() \
546 unsigned long v_check(unsigned long v) { \
547 if(v >= OSSL_DYNAMIC_OLDEST) return OSSL_DYNAMIC_VERSION; \
550 /* This function is passed the ENGINE structure to initialise with its own
551 * function and command settings. It should not adjust the structural or
552 * functional reference counts. If this function returns zero, (a) the load will
553 * be aborted, (b) the previous ENGINE state will be memcpy'd back onto the
554 * structure, and (c) the shared library will be unloaded. So implementations
555 * should do their own internal cleanup in failure circumstances otherwise they
556 * could leak. The 'id' parameter, if non-NULL, represents the ENGINE id that
557 * the loader is looking for. If this is NULL, the shared library can choose to
558 * return failure or to initialise a 'default' ENGINE. If non-NULL, the shared
559 * library must initialise only an ENGINE matching the passed 'id'. The function
560 * is expected to be implemented with the symbol name "bind_engine". A standard
561 * implementation can be instantiated with IMPLEMENT_DYNAMIC_BIND_FN(fn) where
562 * the parameter 'fn' is a callback function that populates the ENGINE structure
563 * and returns an int value (zero for failure). 'fn' should have prototype;
564 * [static] int fn(ENGINE *e, const char *id); */
565 typedef int (*dynamic_bind_engine)(ENGINE *e, const char *id,
566 const dynamic_fns *fns);
567 #define IMPLEMENT_DYNAMIC_BIND_FN(fn) \
568 int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns) { \
569 if(!CRYPTO_set_mem_functions(fns->mem_fns.malloc_cb, \
570 fns->mem_fns.realloc_cb, fns->mem_fns.free_cb)) \
572 CRYPTO_set_locking_callback(fns->lock_fns.lock_locking_cb); \
573 CRYPTO_set_add_lock_callback(fns->lock_fns.lock_add_lock_cb); \
574 CRYPTO_set_dynlock_create_callback(fns->lock_fns.dynlock_create_cb); \
575 CRYPTO_set_dynlock_lock_callback(fns->lock_fns.dynlock_lock_cb); \
576 CRYPTO_set_dynlock_destroy_callback(fns->lock_fns.dynlock_destroy_cb); \
577 if(!CRYPTO_set_ex_data_implementation(fns->ex_data_fns)) \
579 if(!ERR_set_implementation(fns->err_fns)) return 0; \
580 if(!fn(e,id)) return 0; \
583 /* BEGIN ERROR CODES */
584 /* The following lines are auto generated by the script mkerr.pl. Any changes
585 * made after this point may be overwritten when the script is next run.
587 void ERR_load_ENGINE_strings(void);
589 /* Error codes for the ENGINE functions. */
591 /* Function codes. */
592 #define ENGINE_F_DYNAMIC_CTRL 180
593 #define ENGINE_F_DYNAMIC_GET_DATA_CTX 181
594 #define ENGINE_F_DYNAMIC_LOAD 182
595 #define ENGINE_F_ENGINE_ADD 105
596 #define ENGINE_F_ENGINE_BY_ID 106
597 #define ENGINE_F_ENGINE_CMD_IS_EXECUTABLE 170
598 #define ENGINE_F_ENGINE_CTRL 142
599 #define ENGINE_F_ENGINE_CTRL_CMD 178
600 #define ENGINE_F_ENGINE_CTRL_CMD_STRING 171
601 #define ENGINE_F_ENGINE_FINISH 107
602 #define ENGINE_F_ENGINE_FREE 108
603 #define ENGINE_F_ENGINE_GET_DEFAULT_TYPE 177
604 #define ENGINE_F_ENGINE_GET_NEXT 115
605 #define ENGINE_F_ENGINE_GET_PREV 116
606 #define ENGINE_F_ENGINE_INIT 119
607 #define ENGINE_F_ENGINE_LIST_ADD 120
608 #define ENGINE_F_ENGINE_LIST_REMOVE 121
609 #define ENGINE_F_ENGINE_LOAD_PRIVATE_KEY 150
610 #define ENGINE_F_ENGINE_LOAD_PUBLIC_KEY 151
611 #define ENGINE_F_ENGINE_NEW 122
612 #define ENGINE_F_ENGINE_REMOVE 123
613 #define ENGINE_F_ENGINE_SET_DEFAULT_TYPE 126
614 #define ENGINE_F_ENGINE_SET_ID 129
615 #define ENGINE_F_ENGINE_SET_NAME 130
616 #define ENGINE_F_ENGINE_UNLOAD_KEY 152
617 #define ENGINE_F_INT_CTRL_HELPER 172
618 #define ENGINE_F_LOG_MESSAGE 141
619 #define ENGINE_F_SET_DATA_CTX 183
622 #define ENGINE_R_ALREADY_LOADED 100
623 #define ENGINE_R_ARGUMENT_IS_NOT_A_NUMBER 133
624 #define ENGINE_R_BIO_WAS_FREED 121
625 #define ENGINE_R_BN_CTX_FULL 101
626 #define ENGINE_R_BN_EXPAND_FAIL 102
627 #define ENGINE_R_CHIL_ERROR 123
628 #define ENGINE_R_CMD_NOT_EXECUTABLE 134
629 #define ENGINE_R_COMMAND_TAKES_INPUT 135
630 #define ENGINE_R_COMMAND_TAKES_NO_INPUT 136
631 #define ENGINE_R_CONFLICTING_ENGINE_ID 103
632 #define ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED 119
633 #define ENGINE_R_DH_NOT_IMPLEMENTED 139
634 #define ENGINE_R_DSA_NOT_IMPLEMENTED 140
635 #define ENGINE_R_DSO_FAILURE 104
636 #define ENGINE_R_DSO_FUNCTION_NOT_FOUND 131
637 #define ENGINE_R_DSO_NOT_FOUND 132
638 #define ENGINE_R_ENGINE_IS_NOT_IN_LIST 105
639 #define ENGINE_R_FAILED_LOADING_PRIVATE_KEY 128
640 #define ENGINE_R_FAILED_LOADING_PUBLIC_KEY 129
641 #define ENGINE_R_FINISH_FAILED 106
642 #define ENGINE_R_GET_HANDLE_FAILED 107
643 #define ENGINE_R_ID_OR_NAME_MISSING 108
644 #define ENGINE_R_INIT_FAILED 109
645 #define ENGINE_R_INTERNAL_LIST_ERROR 110
646 #define ENGINE_R_INVALID_ARGUMENT 143
647 #define ENGINE_R_INVALID_CMD_NAME 137
648 #define ENGINE_R_INVALID_CMD_NUMBER 138
649 #define ENGINE_R_MISSING_KEY_COMPONENTS 111
650 #define ENGINE_R_NOT_INITIALISED 117
651 #define ENGINE_R_NOT_LOADED 112
652 #define ENGINE_R_NO_CALLBACK 127
653 #define ENGINE_R_NO_CONTROL_FUNCTION 120
654 #define ENGINE_R_NO_INDEX 144
655 #define ENGINE_R_NO_KEY 124
656 #define ENGINE_R_NO_LOAD_FUNCTION 125
657 #define ENGINE_R_NO_REFERENCE 130
658 #define ENGINE_R_NO_SUCH_ENGINE 116
659 #define ENGINE_R_NO_UNLOAD_FUNCTION 126
660 #define ENGINE_R_PRIVATE_KEY_ALGORITHMS_DISABLED 142
661 #define ENGINE_R_PROVIDE_PARAMETERS 113
662 #define ENGINE_R_REQUEST_FAILED 114
663 #define ENGINE_R_REQUEST_FALLBACK 118
664 #define ENGINE_R_RSA_NOT_IMPLEMENTED 141
665 #define ENGINE_R_SIZE_TOO_LARGE_OR_TOO_SMALL 122
666 #define ENGINE_R_UNIT_FAILURE 115
667 #define ENGINE_R_VERSION_INCOMPATIBILITY 145