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