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