crypto/engine/eng_lib.c

   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 #include "e_os.h"
  11 #include "eng_int.h"
  12 #include <openssl/rand.h>
  13 #include "internal/refcount.h"
  14
  15 CRYPTO_RWLOCK *global_engine_lock;
  16
  17 CRYPTO_ONCE engine_lock_init = CRYPTO_ONCE_STATIC_INIT;
  18
  19 /* The "new"/"free" stuff first */
  20
  21 DEFINE_RUN_ONCE(do_engine_lock_init)
  22 {
  23     OPENSSL_init_crypto(0, NULL);
  24     global_engine_lock = CRYPTO_THREAD_glock_new("global_engine");
  25     return global_engine_lock != NULL;
  26 }
  27
  28 ENGINE *ENGINE_new(void)
  29 {
  30     ENGINE *ret;
  31
  32     if (!RUN_ONCE(&engine_lock_init, do_engine_lock_init)
  33         || (ret = OPENSSL_zalloc(sizeof(*ret))) == NULL) {
  34         ENGINEerr(ENGINE_F_ENGINE_NEW, ERR_R_MALLOC_FAILURE);
  35         return NULL;
  36     }
  37     ret->struct_ref = 1;
  38     engine_ref_debug(ret, 0, 1);
  39     if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE, ret, &ret->ex_data)) {
  40         OPENSSL_free(ret);
  41         return NULL;
  42     }
  43     return ret;
  44 }
  45
  46 /*
  47  * Placed here (close proximity to ENGINE_new) so that modifications to the
  48  * elements of the ENGINE structure are more likely to be caught and changed
  49  * here.
  50  */
  51 void engine_set_all_null(ENGINE *e)
  52 {
  53     e->id = NULL;
  54     e->name = NULL;
  55     e->rsa_meth = NULL;
  56     e->dsa_meth = NULL;
  57     e->dh_meth = NULL;
  58     e->rand_meth = NULL;
  59     e->ciphers = NULL;
  60     e->digests = NULL;
  61     e->destroy = NULL;
  62     e->init = NULL;
  63     e->finish = NULL;
  64     e->ctrl = NULL;
  65     e->load_privkey = NULL;
  66     e->load_pubkey = NULL;
  67     e->cmd_defns = NULL;
  68     e->flags = 0;
  69 }
  70
  71 int engine_free_util(ENGINE *e, int not_locked)
  72 {
  73     int i;
  74
  75     if (e == NULL)
  76         return 1;
  77 #ifdef HAVE_ATOMICS
  78     CRYPTO_DOWN_REF(&e->struct_ref, &i, global_engine_lock);
  79 #else
  80     if (not_locked)
  81         CRYPTO_atomic_add(&e->struct_ref, -1, &i, global_engine_lock);
  82     else
  83         i = --e->struct_ref;
  84 #endif
  85     engine_ref_debug(e, 0, -1)
  86     if (i > 0)
  87         return 1;
  88     REF_ASSERT_ISNT(i < 0);
  89     /* Free up any dynamically allocated public key methods */
  90     engine_pkey_meths_free(e);
  91     engine_pkey_asn1_meths_free(e);
  92     /*
  93      * Give the ENGINE a chance to do any structural cleanup corresponding to
  94      * allocation it did in its constructor (eg. unload error strings)
  95      */
  96     if (e->destroy)
  97         e->destroy(e);
  98     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE, e, &e->ex_data);
  99     OPENSSL_free(e);
 100     return 1;
 101 }
 102
 103 int ENGINE_free(ENGINE *e)
 104 {
 105     return engine_free_util(e, 1);
 106 }
 107
 108 /* Cleanup stuff */
 109
 110 /*
 111  * engine_cleanup_int() is coded such that anything that does work that will
 112  * need cleanup can register a "cleanup" callback here. That way we don't get
 113  * linker bloat by referring to all *possible* cleanups, but any linker bloat
 114  * into code "X" will cause X's cleanup function to end up here.
 115  */
 116 static STACK_OF(ENGINE_CLEANUP_ITEM) *cleanup_stack = NULL;
 117 static int int_cleanup_check(int create)
 118 {
 119     if (cleanup_stack)
 120         return 1;
 121     if (!create)
 122         return 0;
 123     cleanup_stack = sk_ENGINE_CLEANUP_ITEM_new_null();
 124     return (cleanup_stack ? 1 : 0);
 125 }
 126
 127 static ENGINE_CLEANUP_ITEM *int_cleanup_item(ENGINE_CLEANUP_CB *cb)
 128 {
 129     ENGINE_CLEANUP_ITEM *item = OPENSSL_malloc(sizeof(*item));
 130     if (item == NULL)
 131         return NULL;
 132     item->cb = cb;
 133     return item;
 134 }
 135
 136 void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb)
 137 {
 138     ENGINE_CLEANUP_ITEM *item;
 139     if (!int_cleanup_check(1))
 140         return;
 141     item = int_cleanup_item(cb);
 142     if (item)
 143         sk_ENGINE_CLEANUP_ITEM_insert(cleanup_stack, item, 0);
 144 }
 145
 146 void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb)
 147 {
 148     ENGINE_CLEANUP_ITEM *item;
 149     if (!int_cleanup_check(1))
 150         return;
 151     item = int_cleanup_item(cb);
 152     if (item)
 153         sk_ENGINE_CLEANUP_ITEM_push(cleanup_stack, item);
 154 }
 155
 156 /* The API function that performs all cleanup */
 157 static void engine_cleanup_cb_free(ENGINE_CLEANUP_ITEM *item)
 158 {
 159     (*(item->cb)) ();
 160     OPENSSL_free(item);
 161 }
 162
 163 void engine_cleanup_int(void)
 164 {
 165     if (int_cleanup_check(0)) {
 166         sk_ENGINE_CLEANUP_ITEM_pop_free(cleanup_stack,
 167                                         engine_cleanup_cb_free);
 168         cleanup_stack = NULL;
 169     }
 170     CRYPTO_THREAD_lock_free(global_engine_lock);
 171 }
 172
 173 /* Now the "ex_data" support */
 174
 175 int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg)
 176 {
 177     return (CRYPTO_set_ex_data(&e->ex_data, idx, arg));
 178 }
 179
 180 void *ENGINE_get_ex_data(const ENGINE *e, int idx)
 181 {
 182     return (CRYPTO_get_ex_data(&e->ex_data, idx));
 183 }
 184
 185 /*
 186  * Functions to get/set an ENGINE's elements - mainly to avoid exposing the
 187  * ENGINE structure itself.
 188  */
 189
 190 int ENGINE_set_id(ENGINE *e, const char *id)
 191 {
 192     if (id == NULL) {
 193         ENGINEerr(ENGINE_F_ENGINE_SET_ID, ERR_R_PASSED_NULL_PARAMETER);
 194         return 0;
 195     }
 196     e->id = id;
 197     return 1;
 198 }
 199
 200 int ENGINE_set_name(ENGINE *e, const char *name)
 201 {
 202     if (name == NULL) {
 203         ENGINEerr(ENGINE_F_ENGINE_SET_NAME, ERR_R_PASSED_NULL_PARAMETER);
 204         return 0;
 205     }
 206     e->name = name;
 207     return 1;
 208 }
 209
 210 int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f)
 211 {
 212     e->destroy = destroy_f;
 213     return 1;
 214 }
 215
 216 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f)
 217 {
 218     e->init = init_f;
 219     return 1;
 220 }
 221
 222 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f)
 223 {
 224     e->finish = finish_f;
 225     return 1;
 226 }
 227
 228 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f)
 229 {
 230     e->ctrl = ctrl_f;
 231     return 1;
 232 }
 233
 234 int ENGINE_set_flags(ENGINE *e, int flags)
 235 {
 236     e->flags = flags;
 237     return 1;
 238 }
 239
 240 int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns)
 241 {
 242     e->cmd_defns = defns;
 243     return 1;
 244 }
 245
 246 const char *ENGINE_get_id(const ENGINE *e)
 247 {
 248     return e->id;
 249 }
 250
 251 const char *ENGINE_get_name(const ENGINE *e)
 252 {
 253     return e->name;
 254 }
 255
 256 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e)
 257 {
 258     return e->destroy;
 259 }
 260
 261 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e)
 262 {
 263     return e->init;
 264 }
 265
 266 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e)
 267 {
 268     return e->finish;
 269 }
 270
 271 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e)
 272 {
 273     return e->ctrl;
 274 }
 275
 276 int ENGINE_get_flags(const ENGINE *e)
 277 {
 278     return e->flags;
 279 }
 280
 281 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e)
 282 {
 283     return e->cmd_defns;
 284 }
 285
 286 /*
 287  * eng_lib.o is pretty much linked into anything that touches ENGINE already,
 288  * so put the "static_state" hack here.
 289  */
 290
 291 static int internal_static_hack = 0;
 292
 293 void *ENGINE_get_static_state(void)
 294 {
 295     return &internal_static_hack;
 296 }