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