Updated OSSL_DYNAMIC_VERSION/OSSL_DYNAMIC_OLDEST
[openssl.git] / include / openssl / engine.h
1 /* openssl/engine.h */
2 /*
3  * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project
4  * 2000.
5  */
6 /* ====================================================================
7  * Copyright (c) 1999-2004 The OpenSSL Project.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in
18  *    the documentation and/or other materials provided with the
19  *    distribution.
20  *
21  * 3. All advertising materials mentioning features or use of this
22  *    software must display the following acknowledgment:
23  *    "This product includes software developed by the OpenSSL Project
24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25  *
26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27  *    endorse or promote products derived from this software without
28  *    prior written permission. For written permission, please contact
29  *    licensing@OpenSSL.org.
30  *
31  * 5. Products derived from this software may not be called "OpenSSL"
32  *    nor may "OpenSSL" appear in their names without prior written
33  *    permission of the OpenSSL Project.
34  *
35  * 6. Redistributions of any form whatsoever must retain the following
36  *    acknowledgment:
37  *    "This product includes software developed by the OpenSSL Project
38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51  * OF THE POSSIBILITY OF SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This product includes cryptographic software written by Eric Young
55  * (eay@cryptsoft.com).  This product includes software written by Tim
56  * Hudson (tjh@cryptsoft.com).
57  *
58  */
59 /* ====================================================================
60  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
61  * ECDH support in OpenSSL originally developed by
62  * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
63  */
64
65 #ifndef HEADER_ENGINE_H
66 # define HEADER_ENGINE_H
67
68 # include <openssl/opensslconf.h>
69
70 # ifdef OPENSSL_NO_ENGINE
71 #  error ENGINE is disabled.
72 # endif
73
74 # if OPENSSL_API_COMPAT < 0x10100000L
75 #  include <openssl/bn.h>
76 #  ifndef OPENSSL_NO_RSA
77 #   include <openssl/rsa.h>
78 #  endif
79 #  ifndef OPENSSL_NO_DSA
80 #   include <openssl/dsa.h>
81 #  endif
82 #  ifndef OPENSSL_NO_DH
83 #   include <openssl/dh.h>
84 #  endif
85 #  ifndef OPENSSL_NO_EC
86 #   include <openssl/ec.h>
87 #  endif
88 #  include <openssl/rand.h>
89 #  include <openssl/ui.h>
90 #  include <openssl/err.h>
91 # endif
92
93 # include <openssl/ossl_typ.h>
94 # include <openssl/symhacks.h>
95
96 # include <openssl/x509.h>
97
98 #ifdef  __cplusplus
99 extern "C" {
100 #endif
101
102 /*
103  * These flags are used to control combinations of algorithm (methods) by
104  * bitwise "OR"ing.
105  */
106 # define ENGINE_METHOD_RSA               (unsigned int)0x0001
107 # define ENGINE_METHOD_DSA               (unsigned int)0x0002
108 # define ENGINE_METHOD_DH                (unsigned int)0x0004
109 # define ENGINE_METHOD_RAND              (unsigned int)0x0008
110 # define ENGINE_METHOD_CIPHERS           (unsigned int)0x0040
111 # define ENGINE_METHOD_DIGESTS           (unsigned int)0x0080
112 # define ENGINE_METHOD_STORE             (unsigned int)0x0100
113 # define ENGINE_METHOD_PKEY_METHS        (unsigned int)0x0200
114 # define ENGINE_METHOD_PKEY_ASN1_METHS   (unsigned int)0x0400
115 # define ENGINE_METHOD_EC                (unsigned int)0x0800
116 /* Obvious all-or-nothing cases. */
117 # define ENGINE_METHOD_ALL               (unsigned int)0xFFFF
118 # define ENGINE_METHOD_NONE              (unsigned int)0x0000
119
120 /*
121  * This(ese) flag(s) controls behaviour of the ENGINE_TABLE mechanism used
122  * internally to control registration of ENGINE implementations, and can be
123  * set by ENGINE_set_table_flags(). The "NOINIT" flag prevents attempts to
124  * initialise registered ENGINEs if they are not already initialised.
125  */
126 # define ENGINE_TABLE_FLAG_NOINIT        (unsigned int)0x0001
127
128 /* ENGINE flags that can be set by ENGINE_set_flags(). */
129 /* Not used */
130 /* #define ENGINE_FLAGS_MALLOCED        0x0001 */
131
132 /*
133  * This flag is for ENGINEs that wish to handle the various 'CMD'-related
134  * control commands on their own. Without this flag, ENGINE_ctrl() handles
135  * these control commands on behalf of the ENGINE using their "cmd_defns"
136  * data.
137  */
138 # define ENGINE_FLAGS_MANUAL_CMD_CTRL    (int)0x0002
139
140 /*
141  * This flag is for ENGINEs who return new duplicate structures when found
142  * via "ENGINE_by_id()". When an ENGINE must store state (eg. if
143  * ENGINE_ctrl() commands are called in sequence as part of some stateful
144  * process like key-generation setup and execution), it can set this flag -
145  * then each attempt to obtain the ENGINE will result in it being copied into
146  * a new structure. Normally, ENGINEs don't declare this flag so
147  * ENGINE_by_id() just increments the existing ENGINE's structural reference
148  * count.
149  */
150 # define ENGINE_FLAGS_BY_ID_COPY         (int)0x0004
151
152 /*
153  * This flag if for an ENGINE that does not want its methods registered as
154  * part of ENGINE_register_all_complete() for example if the methods are not
155  * usable as default methods.
156  */
157
158 # define ENGINE_FLAGS_NO_REGISTER_ALL    (int)0x0008
159
160 /*
161  * ENGINEs can support their own command types, and these flags are used in
162  * ENGINE_CTRL_GET_CMD_FLAGS to indicate to the caller what kind of input
163  * each command expects. Currently only numeric and string input is
164  * supported. If a control command supports none of the _NUMERIC, _STRING, or
165  * _NO_INPUT options, then it is regarded as an "internal" control command -
166  * and not for use in config setting situations. As such, they're not
167  * available to the ENGINE_ctrl_cmd_string() function, only raw ENGINE_ctrl()
168  * access. Changes to this list of 'command types' should be reflected
169  * carefully in ENGINE_cmd_is_executable() and ENGINE_ctrl_cmd_string().
170  */
171
172 /* accepts a 'long' input value (3rd parameter to ENGINE_ctrl) */
173 # define ENGINE_CMD_FLAG_NUMERIC         (unsigned int)0x0001
174 /*
175  * accepts string input (cast from 'void*' to 'const char *', 4th parameter
176  * to ENGINE_ctrl)
177  */
178 # define ENGINE_CMD_FLAG_STRING          (unsigned int)0x0002
179 /*
180  * Indicates that the control command takes *no* input. Ie. the control
181  * command is unparameterised.
182  */
183 # define ENGINE_CMD_FLAG_NO_INPUT        (unsigned int)0x0004
184 /*
185  * Indicates that the control command is internal. This control command won't
186  * be shown in any output, and is only usable through the ENGINE_ctrl_cmd()
187  * function.
188  */
189 # define ENGINE_CMD_FLAG_INTERNAL        (unsigned int)0x0008
190
191 /*
192  * NB: These 3 control commands are deprecated and should not be used.
193  * ENGINEs relying on these commands should compile conditional support for
194  * compatibility (eg. if these symbols are defined) but should also migrate
195  * the same functionality to their own ENGINE-specific control functions that
196  * can be "discovered" by calling applications. The fact these control
197  * commands wouldn't be "executable" (ie. usable by text-based config)
198  * doesn't change the fact that application code can find and use them
199  * without requiring per-ENGINE hacking.
200  */
201
202 /*
203  * These flags are used to tell the ctrl function what should be done. All
204  * command numbers are shared between all engines, even if some don't make
205  * sense to some engines.  In such a case, they do nothing but return the
206  * error ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED.
207  */
208 # define ENGINE_CTRL_SET_LOGSTREAM               1
209 # define ENGINE_CTRL_SET_PASSWORD_CALLBACK       2
210 # define ENGINE_CTRL_HUP                         3/* Close and reinitialise
211                                                    * any handles/connections
212                                                    * etc. */
213 # define ENGINE_CTRL_SET_USER_INTERFACE          4/* Alternative to callback */
214 # define ENGINE_CTRL_SET_CALLBACK_DATA           5/* User-specific data, used
215                                                    * when calling the password
216                                                    * callback and the user
217                                                    * interface */
218 # define ENGINE_CTRL_LOAD_CONFIGURATION          6/* Load a configuration,
219                                                    * given a string that
220                                                    * represents a file name
221                                                    * or so */
222 # define ENGINE_CTRL_LOAD_SECTION                7/* Load data from a given
223                                                    * section in the already
224                                                    * loaded configuration */
225
226 /*
227  * These control commands allow an application to deal with an arbitrary
228  * engine in a dynamic way. Warn: Negative return values indicate errors FOR
229  * THESE COMMANDS because zero is used to indicate 'end-of-list'. Other
230  * commands, including ENGINE-specific command types, return zero for an
231  * error. An ENGINE can choose to implement these ctrl functions, and can
232  * internally manage things however it chooses - it does so by setting the
233  * ENGINE_FLAGS_MANUAL_CMD_CTRL flag (using ENGINE_set_flags()). Otherwise
234  * the ENGINE_ctrl() code handles this on the ENGINE's behalf using the
235  * cmd_defns data (set using ENGINE_set_cmd_defns()). This means an ENGINE's
236  * ctrl() handler need only implement its own commands - the above "meta"
237  * commands will be taken care of.
238  */
239
240 /*
241  * Returns non-zero if the supplied ENGINE has a ctrl() handler. If "not",
242  * then all the remaining control commands will return failure, so it is
243  * worth checking this first if the caller is trying to "discover" the
244  * engine's capabilities and doesn't want errors generated unnecessarily.
245  */
246 # define ENGINE_CTRL_HAS_CTRL_FUNCTION           10
247 /*
248  * Returns a positive command number for the first command supported by the
249  * engine. Returns zero if no ctrl commands are supported.
250  */
251 # define ENGINE_CTRL_GET_FIRST_CMD_TYPE          11
252 /*
253  * The 'long' argument specifies a command implemented by the engine, and the
254  * return value is the next command supported, or zero if there are no more.
255  */
256 # define ENGINE_CTRL_GET_NEXT_CMD_TYPE           12
257 /*
258  * The 'void*' argument is a command name (cast from 'const char *'), and the
259  * return value is the command that corresponds to it.
260  */
261 # define ENGINE_CTRL_GET_CMD_FROM_NAME           13
262 /*
263  * The next two allow a command to be converted into its corresponding string
264  * form. In each case, the 'long' argument supplies the command. In the
265  * NAME_LEN case, the return value is the length of the command name (not
266  * counting a trailing EOL). In the NAME case, the 'void*' argument must be a
267  * string buffer large enough, and it will be populated with the name of the
268  * command (WITH a trailing EOL).
269  */
270 # define ENGINE_CTRL_GET_NAME_LEN_FROM_CMD       14
271 # define ENGINE_CTRL_GET_NAME_FROM_CMD           15
272 /* The next two are similar but give a "short description" of a command. */
273 # define ENGINE_CTRL_GET_DESC_LEN_FROM_CMD       16
274 # define ENGINE_CTRL_GET_DESC_FROM_CMD           17
275 /*
276  * With this command, the return value is the OR'd combination of
277  * ENGINE_CMD_FLAG_*** values that indicate what kind of input a given
278  * engine-specific ctrl command expects.
279  */
280 # define ENGINE_CTRL_GET_CMD_FLAGS               18
281
282 /*
283  * ENGINE implementations should start the numbering of their own control
284  * commands from this value. (ie. ENGINE_CMD_BASE, ENGINE_CMD_BASE + 1, etc).
285  */
286 # define ENGINE_CMD_BASE                         200
287
288 /*
289  * NB: These 2 nCipher "chil" control commands are deprecated, and their
290  * functionality is now available through ENGINE-specific control commands
291  * (exposed through the above-mentioned 'CMD'-handling). Code using these 2
292  * commands should be migrated to the more general command handling before
293  * these are removed.
294  */
295
296 /* Flags specific to the nCipher "chil" engine */
297 # define ENGINE_CTRL_CHIL_SET_FORKCHECK          100
298         /*
299          * Depending on the value of the (long)i argument, this sets or
300          * unsets the SimpleForkCheck flag in the CHIL API to enable or
301          * disable checking and workarounds for applications that fork().
302          */
303 # define ENGINE_CTRL_CHIL_NO_LOCKING             101
304         /*
305          * This prevents the initialisation function from providing mutex
306          * callbacks to the nCipher library.
307          */
308
309 /*
310  * If an ENGINE supports its own specific control commands and wishes the
311  * framework to handle the above 'ENGINE_CMD_***'-manipulation commands on
312  * its behalf, it should supply a null-terminated array of ENGINE_CMD_DEFN
313  * entries to ENGINE_set_cmd_defns(). It should also implement a ctrl()
314  * handler that supports the stated commands (ie. the "cmd_num" entries as
315  * described by the array). NB: The array must be ordered in increasing order
316  * of cmd_num. "null-terminated" means that the last ENGINE_CMD_DEFN element
317  * has cmd_num set to zero and/or cmd_name set to NULL.
318  */
319 typedef struct ENGINE_CMD_DEFN_st {
320     unsigned int cmd_num;       /* The command number */
321     const char *cmd_name;       /* The command name itself */
322     const char *cmd_desc;       /* A short description of the command */
323     unsigned int cmd_flags;     /* The input the command expects */
324 } ENGINE_CMD_DEFN;
325
326 /* Generic function pointer */
327 typedef int (*ENGINE_GEN_FUNC_PTR) (void);
328 /* Generic function pointer taking no arguments */
329 typedef int (*ENGINE_GEN_INT_FUNC_PTR) (ENGINE *);
330 /* Specific control function pointer */
331 typedef int (*ENGINE_CTRL_FUNC_PTR) (ENGINE *, int, long, void *,
332                                      void (*f) (void));
333 /* Generic load_key function pointer */
334 typedef EVP_PKEY *(*ENGINE_LOAD_KEY_PTR)(ENGINE *, const char *,
335                                          UI_METHOD *ui_method,
336                                          void *callback_data);
337 typedef int (*ENGINE_SSL_CLIENT_CERT_PTR) (ENGINE *, SSL *ssl,
338                                            STACK_OF(X509_NAME) *ca_dn,
339                                            X509 **pcert, EVP_PKEY **pkey,
340                                            STACK_OF(X509) **pother,
341                                            UI_METHOD *ui_method,
342                                            void *callback_data);
343 /*-
344  * These callback types are for an ENGINE's handler for cipher and digest logic.
345  * These handlers have these prototypes;
346  *   int foo(ENGINE *e, const EVP_CIPHER **cipher, const int **nids, int nid);
347  *   int foo(ENGINE *e, const EVP_MD **digest, const int **nids, int nid);
348  * Looking at how to implement these handlers in the case of cipher support, if
349  * the framework wants the EVP_CIPHER for 'nid', it will call;
350  *   foo(e, &p_evp_cipher, NULL, nid);    (return zero for failure)
351  * If the framework wants a list of supported 'nid's, it will call;
352  *   foo(e, NULL, &p_nids, 0); (returns number of 'nids' or -1 for error)
353  */
354 /*
355  * Returns to a pointer to the array of supported cipher 'nid's. If the
356  * second parameter is non-NULL it is set to the size of the returned array.
357  */
358 typedef int (*ENGINE_CIPHERS_PTR) (ENGINE *, const EVP_CIPHER **,
359                                    const int **, int);
360 typedef int (*ENGINE_DIGESTS_PTR) (ENGINE *, const EVP_MD **, const int **,
361                                    int);
362 typedef int (*ENGINE_PKEY_METHS_PTR) (ENGINE *, EVP_PKEY_METHOD **,
363                                       const int **, int);
364 typedef int (*ENGINE_PKEY_ASN1_METHS_PTR) (ENGINE *, EVP_PKEY_ASN1_METHOD **,
365                                            const int **, int);
366 /*
367  * STRUCTURE functions ... all of these functions deal with pointers to
368  * ENGINE structures where the pointers have a "structural reference". This
369  * means that their reference is to allowed access to the structure but it
370  * does not imply that the structure is functional. To simply increment or
371  * decrement the structural reference count, use ENGINE_by_id and
372  * ENGINE_free. NB: This is not required when iterating using ENGINE_get_next
373  * as it will automatically decrement the structural reference count of the
374  * "current" ENGINE and increment the structural reference count of the
375  * ENGINE it returns (unless it is NULL).
376  */
377
378 /* Get the first/last "ENGINE" type available. */
379 ENGINE *ENGINE_get_first(void);
380 ENGINE *ENGINE_get_last(void);
381 /* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */
382 ENGINE *ENGINE_get_next(ENGINE *e);
383 ENGINE *ENGINE_get_prev(ENGINE *e);
384 /* Add another "ENGINE" type into the array. */
385 int ENGINE_add(ENGINE *e);
386 /* Remove an existing "ENGINE" type from the array. */
387 int ENGINE_remove(ENGINE *e);
388 /* Retrieve an engine from the list by its unique "id" value. */
389 ENGINE *ENGINE_by_id(const char *id);
390 /* Add all the built-in engines. */
391 void ENGINE_load_openssl(void);
392 void ENGINE_load_dynamic(void);
393 # ifndef OPENSSL_NO_STATIC_ENGINE
394 void ENGINE_load_4758cca(void);
395 void ENGINE_load_aep(void);
396 void ENGINE_load_atalla(void);
397 void ENGINE_load_chil(void);
398 void ENGINE_load_cswift(void);
399 void ENGINE_load_nuron(void);
400 void ENGINE_load_sureware(void);
401 void ENGINE_load_ubsec(void);
402 void ENGINE_load_padlock(void);
403 void ENGINE_load_capi(void);
404 void ENGINE_load_dasync(void);
405 # endif
406 void ENGINE_load_cryptodev(void);
407 void ENGINE_load_rdrand(void);
408 void ENGINE_load_builtin_engines(void);
409
410 /*
411  * Get and set global flags (ENGINE_TABLE_FLAG_***) for the implementation
412  * "registry" handling.
413  */
414 unsigned int ENGINE_get_table_flags(void);
415 void ENGINE_set_table_flags(unsigned int flags);
416
417 /*- Manage registration of ENGINEs per "table". For each type, there are 3
418  * functions;
419  *   ENGINE_register_***(e) - registers the implementation from 'e' (if it has one)
420  *   ENGINE_unregister_***(e) - unregister the implementation from 'e'
421  *   ENGINE_register_all_***() - call ENGINE_register_***() for each 'e' in the list
422  * Cleanup is automatically registered from each table when required, so
423  * ENGINE_cleanup() will reverse any "register" operations.
424  */
425
426 int ENGINE_register_RSA(ENGINE *e);
427 void ENGINE_unregister_RSA(ENGINE *e);
428 void ENGINE_register_all_RSA(void);
429
430 int ENGINE_register_DSA(ENGINE *e);
431 void ENGINE_unregister_DSA(ENGINE *e);
432 void ENGINE_register_all_DSA(void);
433
434 int ENGINE_register_EC(ENGINE *e);
435 void ENGINE_unregister_EC(ENGINE *e);
436 void ENGINE_register_all_EC(void);
437
438 int ENGINE_register_DH(ENGINE *e);
439 void ENGINE_unregister_DH(ENGINE *e);
440 void ENGINE_register_all_DH(void);
441
442 int ENGINE_register_RAND(ENGINE *e);
443 void ENGINE_unregister_RAND(ENGINE *e);
444 void ENGINE_register_all_RAND(void);
445
446 int ENGINE_register_STORE(ENGINE *e);
447 void ENGINE_unregister_STORE(ENGINE *e);
448 void ENGINE_register_all_STORE(void);
449
450 int ENGINE_register_ciphers(ENGINE *e);
451 void ENGINE_unregister_ciphers(ENGINE *e);
452 void ENGINE_register_all_ciphers(void);
453
454 int ENGINE_register_digests(ENGINE *e);
455 void ENGINE_unregister_digests(ENGINE *e);
456 void ENGINE_register_all_digests(void);
457
458 int ENGINE_register_pkey_meths(ENGINE *e);
459 void ENGINE_unregister_pkey_meths(ENGINE *e);
460 void ENGINE_register_all_pkey_meths(void);
461
462 int ENGINE_register_pkey_asn1_meths(ENGINE *e);
463 void ENGINE_unregister_pkey_asn1_meths(ENGINE *e);
464 void ENGINE_register_all_pkey_asn1_meths(void);
465
466 /*
467  * These functions register all support from the above categories. Note, use
468  * of these functions can result in static linkage of code your application
469  * may not need. If you only need a subset of functionality, consider using
470  * more selective initialisation.
471  */
472 int ENGINE_register_complete(ENGINE *e);
473 int ENGINE_register_all_complete(void);
474
475 /*
476  * Send parametrised control commands to the engine. The possibilities to
477  * send down an integer, a pointer to data or a function pointer are
478  * provided. Any of the parameters may or may not be NULL, depending on the
479  * command number. In actuality, this function only requires a structural
480  * (rather than functional) reference to an engine, but many control commands
481  * may require the engine be functional. The caller should be aware of trying
482  * commands that require an operational ENGINE, and only use functional
483  * references in such situations.
484  */
485 int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void));
486
487 /*
488  * This function tests if an ENGINE-specific command is usable as a
489  * "setting". Eg. in an application's config file that gets processed through
490  * ENGINE_ctrl_cmd_string(). If this returns zero, it is not available to
491  * ENGINE_ctrl_cmd_string(), only ENGINE_ctrl().
492  */
493 int ENGINE_cmd_is_executable(ENGINE *e, int cmd);
494
495 /*
496  * This function works like ENGINE_ctrl() with the exception of taking a
497  * command name instead of a command number, and can handle optional
498  * commands. See the comment on ENGINE_ctrl_cmd_string() for an explanation
499  * on how to use the cmd_name and cmd_optional.
500  */
501 int ENGINE_ctrl_cmd(ENGINE *e, const char *cmd_name,
502                     long i, void *p, void (*f) (void), int cmd_optional);
503
504 /*
505  * This function passes a command-name and argument to an ENGINE. The
506  * cmd_name is converted to a command number and the control command is
507  * called using 'arg' as an argument (unless the ENGINE doesn't support such
508  * a command, in which case no control command is called). The command is
509  * checked for input flags, and if necessary the argument will be converted
510  * to a numeric value. If cmd_optional is non-zero, then if the ENGINE
511  * doesn't support the given cmd_name the return value will be success
512  * anyway. This function is intended for applications to use so that users
513  * (or config files) can supply engine-specific config data to the ENGINE at
514  * run-time to control behaviour of specific engines. As such, it shouldn't
515  * be used for calling ENGINE_ctrl() functions that return data, deal with
516  * binary data, or that are otherwise supposed to be used directly through
517  * ENGINE_ctrl() in application code. Any "return" data from an ENGINE_ctrl()
518  * operation in this function will be lost - the return value is interpreted
519  * as failure if the return value is zero, success otherwise, and this
520  * function returns a boolean value as a result. In other words, vendors of
521  * 'ENGINE'-enabled devices should write ENGINE implementations with
522  * parameterisations that work in this scheme, so that compliant ENGINE-based
523  * applications can work consistently with the same configuration for the
524  * same ENGINE-enabled devices, across applications.
525  */
526 int ENGINE_ctrl_cmd_string(ENGINE *e, const char *cmd_name, const char *arg,
527                            int cmd_optional);
528
529 /*
530  * These functions are useful for manufacturing new ENGINE structures. They
531  * don't address reference counting at all - one uses them to populate an
532  * ENGINE structure with personalised implementations of things prior to
533  * using it directly or adding it to the builtin ENGINE list in OpenSSL.
534  * These are also here so that the ENGINE structure doesn't have to be
535  * exposed and break binary compatibility!
536  */
537 ENGINE *ENGINE_new(void);
538 int ENGINE_free(ENGINE *e);
539 int ENGINE_up_ref(ENGINE *e);
540 int ENGINE_set_id(ENGINE *e, const char *id);
541 int ENGINE_set_name(ENGINE *e, const char *name);
542 int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth);
543 int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth);
544 int ENGINE_set_EC(ENGINE *e, const EC_KEY_METHOD *ecdsa_meth);
545 int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth);
546 int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth);
547 int ENGINE_set_STORE(ENGINE *e, const STORE_METHOD *store_meth);
548 int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f);
549 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f);
550 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f);
551 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f);
552 int ENGINE_set_load_privkey_function(ENGINE *e,
553                                      ENGINE_LOAD_KEY_PTR loadpriv_f);
554 int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f);
555 int ENGINE_set_load_ssl_client_cert_function(ENGINE *e,
556                                              ENGINE_SSL_CLIENT_CERT_PTR
557                                              loadssl_f);
558 int ENGINE_set_ciphers(ENGINE *e, ENGINE_CIPHERS_PTR f);
559 int ENGINE_set_digests(ENGINE *e, ENGINE_DIGESTS_PTR f);
560 int ENGINE_set_pkey_meths(ENGINE *e, ENGINE_PKEY_METHS_PTR f);
561 int ENGINE_set_pkey_asn1_meths(ENGINE *e, ENGINE_PKEY_ASN1_METHS_PTR f);
562 int ENGINE_set_flags(ENGINE *e, int flags);
563 int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns);
564 /* These functions allow control over any per-structure ENGINE data. */
565 #define ENGINE_get_ex_new_index(l, p, newf, dupf, freef) \
566     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_ENGINE, l, p, newf, dupf, freef)
567 int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg);
568 void *ENGINE_get_ex_data(const ENGINE *e, int idx);
569
570 /*
571  * This function cleans up anything that needs it. Eg. the ENGINE_add()
572  * function automatically ensures the list cleanup function is registered to
573  * be called from ENGINE_cleanup(). Similarly, all ENGINE_register_***
574  * functions ensure ENGINE_cleanup() will clean up after them.
575  */
576 void ENGINE_cleanup(void);
577
578 /*
579  * These return values from within the ENGINE structure. These can be useful
580  * with functional references as well as structural references - it depends
581  * which you obtained. Using the result for functional purposes if you only
582  * obtained a structural reference may be problematic!
583  */
584 const char *ENGINE_get_id(const ENGINE *e);
585 const char *ENGINE_get_name(const ENGINE *e);
586 const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e);
587 const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e);
588 const EC_KEY_METHOD *ENGINE_get_EC(const ENGINE *e);
589 const DH_METHOD *ENGINE_get_DH(const ENGINE *e);
590 const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e);
591 const STORE_METHOD *ENGINE_get_STORE(const ENGINE *e);
592 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e);
593 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e);
594 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e);
595 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e);
596 ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e);
597 ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e);
598 ENGINE_SSL_CLIENT_CERT_PTR ENGINE_get_ssl_client_cert_function(const ENGINE
599                                                                *e);
600 ENGINE_CIPHERS_PTR ENGINE_get_ciphers(const ENGINE *e);
601 ENGINE_DIGESTS_PTR ENGINE_get_digests(const ENGINE *e);
602 ENGINE_PKEY_METHS_PTR ENGINE_get_pkey_meths(const ENGINE *e);
603 ENGINE_PKEY_ASN1_METHS_PTR ENGINE_get_pkey_asn1_meths(const ENGINE *e);
604 const EVP_CIPHER *ENGINE_get_cipher(ENGINE *e, int nid);
605 const EVP_MD *ENGINE_get_digest(ENGINE *e, int nid);
606 const EVP_PKEY_METHOD *ENGINE_get_pkey_meth(ENGINE *e, int nid);
607 const EVP_PKEY_ASN1_METHOD *ENGINE_get_pkey_asn1_meth(ENGINE *e, int nid);
608 const EVP_PKEY_ASN1_METHOD *ENGINE_get_pkey_asn1_meth_str(ENGINE *e,
609                                                           const char *str,
610                                                           int len);
611 const EVP_PKEY_ASN1_METHOD *ENGINE_pkey_asn1_find_str(ENGINE **pe,
612                                                       const char *str,
613                                                       int len);
614 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e);
615 int ENGINE_get_flags(const ENGINE *e);
616
617 /*
618  * FUNCTIONAL functions. These functions deal with ENGINE structures that
619  * have (or will) be initialised for use. Broadly speaking, the structural
620  * functions are useful for iterating the list of available engine types,
621  * creating new engine types, and other "list" operations. These functions
622  * actually deal with ENGINEs that are to be used. As such these functions
623  * can fail (if applicable) when particular engines are unavailable - eg. if
624  * a hardware accelerator is not attached or not functioning correctly. Each
625  * ENGINE has 2 reference counts; structural and functional. Every time a
626  * functional reference is obtained or released, a corresponding structural
627  * reference is automatically obtained or released too.
628  */
629
630 /*
631  * Initialise a engine type for use (or up its reference count if it's
632  * already in use). This will fail if the engine is not currently operational
633  * and cannot initialise.
634  */
635 int ENGINE_init(ENGINE *e);
636 /*
637  * Free a functional reference to a engine type. This does not require a
638  * corresponding call to ENGINE_free as it also releases a structural
639  * reference.
640  */
641 int ENGINE_finish(ENGINE *e);
642
643 /*
644  * The following functions handle keys that are stored in some secondary
645  * location, handled by the engine.  The storage may be on a card or
646  * whatever.
647  */
648 EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id,
649                                   UI_METHOD *ui_method, void *callback_data);
650 EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id,
651                                  UI_METHOD *ui_method, void *callback_data);
652 int ENGINE_load_ssl_client_cert(ENGINE *e, SSL *s,
653                                 STACK_OF(X509_NAME) *ca_dn, X509 **pcert,
654                                 EVP_PKEY **ppkey, STACK_OF(X509) **pother,
655                                 UI_METHOD *ui_method, void *callback_data);
656
657 /*
658  * This returns a pointer for the current ENGINE structure that is (by
659  * default) performing any RSA operations. The value returned is an
660  * incremented reference, so it should be free'd (ENGINE_finish) before it is
661  * discarded.
662  */
663 ENGINE *ENGINE_get_default_RSA(void);
664 /* Same for the other "methods" */
665 ENGINE *ENGINE_get_default_DSA(void);
666 ENGINE *ENGINE_get_default_EC(void);
667 ENGINE *ENGINE_get_default_DH(void);
668 ENGINE *ENGINE_get_default_RAND(void);
669 /*
670  * These functions can be used to get a functional reference to perform
671  * ciphering or digesting corresponding to "nid".
672  */
673 ENGINE *ENGINE_get_cipher_engine(int nid);
674 ENGINE *ENGINE_get_digest_engine(int nid);
675 ENGINE *ENGINE_get_pkey_meth_engine(int nid);
676 ENGINE *ENGINE_get_pkey_asn1_meth_engine(int nid);
677
678 /*
679  * This sets a new default ENGINE structure for performing RSA operations. If
680  * the result is non-zero (success) then the ENGINE structure will have had
681  * its reference count up'd so the caller should still free their own
682  * reference 'e'.
683  */
684 int ENGINE_set_default_RSA(ENGINE *e);
685 int ENGINE_set_default_string(ENGINE *e, const char *def_list);
686 /* Same for the other "methods" */
687 int ENGINE_set_default_DSA(ENGINE *e);
688 int ENGINE_set_default_EC(ENGINE *e);
689 int ENGINE_set_default_DH(ENGINE *e);
690 int ENGINE_set_default_RAND(ENGINE *e);
691 int ENGINE_set_default_ciphers(ENGINE *e);
692 int ENGINE_set_default_digests(ENGINE *e);
693 int ENGINE_set_default_pkey_meths(ENGINE *e);
694 int ENGINE_set_default_pkey_asn1_meths(ENGINE *e);
695
696 /*
697  * The combination "set" - the flags are bitwise "OR"d from the
698  * ENGINE_METHOD_*** defines above. As with the "ENGINE_register_complete()"
699  * function, this function can result in unnecessary static linkage. If your
700  * application requires only specific functionality, consider using more
701  * selective functions.
702  */
703 int ENGINE_set_default(ENGINE *e, unsigned int flags);
704
705 void ENGINE_add_conf_module(void);
706
707 /* Deprecated functions ... */
708 /* int ENGINE_clear_defaults(void); */
709
710 /**************************/
711 /* DYNAMIC ENGINE SUPPORT */
712 /**************************/
713
714 /* Binary/behaviour compatibility levels */
715 # define OSSL_DYNAMIC_VERSION            (unsigned long)0x00030000
716 /*
717  * Binary versions older than this are too old for us (whether we're a loader
718  * or a loadee)
719  */
720 # define OSSL_DYNAMIC_OLDEST             (unsigned long)0x00030000
721
722 /*
723  * When compiling an ENGINE entirely as an external shared library, loadable
724  * by the "dynamic" ENGINE, these types are needed. The 'dynamic_fns'
725  * structure type provides the calling application's (or library's) error
726  * functionality and memory management function pointers to the loaded
727  * library. These should be used/set in the loaded library code so that the
728  * loading application's 'state' will be used/changed in all operations. The
729  * 'static_state' pointer allows the loaded library to know if it shares the
730  * same static data as the calling application (or library), and thus whether
731  * these callbacks need to be set or not.
732  */
733 /*
734  * FIXME: Perhaps the memory and locking code (crypto.h) should declare and
735  * use these types so we (and any other dependant code) can simplify a bit??
736  */
737 typedef void (*dyn_lock_locking_cb) (int, int, const char *, int);
738 typedef int (*dyn_lock_add_lock_cb) (int *, int, int, const char *, int);
739 typedef struct CRYPTO_dynlock_value *(*dyn_dynlock_create_cb) (const char *,
740                                                                int);
741 typedef void (*dyn_dynlock_lock_cb) (int, struct CRYPTO_dynlock_value *,
742                                      const char *, int);
743 typedef void (*dyn_dynlock_destroy_cb) (struct CRYPTO_dynlock_value *,
744                                         const char *, int);
745 typedef struct st_dynamic_LOCK_fns {
746     dyn_lock_locking_cb lock_locking_cb;
747     dyn_lock_add_lock_cb lock_add_lock_cb;
748     dyn_dynlock_create_cb dynlock_create_cb;
749     dyn_dynlock_lock_cb dynlock_lock_cb;
750     dyn_dynlock_destroy_cb dynlock_destroy_cb;
751 } dynamic_LOCK_fns;
752 /* The top-level structure */
753 typedef struct st_dynamic_fns {
754     void *static_state;
755     dynamic_LOCK_fns lock_fns;
756 } dynamic_fns;
757
758 /*
759  * The version checking function should be of this prototype. NB: The
760  * ossl_version value passed in is the OSSL_DYNAMIC_VERSION of the loading
761  * code. If this function returns zero, it indicates a (potential) version
762  * incompatibility and the loaded library doesn't believe it can proceed.
763  * Otherwise, the returned value is the (latest) version supported by the
764  * loading library. The loader may still decide that the loaded code's
765  * version is unsatisfactory and could veto the load. The function is
766  * expected to be implemented with the symbol name "v_check", and a default
767  * implementation can be fully instantiated with
768  * IMPLEMENT_DYNAMIC_CHECK_FN().
769  */
770 typedef unsigned long (*dynamic_v_check_fn) (unsigned long ossl_version);
771 # define IMPLEMENT_DYNAMIC_CHECK_FN() \
772         OPENSSL_EXPORT unsigned long v_check(unsigned long v); \
773         OPENSSL_EXPORT unsigned long v_check(unsigned long v) { \
774                 if(v >= OSSL_DYNAMIC_OLDEST) return OSSL_DYNAMIC_VERSION; \
775                 return 0; }
776
777 /*
778  * This function is passed the ENGINE structure to initialise with its own
779  * function and command settings. It should not adjust the structural or
780  * functional reference counts. If this function returns zero, (a) the load
781  * will be aborted, (b) the previous ENGINE state will be memcpy'd back onto
782  * the structure, and (c) the shared library will be unloaded. So
783  * implementations should do their own internal cleanup in failure
784  * circumstances otherwise they could leak. The 'id' parameter, if non-NULL,
785  * represents the ENGINE id that the loader is looking for. If this is NULL,
786  * the shared library can choose to return failure or to initialise a
787  * 'default' ENGINE. If non-NULL, the shared library must initialise only an
788  * ENGINE matching the passed 'id'. The function is expected to be
789  * implemented with the symbol name "bind_engine". A standard implementation
790  * can be instantiated with IMPLEMENT_DYNAMIC_BIND_FN(fn) where the parameter
791  * 'fn' is a callback function that populates the ENGINE structure and
792  * returns an int value (zero for failure). 'fn' should have prototype;
793  * [static] int fn(ENGINE *e, const char *id);
794  */
795 typedef int (*dynamic_bind_engine) (ENGINE *e, const char *id,
796                                     const dynamic_fns *fns);
797 # define IMPLEMENT_DYNAMIC_BIND_FN(fn) \
798         OPENSSL_EXPORT \
799         int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns); \
800         OPENSSL_EXPORT \
801         int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns) { \
802                 if(ENGINE_get_static_state() == fns->static_state) goto skip_cbs; \
803                 CRYPTO_set_locking_callback(fns->lock_fns.lock_locking_cb); \
804                 CRYPTO_set_add_lock_callback(fns->lock_fns.lock_add_lock_cb); \
805                 CRYPTO_set_dynlock_create_callback(fns->lock_fns.dynlock_create_cb); \
806                 CRYPTO_set_dynlock_lock_callback(fns->lock_fns.dynlock_lock_cb); \
807                 CRYPTO_set_dynlock_destroy_callback(fns->lock_fns.dynlock_destroy_cb); \
808         skip_cbs: \
809                 if(!fn(e,id)) return 0; \
810                 return 1; }
811
812 /*
813  * If the loading application (or library) and the loaded ENGINE library
814  * share the same static data (eg. they're both dynamically linked to the
815  * same libcrypto.so) we need a way to avoid trying to set system callbacks -
816  * this would fail, and for the same reason that it's unnecessary to try. If
817  * the loaded ENGINE has (or gets from through the loader) its own copy of
818  * the libcrypto static data, we will need to set the callbacks. The easiest
819  * way to detect this is to have a function that returns a pointer to some
820  * static data and let the loading application and loaded ENGINE compare
821  * their respective values.
822  */
823 void *ENGINE_get_static_state(void);
824
825 # if defined(__OpenBSD__) || defined(__FreeBSD__) || defined(HAVE_CRYPTODEV)
826 void ENGINE_setup_bsd_cryptodev(void);
827 # endif
828
829 /* BEGIN ERROR CODES */
830 /*
831  * The following lines are auto generated by the script mkerr.pl. Any changes
832  * made after this point may be overwritten when the script is next run.
833  */
834 void ERR_load_ENGINE_strings(void);
835
836 /* Error codes for the ENGINE functions. */
837
838 /* Function codes. */
839 # define ENGINE_F_DYNAMIC_CTRL                            180
840 # define ENGINE_F_DYNAMIC_GET_DATA_CTX                    181
841 # define ENGINE_F_DYNAMIC_LOAD                            182
842 # define ENGINE_F_DYNAMIC_SET_DATA_CTX                    183
843 # define ENGINE_F_ENGINE_ADD                              105
844 # define ENGINE_F_ENGINE_BY_ID                            106
845 # define ENGINE_F_ENGINE_CMD_IS_EXECUTABLE                170
846 # define ENGINE_F_ENGINE_CTRL                             142
847 # define ENGINE_F_ENGINE_CTRL_CMD                         178
848 # define ENGINE_F_ENGINE_CTRL_CMD_STRING                  171
849 # define ENGINE_F_ENGINE_FINISH                           107
850 # define ENGINE_F_ENGINE_FREE_UTIL                        108
851 # define ENGINE_F_ENGINE_GET_CIPHER                       185
852 # define ENGINE_F_ENGINE_GET_DEFAULT_TYPE                 177
853 # define ENGINE_F_ENGINE_GET_DIGEST                       186
854 # define ENGINE_F_ENGINE_GET_NEXT                         115
855 # define ENGINE_F_ENGINE_GET_PKEY_ASN1_METH               193
856 # define ENGINE_F_ENGINE_GET_PKEY_METH                    192
857 # define ENGINE_F_ENGINE_GET_PREV                         116
858 # define ENGINE_F_ENGINE_INIT                             119
859 # define ENGINE_F_ENGINE_LIST_ADD                         120
860 # define ENGINE_F_ENGINE_LIST_REMOVE                      121
861 # define ENGINE_F_ENGINE_LOAD_PRIVATE_KEY                 150
862 # define ENGINE_F_ENGINE_LOAD_PUBLIC_KEY                  151
863 # define ENGINE_F_ENGINE_LOAD_SSL_CLIENT_CERT             194
864 # define ENGINE_F_ENGINE_NEW                              122
865 # define ENGINE_F_ENGINE_REMOVE                           123
866 # define ENGINE_F_ENGINE_SET_DEFAULT_STRING               189
867 # define ENGINE_F_ENGINE_SET_DEFAULT_TYPE                 126
868 # define ENGINE_F_ENGINE_SET_ID                           129
869 # define ENGINE_F_ENGINE_SET_NAME                         130
870 # define ENGINE_F_ENGINE_TABLE_REGISTER                   184
871 # define ENGINE_F_ENGINE_UNLOAD_KEY                       152
872 # define ENGINE_F_ENGINE_UNLOCKED_FINISH                  191
873 # define ENGINE_F_ENGINE_UP_REF                           190
874 # define ENGINE_F_INT_CTRL_HELPER                         172
875 # define ENGINE_F_INT_ENGINE_CONFIGURE                    188
876 # define ENGINE_F_INT_ENGINE_MODULE_INIT                  187
877 # define ENGINE_F_LOG_MESSAGE                             141
878
879 /* Reason codes. */
880 # define ENGINE_R_ALREADY_LOADED                          100
881 # define ENGINE_R_ARGUMENT_IS_NOT_A_NUMBER                133
882 # define ENGINE_R_CMD_NOT_EXECUTABLE                      134
883 # define ENGINE_R_COMMAND_TAKES_INPUT                     135
884 # define ENGINE_R_COMMAND_TAKES_NO_INPUT                  136
885 # define ENGINE_R_CONFLICTING_ENGINE_ID                   103
886 # define ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED            119
887 # define ENGINE_R_DH_NOT_IMPLEMENTED                      139
888 # define ENGINE_R_DSA_NOT_IMPLEMENTED                     140
889 # define ENGINE_R_DSO_FAILURE                             104
890 # define ENGINE_R_DSO_NOT_FOUND                           132
891 # define ENGINE_R_ENGINES_SECTION_ERROR                   148
892 # define ENGINE_R_ENGINE_CONFIGURATION_ERROR              102
893 # define ENGINE_R_ENGINE_IS_NOT_IN_LIST                   105
894 # define ENGINE_R_ENGINE_SECTION_ERROR                    149
895 # define ENGINE_R_FAILED_LOADING_PRIVATE_KEY              128
896 # define ENGINE_R_FAILED_LOADING_PUBLIC_KEY               129
897 # define ENGINE_R_FINISH_FAILED                           106
898 # define ENGINE_R_GET_HANDLE_FAILED                       107
899 # define ENGINE_R_ID_OR_NAME_MISSING                      108
900 # define ENGINE_R_INIT_FAILED                             109
901 # define ENGINE_R_INTERNAL_LIST_ERROR                     110
902 # define ENGINE_R_INVALID_ARGUMENT                        143
903 # define ENGINE_R_INVALID_CMD_NAME                        137
904 # define ENGINE_R_INVALID_CMD_NUMBER                      138
905 # define ENGINE_R_INVALID_INIT_VALUE                      151
906 # define ENGINE_R_INVALID_STRING                          150
907 # define ENGINE_R_NOT_INITIALISED                         117
908 # define ENGINE_R_NOT_LOADED                              112
909 # define ENGINE_R_NO_CONTROL_FUNCTION                     120
910 # define ENGINE_R_NO_INDEX                                144
911 # define ENGINE_R_NO_LOAD_FUNCTION                        125
912 # define ENGINE_R_NO_REFERENCE                            130
913 # define ENGINE_R_NO_SUCH_ENGINE                          116
914 # define ENGINE_R_NO_UNLOAD_FUNCTION                      126
915 # define ENGINE_R_PROVIDE_PARAMETERS                      113
916 # define ENGINE_R_RSA_NOT_IMPLEMENTED                     141
917 # define ENGINE_R_UNIMPLEMENTED_CIPHER                    146
918 # define ENGINE_R_UNIMPLEMENTED_DIGEST                    147
919 # define ENGINE_R_UNIMPLEMENTED_PUBLIC_KEY_METHOD         101
920 # define ENGINE_R_VERSION_INCOMPATIBILITY                 145
921
922 #ifdef  __cplusplus
923 }
924 #endif
925 #endif