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 /* Take public definitions from engine.h */
  63 #include <openssl/engine.h>
  64
  65 #ifdef  __cplusplus
  66 extern "C" {
  67 #endif
  68
  69 /* If we compile with this symbol defined, then both reference counts in the
  70  * ENGINE structure will be monitored with a line of output on stderr for each
  71  * change. This prints the engine's pointer address (truncated to unsigned int),
  72  * "struct" or "funct" to indicate the reference type, the before and after
  73  * reference count, and the file:line-number pair. The "engine_ref_debug"
  74  * statements must come *after* the change. */
  75 #ifdef ENGINE_REF_COUNT_DEBUG
  76
  77 #define engine_ref_debug(e, isfunct, diff) \
  78         fprintf(stderr, "engine: %08x %s from %d to %d (%s:%d)\n", \
  79                 (unsigned int)(e), (isfunct ? "funct" : "struct"), \
  80                 ((isfunct) ? ((e)->funct_ref - (diff)) : ((e)->struct_ref - (diff))), \
  81                 ((isfunct) ? (e)->funct_ref : (e)->struct_ref), \
  82                 (__FILE__), (__LINE__));
  83
  84 #else
  85
  86 #define engine_ref_debug(e, isfunct, diff)
  87
  88 #endif
  89
  90 /* NB: Bitwise OR-able values for the "flags" variable in ENGINE are now exposed
  91  * in engine.h. */
  92
  93 /* This is a structure for storing implementations of various crypto
  94  * algorithms and functions. */
  95 struct engine_st
  96         {
  97         const char *id;
  98         const char *name;
  99         const RSA_METHOD *rsa_meth;
 100         const DSA_METHOD *dsa_meth;
 101         const DH_METHOD *dh_meth;
 102         const RAND_METHOD *rand_meth;
 103         BN_MOD_EXP bn_mod_exp;
 104         BN_MOD_EXP_CRT bn_mod_exp_crt;
 105         ENGINE_GEN_INT_FUNC_PTR init;
 106         ENGINE_GEN_INT_FUNC_PTR finish;
 107         ENGINE_CTRL_FUNC_PTR ctrl;
 108         ENGINE_LOAD_KEY_PTR load_privkey;
 109         ENGINE_LOAD_KEY_PTR load_pubkey;
 110         const ENGINE_CMD_DEFN *cmd_defns;
 111         int flags;
 112         /* reference count on the structure itself */
 113         int struct_ref;
 114         /* reference count on usability of the engine type. NB: This
 115          * controls the loading and initialisation of any functionlity
 116          * required by this engine, whereas the previous count is
 117          * simply to cope with (de)allocation of this structure. Hence,
 118          * running_ref <= struct_ref at all times. */
 119         int funct_ref;
 120         /* A place to store per-key data */
 121         CRYPTO_EX_DATA ex_data;
 122         /* Used to maintain the linked-list of engines. */
 123         struct engine_st *prev;
 124         struct engine_st *next;
 125         };
 126
 127 /* BUILT-IN ENGINES. (these functions are only ever called once and
 128  * do not return references - they are purely for bootstrapping). */
 129
 130 /* Returns a structure of software only methods (the default). */
 131 ENGINE *ENGINE_openssl();
 132
 133 #ifndef OPENSSL_NO_HW
 134
 135 #ifndef OPENSSL_NO_HW_CSWIFT
 136 /* Returns a structure of cswift methods ... NB: This can exist and be
 137  * "used" even on non-cswift systems because the "init" will fail if the
 138  * card/library are not found. */
 139 ENGINE *ENGINE_cswift();
 140 #endif /* !OPENSSL_NO_HW_CSWIFT */
 141
 142 #ifndef OPENSSL_NO_HW_NCIPHER
 143 ENGINE *ENGINE_ncipher();
 144 #endif /* !OPENSSL_NO_HW_NCIPHER */
 145
 146 #ifndef OPENSSL_NO_HW_ATALLA
 147 /* Returns a structure of atalla methods. */
 148 ENGINE *ENGINE_atalla();
 149 #endif /* !OPENSSL_NO_HW_ATALLA */
 150
 151 #ifndef OPENSSL_NO_HW_NURON
 152 ENGINE *ENGINE_nuron();
 153 #endif /* !OPENSSL_NO_HW_NURON */
 154
 155 #ifndef OPENSSL_NO_HW_UBSEC
 156 ENGINE *ENGINE_ubsec();
 157 #endif /* !OPENSSL_NO_HW_UBSEC */
 158
 159 #endif /* !OPENSSL_NO_HW */
 160
 161 #ifdef  __cplusplus
 162 }
 163 #endif
 164
 165 #endif /* HEADER_ENGINE_INT_H */