693b820894d82c01b0bef7de618288589870ae66
[openssl.git] / crypto / engine / engine.h
1 /* openssl/engine.h */
2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
3  * project 2000.
4  */
5 /* ====================================================================
6  * Copyright (c) 1999 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer. 
14  *
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
18  *    distribution.
19  *
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/)"
24  *
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.
29  *
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.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
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  * ====================================================================
52  *
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).
56  *
57  */
58
59 #ifndef HEADER_ENGINE_H
60 #define HEADER_ENGINE_H
61
62 #include <openssl/types.h>
63 #include <openssl/bn.h>
64 #ifndef OPENSSL_NO_RSA
65 #include <openssl/rsa.h>
66 #endif
67 #ifndef OPENSSL_NO_DSA
68 #include <openssl/dsa.h>
69 #endif
70 #ifndef OPENSSL_NO_DH
71 #include <openssl/dh.h>
72 #endif
73 #include <openssl/rand.h>
74 #include <openssl/ui.h>
75 #include <openssl/symhacks.h>
76
77 #ifdef  __cplusplus
78 extern "C" {
79 #endif
80
81 /* Fixups for missing algorithms */
82 #ifdef OPENSSL_NO_RSA
83 typedef void RSA_METHOD;
84 #endif
85 #ifdef OPENSSL_NO_DSA
86 typedef void DSA_METHOD;
87 #endif
88 #ifdef OPENSSL_NO_DH
89 typedef void DH_METHOD;
90 #endif
91
92 /* These flags are used to control combinations of algorithm (methods)
93  * by bitwise "OR"ing. */
94 #define ENGINE_METHOD_RSA               (unsigned int)0x0001
95 #define ENGINE_METHOD_DSA               (unsigned int)0x0002
96 #define ENGINE_METHOD_DH                (unsigned int)0x0004
97 #define ENGINE_METHOD_RAND              (unsigned int)0x0008
98 #define ENGINE_METHOD_BN_MOD_EXP        (unsigned int)0x0010
99 #define ENGINE_METHOD_BN_MOD_EXP_CRT    (unsigned int)0x0020
100 /* Obvious all-or-nothing cases. */
101 #define ENGINE_METHOD_ALL               (unsigned int)0xFFFF
102 #define ENGINE_METHOD_NONE              (unsigned int)0x0000
103
104 /* ENGINE flags that can be set by ENGINE_set_flags(). */
105 /* #define ENGINE_FLAGS_MALLOCED        0x0001 */ /* Not used */
106
107 /* This flag is for ENGINEs that wish to handle the various 'CMD'-related
108  * control commands on their own. Without this flag, ENGINE_ctrl() handles these
109  * control commands on behalf of the ENGINE using their "cmd_defns" data. */
110 #define ENGINE_FLAGS_MANUAL_CMD_CTRL    (int)0x0002
111
112 /* This flag is for ENGINEs who return new duplicate structures when found via
113  * "ENGINE_by_id()". When an ENGINE must store state (eg. if ENGINE_ctrl()
114  * commands are called in sequence as part of some stateful process like
115  * key-generation setup and execution), it can set this flag - then each attempt
116  * to obtain the ENGINE will result in it being copied into a new structure.
117  * Normally, ENGINEs don't declare this flag so ENGINE_by_id() just increments
118  * the existing ENGINE's structural reference count. */
119 #define ENGINE_FLAGS_BY_ID_COPY         (int)0x0004
120
121 /* ENGINEs can support their own command types, and these flags are used in
122  * ENGINE_CTRL_GET_CMD_FLAGS to indicate to the caller what kind of input each
123  * command expects. Currently only numeric and string input is supported. If a
124  * control command supports none of the _NUMERIC, _STRING, or _NO_INPUT options,
125  * then it is regarded as an "internal" control command - and not for use in
126  * config setting situations. As such, they're not available to the
127  * ENGINE_ctrl_cmd_string() function, only raw ENGINE_ctrl() access. Changes to
128  * this list of 'command types' should be reflected carefully in
129  * ENGINE_cmd_is_executable() and ENGINE_ctrl_cmd_string(). */
130
131 /* accepts a 'long' input value (3rd parameter to ENGINE_ctrl) */
132 #define ENGINE_CMD_FLAG_NUMERIC         (unsigned int)0x0001
133 /* accepts string input (cast from 'void*' to 'const char *', 4th parameter to
134  * ENGINE_ctrl) */
135 #define ENGINE_CMD_FLAG_STRING          (unsigned int)0x0002
136 /* Indicates that the control command takes *no* input. Ie. the control command
137  * is unparameterised. */
138 #define ENGINE_CMD_FLAG_NO_INPUT        (unsigned int)0x0004
139 /* Indicates that the control command is internal. This control command won't
140  * be shown in any output, and is only usable through the ENGINE_ctrl_cmd()
141  * function. */
142 #define ENGINE_CMD_FLAG_INTERNAL        (unsigned int)0x0008
143
144 /* NB: These 3 control commands are deprecated and should not be used. ENGINEs
145  * relying on these commands should compile conditional support for
146  * compatibility (eg. if these symbols are defined) but should also migrate the
147  * same functionality to their own ENGINE-specific control functions that can be
148  * "discovered" by calling applications. The fact these control commands
149  * wouldn't be "executable" (ie. usable by text-based config) doesn't change the
150  * fact that application code can find and use them without requiring per-ENGINE
151  * hacking. */
152
153 /* These flags are used to tell the ctrl function what should be done.
154  * All command numbers are shared between all engines, even if some don't
155  * make sense to some engines.  In such a case, they do nothing but return
156  * the error ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED. */
157 #define ENGINE_CTRL_SET_LOGSTREAM               1
158 #define ENGINE_CTRL_SET_PASSWORD_CALLBACK       2
159 #define ENGINE_CTRL_HUP                         3 /* Close and reinitialise any
160                                                      handles/connections etc. */
161 #define ENGINE_CTRL_SET_USER_INTERFACE          4 /* Alternative to callback */
162 #define ENGINE_CTRL_SET_CALLBACK_DATA           5 /* User-specific data, used
163                                                      when calling the password
164                                                      callback and the user
165                                                      interface */
166
167 /* These control commands allow an application to deal with an arbitrary engine
168  * in a dynamic way. Warn: Negative return values indicate errors FOR THESE
169  * COMMANDS because zero is used to indicate 'end-of-list'. Other commands,
170  * including ENGINE-specific command types, return zero for an error.
171  *
172  * An ENGINE can choose to implement these ctrl functions, and can internally
173  * manage things however it chooses - it does so by setting the
174  * ENGINE_FLAGS_MANUAL_CMD_CTRL flag (using ENGINE_set_flags()). Otherwise the
175  * ENGINE_ctrl() code handles this on the ENGINE's behalf using the cmd_defns
176  * data (set using ENGINE_set_cmd_defns()). This means an ENGINE's ctrl()
177  * handler need only implement its own commands - the above "meta" commands will
178  * be taken care of. */
179
180 /* Returns non-zero if the supplied ENGINE has a ctrl() handler. If "not", then
181  * all the remaining control commands will return failure, so it is worth
182  * checking this first if the caller is trying to "discover" the engine's
183  * capabilities and doesn't want errors generated unnecessarily. */
184 #define ENGINE_CTRL_HAS_CTRL_FUNCTION           10
185 /* Returns a positive command number for the first command supported by the
186  * engine. Returns zero if no ctrl commands are supported. */
187 #define ENGINE_CTRL_GET_FIRST_CMD_TYPE          11
188 /* The 'long' argument specifies a command implemented by the engine, and the
189  * return value is the next command supported, or zero if there are no more. */
190 #define ENGINE_CTRL_GET_NEXT_CMD_TYPE           12
191 /* The 'void*' argument is a command name (cast from 'const char *'), and the
192  * return value is the command that corresponds to it. */
193 #define ENGINE_CTRL_GET_CMD_FROM_NAME           13
194 /* The next two allow a command to be converted into its corresponding string
195  * form. In each case, the 'long' argument supplies the command. In the NAME_LEN
196  * case, the return value is the length of the command name (not counting a
197  * trailing EOL). In the NAME case, the 'void*' argument must be a string buffer
198  * large enough, and it will be populated with the name of the command (WITH a
199  * trailing EOL). */
200 #define ENGINE_CTRL_GET_NAME_LEN_FROM_CMD       14
201 #define ENGINE_CTRL_GET_NAME_FROM_CMD           15
202 /* The next two are similar but give a "short description" of a command. */
203 #define ENGINE_CTRL_GET_DESC_LEN_FROM_CMD       16
204 #define ENGINE_CTRL_GET_DESC_FROM_CMD           17
205 /* With this command, the return value is the OR'd combination of
206  * ENGINE_CMD_FLAG_*** values that indicate what kind of input a given
207  * engine-specific ctrl command expects. */
208 #define ENGINE_CTRL_GET_CMD_FLAGS               18
209
210 /* ENGINE implementations should start the numbering of their own control
211  * commands from this value. (ie. ENGINE_CMD_BASE, ENGINE_CMD_BASE + 1, etc). */
212 #define ENGINE_CMD_BASE         200
213
214 /* NB: These 2 nCipher "chil" control commands are deprecated, and their
215  * functionality is now available through ENGINE-specific control commands
216  * (exposed through the above-mentioned 'CMD'-handling). Code using these 2
217  * commands should be migrated to the more general command handling before these
218  * are removed. */
219
220 /* Flags specific to the nCipher "chil" engine */
221 #define ENGINE_CTRL_CHIL_SET_FORKCHECK          100
222         /* Depending on the value of the (long)i argument, this sets or
223          * unsets the SimpleForkCheck flag in the CHIL API to enable or
224          * disable checking and workarounds for applications that fork().
225          */
226 #define ENGINE_CTRL_CHIL_NO_LOCKING             101
227         /* This prevents the initialisation function from providing mutex
228          * callbacks to the nCipher library. */
229
230 /* If an ENGINE supports its own specific control commands and wishes the
231  * framework to handle the above 'ENGINE_CMD_***'-manipulation commands on its
232  * behalf, it should supply a null-terminated array of ENGINE_CMD_DEFN entries
233  * to ENGINE_set_cmd_defns(). It should also implement a ctrl() handler that
234  * supports the stated commands (ie. the "cmd_num" entries as described by the
235  * array). NB: The array must be ordered in increasing order of cmd_num.
236  * "null-terminated" means that the last ENGINE_CMD_DEFN element has cmd_num set
237  * to zero and/or cmd_name set to NULL. */
238 typedef struct ENGINE_CMD_DEFN_st
239         {
240         unsigned int cmd_num; /* The command number */
241         const char *cmd_name; /* The command name itself */
242         const char *cmd_desc; /* A short description of the command */
243         unsigned int cmd_flags; /* The input the command expects */
244         } ENGINE_CMD_DEFN;
245
246 /* As we're missing a BIGNUM_METHOD, we need a couple of locally
247  * defined function types that engines can implement. */
248
249 /* mod_exp operation, calculates; r = a ^ p mod m
250  * NB: ctx can be NULL, but if supplied, the implementation may use
251  * it if it wishes. */
252 typedef int (*BN_MOD_EXP)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
253                 const BIGNUM *m, BN_CTX *ctx);
254
255 /* private key operation for RSA, provided seperately in case other
256  * RSA implementations wish to use it. */
257 typedef int (*BN_MOD_EXP_CRT)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
258                 const BIGNUM *q, const BIGNUM *dmp1, const BIGNUM *dmq1,
259                 const BIGNUM *iqmp, BN_CTX *ctx);
260
261 /* The list of "engine" types is a static array of (const ENGINE*)
262  * pointers (not dynamic because static is fine for now and we otherwise
263  * have to hook an appropriate load/unload function in to initialise and
264  * cleanup). */
265 struct engine_st;
266 typedef struct engine_st ENGINE;
267
268 /* Generic function pointer */
269 typedef int (*ENGINE_GEN_FUNC_PTR)();
270 /* Generic function pointer taking no arguments */
271 typedef int (*ENGINE_GEN_INT_FUNC_PTR)(ENGINE *);
272 /* Specific control function pointer */
273 typedef int (*ENGINE_CTRL_FUNC_PTR)(ENGINE *, int, long, void *, void (*f)());
274 /* Generic load_key function pointer */
275 typedef EVP_PKEY * (*ENGINE_LOAD_KEY_PTR)(ENGINE *, const char *,
276         UI_METHOD *ui_method, void *callback_data);
277
278 /* STRUCTURE functions ... all of these functions deal with pointers to ENGINE
279  * structures where the pointers have a "structural reference". This means that
280  * their reference is to allowed access to the structure but it does not imply
281  * that the structure is functional. To simply increment or decrement the
282  * structural reference count, use ENGINE_by_id and ENGINE_free. NB: This is not
283  * required when iterating using ENGINE_get_next as it will automatically
284  * decrement the structural reference count of the "current" ENGINE and
285  * increment the structural reference count of the ENGINE it returns (unless it
286  * is NULL). */
287
288 /* Get the first/last "ENGINE" type available. */
289 ENGINE *ENGINE_get_first(void);
290 ENGINE *ENGINE_get_last(void);
291 /* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */
292 ENGINE *ENGINE_get_next(ENGINE *e);
293 ENGINE *ENGINE_get_prev(ENGINE *e);
294 /* Add another "ENGINE" type into the array. */
295 int ENGINE_add(ENGINE *e);
296 /* Remove an existing "ENGINE" type from the array. */
297 int ENGINE_remove(ENGINE *e);
298 /* Retrieve an engine from the list by its unique "id" value. */
299 ENGINE *ENGINE_by_id(const char *id);
300 /* Add all the built-in engines.  By default, only the OpenSSL software
301    engine is loaded */
302 void ENGINE_load_cswift(void);
303 void ENGINE_load_chil(void);
304 void ENGINE_load_atalla(void);
305 void ENGINE_load_nuron(void);
306 void ENGINE_load_ubsec(void);
307 void ENGINE_load_builtin_engines(void);
308
309 /* Send parametrised control commands to the engine. The possibilities to send
310  * down an integer, a pointer to data or a function pointer are provided. Any of
311  * the parameters may or may not be NULL, depending on the command number. In
312  * actuality, this function only requires a structural (rather than functional)
313  * reference to an engine, but many control commands may require the engine be
314  * functional. The caller should be aware of trying commands that require an
315  * operational ENGINE, and only use functional references in such situations. */
316 int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)());
317
318 /* This function tests if an ENGINE-specific command is usable as a "setting".
319  * Eg. in an application's config file that gets processed through
320  * ENGINE_ctrl_cmd_string(). If this returns zero, it is not available to
321  * ENGINE_ctrl_cmd_string(), only ENGINE_ctrl(). */
322 int ENGINE_cmd_is_executable(ENGINE *e, int cmd);
323
324 /* This function works like ENGINE_ctrl() with the exception of taking a
325  * command name instead of a command number, and can handle optional commands.
326  * See the comment on ENGINE_ctrl_cmd_string() for an explanation on how to
327  * use the cmd_name and cmd_optional. */
328 int ENGINE_ctrl_cmd(ENGINE *e, const char *cmd_name,
329         long i, void *p, void (*f)(), int cmd_optional);
330
331 /* This function passes a command-name and argument to an ENGINE. The cmd_name
332  * is converted to a command number and the control command is called using
333  * 'arg' as an argument (unless the ENGINE doesn't support such a command, in
334  * which case no control command is called). The command is checked for input
335  * flags, and if necessary the argument will be converted to a numeric value. If
336  * cmd_optional is non-zero, then if the ENGINE doesn't support the given
337  * cmd_name the return value will be success anyway. This function is intended
338  * for applications to use so that users (or config files) can supply
339  * engine-specific config data to the ENGINE at run-time to control behaviour of
340  * specific engines. As such, it shouldn't be used for calling ENGINE_ctrl()
341  * functions that return data, deal with binary data, or that are otherwise
342  * supposed to be used directly through ENGINE_ctrl() in application code. Any
343  * "return" data from an ENGINE_ctrl() operation in this function will be lost -
344  * the return value is interpreted as failure if the return value is zero,
345  * success otherwise, and this function returns a boolean value as a result. In
346  * other words, vendors of 'ENGINE'-enabled devices should write ENGINE
347  * implementations with parameterisations that work in this scheme, so that
348  * compliant ENGINE-based applications can work consistently with the same
349  * configuration for the same ENGINE-enabled devices, across applications. */
350 int ENGINE_ctrl_cmd_string(ENGINE *e, const char *cmd_name, const char *arg,
351                                 int cmd_optional);
352
353 /* These functions are useful for manufacturing new ENGINE structures. They
354  * don't address reference counting at all - one uses them to populate an ENGINE
355  * structure with personalised implementations of things prior to using it
356  * directly or adding it to the builtin ENGINE list in OpenSSL. These are also
357  * here so that the ENGINE structure doesn't have to be exposed and break binary
358  * compatibility! */
359 ENGINE *ENGINE_new(void);
360 int ENGINE_free(ENGINE *e);
361 int ENGINE_set_id(ENGINE *e, const char *id);
362 int ENGINE_set_name(ENGINE *e, const char *name);
363 int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth);
364 int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth);
365 int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth);
366 int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth);
367 int ENGINE_set_BN_mod_exp(ENGINE *e, BN_MOD_EXP bn_mod_exp);
368 int ENGINE_set_BN_mod_exp_crt(ENGINE *e, BN_MOD_EXP_CRT bn_mod_exp_crt);
369 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f);
370 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f);
371 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f);
372 int ENGINE_set_load_privkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpriv_f);
373 int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f);
374 int ENGINE_set_flags(ENGINE *e, int flags);
375 int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns);
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);
391
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 BN_MOD_EXP ENGINE_get_BN_mod_exp(const ENGINE *e);
403 BN_MOD_EXP_CRT ENGINE_get_BN_mod_exp_crt(const ENGINE *e);
404 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e);
405 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e);
406 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e);
407 ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e);
408 ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e);
409 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e);
410 int ENGINE_get_flags(const ENGINE *e);
411 void *ENGINE_get_ex_data(const ENGINE *e, int idx);
412
413 /* FUNCTIONAL functions. These functions deal with ENGINE structures
414  * that have (or will) be initialised for use. Broadly speaking, the
415  * structural functions are useful for iterating the list of available
416  * engine types, creating new engine types, and other "list" operations.
417  * These functions actually deal with ENGINEs that are to be used. As
418  * such these functions can fail (if applicable) when particular
419  * engines are unavailable - eg. if a hardware accelerator is not
420  * attached or not functioning correctly. Each ENGINE has 2 reference
421  * counts; structural and functional. Every time a functional reference
422  * is obtained or released, a corresponding structural reference is
423  * automatically obtained or released too. */
424
425 /* Initialise a engine type for use (or up its reference count if it's
426  * already in use). This will fail if the engine is not currently
427  * operational and cannot initialise. */
428 int ENGINE_init(ENGINE *e);
429 /* Free a functional reference to a engine type. This does not require
430  * a corresponding call to ENGINE_free as it also releases a structural
431  * reference. */
432 int ENGINE_finish(ENGINE *e);
433
434 /* The following functions handle keys that are stored in some secondary
435  * location, handled by the engine.  The storage may be on a card or
436  * whatever. */
437 EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id,
438         UI_METHOD *ui_method, void *callback_data);
439 EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id,
440         UI_METHOD *ui_method, void *callback_data);
441
442 /* This returns a pointer for the current ENGINE structure that
443  * is (by default) performing any RSA operations. The value returned
444  * is an incremented reference, so it should be free'd (ENGINE_finish)
445  * before it is discarded. */
446 ENGINE *ENGINE_get_default_RSA(void);
447 /* Same for the other "methods" */
448 ENGINE *ENGINE_get_default_DSA(void);
449 ENGINE *ENGINE_get_default_DH(void);
450 ENGINE *ENGINE_get_default_RAND(void);
451 ENGINE *ENGINE_get_default_BN_mod_exp(void);
452 ENGINE *ENGINE_get_default_BN_mod_exp_crt(void);
453
454 /* This sets a new default ENGINE structure for performing RSA
455  * operations. If the result is non-zero (success) then the ENGINE
456  * structure will have had its reference count up'd so the caller
457  * should still free their own reference 'e'. */
458 int ENGINE_set_default_RSA(ENGINE *e);
459 /* Same for the other "methods" */
460 int ENGINE_set_default_DSA(ENGINE *e);
461 int ENGINE_set_default_DH(ENGINE *e);
462 int ENGINE_set_default_RAND(ENGINE *e);
463 int ENGINE_set_default_BN_mod_exp(ENGINE *e);
464 int ENGINE_set_default_BN_mod_exp_crt(ENGINE *e);
465
466 /* The combination "set" - the flags are bitwise "OR"d from the
467  * ENGINE_METHOD_*** defines above. */
468 int ENGINE_set_default(ENGINE *e, unsigned int flags);
469
470 /* This function resets all the internal "default" ENGINEs (there's one for each
471  * of the various algorithms) to NULL, releasing any references as appropriate.
472  * This function is called as part of the ENGINE_cleanup() function, so there's
473  * no need to call both (although no harm is done). */
474 int ENGINE_clear_defaults(void);
475
476 /* Obligatory error function. */
477 void ERR_load_ENGINE_strings(void);
478
479 /* BEGIN ERROR CODES */
480 /* The following lines are auto generated by the script mkerr.pl. Any changes
481  * made after this point may be overwritten when the script is next run.
482  */
483 void ERR_load_ENGINE_strings(void);
484
485 /* Error codes for the ENGINE functions. */
486
487 /* Function codes. */
488 #define ENGINE_F_ATALLA_CTRL                             173
489 #define ENGINE_F_ATALLA_FINISH                           159
490 #define ENGINE_F_ATALLA_INIT                             160
491 #define ENGINE_F_ATALLA_MOD_EXP                          161
492 #define ENGINE_F_ATALLA_RSA_MOD_EXP                      162
493 #define ENGINE_F_CSWIFT_CTRL                             174
494 #define ENGINE_F_CSWIFT_DSA_SIGN                         133
495 #define ENGINE_F_CSWIFT_DSA_VERIFY                       134
496 #define ENGINE_F_CSWIFT_FINISH                           100
497 #define ENGINE_F_CSWIFT_INIT                             101
498 #define ENGINE_F_CSWIFT_MOD_EXP                          102
499 #define ENGINE_F_CSWIFT_MOD_EXP_CRT                      103
500 #define ENGINE_F_CSWIFT_RSA_MOD_EXP                      104
501 #define ENGINE_F_ENGINE_ADD                              105
502 #define ENGINE_F_ENGINE_BY_ID                            106
503 #define ENGINE_F_ENGINE_CMD_IS_EXECUTABLE                170
504 #define ENGINE_F_ENGINE_CTRL                             142
505 #define ENGINE_F_ENGINE_CTRL_CMD                         178
506 #define ENGINE_F_ENGINE_CTRL_CMD_STRING                  171
507 #define ENGINE_F_ENGINE_FINISH                           107
508 #define ENGINE_F_ENGINE_FREE                             108
509 #define ENGINE_F_ENGINE_GET_DEFAULT_TYPE                 177
510 #define ENGINE_F_ENGINE_GET_NEXT                         115
511 #define ENGINE_F_ENGINE_GET_PREV                         116
512 #define ENGINE_F_ENGINE_INIT                             119
513 #define ENGINE_F_ENGINE_LIST_ADD                         120
514 #define ENGINE_F_ENGINE_LIST_REMOVE                      121
515 #define ENGINE_F_ENGINE_LOAD_PRIVATE_KEY                 150
516 #define ENGINE_F_ENGINE_LOAD_PUBLIC_KEY                  151
517 #define ENGINE_F_ENGINE_NEW                              122
518 #define ENGINE_F_ENGINE_REMOVE                           123
519 #define ENGINE_F_ENGINE_SET_DEFAULT_TYPE                 126
520 #define ENGINE_F_ENGINE_SET_ID                           129
521 #define ENGINE_F_ENGINE_SET_NAME                         130
522 #define ENGINE_F_ENGINE_UNLOAD_KEY                       152
523 #define ENGINE_F_HWCRHK_CTRL                             143
524 #define ENGINE_F_HWCRHK_FINISH                           135
525 #define ENGINE_F_HWCRHK_GET_PASS                         155
526 #define ENGINE_F_HWCRHK_INIT                             136
527 #define ENGINE_F_HWCRHK_INSERT_CARD                      179
528 #define ENGINE_F_HWCRHK_LOAD_PRIVKEY                     153
529 #define ENGINE_F_HWCRHK_LOAD_PUBKEY                      154
530 #define ENGINE_F_HWCRHK_MOD_EXP                          137
531 #define ENGINE_F_HWCRHK_MOD_EXP_CRT                      138
532 #define ENGINE_F_HWCRHK_RAND_BYTES                       139
533 #define ENGINE_F_HWCRHK_RSA_MOD_EXP                      140
534 #define ENGINE_F_INT_CTRL_HELPER                         172
535 #define ENGINE_F_LOG_MESSAGE                             141
536 #define ENGINE_F_NURON_CTRL                              175
537 #define ENGINE_F_NURON_FINISH                            157
538 #define ENGINE_F_NURON_INIT                              156
539 #define ENGINE_F_NURON_MOD_EXP                           158
540 #define ENGINE_F_UBSEC_CTRL                              176
541 #define ENGINE_F_UBSEC_DSA_SIGN                          163
542 #define ENGINE_F_UBSEC_DSA_VERIFY                        164
543 #define ENGINE_F_UBSEC_FINISH                            165
544 #define ENGINE_F_UBSEC_INIT                              166
545 #define ENGINE_F_UBSEC_MOD_EXP                           167
546 #define ENGINE_F_UBSEC_RSA_MOD_EXP                       168
547 #define ENGINE_F_UBSEC_RSA_MOD_EXP_CRT                   169
548
549 /* Reason codes. */
550 #define ENGINE_R_ALREADY_LOADED                          100
551 #define ENGINE_R_ARGUMENT_IS_NOT_A_NUMBER                133
552 #define ENGINE_R_BIO_WAS_FREED                           121
553 #define ENGINE_R_BN_CTX_FULL                             101
554 #define ENGINE_R_BN_EXPAND_FAIL                          102
555 #define ENGINE_R_CHIL_ERROR                              123
556 #define ENGINE_R_CMD_NOT_EXECUTABLE                      134
557 #define ENGINE_R_COMMAND_TAKES_INPUT                     135
558 #define ENGINE_R_COMMAND_TAKES_NO_INPUT                  136
559 #define ENGINE_R_CONFLICTING_ENGINE_ID                   103
560 #define ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED            119
561 #define ENGINE_R_DH_NOT_IMPLEMENTED                      139
562 #define ENGINE_R_DSA_NOT_IMPLEMENTED                     140
563 #define ENGINE_R_DSO_FAILURE                             104
564 #define ENGINE_R_DSO_FUNCTION_NOT_FOUND                  131
565 #define ENGINE_R_DSO_NOT_FOUND                           132
566 #define ENGINE_R_ENGINE_IS_NOT_IN_LIST                   105
567 #define ENGINE_R_FAILED_LOADING_PRIVATE_KEY              128
568 #define ENGINE_R_FAILED_LOADING_PUBLIC_KEY               129
569 #define ENGINE_R_FINISH_FAILED                           106
570 #define ENGINE_R_GET_HANDLE_FAILED                       107
571 #define ENGINE_R_ID_OR_NAME_MISSING                      108
572 #define ENGINE_R_INIT_FAILED                             109
573 #define ENGINE_R_INTERNAL_LIST_ERROR                     110
574 #define ENGINE_R_INVALID_CMD_NAME                        137
575 #define ENGINE_R_INVALID_CMD_NUMBER                      138
576 #define ENGINE_R_MISSING_KEY_COMPONENTS                  111
577 #define ENGINE_R_NOT_INITIALISED                         117
578 #define ENGINE_R_NOT_LOADED                              112
579 #define ENGINE_R_NO_CALLBACK                             127
580 #define ENGINE_R_NO_CONTROL_FUNCTION                     120
581 #define ENGINE_R_NO_KEY                                  124
582 #define ENGINE_R_NO_LOAD_FUNCTION                        125
583 #define ENGINE_R_NO_REFERENCE                            130
584 #define ENGINE_R_NO_SUCH_ENGINE                          116
585 #define ENGINE_R_NO_UNLOAD_FUNCTION                      126
586 #define ENGINE_R_PRIVATE_KEY_ALGORITHMS_DISABLED         142
587 #define ENGINE_R_PROVIDE_PARAMETERS                      113
588 #define ENGINE_R_REQUEST_FAILED                          114
589 #define ENGINE_R_REQUEST_FALLBACK                        118
590 #define ENGINE_R_RSA_NOT_IMPLEMENTED                     141
591 #define ENGINE_R_SIZE_TOO_LARGE_OR_TOO_SMALL             122
592 #define ENGINE_R_UNIT_FAILURE                            115
593
594 #ifdef  __cplusplus
595 }
596 #endif
597 #endif