crypto/engine/eng_int.h

   1 /*
   2  * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project
   3  * 2000.
   4  */
   5 /* ====================================================================
   6  * Copyright (c) 1999-2001 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_INT_H
  65 # define HEADER_ENGINE_INT_H
  66
  67 # include "internal/cryptlib.h"
  68 # include "internal/threads.h"
  69 # include <internal/engine.h>
  70
  71 #ifdef  __cplusplus
  72 extern "C" {
  73 #endif
  74
  75 extern CRYPTO_RWLOCK *global_engine_lock;
  76
  77 /*
  78  * If we compile with this symbol defined, then both reference counts in the
  79  * ENGINE structure will be monitored with a line of output on stderr for
  80  * each change. This prints the engine's pointer address (truncated to
  81  * unsigned int), "struct" or "funct" to indicate the reference type, the
  82  * before and after reference count, and the file:line-number pair. The
  83  * "engine_ref_debug" statements must come *after* the change.
  84  */
  85 # ifdef ENGINE_REF_COUNT_DEBUG
  86
  87 #  define engine_ref_debug(e, isfunct, diff) \
  88         fprintf(stderr, "engine: %08x %s from %d to %d (%s:%d)\n", \
  89                 (unsigned int)(e), (isfunct ? "funct" : "struct"), \
  90                 ((isfunct) ? ((e)->funct_ref - (diff)) : ((e)->struct_ref - (diff))), \
  91                 ((isfunct) ? (e)->funct_ref : (e)->struct_ref), \
  92                 (OPENSSL_FILE), (OPENSSL_LINE))
  93
  94 # else
  95
  96 #  define engine_ref_debug(e, isfunct, diff)
  97
  98 # endif
  99
 100 /*
 101  * Any code that will need cleanup operations should use these functions to
 102  * register callbacks. ENGINE_cleanup() will call all registered callbacks in
 103  * order. NB: both the "add" functions assume the engine lock to already be
 104  * held (in "write" mode).
 105  */
 106 typedef void (ENGINE_CLEANUP_CB) (void);
 107 typedef struct st_engine_cleanup_item {
 108     ENGINE_CLEANUP_CB *cb;
 109 } ENGINE_CLEANUP_ITEM;
 110 DEFINE_STACK_OF(ENGINE_CLEANUP_ITEM)
 111 void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb);
 112 void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb);
 113
 114 /* We need stacks of ENGINEs for use in eng_table.c */
 115 DEFINE_STACK_OF(ENGINE)
 116
 117 /*
 118  * If this symbol is defined then engine_table_select(), the function that is
 119  * used by RSA, DSA (etc) code to select registered ENGINEs, cache defaults
 120  * and functional references (etc), will display debugging summaries to
 121  * stderr.
 122  */
 123 /* #define ENGINE_TABLE_DEBUG */
 124
 125 /*
 126  * This represents an implementation table. Dependent code should instantiate
 127  * it as a (ENGINE_TABLE *) pointer value set initially to NULL.
 128  */
 129 typedef struct st_engine_table ENGINE_TABLE;
 130 int engine_table_register(ENGINE_TABLE **table, ENGINE_CLEANUP_CB *cleanup,
 131                           ENGINE *e, const int *nids, int num_nids,
 132                           int setdefault);
 133 void engine_table_unregister(ENGINE_TABLE **table, ENGINE *e);
 134 void engine_table_cleanup(ENGINE_TABLE **table);
 135 # ifndef ENGINE_TABLE_DEBUG
 136 ENGINE *engine_table_select(ENGINE_TABLE **table, int nid);
 137 # else
 138 ENGINE *engine_table_select_tmp(ENGINE_TABLE **table, int nid, const char *f,
 139                                 int l);
 140 #  define engine_table_select(t,n) engine_table_select_tmp(t,n,OPENSSL_FILE,OPENSSL_LINE)
 141 # endif
 142 typedef void (engine_table_doall_cb) (int nid, STACK_OF(ENGINE) *sk,
 143                                       ENGINE *def, void *arg);
 144 void engine_table_doall(ENGINE_TABLE *table, engine_table_doall_cb *cb,
 145                         void *arg);
 146
 147 /*
 148  * Internal versions of API functions that have control over locking. These
 149  * are used between C files when functionality needs to be shared but the
 150  * caller may already be controlling of the engine lock.
 151  */
 152 int engine_unlocked_init(ENGINE *e);
 153 int engine_unlocked_finish(ENGINE *e, int unlock_for_handlers);
 154 int engine_free_util(ENGINE *e, int locked);
 155
 156 /*
 157  * This function will reset all "set"able values in an ENGINE to NULL. This
 158  * won't touch reference counts or ex_data, but is equivalent to calling all
 159  * the ENGINE_set_***() functions with a NULL value.
 160  */
 161 void engine_set_all_null(ENGINE *e);
 162
 163 /*
 164  * NB: Bitwise OR-able values for the "flags" variable in ENGINE are now
 165  * exposed in engine.h.
 166  */
 167
 168 /* Free up dynamically allocated public key methods associated with ENGINE */
 169
 170 void engine_pkey_meths_free(ENGINE *e);
 171 void engine_pkey_asn1_meths_free(ENGINE *e);
 172
 173 /* Once initialisation function */
 174 extern CRYPTO_ONCE engine_lock_init;
 175 void do_engine_lock_init(void);
 176
 177 /*
 178  * This is a structure for storing implementations of various crypto
 179  * algorithms and functions.
 180  */
 181 struct engine_st {
 182     const char *id;
 183     const char *name;
 184     const RSA_METHOD *rsa_meth;
 185     const DSA_METHOD *dsa_meth;
 186     const DH_METHOD *dh_meth;
 187     const EC_KEY_METHOD *ec_meth;
 188     const RAND_METHOD *rand_meth;
 189     /* Cipher handling is via this callback */
 190     ENGINE_CIPHERS_PTR ciphers;
 191     /* Digest handling is via this callback */
 192     ENGINE_DIGESTS_PTR digests;
 193     /* Public key handling via this callback */
 194     ENGINE_PKEY_METHS_PTR pkey_meths;
 195     /* ASN1 public key handling via this callback */
 196     ENGINE_PKEY_ASN1_METHS_PTR pkey_asn1_meths;
 197     ENGINE_GEN_INT_FUNC_PTR destroy;
 198     ENGINE_GEN_INT_FUNC_PTR init;
 199     ENGINE_GEN_INT_FUNC_PTR finish;
 200     ENGINE_CTRL_FUNC_PTR ctrl;
 201     ENGINE_LOAD_KEY_PTR load_privkey;
 202     ENGINE_LOAD_KEY_PTR load_pubkey;
 203     ENGINE_SSL_CLIENT_CERT_PTR load_ssl_client_cert;
 204     const ENGINE_CMD_DEFN *cmd_defns;
 205     int flags;
 206     /* reference count on the structure itself */
 207     int struct_ref;
 208     /*
 209      * reference count on usability of the engine type. NB: This controls the
 210      * loading and initialisation of any functionlity required by this
 211      * engine, whereas the previous count is simply to cope with
 212      * (de)allocation of this structure. Hence, running_ref <= struct_ref at
 213      * all times.
 214      */
 215     int funct_ref;
 216     /* A place to store per-ENGINE data */
 217     CRYPTO_EX_DATA ex_data;
 218     /* Used to maintain the linked-list of engines. */
 219     struct engine_st *prev;
 220     struct engine_st *next;
 221 };
 222
 223 typedef struct st_engine_pile ENGINE_PILE;
 224
 225 DEFINE_LHASH_OF(ENGINE_PILE);
 226
 227 #ifdef  __cplusplus
 228 }
 229 #endif
 230
 231 #endif                          /* HEADER_ENGINE_INT_H */