crypto/engine/eng_int.h

   1 /*
   2  * Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 /* ====================================================================
  11  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
  12  * ECDH support in OpenSSL originally developed by
  13  * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
  14  */
  15
  16 #ifndef HEADER_ENGINE_INT_H
  17 # define HEADER_ENGINE_INT_H
  18
  19 # include "internal/cryptlib.h"
  20 # include <internal/engine.h>
  21
  22 #ifdef  __cplusplus
  23 extern "C" {
  24 #endif
  25
  26 extern CRYPTO_RWLOCK *global_engine_lock;
  27
  28 /*
  29  * If we compile with this symbol defined, then both reference counts in the
  30  * ENGINE structure will be monitored with a line of output on stderr for
  31  * each change. This prints the engine's pointer address (truncated to
  32  * unsigned int), "struct" or "funct" to indicate the reference type, the
  33  * before and after reference count, and the file:line-number pair. The
  34  * "engine_ref_debug" statements must come *after* the change.
  35  */
  36 # ifdef ENGINE_REF_COUNT_DEBUG
  37
  38 #  define engine_ref_debug(e, isfunct, diff) \
  39         fprintf(stderr, "engine: %08x %s from %d to %d (%s:%d)\n", \
  40                 (unsigned int)(e), (isfunct ? "funct" : "struct"), \
  41                 ((isfunct) ? ((e)->funct_ref - (diff)) : ((e)->struct_ref - (diff))), \
  42                 ((isfunct) ? (e)->funct_ref : (e)->struct_ref), \
  43                 (OPENSSL_FILE), (OPENSSL_LINE))
  44
  45 # else
  46
  47 #  define engine_ref_debug(e, isfunct, diff)
  48
  49 # endif
  50
  51 /*
  52  * Any code that will need cleanup operations should use these functions to
  53  * register callbacks. engine_cleanup_int() will call all registered
  54  * callbacks in order. NB: both the "add" functions assume the engine lock to
  55  * already be held (in "write" mode).
  56  */
  57 typedef void (ENGINE_CLEANUP_CB) (void);
  58 typedef struct st_engine_cleanup_item {
  59     ENGINE_CLEANUP_CB *cb;
  60 } ENGINE_CLEANUP_ITEM;
  61 DEFINE_STACK_OF(ENGINE_CLEANUP_ITEM)
  62 void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb);
  63 void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb);
  64
  65 /* We need stacks of ENGINEs for use in eng_table.c */
  66 DEFINE_STACK_OF(ENGINE)
  67
  68 /*
  69  * If this symbol is defined then engine_table_select(), the function that is
  70  * used by RSA, DSA (etc) code to select registered ENGINEs, cache defaults
  71  * and functional references (etc), will display debugging summaries to
  72  * stderr.
  73  */
  74 /* #define ENGINE_TABLE_DEBUG */
  75
  76 /*
  77  * This represents an implementation table. Dependent code should instantiate
  78  * it as a (ENGINE_TABLE *) pointer value set initially to NULL.
  79  */
  80 typedef struct st_engine_table ENGINE_TABLE;
  81 int engine_table_register(ENGINE_TABLE **table, ENGINE_CLEANUP_CB *cleanup,
  82                           ENGINE *e, const int *nids, int num_nids,
  83                           int setdefault);
  84 void engine_table_unregister(ENGINE_TABLE **table, ENGINE *e);
  85 void engine_table_cleanup(ENGINE_TABLE **table);
  86 # ifndef ENGINE_TABLE_DEBUG
  87 ENGINE *engine_table_select(ENGINE_TABLE **table, int nid);
  88 # else
  89 ENGINE *engine_table_select_tmp(ENGINE_TABLE **table, int nid, const char *f,
  90                                 int l);
  91 #  define engine_table_select(t,n) engine_table_select_tmp(t,n,OPENSSL_FILE,OPENSSL_LINE)
  92 # endif
  93 typedef void (engine_table_doall_cb) (int nid, STACK_OF(ENGINE) *sk,
  94                                       ENGINE *def, void *arg);
  95 void engine_table_doall(ENGINE_TABLE *table, engine_table_doall_cb *cb,
  96                         void *arg);
  97
  98 /*
  99  * Internal versions of API functions that have control over locking. These
 100  * are used between C files when functionality needs to be shared but the
 101  * caller may already be controlling of the engine lock.
 102  */
 103 int engine_unlocked_init(ENGINE *e);
 104 int engine_unlocked_finish(ENGINE *e, int unlock_for_handlers);
 105 int engine_free_util(ENGINE *e, int locked);
 106
 107 /*
 108  * This function will reset all "set"able values in an ENGINE to NULL. This
 109  * won't touch reference counts or ex_data, but is equivalent to calling all
 110  * the ENGINE_set_***() functions with a NULL value.
 111  */
 112 void engine_set_all_null(ENGINE *e);
 113
 114 /*
 115  * NB: Bitwise OR-able values for the "flags" variable in ENGINE are now
 116  * exposed in engine.h.
 117  */
 118
 119 /* Free up dynamically allocated public key methods associated with ENGINE */
 120
 121 void engine_pkey_meths_free(ENGINE *e);
 122 void engine_pkey_asn1_meths_free(ENGINE *e);
 123
 124 /* Once initialisation function */
 125 extern CRYPTO_ONCE engine_lock_init;
 126 void do_engine_lock_init(void);
 127
 128 /*
 129  * This is a structure for storing implementations of various crypto
 130  * algorithms and functions.
 131  */
 132 struct engine_st {
 133     const char *id;
 134     const char *name;
 135     const RSA_METHOD *rsa_meth;
 136     const DSA_METHOD *dsa_meth;
 137     const DH_METHOD *dh_meth;
 138     const EC_KEY_METHOD *ec_meth;
 139     const RAND_METHOD *rand_meth;
 140     /* Cipher handling is via this callback */
 141     ENGINE_CIPHERS_PTR ciphers;
 142     /* Digest handling is via this callback */
 143     ENGINE_DIGESTS_PTR digests;
 144     /* Public key handling via this callback */
 145     ENGINE_PKEY_METHS_PTR pkey_meths;
 146     /* ASN1 public key handling via this callback */
 147     ENGINE_PKEY_ASN1_METHS_PTR pkey_asn1_meths;
 148     ENGINE_GEN_INT_FUNC_PTR destroy;
 149     ENGINE_GEN_INT_FUNC_PTR init;
 150     ENGINE_GEN_INT_FUNC_PTR finish;
 151     ENGINE_CTRL_FUNC_PTR ctrl;
 152     ENGINE_LOAD_KEY_PTR load_privkey;
 153     ENGINE_LOAD_KEY_PTR load_pubkey;
 154     ENGINE_SSL_CLIENT_CERT_PTR load_ssl_client_cert;
 155     const ENGINE_CMD_DEFN *cmd_defns;
 156     int flags;
 157     /* reference count on the structure itself */
 158     int struct_ref;
 159     /*
 160      * reference count on usability of the engine type. NB: This controls the
 161      * loading and initialisation of any functionality required by this
 162      * engine, whereas the previous count is simply to cope with
 163      * (de)allocation of this structure. Hence, running_ref <= struct_ref at
 164      * all times.
 165      */
 166     int funct_ref;
 167     /* A place to store per-ENGINE data */
 168     CRYPTO_EX_DATA ex_data;
 169     /* Used to maintain the linked-list of engines. */
 170     struct engine_st *prev;
 171     struct engine_st *next;
 172 };
 173
 174 typedef struct st_engine_pile ENGINE_PILE;
 175
 176 DEFINE_LHASH_OF(ENGINE_PILE);
 177
 178 #ifdef  __cplusplus
 179 }
 180 #endif
 181
 182 #endif                          /* HEADER_ENGINE_INT_H */