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