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