/* openssl/engine.h *//* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL * project 2000. *//* ==================================================================== * Copyright (c) 1999 The OpenSSL Project.  All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright *    notice, this list of conditions and the following disclaimer.  * * 2. Redistributions in binary form must reproduce the above copyright *    notice, this list of conditions and the following disclaimer in *    the documentation and/or other materials provided with the *    distribution. * * 3. All advertising materials mentioning features or use of this *    software must display the following acknowledgment: *    "This product includes software developed by the OpenSSL Project *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" * * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to *    endorse or promote products derived from this software without *    prior written permission. For written permission, please contact *    licensing@OpenSSL.org. * * 5. Products derived from this software may not be called "OpenSSL" *    nor may "OpenSSL" appear in their names without prior written *    permission of the OpenSSL Project. * * 6. Redistributions of any form whatsoever must retain the following *    acknowledgment: *    "This product includes software developed by the OpenSSL Project *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" * * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED * OF THE POSSIBILITY OF SUCH DAMAGE. * ==================================================================== * * This product includes cryptographic software written by Eric Young * (eay@cryptsoft.com).  This product includes software written by Tim * Hudson (tjh@cryptsoft.com). * */#ifndef HEADER_ENGINE_H#define HEADER_ENGINE_H#include <openssl/bn.h>#include <openssl/rsa.h>#include <openssl/dsa.h>#include <openssl/dh.h>#include <openssl/rand.h>#include <openssl/evp.h>#include <openssl/symhacks.h>#ifdef  __cplusplusextern "C" {#endif/* These flags are used to control combinations of algorithm (methods) * by bitwise "OR"ing. */#define ENGINE_METHOD_RSA		(unsigned int)0x0001#define ENGINE_METHOD_DSA		(unsigned int)0x0002#define ENGINE_METHOD_DH		(unsigned int)0x0004#define ENGINE_METHOD_RAND		(unsigned int)0x0008#define ENGINE_METHOD_BN_MOD_EXP	(unsigned int)0x0010#define ENGINE_METHOD_BN_MOD_EXP_CRT	(unsigned int)0x0020/* Obvious all-or-nothing cases. */#define ENGINE_METHOD_ALL		(unsigned int)0xFFFF#define ENGINE_METHOD_NONE		(unsigned int)0x0000/* These flags are used to tell the ctrl function what should be done. * All command numbers are shared between all engines, even if some don't * make sense to some engines.  In such a case, they do nothing but return * the error ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED. */#define ENGINE_CTRL_SET_LOGSTREAM		1#define ENGINE_CTRL_SET_PASSWORD_CALLBACK	2/* Flags specific to the nCipher "chil" engine */#define ENGINE_CTRL_CHIL_SET_FORKCHECK		100	/* Depending on the value of the (long)i argument, this sets or	 * unsets the SimpleForkCheck flag in the CHIL API to enable or	 * disable checking and workarounds for applications that fork().	 */#define ENGINE_CTRL_CHIL_NO_LOCKING		101	/* This prevents the initialisation function from providing mutex	 * callbacks to the nCipher library. *//* As we're missing a BIGNUM_METHOD, we need a couple of locally * defined function types that engines can implement. */#ifndef HEADER_ENGINE_INT_H/* mod_exp operation, calculates; r = a ^ p mod m * NB: ctx can be NULL, but if supplied, the implementation may use * it if it wishes. */typedef int (*BN_MOD_EXP)(BIGNUM *r, BIGNUM *a, const BIGNUM *p,		const BIGNUM *m, BN_CTX *ctx);/* private key operation for RSA, provided seperately in case other * RSA implementations wish to use it. */typedef int (*BN_MOD_EXP_CRT)(BIGNUM *r, BIGNUM *a, const BIGNUM *p,		const BIGNUM *q, const BIGNUM *dmp1, const BIGNUM *dmq1,		const BIGNUM *iqmp, BN_CTX *ctx);/* Generic function pointer */typedef void (*ENGINE_GEN_FUNC_PTR)();/* Generic function pointer taking no arguments */typedef void (*ENGINE_GEN_INT_FUNC_PTR)(void);/* Specific control function pointer */typedef int (*ENGINE_CTRL_FUNC_PTR)(int cmd, long i, void *p, void (*f)());/* The list of "engine" types is a static array of (const ENGINE*) * pointers (not dynamic because static is fine for now and we otherwise * have to hook an appropriate load/unload function in to initialise and * cleanup). */typedef struct engine_st ENGINE;#endif/* STRUCTURE functions ... all of these functions deal with pointers to * ENGINE structures where the pointers have a "structural reference". * This means that their reference is to allow access to the structure * but it does not imply that the structure is functional. To simply * increment or decrement the structural reference count, use ENGINE_new * and ENGINE_free. NB: This is not required when iterating using * ENGINE_get_next as it will automatically decrement the structural * reference count of the "current" ENGINE and increment the structural * reference count of the ENGINE it returns (unless it is NULL). *//* Get the first/last "ENGINE" type available. */ENGINE *ENGINE_get_first(void);ENGINE *ENGINE_get_last(void);/* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */ENGINE *ENGINE_get_next(ENGINE *e);ENGINE *ENGINE_get_prev(ENGINE *e);/* Add another "ENGINE" type into the array. */int ENGINE_add(ENGINE *e);/* Remove an existing "ENGINE" type from the array. */int ENGINE_remove(ENGINE *e);/* Retrieve an engine from the list by its unique "id" value. */ENGINE *ENGINE_by_id(const char *id);/* These functions are useful for manufacturing new ENGINE * structures. They don't address reference counting at all - * one uses them to populate an ENGINE structure with personalised * implementations of things prior to using it directly or adding * it to the builtin ENGINE list in OpenSSL. These are also here * so that the ENGINE structure doesn't have to be exposed and * break binary compatibility! * * NB: I'm changing ENGINE_new to force the ENGINE structure to * be allocated from within OpenSSL. See the comment for * ENGINE_get_struct_size(). */#if 0ENGINE *ENGINE_new(ENGINE *e);#elseENGINE *ENGINE_new(void);#endifint ENGINE_free(ENGINE *e);int ENGINE_set_id(ENGINE *e, const char *id);int ENGINE_set_name(ENGINE *e, const char *name);int ENGINE_set_RSA(ENGINE *e, RSA_METHOD *rsa_meth);int ENGINE_set_DSA(ENGINE *e, DSA_METHOD *dsa_meth);int ENGINE_set_DH(ENGINE *e, DH_METHOD *dh_meth);int ENGINE_set_RAND(ENGINE *e, RAND_METHOD *rand_meth);int ENGINE_set_BN_mod_exp(ENGINE *e, BN_MOD_EXP bn_mod_exp);int ENGINE_set_BN_mod_exp_crt(ENGINE *e, BN_MOD_EXP_CRT bn_mod_exp_crt);int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f);int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f);int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f);/* These return values from within the ENGINE structure. These can * be useful with functional references as well as structural * references - it depends which you obtained. Using the result * for functional purposes if you only obtained a structural * reference may be problematic! */const char *ENGINE_get_id(ENGINE *e);const char *ENGINE_get_name(ENGINE *e);RSA_METHOD *ENGINE_get_RSA(ENGINE *e);DSA_METHOD *ENGINE_get_DSA(ENGINE *e);DH_METHOD *ENGINE_get_DH(ENGINE *e);RAND_METHOD *ENGINE_get_RAND(ENGINE *e);BN_MOD_EXP ENGINE_get_BN_mod_exp(ENGINE *e);BN_MOD_EXP_CRT ENGINE_get_BN_mod_exp_crt(ENGINE *e);ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(ENGINE *e);ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(ENGINE *e);ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(ENGINE *e);/* ENGINE_new is normally passed a NULL in the first parameter because * the calling code doesn't have access to the definition of the ENGINE * structure (for good reason). However, if the caller wishes to use * its own memory allocation or use a static array, the following call * should be used to check the amount of memory the ENGINE structure * will occupy. This will make the code more future-proof. * * NB: I'm "#if 0"-ing this out because it's better to force the use of * internally allocated memory. See similar change in ENGINE_new(). */#if 0int ENGINE_get_struct_size(void);#endif/* FUNCTIONAL functions. These functions deal with ENGINE structures * that have (or will) be initialised for use. Broadly speaking, the * structural functions are useful for iterating the list of available * engine types, creating new engine types, and other "list" operations. * These functions actually deal with ENGINEs that are to be used. As * such these functions can fail (if applicable) when particular * engines are unavailable - eg. if a hardware accelerator is not * attached or not functioning correctly. Each ENGINE has 2 reference * counts; structural and functional. Every time a functional reference * is obtained or released, a corresponding structural reference is * automatically obtained or released too. *//* Initialise a engine type for use (or up its reference count if it's * already in use). This will fail if the engine is not currently * operational and cannot initialise. */