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