2c5ad3c8ca4dc7dcf8fa1f82c92cb308c5c33b4e
[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-2001 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/ossl_typ.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 #include <openssl/err.h>
77
78 #ifdef  __cplusplus
79 extern "C" {
80 #endif
81
82 /* Fixups for missing algorithms */
83 #ifdef OPENSSL_NO_RSA
84 typedef void RSA_METHOD;
85 #endif
86 #ifdef OPENSSL_NO_DSA
87 typedef void DSA_METHOD;
88 #endif
89 #ifdef OPENSSL_NO_DH
90 typedef void DH_METHOD;
91 #endif
92
93 /* These flags are used to control combinations of algorithm (methods)
94  * by bitwise "OR"ing. */
95 #define ENGINE_METHOD_RSA               (unsigned int)0x0001
96 #define ENGINE_METHOD_DSA               (unsigned int)0x0002
97 #define ENGINE_METHOD_DH                (unsigned int)0x0004
98 #define ENGINE_METHOD_RAND              (unsigned int)0x0008
99 #define ENGINE_METHOD_CIPHERS           (unsigned int)0x0040
100 #define ENGINE_METHOD_DIGESTS           (unsigned int)0x0080
101 /* Obvious all-or-nothing cases. */
102 #define ENGINE_METHOD_ALL               (unsigned int)0xFFFF
103 #define ENGINE_METHOD_NONE              (unsigned int)0x0000
104
105 /* This(ese) flag(s) controls behaviour of the ENGINE_TABLE mechanism used
106  * internally to control registration of ENGINE implementations, and can be set
107  * by ENGINE_set_table_flags(). The "NOINIT" flag prevents attempts to
108  * initialise registered ENGINEs if they are not already initialised. */
109 #define ENGINE_TABLE_FLAG_NOINIT        (unsigned int)0x0001
110
111 /* ENGINE flags that can be set by ENGINE_set_flags(). */
112 /* #define ENGINE_FLAGS_MALLOCED        0x0001 */ /* Not used */
113
114 /* This flag is for ENGINEs that wish to handle the various 'CMD'-related
115  * control commands on their own. Without this flag, ENGINE_ctrl() handles these
116  * control commands on behalf of the ENGINE using their "cmd_defns" data. */
117 #define ENGINE_FLAGS_MANUAL_CMD_CTRL    (int)0x0002
118
119 /* This flag is for ENGINEs who return new duplicate structures when found via
120  * "ENGINE_by_id()". When an ENGINE must store state (eg. if ENGINE_ctrl()
121  * commands are called in sequence as part of some stateful process like
122  * key-generation setup and execution), it can set this flag - then each attempt
123  * to obtain the ENGINE will result in it being copied into a new structure.
124  * Normally, ENGINEs don't declare this flag so ENGINE_by_id() just increments
125  * the existing ENGINE's structural reference count. */
126 #define ENGINE_FLAGS_BY_ID_COPY         (int)0x0004
127
128 /* ENGINEs can support their own command types, and these flags are used in
129  * ENGINE_CTRL_GET_CMD_FLAGS to indicate to the caller what kind of input each
130  * command expects. Currently only numeric and string input is supported. If a
131  * control command supports none of the _NUMERIC, _STRING, or _NO_INPUT options,
132  * then it is regarded as an "internal" control command - and not for use in
133  * config setting situations. As such, they're not available to the
134  * ENGINE_ctrl_cmd_string() function, only raw ENGINE_ctrl() access. Changes to
135  * this list of 'command types' should be reflected carefully in
136  * ENGINE_cmd_is_executable() and ENGINE_ctrl_cmd_string(). */
137
138 /* accepts a 'long' input value (3rd parameter to ENGINE_ctrl) */
139 #define ENGINE_CMD_FLAG_NUMERIC         (unsigned int)0x0001
140 /* accepts string input (cast from 'void*' to 'const char *', 4th parameter to
141  * ENGINE_ctrl) */
142 #define ENGINE_CMD_FLAG_STRING          (unsigned int)0x0002
143 /* Indicates that the control command takes *no* input. Ie. the control command
144  * is unparameterised. */
145 #define ENGINE_CMD_FLAG_NO_INPUT        (unsigned int)0x0004
146 /* Indicates that the control command is internal. This control command won't
147  * be shown in any output, and is only usable through the ENGINE_ctrl_cmd()
148  * function. */
149 #define ENGINE_CMD_FLAG_INTERNAL        (unsigned int)0x0008
150
151 /* NB: These 3 control commands are deprecated and should not be used. ENGINEs
152  * relying on these commands should compile conditional support for
153  * compatibility (eg. if these symbols are defined) but should also migrate the
154  * same functionality to their own ENGINE-specific control functions that can be
155  * "discovered" by calling applications. The fact these control commands
156  * wouldn't be "executable" (ie. usable by text-based config) doesn't change the
157  * fact that application code can find and use them without requiring per-ENGINE
158  * hacking. */
159
160 /* These flags are used to tell the ctrl function what should be done.
161  * All command numbers are shared between all engines, even if some don't
162  * make sense to some engines.  In such a case, they do nothing but return
163  * the error ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED. */
164 #define ENGINE_CTRL_SET_LOGSTREAM               1
165 #define ENGINE_CTRL_SET_PASSWORD_CALLBACK       2
166 #define ENGINE_CTRL_HUP                         3 /* Close and reinitialise any
167                                                      handles/connections etc. */
168 #define ENGINE_CTRL_SET_USER_INTERFACE          4 /* Alternative to callback */
169 #define ENGINE_CTRL_SET_CALLBACK_DATA           5 /* User-specific data, used
170                                                      when calling the password
171                                                      callback and the user
172                                                      interface */
173
174 /* These control commands allow an application to deal with an arbitrary engine
175  * in a dynamic way. Warn: Negative return values indicate errors FOR THESE
176  * COMMANDS because zero is used to indicate 'end-of-list'. Other commands,
177  * including ENGINE-specific command types, return zero for an error.
178  *
179  * An ENGINE can choose to implement these ctrl functions, and can internally
180  * manage things however it chooses - it does so by setting the
181  * ENGINE_FLAGS_MANUAL_CMD_CTRL flag (using ENGINE_set_flags()). Otherwise the
182  * ENGINE_ctrl() code handles this on the ENGINE's behalf using the cmd_defns
183  * data (set using ENGINE_set_cmd_defns()). This means an ENGINE's ctrl()
184  * handler need only implement its own commands - the above "meta" commands will
185  * be taken care of. */
186
187 /* Returns non-zero if the supplied ENGINE has a ctrl() handler. If "not", then
188  * all the remaining control commands will return failure, so it is worth
189  * checking this first if the caller is trying to "discover" the engine's
190  * capabilities and doesn't want errors generated unnecessarily. */
191 #define ENGINE_CTRL_HAS_CTRL_FUNCTION           10
192 /* Returns a positive command number for the first command supported by the
193  * engine. Returns zero if no ctrl commands are supported. */
194 #define ENGINE_CTRL_GET_FIRST_CMD_TYPE          11
195 /* The 'long' argument specifies a command implemented by the engine, and the
196  * return value is the next command supported, or zero if there are no more. */
197 #define ENGINE_CTRL_GET_NEXT_CMD_TYPE           12
198 /* The 'void*' argument is a command name (cast from 'const char *'), and the
199  * return value is the command that corresponds to it. */
200 #define ENGINE_CTRL_GET_CMD_FROM_NAME           13
201 /* The next two allow a command to be converted into its corresponding string
202  * form. In each case, the 'long' argument supplies the command. In the NAME_LEN
203  * case, the return value is the length of the command name (not counting a
204  * trailing EOL). In the NAME case, the 'void*' argument must be a string buffer
205  * large enough, and it will be populated with the name of the command (WITH a
206  * trailing EOL). */
207 #define ENGINE_CTRL_GET_NAME_LEN_FROM_CMD       14
208 #define ENGINE_CTRL_GET_NAME_FROM_CMD           15
209 /* The next two are similar but give a "short description" of a command. */
210 #define ENGINE_CTRL_GET_DESC_LEN_FROM_CMD       16
211 #define ENGINE_CTRL_GET_DESC_FROM_CMD           17
212 /* With this command, the return value is the OR'd combination of
213  * ENGINE_CMD_FLAG_*** values that indicate what kind of input a given
214  * engine-specific ctrl command expects. */
215 #define ENGINE_CTRL_GET_CMD_FLAGS               18
216
217 /* ENGINE implementations should start the numbering of their own control
218  * commands from this value. (ie. ENGINE_CMD_BASE, ENGINE_CMD_BASE + 1, etc). */
219 #define ENGINE_CMD_BASE         200
220
221 /* NB: These 2 nCipher "chil" control commands are deprecated, and their
222  * functionality is now available through ENGINE-specific control commands
223  * (exposed through the above-mentioned 'CMD'-handling). Code using these 2
224  * commands should be migrated to the more general command handling before these
225  * are removed. */
226
227 /* Flags specific to the nCipher "chil" engine */
228 #define ENGINE_CTRL_CHIL_SET_FORKCHECK          100
229         /* Depending on the value of the (long)i argument, this sets or
230          * unsets the SimpleForkCheck flag in the CHIL API to enable or
231          * disable checking and workarounds for applications that fork().
232          */
233 #define ENGINE_CTRL_CHIL_NO_LOCKING             101
234         /* This prevents the initialisation function from providing mutex
235          * callbacks to the nCipher library. */
236
237 /* If an ENGINE supports its own specific control commands and wishes the
238  * framework to handle the above 'ENGINE_CMD_***'-manipulation commands on its
239  * behalf, it should supply a null-terminated array of ENGINE_CMD_DEFN entries
240  * to ENGINE_set_cmd_defns(). It should also implement a ctrl() handler that
241  * supports the stated commands (ie. the "cmd_num" entries as described by the
242  * array). NB: The array must be ordered in increasing order of cmd_num.
243  * "null-terminated" means that the last ENGINE_CMD_DEFN element has cmd_num set
244  * to zero and/or cmd_name set to NULL. */
245 typedef struct ENGINE_CMD_DEFN_st
246         {
247         unsigned int cmd_num; /* The command number */
248         const char *cmd_name; /* The command name itself */
249         const char *cmd_desc; /* A short description of the command */
250         unsigned int cmd_flags; /* The input the command expects */
251         } ENGINE_CMD_DEFN;
252
253 /* Generic function pointer */
254 typedef int (*ENGINE_GEN_FUNC_PTR)();
255 /* Generic function pointer taking no arguments */
256 typedef int (*ENGINE_GEN_INT_FUNC_PTR)(ENGINE *);
257 /* Specific control function pointer */
258 typedef int (*ENGINE_CTRL_FUNC_PTR)(ENGINE *, int, long, void *, void (*f)());
259 /* Generic load_key function pointer */
260 typedef EVP_PKEY * (*ENGINE_LOAD_KEY_PTR)(ENGINE *, const char *,
261         UI_METHOD *ui_method, void *callback_data);
262 /* These callback types are for an ENGINE's handler for cipher and digest logic.
263  * These handlers have these prototypes;
264  *   int foo(ENGINE *e, const EVP_CIPHER **cipher, const int **nids, int nid);
265  *   int foo(ENGINE *e, const EVP_MD **digest, const int **nids, int nid);
266  * Looking at how to implement these handlers in the case of cipher support, if
267  * the framework wants the EVP_CIPHER for 'nid', it will call;
268  *   foo(e, &p_evp_cipher, NULL, nid);    (return zero for failure)
269  * If the framework wants a list of supported 'nid's, it will call;
270  *   foo(e, NULL, &p_nids, 0); (returns number of 'nids' or -1 for error)
271  */
272 /* Returns to a pointer to the array of supported cipher 'nid's. If the second
273  * parameter is non-NULL it is set to the size of the returned array. */
274 typedef int (*ENGINE_CIPHERS_PTR)(ENGINE *, const EVP_CIPHER **, const int **, int);
275 typedef int (*ENGINE_DIGESTS_PTR)(ENGINE *, const EVP_MD **, const int **, int);
276
277 /* STRUCTURE functions ... all of these functions deal with pointers to ENGINE
278  * structures where the pointers have a "structural reference". This means that
279  * their reference is to allowed access to the structure but it does not imply
280  * that the structure is functional. To simply increment or decrement the
281  * structural reference count, use ENGINE_by_id and ENGINE_free. NB: This is not
282  * required when iterating using ENGINE_get_next as it will automatically
283  * decrement the structural reference count of the "current" ENGINE and
284  * increment the structural reference count of the ENGINE it returns (unless it
285  * is NULL). */
286
287 /* Get the first/last "ENGINE" type available. */
288 ENGINE *ENGINE_get_first(void);
289 ENGINE *ENGINE_get_last(void);
290 /* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */
291 ENGINE *ENGINE_get_next(ENGINE *e);
292 ENGINE *ENGINE_get_prev(ENGINE *e);
293 /* Add another "ENGINE" type into the array. */
294 int ENGINE_add(ENGINE *e);
295 /* Remove an existing "ENGINE" type from the array. */
296 int ENGINE_remove(ENGINE *e);
297 /* Retrieve an engine from the list by its unique "id" value. */
298 ENGINE *ENGINE_by_id(const char *id);
299 /* Add all the built-in engines. */
300 void ENGINE_load_openssl(void);
301 void ENGINE_load_dynamic(void);
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_openbsd_dev_crypto(void);
308 void ENGINE_load_builtin_engines(void);
309
310 /* Get and set global flags (ENGINE_TABLE_FLAG_***) for the implementation
311  * "registry" handling. */
312 unsigned int ENGINE_get_table_flags(void);
313 void ENGINE_set_table_flags(unsigned int flags);
314
315 /* Manage registration of ENGINEs per "table". For each type, there are 3
316  * functions;
317  *   ENGINE_register_***(e) - registers the implementation from 'e' (if it has one)
318  *   ENGINE_unregister_***(e) - unregister the implementation from 'e'
319  *   ENGINE_register_all_***() - call ENGINE_register_***() for each 'e' in the list
320  * Cleanup is automatically registered from each table when required, so
321  * ENGINE_cleanup() will reverse any "register" operations. */
322
323 int ENGINE_register_RSA(ENGINE *e);
324 void ENGINE_unregister_RSA(ENGINE *e);
325 void ENGINE_register_all_RSA(void);
326
327 int ENGINE_register_DSA(ENGINE *e);
328 void ENGINE_unregister_DSA(ENGINE *e);
329 void ENGINE_register_all_DSA(void);
330
331 int ENGINE_register_DH(ENGINE *e);
332 void ENGINE_unregister_DH(ENGINE *e);
333 void ENGINE_register_all_DH(void);
334
335 int ENGINE_register_RAND(ENGINE *e);
336 void ENGINE_unregister_RAND(ENGINE *e);
337 void ENGINE_register_all_RAND(void);
338
339 int ENGINE_register_ciphers(ENGINE *e);
340 void ENGINE_unregister_ciphers(ENGINE *e);
341 void ENGINE_register_all_ciphers(void);
342
343 int ENGINE_register_digests(ENGINE *e);
344 void ENGINE_unregister_digests(ENGINE *e);
345 void ENGINE_register_all_digests(void);
346
347 /* These functions register all support from the above categories. Note, use of
348  * these functions can result in static linkage of code your application may not
349  * need. If you only need a subset of functionality, consider using more
350  * selective initialisation. */
351 int ENGINE_register_complete(ENGINE *e);
352 int ENGINE_register_all_complete(void);
353
354 /* Send parametrised control commands to the engine. The possibilities to send
355  * down an integer, a pointer to data or a function pointer are provided. Any of
356  * the parameters may or may not be NULL, depending on the command number. In
357  * actuality, this function only requires a structural (rather than functional)
358  * reference to an engine, but many control commands may require the engine be
359  * functional. The caller should be aware of trying commands that require an
360  * operational ENGINE, and only use functional references in such situations. */
361 int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)());
362
363 /* This function tests if an ENGINE-specific command is usable as a "setting".
364  * Eg. in an application's config file that gets processed through
365  * ENGINE_ctrl_cmd_string(). If this returns zero, it is not available to
366  * ENGINE_ctrl_cmd_string(), only ENGINE_ctrl(). */
367 int ENGINE_cmd_is_executable(ENGINE *e, int cmd);
368
369 /* This function works like ENGINE_ctrl() with the exception of taking a
370  * command name instead of a command number, and can handle optional commands.
371  * See the comment on ENGINE_ctrl_cmd_string() for an explanation on how to
372  * use the cmd_name and cmd_optional. */
373 int ENGINE_ctrl_cmd(ENGINE *e, const char *cmd_name,
374         long i, void *p, void (*f)(), int cmd_optional);
375
376 /* This function passes a command-name and argument to an ENGINE. The cmd_name
377  * is converted to a command number and the control command is called using
378  * 'arg' as an argument (unless the ENGINE doesn't support such a command, in
379  * which case no control command is called). The command is checked for input
380  * flags, and if necessary the argument will be converted to a numeric value. If
381  * cmd_optional is non-zero, then if the ENGINE doesn't support the given
382  * cmd_name the return value will be success anyway. This function is intended
383  * for applications to use so that users (or config files) can supply
384  * engine-specific config data to the ENGINE at run-time to control behaviour of
385  * specific engines. As such, it shouldn't be used for calling ENGINE_ctrl()
386  * functions that return data, deal with binary data, or that are otherwise
387  * supposed to be used directly through ENGINE_ctrl() in application code. Any
388  * "return" data from an ENGINE_ctrl() operation in this function will be lost -
389  * the return value is interpreted as failure if the return value is zero,
390  * success otherwise, and this function returns a boolean value as a result. In
391  * other words, vendors of 'ENGINE'-enabled devices should write ENGINE
392  * implementations with parameterisations that work in this scheme, so that
393  * compliant ENGINE-based applications can work consistently with the same
394  * configuration for the same ENGINE-enabled devices, across applications. */
395 int ENGINE_ctrl_cmd_string(ENGINE *e, const char *cmd_name, const char *arg,
396                                 int cmd_optional);
397
398 /* These functions are useful for manufacturing new ENGINE structures. They
399  * don't address reference counting at all - one uses them to populate an ENGINE
400  * structure with personalised implementations of things prior to using it
401  * directly or adding it to the builtin ENGINE list in OpenSSL. These are also
402  * here so that the ENGINE structure doesn't have to be exposed and break binary
403  * compatibility! */
404 ENGINE *ENGINE_new(void);
405 int ENGINE_free(ENGINE *e);
406 int ENGINE_set_id(ENGINE *e, const char *id);
407 int ENGINE_set_name(ENGINE *e, const char *name);
408 int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth);
409 int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth);
410 int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth);
411 int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth);
412 int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f);
413 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f);
414 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f);
415 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f);
416 int ENGINE_set_load_privkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpriv_f);
417 int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f);
418 int ENGINE_set_ciphers(ENGINE *e, ENGINE_CIPHERS_PTR f);
419 int ENGINE_set_digests(ENGINE *e, ENGINE_DIGESTS_PTR f);
420 int ENGINE_set_flags(ENGINE *e, int flags);
421 int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns);
422 /* These functions (and the "get" function lower down) allow control over any
423  * per-structure ENGINE data. */
424 int ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
425                 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
426 int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg);
427
428 /* This function cleans up anything that needs it. Eg. the ENGINE_add() function
429  * automatically ensures the list cleanup function is registered to be called
430  * from ENGINE_cleanup(). Similarly, all ENGINE_register_*** functions ensure
431  * ENGINE_cleanup() will clean up after them. */
432 void ENGINE_cleanup(void);
433
434 /* These return values from within the ENGINE structure. These can be useful
435  * with functional references as well as structural references - it depends
436  * which you obtained. Using the result for functional purposes if you only
437  * obtained a structural reference may be problematic! */
438 const char *ENGINE_get_id(const ENGINE *e);
439 const char *ENGINE_get_name(const ENGINE *e);
440 const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e);
441 const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e);
442 const DH_METHOD *ENGINE_get_DH(const ENGINE *e);
443 const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e);
444 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e);
445 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e);
446 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e);
447 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e);
448 ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e);
449 ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e);
450 ENGINE_CIPHERS_PTR ENGINE_get_ciphers(const ENGINE *e);
451 ENGINE_DIGESTS_PTR ENGINE_get_digests(const ENGINE *e);
452 const EVP_CIPHER *ENGINE_get_cipher(ENGINE *e, int nid);
453 const EVP_MD *ENGINE_get_digest(ENGINE *e, int nid);
454 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e);
455 int ENGINE_get_flags(const ENGINE *e);
456 void *ENGINE_get_ex_data(const ENGINE *e, int idx);
457
458 /* FUNCTIONAL functions. These functions deal with ENGINE structures
459  * that have (or will) be initialised for use. Broadly speaking, the
460  * structural functions are useful for iterating the list of available
461  * engine types, creating new engine types, and other "list" operations.
462  * These functions actually deal with ENGINEs that are to be used. As
463  * such these functions can fail (if applicable) when particular
464  * engines are unavailable - eg. if a hardware accelerator is not
465  * attached or not functioning correctly. Each ENGINE has 2 reference
466  * counts; structural and functional. Every time a functional reference
467  * is obtained or released, a corresponding structural reference is
468  * automatically obtained or released too. */
469
470 /* Initialise a engine type for use (or up its reference count if it's
471  * already in use). This will fail if the engine is not currently
472  * operational and cannot initialise. */
473 int ENGINE_init(ENGINE *e);
474 /* Free a functional reference to a engine type. This does not require
475  * a corresponding call to ENGINE_free as it also releases a structural
476  * reference. */
477 int ENGINE_finish(ENGINE *e);
478
479 /* The following functions handle keys that are stored in some secondary
480  * location, handled by the engine.  The storage may be on a card or
481  * whatever. */
482 EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id,
483         UI_METHOD *ui_method, void *callback_data);
484 EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id,
485         UI_METHOD *ui_method, void *callback_data);
486
487 /* This returns a pointer for the current ENGINE structure that
488  * is (by default) performing any RSA operations. The value returned
489  * is an incremented reference, so it should be free'd (ENGINE_finish)
490  * before it is discarded. */
491 ENGINE *ENGINE_get_default_RSA(void);
492 /* Same for the other "methods" */
493 ENGINE *ENGINE_get_default_DSA(void);
494 ENGINE *ENGINE_get_default_DH(void);
495 ENGINE *ENGINE_get_default_RAND(void);
496 /* These functions can be used to get a functional reference to perform
497  * ciphering or digesting corresponding to "nid". */
498 ENGINE *ENGINE_get_cipher_engine(int nid);
499 ENGINE *ENGINE_get_digest_engine(int nid);
500
501 /* This sets a new default ENGINE structure for performing RSA
502  * operations. If the result is non-zero (success) then the ENGINE
503  * structure will have had its reference count up'd so the caller
504  * should still free their own reference 'e'. */
505 int ENGINE_set_default_RSA(ENGINE *e);
506 int ENGINE_set_default_string(ENGINE *e, const char *list);
507 /* Same for the other "methods" */
508 int ENGINE_set_default_DSA(ENGINE *e);
509 int ENGINE_set_default_DH(ENGINE *e);
510 int ENGINE_set_default_RAND(ENGINE *e);
511 int ENGINE_set_default_ciphers(ENGINE *e);
512 int ENGINE_set_default_digests(ENGINE *e);
513
514 /* The combination "set" - the flags are bitwise "OR"d from the
515  * ENGINE_METHOD_*** defines above. As with the "ENGINE_register_complete()"
516  * function, this function can result in unnecessary static linkage. If your
517  * application requires only specific functionality, consider using more
518  * selective functions. */
519 int ENGINE_set_default(ENGINE *e, unsigned int flags);
520
521 void ENGINE_add_conf_module(void);
522
523 /* Deprecated functions ... */
524 /* int ENGINE_clear_defaults(void); */
525
526 /**************************/
527 /* DYNAMIC ENGINE SUPPORT */
528 /**************************/
529
530 /* Binary/behaviour compatibility levels */
531 #define OSSL_DYNAMIC_VERSION            (unsigned long)0x00010100
532 /* Binary versions older than this are too old for us (whether we're a loader or
533  * a loadee) */
534 #define OSSL_DYNAMIC_OLDEST             (unsigned long)0x00010100
535
536 /* When compiling an ENGINE entirely as an external shared library, loadable by
537  * the "dynamic" ENGINE, these types are needed. The 'dynamic_fns' structure
538  * type provides the calling application's (or library's) error functionality
539  * and memory management function pointers to the loaded library. These should
540  * be used/set in the loaded library code so that the loading application's
541  * 'state' will be used/changed in all operations. */
542 typedef void *(*dyn_MEM_malloc_cb)(size_t);
543 typedef void *(*dyn_MEM_realloc_cb)(void *, size_t);
544 typedef void (*dyn_MEM_free_cb)(void *);
545 typedef struct st_dynamic_MEM_fns {
546         dyn_MEM_malloc_cb                       malloc_cb;
547         dyn_MEM_realloc_cb                      realloc_cb;
548         dyn_MEM_free_cb                         free_cb;
549         } dynamic_MEM_fns;
550 /* FIXME: Perhaps the memory and locking code (crypto.h) should declare and use
551  * these types so we (and any other dependant code) can simplify a bit?? */
552 typedef void (*dyn_lock_locking_cb)(int,int,const char *,int);
553 typedef int (*dyn_lock_add_lock_cb)(int*,int,int,const char *,int);
554 typedef struct CRYPTO_dynlock_value *(*dyn_dynlock_create_cb)(
555                                                 const char *,int);
556 typedef void (*dyn_dynlock_lock_cb)(int,struct CRYPTO_dynlock_value *,
557                                                 const char *,int);
558 typedef void (*dyn_dynlock_destroy_cb)(struct CRYPTO_dynlock_value *,
559                                                 const char *,int);
560 typedef struct st_dynamic_LOCK_fns {
561         dyn_lock_locking_cb                     lock_locking_cb;
562         dyn_lock_add_lock_cb                    lock_add_lock_cb;
563         dyn_dynlock_create_cb                   dynlock_create_cb;
564         dyn_dynlock_lock_cb                     dynlock_lock_cb;
565         dyn_dynlock_destroy_cb                  dynlock_destroy_cb;
566         } dynamic_LOCK_fns;
567 /* The top-level structure */
568 typedef struct st_dynamic_fns {
569         const ERR_FNS                           *err_fns;
570         const CRYPTO_EX_DATA_IMPL               *ex_data_fns;
571         dynamic_MEM_fns                         mem_fns;
572         dynamic_LOCK_fns                        lock_fns;
573         } dynamic_fns;
574
575 /* The version checking function should be of this prototype. NB: The
576  * ossl_version value passed in is the OSSL_DYNAMIC_VERSION of the loading code.
577  * If this function returns zero, it indicates a (potential) version
578  * incompatibility and the loaded library doesn't believe it can proceed.
579  * Otherwise, the returned value is the (latest) version supported by the
580  * loading library. The loader may still decide that the loaded code's version
581  * is unsatisfactory and could veto the load. The function is expected to
582  * be implemented with the symbol name "v_check", and a default implementation
583  * can be fully instantiated with IMPLEMENT_DYNAMIC_CHECK_FN(). */
584 typedef unsigned long (*dynamic_v_check_fn)(unsigned long ossl_version);
585 #define IMPLEMENT_DYNAMIC_CHECK_FN() \
586         unsigned long v_check(unsigned long v) { \
587                 if(v >= OSSL_DYNAMIC_OLDEST) return OSSL_DYNAMIC_VERSION; \
588                 return 0; }
589
590 /* This function is passed the ENGINE structure to initialise with its own
591  * function and command settings. It should not adjust the structural or
592  * functional reference counts. If this function returns zero, (a) the load will
593  * be aborted, (b) the previous ENGINE state will be memcpy'd back onto the
594  * structure, and (c) the shared library will be unloaded. So implementations
595  * should do their own internal cleanup in failure circumstances otherwise they
596  * could leak. The 'id' parameter, if non-NULL, represents the ENGINE id that
597  * the loader is looking for. If this is NULL, the shared library can choose to
598  * return failure or to initialise a 'default' ENGINE. If non-NULL, the shared
599  * library must initialise only an ENGINE matching the passed 'id'. The function
600  * is expected to be implemented with the symbol name "bind_engine". A standard
601  * implementation can be instantiated with IMPLEMENT_DYNAMIC_BIND_FN(fn) where
602  * the parameter 'fn' is a callback function that populates the ENGINE structure
603  * and returns an int value (zero for failure). 'fn' should have prototype;
604  *    [static] int fn(ENGINE *e, const char *id); */
605 typedef int (*dynamic_bind_engine)(ENGINE *e, const char *id,
606                                 const dynamic_fns *fns);
607 #define IMPLEMENT_DYNAMIC_BIND_FN(fn) \
608         int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns) { \
609                 if(!CRYPTO_set_mem_functions(fns->mem_fns.malloc_cb, \
610                         fns->mem_fns.realloc_cb, fns->mem_fns.free_cb)) \
611                         return 0; \
612                 CRYPTO_set_locking_callback(fns->lock_fns.lock_locking_cb); \
613                 CRYPTO_set_add_lock_callback(fns->lock_fns.lock_add_lock_cb); \
614                 CRYPTO_set_dynlock_create_callback(fns->lock_fns.dynlock_create_cb); \
615                 CRYPTO_set_dynlock_lock_callback(fns->lock_fns.dynlock_lock_cb); \
616                 CRYPTO_set_dynlock_destroy_callback(fns->lock_fns.dynlock_destroy_cb); \
617                 if(!CRYPTO_set_ex_data_implementation(fns->ex_data_fns)) \
618                         return 0; \
619                 if(!ERR_set_implementation(fns->err_fns)) return 0; \
620                 if(!fn(e,id)) return 0; \
621                 return 1; }
622
623 /* BEGIN ERROR CODES */
624 /* The following lines are auto generated by the script mkerr.pl. Any changes
625  * made after this point may be overwritten when the script is next run.
626  */
627 void ERR_load_ENGINE_strings(void);
628
629 /* Error codes for the ENGINE functions. */
630
631 /* Function codes. */
632 #define ENGINE_F_DYNAMIC_CTRL                            180
633 #define ENGINE_F_DYNAMIC_GET_DATA_CTX                    181
634 #define ENGINE_F_DYNAMIC_LOAD                            182
635 #define ENGINE_F_ENGINE_ADD                              105
636 #define ENGINE_F_ENGINE_BY_ID                            106
637 #define ENGINE_F_ENGINE_CMD_IS_EXECUTABLE                170
638 #define ENGINE_F_ENGINE_CTRL                             142
639 #define ENGINE_F_ENGINE_CTRL_CMD                         178
640 #define ENGINE_F_ENGINE_CTRL_CMD_STRING                  171
641 #define ENGINE_F_ENGINE_FINISH                           107
642 #define ENGINE_F_ENGINE_FREE                             108
643 #define ENGINE_F_ENGINE_GET_CIPHER                       185
644 #define ENGINE_F_ENGINE_GET_DEFAULT_TYPE                 177
645 #define ENGINE_F_ENGINE_GET_DIGEST                       186
646 #define ENGINE_F_ENGINE_GET_NEXT                         115
647 #define ENGINE_F_ENGINE_GET_PREV                         116
648 #define ENGINE_F_ENGINE_INIT                             119
649 #define ENGINE_F_ENGINE_LIST_ADD                         120
650 #define ENGINE_F_ENGINE_LIST_REMOVE                      121
651 #define ENGINE_F_ENGINE_LOAD_PRIVATE_KEY                 150
652 #define ENGINE_F_ENGINE_LOAD_PUBLIC_KEY                  151
653 #define ENGINE_F_ENGINE_MODULE_INIT                      187
654 #define ENGINE_F_ENGINE_NEW                              122
655 #define ENGINE_F_ENGINE_REMOVE                           123
656 #define ENGINE_F_ENGINE_SET_DEFAULT_STRING               189
657 #define ENGINE_F_ENGINE_SET_DEFAULT_TYPE                 126
658 #define ENGINE_F_ENGINE_SET_ID                           129
659 #define ENGINE_F_ENGINE_SET_NAME                         130
660 #define ENGINE_F_ENGINE_TABLE_REGISTER                   184
661 #define ENGINE_F_ENGINE_UNLOAD_KEY                       152
662 #define ENGINE_F_INT_CTRL_HELPER                         172
663 #define ENGINE_F_INT_ENGINE_CONFIGURE                    188
664 #define ENGINE_F_LOG_MESSAGE                             141
665 #define ENGINE_F_SET_DATA_CTX                            183
666
667 /* Reason codes. */
668 #define ENGINE_R_ALREADY_LOADED                          100
669 #define ENGINE_R_ARGUMENT_IS_NOT_A_NUMBER                133
670 #define ENGINE_R_BIO_WAS_FREED                           121
671 #define ENGINE_R_BN_CTX_FULL                             101
672 #define ENGINE_R_BN_EXPAND_FAIL                          102
673 #define ENGINE_R_CHIL_ERROR                              123
674 #define ENGINE_R_CMD_NOT_EXECUTABLE                      134
675 #define ENGINE_R_COMMAND_TAKES_INPUT                     135
676 #define ENGINE_R_COMMAND_TAKES_NO_INPUT                  136
677 #define ENGINE_R_CONFLICTING_ENGINE_ID                   103
678 #define ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED            119
679 #define ENGINE_R_DH_NOT_IMPLEMENTED                      139
680 #define ENGINE_R_DSA_NOT_IMPLEMENTED                     140
681 #define ENGINE_R_DSO_FAILURE                             104
682 #define ENGINE_R_DSO_FUNCTION_NOT_FOUND                  131
683 #define ENGINE_R_DSO_NOT_FOUND                           132
684 #define ENGINE_R_ENGINES_SECTION_ERROR                   148
685 #define ENGINE_R_ENGINE_IS_NOT_IN_LIST                   105
686 #define ENGINE_R_ENGINE_SECTION_ERROR                    149
687 #define ENGINE_R_FAILED_LOADING_PRIVATE_KEY              128
688 #define ENGINE_R_FAILED_LOADING_PUBLIC_KEY               129
689 #define ENGINE_R_FINISH_FAILED                           106
690 #define ENGINE_R_GET_HANDLE_FAILED                       107
691 #define ENGINE_R_ID_OR_NAME_MISSING                      108
692 #define ENGINE_R_INIT_FAILED                             109
693 #define ENGINE_R_INTERNAL_LIST_ERROR                     110
694 #define ENGINE_R_INVALID_ARGUMENT                        143
695 #define ENGINE_R_INVALID_CMD_NAME                        137
696 #define ENGINE_R_INVALID_CMD_NUMBER                      138
697 #define ENGINE_R_INVALID_STRING                          150
698 #define ENGINE_R_MISSING_KEY_COMPONENTS                  111
699 #define ENGINE_R_NOT_INITIALISED                         117
700 #define ENGINE_R_NOT_LOADED                              112
701 #define ENGINE_R_NO_CALLBACK                             127
702 #define ENGINE_R_NO_CONTROL_FUNCTION                     120
703 #define ENGINE_R_NO_INDEX                                144
704 #define ENGINE_R_NO_KEY                                  124
705 #define ENGINE_R_NO_LOAD_FUNCTION                        125
706 #define ENGINE_R_NO_REFERENCE                            130
707 #define ENGINE_R_NO_SUCH_ENGINE                          116
708 #define ENGINE_R_NO_UNLOAD_FUNCTION                      126
709 #define ENGINE_R_PRIVATE_KEY_ALGORITHMS_DISABLED         142
710 #define ENGINE_R_PROVIDE_PARAMETERS                      113
711 #define ENGINE_R_REQUEST_FAILED                          114
712 #define ENGINE_R_REQUEST_FALLBACK                        118
713 #define ENGINE_R_RSA_NOT_IMPLEMENTED                     141
714 #define ENGINE_R_SIZE_TOO_LARGE_OR_TOO_SMALL             122
715 #define ENGINE_R_UNIMPLEMENTED_CIPHER                    146
716 #define ENGINE_R_UNIMPLEMENTED_DIGEST                    147
717 #define ENGINE_R_UNIT_FAILURE                            115
718 #define ENGINE_R_VERSION_INCOMPATIBILITY                 145
719
720 #ifdef  __cplusplus
721 }
722 #endif
723 #endif