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