jpayne@69: /* jpayne@69: * Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved. jpayne@69: * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved jpayne@69: * jpayne@69: * Licensed under the OpenSSL license (the "License"). You may not use jpayne@69: * this file except in compliance with the License. You can obtain a copy jpayne@69: * in the file LICENSE in the source distribution or at jpayne@69: * https://www.openssl.org/source/license.html jpayne@69: */ jpayne@69: jpayne@69: #ifndef HEADER_ENGINE_H jpayne@69: # define HEADER_ENGINE_H jpayne@69: jpayne@69: # include jpayne@69: jpayne@69: # ifndef OPENSSL_NO_ENGINE jpayne@69: # if OPENSSL_API_COMPAT < 0x10100000L jpayne@69: # include jpayne@69: # include jpayne@69: # include jpayne@69: # include jpayne@69: # include jpayne@69: # include jpayne@69: # include jpayne@69: # include jpayne@69: # endif jpayne@69: # include jpayne@69: # include jpayne@69: # include jpayne@69: # include jpayne@69: # ifdef __cplusplus jpayne@69: extern "C" { jpayne@69: # endif jpayne@69: jpayne@69: /* jpayne@69: * These flags are used to control combinations of algorithm (methods) by jpayne@69: * bitwise "OR"ing. jpayne@69: */ jpayne@69: # define ENGINE_METHOD_RSA (unsigned int)0x0001 jpayne@69: # define ENGINE_METHOD_DSA (unsigned int)0x0002 jpayne@69: # define ENGINE_METHOD_DH (unsigned int)0x0004 jpayne@69: # define ENGINE_METHOD_RAND (unsigned int)0x0008 jpayne@69: # define ENGINE_METHOD_CIPHERS (unsigned int)0x0040 jpayne@69: # define ENGINE_METHOD_DIGESTS (unsigned int)0x0080 jpayne@69: # define ENGINE_METHOD_PKEY_METHS (unsigned int)0x0200 jpayne@69: # define ENGINE_METHOD_PKEY_ASN1_METHS (unsigned int)0x0400 jpayne@69: # define ENGINE_METHOD_EC (unsigned int)0x0800 jpayne@69: /* Obvious all-or-nothing cases. */ jpayne@69: # define ENGINE_METHOD_ALL (unsigned int)0xFFFF jpayne@69: # define ENGINE_METHOD_NONE (unsigned int)0x0000 jpayne@69: jpayne@69: /* jpayne@69: * This(ese) flag(s) controls behaviour of the ENGINE_TABLE mechanism used jpayne@69: * internally to control registration of ENGINE implementations, and can be jpayne@69: * set by ENGINE_set_table_flags(). The "NOINIT" flag prevents attempts to jpayne@69: * initialise registered ENGINEs if they are not already initialised. jpayne@69: */ jpayne@69: # define ENGINE_TABLE_FLAG_NOINIT (unsigned int)0x0001 jpayne@69: jpayne@69: /* ENGINE flags that can be set by ENGINE_set_flags(). */ jpayne@69: /* Not used */ jpayne@69: /* #define ENGINE_FLAGS_MALLOCED 0x0001 */ jpayne@69: jpayne@69: /* jpayne@69: * This flag is for ENGINEs that wish to handle the various 'CMD'-related jpayne@69: * control commands on their own. Without this flag, ENGINE_ctrl() handles jpayne@69: * these control commands on behalf of the ENGINE using their "cmd_defns" jpayne@69: * data. jpayne@69: */ jpayne@69: # define ENGINE_FLAGS_MANUAL_CMD_CTRL (int)0x0002 jpayne@69: jpayne@69: /* jpayne@69: * This flag is for ENGINEs who return new duplicate structures when found jpayne@69: * via "ENGINE_by_id()". When an ENGINE must store state (eg. if jpayne@69: * ENGINE_ctrl() commands are called in sequence as part of some stateful jpayne@69: * process like key-generation setup and execution), it can set this flag - jpayne@69: * then each attempt to obtain the ENGINE will result in it being copied into jpayne@69: * a new structure. Normally, ENGINEs don't declare this flag so jpayne@69: * ENGINE_by_id() just increments the existing ENGINE's structural reference jpayne@69: * count. jpayne@69: */ jpayne@69: # define ENGINE_FLAGS_BY_ID_COPY (int)0x0004 jpayne@69: jpayne@69: /* jpayne@69: * This flag if for an ENGINE that does not want its methods registered as jpayne@69: * part of ENGINE_register_all_complete() for example if the methods are not jpayne@69: * usable as default methods. jpayne@69: */ jpayne@69: jpayne@69: # define ENGINE_FLAGS_NO_REGISTER_ALL (int)0x0008 jpayne@69: jpayne@69: /* jpayne@69: * ENGINEs can support their own command types, and these flags are used in jpayne@69: * ENGINE_CTRL_GET_CMD_FLAGS to indicate to the caller what kind of input jpayne@69: * each command expects. Currently only numeric and string input is jpayne@69: * supported. If a control command supports none of the _NUMERIC, _STRING, or jpayne@69: * _NO_INPUT options, then it is regarded as an "internal" control command - jpayne@69: * and not for use in config setting situations. As such, they're not jpayne@69: * available to the ENGINE_ctrl_cmd_string() function, only raw ENGINE_ctrl() jpayne@69: * access. Changes to this list of 'command types' should be reflected jpayne@69: * carefully in ENGINE_cmd_is_executable() and ENGINE_ctrl_cmd_string(). jpayne@69: */ jpayne@69: jpayne@69: /* accepts a 'long' input value (3rd parameter to ENGINE_ctrl) */ jpayne@69: # define ENGINE_CMD_FLAG_NUMERIC (unsigned int)0x0001 jpayne@69: /* jpayne@69: * accepts string input (cast from 'void*' to 'const char *', 4th parameter jpayne@69: * to ENGINE_ctrl) jpayne@69: */ jpayne@69: # define ENGINE_CMD_FLAG_STRING (unsigned int)0x0002 jpayne@69: /* jpayne@69: * Indicates that the control command takes *no* input. Ie. the control jpayne@69: * command is unparameterised. jpayne@69: */ jpayne@69: # define ENGINE_CMD_FLAG_NO_INPUT (unsigned int)0x0004 jpayne@69: /* jpayne@69: * Indicates that the control command is internal. This control command won't jpayne@69: * be shown in any output, and is only usable through the ENGINE_ctrl_cmd() jpayne@69: * function. jpayne@69: */ jpayne@69: # define ENGINE_CMD_FLAG_INTERNAL (unsigned int)0x0008 jpayne@69: jpayne@69: /* jpayne@69: * NB: These 3 control commands are deprecated and should not be used. jpayne@69: * ENGINEs relying on these commands should compile conditional support for jpayne@69: * compatibility (eg. if these symbols are defined) but should also migrate jpayne@69: * the same functionality to their own ENGINE-specific control functions that jpayne@69: * can be "discovered" by calling applications. The fact these control jpayne@69: * commands wouldn't be "executable" (ie. usable by text-based config) jpayne@69: * doesn't change the fact that application code can find and use them jpayne@69: * without requiring per-ENGINE hacking. jpayne@69: */ jpayne@69: jpayne@69: /* jpayne@69: * These flags are used to tell the ctrl function what should be done. All jpayne@69: * command numbers are shared between all engines, even if some don't make jpayne@69: * sense to some engines. In such a case, they do nothing but return the jpayne@69: * error ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED. jpayne@69: */ jpayne@69: # define ENGINE_CTRL_SET_LOGSTREAM 1 jpayne@69: # define ENGINE_CTRL_SET_PASSWORD_CALLBACK 2 jpayne@69: # define ENGINE_CTRL_HUP 3/* Close and reinitialise jpayne@69: * any handles/connections jpayne@69: * etc. */ jpayne@69: # define ENGINE_CTRL_SET_USER_INTERFACE 4/* Alternative to callback */ jpayne@69: # define ENGINE_CTRL_SET_CALLBACK_DATA 5/* User-specific data, used jpayne@69: * when calling the password jpayne@69: * callback and the user jpayne@69: * interface */ jpayne@69: # define ENGINE_CTRL_LOAD_CONFIGURATION 6/* Load a configuration, jpayne@69: * given a string that jpayne@69: * represents a file name jpayne@69: * or so */ jpayne@69: # define ENGINE_CTRL_LOAD_SECTION 7/* Load data from a given jpayne@69: * section in the already jpayne@69: * loaded configuration */ jpayne@69: jpayne@69: /* jpayne@69: * These control commands allow an application to deal with an arbitrary jpayne@69: * engine in a dynamic way. Warn: Negative return values indicate errors FOR jpayne@69: * THESE COMMANDS because zero is used to indicate 'end-of-list'. Other jpayne@69: * commands, including ENGINE-specific command types, return zero for an jpayne@69: * error. An ENGINE can choose to implement these ctrl functions, and can jpayne@69: * internally manage things however it chooses - it does so by setting the jpayne@69: * ENGINE_FLAGS_MANUAL_CMD_CTRL flag (using ENGINE_set_flags()). Otherwise jpayne@69: * the ENGINE_ctrl() code handles this on the ENGINE's behalf using the jpayne@69: * cmd_defns data (set using ENGINE_set_cmd_defns()). This means an ENGINE's jpayne@69: * ctrl() handler need only implement its own commands - the above "meta" jpayne@69: * commands will be taken care of. jpayne@69: */ jpayne@69: jpayne@69: /* jpayne@69: * Returns non-zero if the supplied ENGINE has a ctrl() handler. If "not", jpayne@69: * then all the remaining control commands will return failure, so it is jpayne@69: * worth checking this first if the caller is trying to "discover" the jpayne@69: * engine's capabilities and doesn't want errors generated unnecessarily. jpayne@69: */ jpayne@69: # define ENGINE_CTRL_HAS_CTRL_FUNCTION 10 jpayne@69: /* jpayne@69: * Returns a positive command number for the first command supported by the jpayne@69: * engine. Returns zero if no ctrl commands are supported. jpayne@69: */ jpayne@69: # define ENGINE_CTRL_GET_FIRST_CMD_TYPE 11 jpayne@69: /* jpayne@69: * The 'long' argument specifies a command implemented by the engine, and the jpayne@69: * return value is the next command supported, or zero if there are no more. jpayne@69: */ jpayne@69: # define ENGINE_CTRL_GET_NEXT_CMD_TYPE 12 jpayne@69: /* jpayne@69: * The 'void*' argument is a command name (cast from 'const char *'), and the jpayne@69: * return value is the command that corresponds to it. jpayne@69: */ jpayne@69: # define ENGINE_CTRL_GET_CMD_FROM_NAME 13 jpayne@69: /* jpayne@69: * The next two allow a command to be converted into its corresponding string jpayne@69: * form. In each case, the 'long' argument supplies the command. In the jpayne@69: * NAME_LEN case, the return value is the length of the command name (not jpayne@69: * counting a trailing EOL). In the NAME case, the 'void*' argument must be a jpayne@69: * string buffer large enough, and it will be populated with the name of the jpayne@69: * command (WITH a trailing EOL). jpayne@69: */ jpayne@69: # define ENGINE_CTRL_GET_NAME_LEN_FROM_CMD 14 jpayne@69: # define ENGINE_CTRL_GET_NAME_FROM_CMD 15 jpayne@69: /* The next two are similar but give a "short description" of a command. */ jpayne@69: # define ENGINE_CTRL_GET_DESC_LEN_FROM_CMD 16 jpayne@69: # define ENGINE_CTRL_GET_DESC_FROM_CMD 17 jpayne@69: /* jpayne@69: * With this command, the return value is the OR'd combination of jpayne@69: * ENGINE_CMD_FLAG_*** values that indicate what kind of input a given jpayne@69: * engine-specific ctrl command expects. jpayne@69: */ jpayne@69: # define ENGINE_CTRL_GET_CMD_FLAGS 18 jpayne@69: jpayne@69: /* jpayne@69: * ENGINE implementations should start the numbering of their own control jpayne@69: * commands from this value. (ie. ENGINE_CMD_BASE, ENGINE_CMD_BASE + 1, etc). jpayne@69: */ jpayne@69: # define ENGINE_CMD_BASE 200 jpayne@69: jpayne@69: /* jpayne@69: * NB: These 2 nCipher "chil" control commands are deprecated, and their jpayne@69: * functionality is now available through ENGINE-specific control commands jpayne@69: * (exposed through the above-mentioned 'CMD'-handling). Code using these 2 jpayne@69: * commands should be migrated to the more general command handling before jpayne@69: * these are removed. jpayne@69: */ jpayne@69: jpayne@69: /* Flags specific to the nCipher "chil" engine */ jpayne@69: # define ENGINE_CTRL_CHIL_SET_FORKCHECK 100 jpayne@69: /* jpayne@69: * Depending on the value of the (long)i argument, this sets or jpayne@69: * unsets the SimpleForkCheck flag in the CHIL API to enable or jpayne@69: * disable checking and workarounds for applications that fork(). jpayne@69: */ jpayne@69: # define ENGINE_CTRL_CHIL_NO_LOCKING 101 jpayne@69: /* jpayne@69: * This prevents the initialisation function from providing mutex jpayne@69: * callbacks to the nCipher library. jpayne@69: */ jpayne@69: jpayne@69: /* jpayne@69: * If an ENGINE supports its own specific control commands and wishes the jpayne@69: * framework to handle the above 'ENGINE_CMD_***'-manipulation commands on jpayne@69: * its behalf, it should supply a null-terminated array of ENGINE_CMD_DEFN jpayne@69: * entries to ENGINE_set_cmd_defns(). It should also implement a ctrl() jpayne@69: * handler that supports the stated commands (ie. the "cmd_num" entries as jpayne@69: * described by the array). NB: The array must be ordered in increasing order jpayne@69: * of cmd_num. "null-terminated" means that the last ENGINE_CMD_DEFN element jpayne@69: * has cmd_num set to zero and/or cmd_name set to NULL. jpayne@69: */ jpayne@69: typedef struct ENGINE_CMD_DEFN_st { jpayne@69: unsigned int cmd_num; /* The command number */ jpayne@69: const char *cmd_name; /* The command name itself */ jpayne@69: const char *cmd_desc; /* A short description of the command */ jpayne@69: unsigned int cmd_flags; /* The input the command expects */ jpayne@69: } ENGINE_CMD_DEFN; jpayne@69: jpayne@69: /* Generic function pointer */ jpayne@69: typedef int (*ENGINE_GEN_FUNC_PTR) (void); jpayne@69: /* Generic function pointer taking no arguments */ jpayne@69: typedef int (*ENGINE_GEN_INT_FUNC_PTR) (ENGINE *); jpayne@69: /* Specific control function pointer */ jpayne@69: typedef int (*ENGINE_CTRL_FUNC_PTR) (ENGINE *, int, long, void *, jpayne@69: void (*f) (void)); jpayne@69: /* Generic load_key function pointer */ jpayne@69: typedef EVP_PKEY *(*ENGINE_LOAD_KEY_PTR)(ENGINE *, const char *, jpayne@69: UI_METHOD *ui_method, jpayne@69: void *callback_data); jpayne@69: typedef int (*ENGINE_SSL_CLIENT_CERT_PTR) (ENGINE *, SSL *ssl, jpayne@69: STACK_OF(X509_NAME) *ca_dn, jpayne@69: X509 **pcert, EVP_PKEY **pkey, jpayne@69: STACK_OF(X509) **pother, jpayne@69: UI_METHOD *ui_method, jpayne@69: void *callback_data); jpayne@69: /*- jpayne@69: * These callback types are for an ENGINE's handler for cipher and digest logic. jpayne@69: * These handlers have these prototypes; jpayne@69: * int foo(ENGINE *e, const EVP_CIPHER **cipher, const int **nids, int nid); jpayne@69: * int foo(ENGINE *e, const EVP_MD **digest, const int **nids, int nid); jpayne@69: * Looking at how to implement these handlers in the case of cipher support, if jpayne@69: * the framework wants the EVP_CIPHER for 'nid', it will call; jpayne@69: * foo(e, &p_evp_cipher, NULL, nid); (return zero for failure) jpayne@69: * If the framework wants a list of supported 'nid's, it will call; jpayne@69: * foo(e, NULL, &p_nids, 0); (returns number of 'nids' or -1 for error) jpayne@69: */ jpayne@69: /* jpayne@69: * Returns to a pointer to the array of supported cipher 'nid's. If the jpayne@69: * second parameter is non-NULL it is set to the size of the returned array. jpayne@69: */ jpayne@69: typedef int (*ENGINE_CIPHERS_PTR) (ENGINE *, const EVP_CIPHER **, jpayne@69: const int **, int); jpayne@69: typedef int (*ENGINE_DIGESTS_PTR) (ENGINE *, const EVP_MD **, const int **, jpayne@69: int); jpayne@69: typedef int (*ENGINE_PKEY_METHS_PTR) (ENGINE *, EVP_PKEY_METHOD **, jpayne@69: const int **, int); jpayne@69: typedef int (*ENGINE_PKEY_ASN1_METHS_PTR) (ENGINE *, EVP_PKEY_ASN1_METHOD **, jpayne@69: const int **, int); jpayne@69: /* jpayne@69: * STRUCTURE functions ... all of these functions deal with pointers to jpayne@69: * ENGINE structures where the pointers have a "structural reference". This jpayne@69: * means that their reference is to allowed access to the structure but it jpayne@69: * does not imply that the structure is functional. To simply increment or jpayne@69: * decrement the structural reference count, use ENGINE_by_id and jpayne@69: * ENGINE_free. NB: This is not required when iterating using ENGINE_get_next jpayne@69: * as it will automatically decrement the structural reference count of the jpayne@69: * "current" ENGINE and increment the structural reference count of the jpayne@69: * ENGINE it returns (unless it is NULL). jpayne@69: */ jpayne@69: jpayne@69: /* Get the first/last "ENGINE" type available. */ jpayne@69: ENGINE *ENGINE_get_first(void); jpayne@69: ENGINE *ENGINE_get_last(void); jpayne@69: /* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */ jpayne@69: ENGINE *ENGINE_get_next(ENGINE *e); jpayne@69: ENGINE *ENGINE_get_prev(ENGINE *e); jpayne@69: /* Add another "ENGINE" type into the array. */ jpayne@69: int ENGINE_add(ENGINE *e); jpayne@69: /* Remove an existing "ENGINE" type from the array. */ jpayne@69: int ENGINE_remove(ENGINE *e); jpayne@69: /* Retrieve an engine from the list by its unique "id" value. */ jpayne@69: ENGINE *ENGINE_by_id(const char *id); jpayne@69: jpayne@69: #if OPENSSL_API_COMPAT < 0x10100000L jpayne@69: # define ENGINE_load_openssl() \ jpayne@69: OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_OPENSSL, NULL) jpayne@69: # define ENGINE_load_dynamic() \ jpayne@69: OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_DYNAMIC, NULL) jpayne@69: # ifndef OPENSSL_NO_STATIC_ENGINE jpayne@69: # define ENGINE_load_padlock() \ jpayne@69: OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_PADLOCK, NULL) jpayne@69: # define ENGINE_load_capi() \ jpayne@69: OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_CAPI, NULL) jpayne@69: # define ENGINE_load_afalg() \ jpayne@69: OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_AFALG, NULL) jpayne@69: # endif jpayne@69: # define ENGINE_load_cryptodev() \ jpayne@69: OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_CRYPTODEV, NULL) jpayne@69: # define ENGINE_load_rdrand() \ jpayne@69: OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_RDRAND, NULL) jpayne@69: #endif jpayne@69: void ENGINE_load_builtin_engines(void); jpayne@69: jpayne@69: /* jpayne@69: * Get and set global flags (ENGINE_TABLE_FLAG_***) for the implementation jpayne@69: * "registry" handling. jpayne@69: */ jpayne@69: unsigned int ENGINE_get_table_flags(void); jpayne@69: void ENGINE_set_table_flags(unsigned int flags); jpayne@69: jpayne@69: /*- Manage registration of ENGINEs per "table". For each type, there are 3 jpayne@69: * functions; jpayne@69: * ENGINE_register_***(e) - registers the implementation from 'e' (if it has one) jpayne@69: * ENGINE_unregister_***(e) - unregister the implementation from 'e' jpayne@69: * ENGINE_register_all_***() - call ENGINE_register_***() for each 'e' in the list jpayne@69: * Cleanup is automatically registered from each table when required. jpayne@69: */ jpayne@69: jpayne@69: int ENGINE_register_RSA(ENGINE *e); jpayne@69: void ENGINE_unregister_RSA(ENGINE *e); jpayne@69: void ENGINE_register_all_RSA(void); jpayne@69: jpayne@69: int ENGINE_register_DSA(ENGINE *e); jpayne@69: void ENGINE_unregister_DSA(ENGINE *e); jpayne@69: void ENGINE_register_all_DSA(void); jpayne@69: jpayne@69: int ENGINE_register_EC(ENGINE *e); jpayne@69: void ENGINE_unregister_EC(ENGINE *e); jpayne@69: void ENGINE_register_all_EC(void); jpayne@69: jpayne@69: int ENGINE_register_DH(ENGINE *e); jpayne@69: void ENGINE_unregister_DH(ENGINE *e); jpayne@69: void ENGINE_register_all_DH(void); jpayne@69: jpayne@69: int ENGINE_register_RAND(ENGINE *e); jpayne@69: void ENGINE_unregister_RAND(ENGINE *e); jpayne@69: void ENGINE_register_all_RAND(void); jpayne@69: jpayne@69: int ENGINE_register_ciphers(ENGINE *e); jpayne@69: void ENGINE_unregister_ciphers(ENGINE *e); jpayne@69: void ENGINE_register_all_ciphers(void); jpayne@69: jpayne@69: int ENGINE_register_digests(ENGINE *e); jpayne@69: void ENGINE_unregister_digests(ENGINE *e); jpayne@69: void ENGINE_register_all_digests(void); jpayne@69: jpayne@69: int ENGINE_register_pkey_meths(ENGINE *e); jpayne@69: void ENGINE_unregister_pkey_meths(ENGINE *e); jpayne@69: void ENGINE_register_all_pkey_meths(void); jpayne@69: jpayne@69: int ENGINE_register_pkey_asn1_meths(ENGINE *e); jpayne@69: void ENGINE_unregister_pkey_asn1_meths(ENGINE *e); jpayne@69: void ENGINE_register_all_pkey_asn1_meths(void); jpayne@69: jpayne@69: /* jpayne@69: * These functions register all support from the above categories. Note, use jpayne@69: * of these functions can result in static linkage of code your application jpayne@69: * may not need. If you only need a subset of functionality, consider using jpayne@69: * more selective initialisation. jpayne@69: */ jpayne@69: int ENGINE_register_complete(ENGINE *e); jpayne@69: int ENGINE_register_all_complete(void); jpayne@69: jpayne@69: /* jpayne@69: * Send parameterised control commands to the engine. The possibilities to jpayne@69: * send down an integer, a pointer to data or a function pointer are jpayne@69: * provided. Any of the parameters may or may not be NULL, depending on the jpayne@69: * command number. In actuality, this function only requires a structural jpayne@69: * (rather than functional) reference to an engine, but many control commands jpayne@69: * may require the engine be functional. The caller should be aware of trying jpayne@69: * commands that require an operational ENGINE, and only use functional jpayne@69: * references in such situations. jpayne@69: */ jpayne@69: int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void)); jpayne@69: jpayne@69: /* jpayne@69: * This function tests if an ENGINE-specific command is usable as a jpayne@69: * "setting". Eg. in an application's config file that gets processed through jpayne@69: * ENGINE_ctrl_cmd_string(). If this returns zero, it is not available to jpayne@69: * ENGINE_ctrl_cmd_string(), only ENGINE_ctrl(). jpayne@69: */ jpayne@69: int ENGINE_cmd_is_executable(ENGINE *e, int cmd); jpayne@69: jpayne@69: /* jpayne@69: * This function works like ENGINE_ctrl() with the exception of taking a jpayne@69: * command name instead of a command number, and can handle optional jpayne@69: * commands. See the comment on ENGINE_ctrl_cmd_string() for an explanation jpayne@69: * on how to use the cmd_name and cmd_optional. jpayne@69: */ jpayne@69: int ENGINE_ctrl_cmd(ENGINE *e, const char *cmd_name, jpayne@69: long i, void *p, void (*f) (void), int cmd_optional); jpayne@69: jpayne@69: /* jpayne@69: * This function passes a command-name and argument to an ENGINE. The jpayne@69: * cmd_name is converted to a command number and the control command is jpayne@69: * called using 'arg' as an argument (unless the ENGINE doesn't support such jpayne@69: * a command, in which case no control command is called). The command is jpayne@69: * checked for input flags, and if necessary the argument will be converted jpayne@69: * to a numeric value. If cmd_optional is non-zero, then if the ENGINE jpayne@69: * doesn't support the given cmd_name the return value will be success jpayne@69: * anyway. This function is intended for applications to use so that users jpayne@69: * (or config files) can supply engine-specific config data to the ENGINE at jpayne@69: * run-time to control behaviour of specific engines. As such, it shouldn't jpayne@69: * be used for calling ENGINE_ctrl() functions that return data, deal with jpayne@69: * binary data, or that are otherwise supposed to be used directly through jpayne@69: * ENGINE_ctrl() in application code. Any "return" data from an ENGINE_ctrl() jpayne@69: * operation in this function will be lost - the return value is interpreted jpayne@69: * as failure if the return value is zero, success otherwise, and this jpayne@69: * function returns a boolean value as a result. In other words, vendors of jpayne@69: * 'ENGINE'-enabled devices should write ENGINE implementations with jpayne@69: * parameterisations that work in this scheme, so that compliant ENGINE-based jpayne@69: * applications can work consistently with the same configuration for the jpayne@69: * same ENGINE-enabled devices, across applications. jpayne@69: */ jpayne@69: int ENGINE_ctrl_cmd_string(ENGINE *e, const char *cmd_name, const char *arg, jpayne@69: int cmd_optional); jpayne@69: jpayne@69: /* jpayne@69: * These functions are useful for manufacturing new ENGINE structures. They jpayne@69: * don't address reference counting at all - one uses them to populate an jpayne@69: * ENGINE structure with personalised implementations of things prior to jpayne@69: * using it directly or adding it to the builtin ENGINE list in OpenSSL. jpayne@69: * These are also here so that the ENGINE structure doesn't have to be jpayne@69: * exposed and break binary compatibility! jpayne@69: */ jpayne@69: ENGINE *ENGINE_new(void); jpayne@69: int ENGINE_free(ENGINE *e); jpayne@69: int ENGINE_up_ref(ENGINE *e); jpayne@69: int ENGINE_set_id(ENGINE *e, const char *id); jpayne@69: int ENGINE_set_name(ENGINE *e, const char *name); jpayne@69: int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth); jpayne@69: int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth); jpayne@69: int ENGINE_set_EC(ENGINE *e, const EC_KEY_METHOD *ecdsa_meth); jpayne@69: int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth); jpayne@69: int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth); jpayne@69: int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f); jpayne@69: int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f); jpayne@69: int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f); jpayne@69: int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f); jpayne@69: int ENGINE_set_load_privkey_function(ENGINE *e, jpayne@69: ENGINE_LOAD_KEY_PTR loadpriv_f); jpayne@69: int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f); jpayne@69: int ENGINE_set_load_ssl_client_cert_function(ENGINE *e, jpayne@69: ENGINE_SSL_CLIENT_CERT_PTR jpayne@69: loadssl_f); jpayne@69: int ENGINE_set_ciphers(ENGINE *e, ENGINE_CIPHERS_PTR f); jpayne@69: int ENGINE_set_digests(ENGINE *e, ENGINE_DIGESTS_PTR f); jpayne@69: int ENGINE_set_pkey_meths(ENGINE *e, ENGINE_PKEY_METHS_PTR f); jpayne@69: int ENGINE_set_pkey_asn1_meths(ENGINE *e, ENGINE_PKEY_ASN1_METHS_PTR f); jpayne@69: int ENGINE_set_flags(ENGINE *e, int flags); jpayne@69: int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns); jpayne@69: /* These functions allow control over any per-structure ENGINE data. */ jpayne@69: #define ENGINE_get_ex_new_index(l, p, newf, dupf, freef) \ jpayne@69: CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_ENGINE, l, p, newf, dupf, freef) jpayne@69: int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg); jpayne@69: void *ENGINE_get_ex_data(const ENGINE *e, int idx); jpayne@69: jpayne@69: #if OPENSSL_API_COMPAT < 0x10100000L jpayne@69: /* jpayne@69: * This function previously cleaned up anything that needs it. Auto-deinit will jpayne@69: * now take care of it so it is no longer required to call this function. jpayne@69: */ jpayne@69: # define ENGINE_cleanup() while(0) continue jpayne@69: #endif jpayne@69: jpayne@69: /* jpayne@69: * These return values from within the ENGINE structure. These can be useful jpayne@69: * with functional references as well as structural references - it depends jpayne@69: * which you obtained. Using the result for functional purposes if you only jpayne@69: * obtained a structural reference may be problematic! jpayne@69: */ jpayne@69: const char *ENGINE_get_id(const ENGINE *e); jpayne@69: const char *ENGINE_get_name(const ENGINE *e); jpayne@69: const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e); jpayne@69: const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e); jpayne@69: const EC_KEY_METHOD *ENGINE_get_EC(const ENGINE *e); jpayne@69: const DH_METHOD *ENGINE_get_DH(const ENGINE *e); jpayne@69: const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e); jpayne@69: ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e); jpayne@69: ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e); jpayne@69: ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e); jpayne@69: ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e); jpayne@69: ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e); jpayne@69: ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e); jpayne@69: ENGINE_SSL_CLIENT_CERT_PTR ENGINE_get_ssl_client_cert_function(const ENGINE jpayne@69: *e); jpayne@69: ENGINE_CIPHERS_PTR ENGINE_get_ciphers(const ENGINE *e); jpayne@69: ENGINE_DIGESTS_PTR ENGINE_get_digests(const ENGINE *e); jpayne@69: ENGINE_PKEY_METHS_PTR ENGINE_get_pkey_meths(const ENGINE *e); jpayne@69: ENGINE_PKEY_ASN1_METHS_PTR ENGINE_get_pkey_asn1_meths(const ENGINE *e); jpayne@69: const EVP_CIPHER *ENGINE_get_cipher(ENGINE *e, int nid); jpayne@69: const EVP_MD *ENGINE_get_digest(ENGINE *e, int nid); jpayne@69: const EVP_PKEY_METHOD *ENGINE_get_pkey_meth(ENGINE *e, int nid); jpayne@69: const EVP_PKEY_ASN1_METHOD *ENGINE_get_pkey_asn1_meth(ENGINE *e, int nid); jpayne@69: const EVP_PKEY_ASN1_METHOD *ENGINE_get_pkey_asn1_meth_str(ENGINE *e, jpayne@69: const char *str, jpayne@69: int len); jpayne@69: const EVP_PKEY_ASN1_METHOD *ENGINE_pkey_asn1_find_str(ENGINE **pe, jpayne@69: const char *str, jpayne@69: int len); jpayne@69: const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e); jpayne@69: int ENGINE_get_flags(const ENGINE *e); jpayne@69: jpayne@69: /* jpayne@69: * FUNCTIONAL functions. These functions deal with ENGINE structures that jpayne@69: * have (or will) be initialised for use. Broadly speaking, the structural jpayne@69: * functions are useful for iterating the list of available engine types, jpayne@69: * creating new engine types, and other "list" operations. These functions jpayne@69: * actually deal with ENGINEs that are to be used. As such these functions jpayne@69: * can fail (if applicable) when particular engines are unavailable - eg. if jpayne@69: * a hardware accelerator is not attached or not functioning correctly. Each jpayne@69: * ENGINE has 2 reference counts; structural and functional. Every time a jpayne@69: * functional reference is obtained or released, a corresponding structural jpayne@69: * reference is automatically obtained or released too. jpayne@69: */ jpayne@69: jpayne@69: /* jpayne@69: * Initialise a engine type for use (or up its reference count if it's jpayne@69: * already in use). This will fail if the engine is not currently operational jpayne@69: * and cannot initialise. jpayne@69: */ jpayne@69: int ENGINE_init(ENGINE *e); jpayne@69: /* jpayne@69: * Free a functional reference to a engine type. This does not require a jpayne@69: * corresponding call to ENGINE_free as it also releases a structural jpayne@69: * reference. jpayne@69: */ jpayne@69: int ENGINE_finish(ENGINE *e); jpayne@69: jpayne@69: /* jpayne@69: * The following functions handle keys that are stored in some secondary jpayne@69: * location, handled by the engine. The storage may be on a card or jpayne@69: * whatever. jpayne@69: */ jpayne@69: EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id, jpayne@69: UI_METHOD *ui_method, void *callback_data); jpayne@69: EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id, jpayne@69: UI_METHOD *ui_method, void *callback_data); jpayne@69: int ENGINE_load_ssl_client_cert(ENGINE *e, SSL *s, jpayne@69: STACK_OF(X509_NAME) *ca_dn, X509 **pcert, jpayne@69: EVP_PKEY **ppkey, STACK_OF(X509) **pother, jpayne@69: UI_METHOD *ui_method, void *callback_data); jpayne@69: jpayne@69: /* jpayne@69: * This returns a pointer for the current ENGINE structure that is (by jpayne@69: * default) performing any RSA operations. The value returned is an jpayne@69: * incremented reference, so it should be free'd (ENGINE_finish) before it is jpayne@69: * discarded. jpayne@69: */ jpayne@69: ENGINE *ENGINE_get_default_RSA(void); jpayne@69: /* Same for the other "methods" */ jpayne@69: ENGINE *ENGINE_get_default_DSA(void); jpayne@69: ENGINE *ENGINE_get_default_EC(void); jpayne@69: ENGINE *ENGINE_get_default_DH(void); jpayne@69: ENGINE *ENGINE_get_default_RAND(void); jpayne@69: /* jpayne@69: * These functions can be used to get a functional reference to perform jpayne@69: * ciphering or digesting corresponding to "nid". jpayne@69: */ jpayne@69: ENGINE *ENGINE_get_cipher_engine(int nid); jpayne@69: ENGINE *ENGINE_get_digest_engine(int nid); jpayne@69: ENGINE *ENGINE_get_pkey_meth_engine(int nid); jpayne@69: ENGINE *ENGINE_get_pkey_asn1_meth_engine(int nid); jpayne@69: jpayne@69: /* jpayne@69: * This sets a new default ENGINE structure for performing RSA operations. If jpayne@69: * the result is non-zero (success) then the ENGINE structure will have had jpayne@69: * its reference count up'd so the caller should still free their own jpayne@69: * reference 'e'. jpayne@69: */ jpayne@69: int ENGINE_set_default_RSA(ENGINE *e); jpayne@69: int ENGINE_set_default_string(ENGINE *e, const char *def_list); jpayne@69: /* Same for the other "methods" */ jpayne@69: int ENGINE_set_default_DSA(ENGINE *e); jpayne@69: int ENGINE_set_default_EC(ENGINE *e); jpayne@69: int ENGINE_set_default_DH(ENGINE *e); jpayne@69: int ENGINE_set_default_RAND(ENGINE *e); jpayne@69: int ENGINE_set_default_ciphers(ENGINE *e); jpayne@69: int ENGINE_set_default_digests(ENGINE *e); jpayne@69: int ENGINE_set_default_pkey_meths(ENGINE *e); jpayne@69: int ENGINE_set_default_pkey_asn1_meths(ENGINE *e); jpayne@69: jpayne@69: /* jpayne@69: * The combination "set" - the flags are bitwise "OR"d from the jpayne@69: * ENGINE_METHOD_*** defines above. As with the "ENGINE_register_complete()" jpayne@69: * function, this function can result in unnecessary static linkage. If your jpayne@69: * application requires only specific functionality, consider using more jpayne@69: * selective functions. jpayne@69: */ jpayne@69: int ENGINE_set_default(ENGINE *e, unsigned int flags); jpayne@69: jpayne@69: void ENGINE_add_conf_module(void); jpayne@69: jpayne@69: /* Deprecated functions ... */ jpayne@69: /* int ENGINE_clear_defaults(void); */ jpayne@69: jpayne@69: /**************************/ jpayne@69: /* DYNAMIC ENGINE SUPPORT */ jpayne@69: /**************************/ jpayne@69: jpayne@69: /* Binary/behaviour compatibility levels */ jpayne@69: # define OSSL_DYNAMIC_VERSION (unsigned long)0x00030000 jpayne@69: /* jpayne@69: * Binary versions older than this are too old for us (whether we're a loader jpayne@69: * or a loadee) jpayne@69: */ jpayne@69: # define OSSL_DYNAMIC_OLDEST (unsigned long)0x00030000 jpayne@69: jpayne@69: /* jpayne@69: * When compiling an ENGINE entirely as an external shared library, loadable jpayne@69: * by the "dynamic" ENGINE, these types are needed. The 'dynamic_fns' jpayne@69: * structure type provides the calling application's (or library's) error jpayne@69: * functionality and memory management function pointers to the loaded jpayne@69: * library. These should be used/set in the loaded library code so that the jpayne@69: * loading application's 'state' will be used/changed in all operations. The jpayne@69: * 'static_state' pointer allows the loaded library to know if it shares the jpayne@69: * same static data as the calling application (or library), and thus whether jpayne@69: * these callbacks need to be set or not. jpayne@69: */ jpayne@69: typedef void *(*dyn_MEM_malloc_fn) (size_t, const char *, int); jpayne@69: typedef void *(*dyn_MEM_realloc_fn) (void *, size_t, const char *, int); jpayne@69: typedef void (*dyn_MEM_free_fn) (void *, const char *, int); jpayne@69: typedef struct st_dynamic_MEM_fns { jpayne@69: dyn_MEM_malloc_fn malloc_fn; jpayne@69: dyn_MEM_realloc_fn realloc_fn; jpayne@69: dyn_MEM_free_fn free_fn; jpayne@69: } dynamic_MEM_fns; jpayne@69: /* jpayne@69: * FIXME: Perhaps the memory and locking code (crypto.h) should declare and jpayne@69: * use these types so we (and any other dependent code) can simplify a bit?? jpayne@69: */ jpayne@69: /* The top-level structure */ jpayne@69: typedef struct st_dynamic_fns { jpayne@69: void *static_state; jpayne@69: dynamic_MEM_fns mem_fns; jpayne@69: } dynamic_fns; jpayne@69: jpayne@69: /* jpayne@69: * The version checking function should be of this prototype. NB: The jpayne@69: * ossl_version value passed in is the OSSL_DYNAMIC_VERSION of the loading jpayne@69: * code. If this function returns zero, it indicates a (potential) version jpayne@69: * incompatibility and the loaded library doesn't believe it can proceed. jpayne@69: * Otherwise, the returned value is the (latest) version supported by the jpayne@69: * loading library. The loader may still decide that the loaded code's jpayne@69: * version is unsatisfactory and could veto the load. The function is jpayne@69: * expected to be implemented with the symbol name "v_check", and a default jpayne@69: * implementation can be fully instantiated with jpayne@69: * IMPLEMENT_DYNAMIC_CHECK_FN(). jpayne@69: */ jpayne@69: typedef unsigned long (*dynamic_v_check_fn) (unsigned long ossl_version); jpayne@69: # define IMPLEMENT_DYNAMIC_CHECK_FN() \ jpayne@69: OPENSSL_EXPORT unsigned long v_check(unsigned long v); \ jpayne@69: OPENSSL_EXPORT unsigned long v_check(unsigned long v) { \ jpayne@69: if (v >= OSSL_DYNAMIC_OLDEST) return OSSL_DYNAMIC_VERSION; \ jpayne@69: return 0; } jpayne@69: jpayne@69: /* jpayne@69: * This function is passed the ENGINE structure to initialise with its own jpayne@69: * function and command settings. It should not adjust the structural or jpayne@69: * functional reference counts. If this function returns zero, (a) the load jpayne@69: * will be aborted, (b) the previous ENGINE state will be memcpy'd back onto jpayne@69: * the structure, and (c) the shared library will be unloaded. So jpayne@69: * implementations should do their own internal cleanup in failure jpayne@69: * circumstances otherwise they could leak. The 'id' parameter, if non-NULL, jpayne@69: * represents the ENGINE id that the loader is looking for. If this is NULL, jpayne@69: * the shared library can choose to return failure or to initialise a jpayne@69: * 'default' ENGINE. If non-NULL, the shared library must initialise only an jpayne@69: * ENGINE matching the passed 'id'. The function is expected to be jpayne@69: * implemented with the symbol name "bind_engine". A standard implementation jpayne@69: * can be instantiated with IMPLEMENT_DYNAMIC_BIND_FN(fn) where the parameter jpayne@69: * 'fn' is a callback function that populates the ENGINE structure and jpayne@69: * returns an int value (zero for failure). 'fn' should have prototype; jpayne@69: * [static] int fn(ENGINE *e, const char *id); jpayne@69: */ jpayne@69: typedef int (*dynamic_bind_engine) (ENGINE *e, const char *id, jpayne@69: const dynamic_fns *fns); jpayne@69: # define IMPLEMENT_DYNAMIC_BIND_FN(fn) \ jpayne@69: OPENSSL_EXPORT \ jpayne@69: int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns); \ jpayne@69: OPENSSL_EXPORT \ jpayne@69: int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns) { \ jpayne@69: if (ENGINE_get_static_state() == fns->static_state) goto skip_cbs; \ jpayne@69: CRYPTO_set_mem_functions(fns->mem_fns.malloc_fn, \ jpayne@69: fns->mem_fns.realloc_fn, \ jpayne@69: fns->mem_fns.free_fn); \ jpayne@69: OPENSSL_init_crypto(OPENSSL_INIT_NO_ATEXIT, NULL); \ jpayne@69: skip_cbs: \ jpayne@69: if (!fn(e, id)) return 0; \ jpayne@69: return 1; } jpayne@69: jpayne@69: /* jpayne@69: * If the loading application (or library) and the loaded ENGINE library jpayne@69: * share the same static data (eg. they're both dynamically linked to the jpayne@69: * same libcrypto.so) we need a way to avoid trying to set system callbacks - jpayne@69: * this would fail, and for the same reason that it's unnecessary to try. If jpayne@69: * the loaded ENGINE has (or gets from through the loader) its own copy of jpayne@69: * the libcrypto static data, we will need to set the callbacks. The easiest jpayne@69: * way to detect this is to have a function that returns a pointer to some jpayne@69: * static data and let the loading application and loaded ENGINE compare jpayne@69: * their respective values. jpayne@69: */ jpayne@69: void *ENGINE_get_static_state(void); jpayne@69: jpayne@69: # if defined(__OpenBSD__) || defined(__FreeBSD__) || defined(__DragonFly__) jpayne@69: DEPRECATEDIN_1_1_0(void ENGINE_setup_bsd_cryptodev(void)) jpayne@69: # endif jpayne@69: jpayne@69: jpayne@69: # ifdef __cplusplus jpayne@69: } jpayne@69: # endif jpayne@69: # endif jpayne@69: #endif