crypto/engine/engine_int.h

   1 /* crypto/engine/engine_int.h */
   2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
   3  * project 2000.
   4  */
   5 /* ====================================================================
   6  * Copyright (c) 1999 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 #ifndef HEADER_ENGINE_INT_H
  60 #define HEADER_ENGINE_INT_H
  61
  62 #include <openssl/rsa.h>
  63 #include <openssl/dsa.h>
  64 #include <openssl/dh.h>
  65 #include <openssl/rand.h>
  66 #include <openssl/bn.h>
  67 #include <openssl/evp.h>
  68
  69 #ifdef  __cplusplus
  70 extern "C" {
  71 #endif
  72
  73 /* Bitwise OR-able values for the "flags" variable in ENGINE. */
  74 #define ENGINE_FLAGS_MALLOCED   0x0001
  75
  76 #ifndef HEADER_ENGINE_H
  77 /* Regrettably, we need to reproduce the "BN" function types here
  78  * because there is no such "BIGNUM_METHOD" as there is with RSA,
  79  * DSA, etc. We do this so that we don't have a case where engine.h
  80  * and engine_int.h conflict with each other. */
  81 typedef int (*BN_MOD_EXP)(BIGNUM *r, BIGNUM *a, const BIGNUM *p,
  82                 const BIGNUM *m, BN_CTX *ctx);
  83
  84 /* private key operation for RSA, provided seperately in case other
  85  * RSA implementations wish to use it. */
  86 typedef int (*BN_MOD_EXP_CRT)(BIGNUM *r, BIGNUM *a, const BIGNUM *p,
  87                 const BIGNUM *q, const BIGNUM *dmp1, const BIGNUM *dmq1,
  88                 const BIGNUM *iqmp, BN_CTX *ctx);
  89
  90 /* Generic function pointer */
  91 typedef int (*ENGINE_GEN_FUNC_PTR)();
  92 /* Generic function pointer taking no arguments */
  93 typedef int (*ENGINE_GEN_INT_FUNC_PTR)(void);
  94 /* Specific control function pointer */
  95 typedef int (*ENGINE_CTRL_FUNC_PTR)(int cmd, long i, void *p, void (*f)());
  96
  97 #endif
  98
  99 /* This is a structure for storing implementations of various crypto
 100  * algorithms and functions. */
 101 typedef struct engine_st
 102         {
 103         const char *id;
 104         const char *name;
 105         RSA_METHOD *rsa_meth;
 106         DSA_METHOD *dsa_meth;
 107         DH_METHOD *dh_meth;
 108         RAND_METHOD *rand_meth;
 109         BN_MOD_EXP bn_mod_exp;
 110         BN_MOD_EXP_CRT bn_mod_exp_crt;
 111         int (*init)(void);
 112         int (*finish)(void);
 113         int (*ctrl)(int cmd, long i, void *p, void (*f)());
 114         EVP_PKEY *(*load_privkey)(const char *key_id, const char *passphrase);
 115         EVP_PKEY *(*load_pubkey)(const char *key_id, const char *passphrase);
 116         int flags;
 117         /* reference count on the structure itself */
 118         int struct_ref;
 119         /* reference count on usability of the engine type. NB: This
 120          * controls the loading and initialisation of any functionlity
 121          * required by this engine, whereas the previous count is
 122          * simply to cope with (de)allocation of this structure. Hence,
 123          * running_ref <= struct_ref at all times. */
 124         int funct_ref;
 125         /* Used to maintain the linked-list of engines. */
 126         struct engine_st *prev;
 127         struct engine_st *next;
 128         } ENGINE;
 129
 130 /* BUILT-IN ENGINES. (these functions are only ever called once and
 131  * do not return references - they are purely for bootstrapping). */
 132
 133 /* Returns a structure of software only methods (the default). */
 134 ENGINE *ENGINE_openssl();
 135
 136 #ifndef NO_HW
 137
 138 #ifndef NO_HW_CSWIFT
 139 /* Returns a structure of cswift methods ... NB: This can exist and be
 140  * "used" even on non-cswift systems because the "init" will fail if the
 141  * card/library are not found. */
 142 ENGINE *ENGINE_cswift();
 143 #endif /* !NO_HW_CSWIFT */
 144
 145 #ifndef NO_HW_NCIPHER
 146 ENGINE *ENGINE_ncipher();
 147 #endif /* !NO_HW_NCIPHER */
 148
 149 #ifndef NO_HW_ATALLA
 150 /* Returns a structure of atalla methods. */
 151 ENGINE *ENGINE_atalla();
 152 #endif /* !NO_HW_ATALLA */
 153
 154 #ifndef NO_HW_NURON
 155 ENGINE *ENGINE_nuron();
 156 #endif /* !NO_HW_NURON */
 157
 158 #endif /* !NO_HW */
 159
 160 #ifdef  __cplusplus
 161 }
 162 #endif
 163
 164 #endif /* HEADER_ENGINE_INT_H */