crypto/engine/eng_lib.c

   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 #include "eng_int.h"
  60 #include <openssl/rand.h>
  61
  62 CRYPTO_RWLOCK *global_engine_lock;
  63
  64 CRYPTO_ONCE engine_lock_init = CRYPTO_ONCE_STATIC_INIT;
  65
  66 /* The "new"/"free" stuff first */
  67
  68 void do_engine_lock_init(void)
  69 {
  70     global_engine_lock = CRYPTO_THREAD_lock_new();
  71 }
  72
  73 ENGINE *ENGINE_new(void)
  74 {
  75     ENGINE *ret;
  76
  77     CRYPTO_THREAD_run_once(&engine_lock_init, do_engine_lock_init);
  78
  79     ret = OPENSSL_zalloc(sizeof(*ret));
  80     if (ret == NULL) {
  81         ENGINEerr(ENGINE_F_ENGINE_NEW, ERR_R_MALLOC_FAILURE);
  82         return NULL;
  83     }
  84     ret->struct_ref = 1;
  85     engine_ref_debug(ret, 0, 1);
  86     CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE, ret, &ret->ex_data);
  87     return ret;
  88 }
  89
  90 /*
  91  * Placed here (close proximity to ENGINE_new) so that modifications to the
  92  * elements of the ENGINE structure are more likely to be caught and changed
  93  * here.
  94  */
  95 void engine_set_all_null(ENGINE *e)
  96 {
  97     e->id = NULL;
  98     e->name = NULL;
  99     e->rsa_meth = NULL;
 100     e->dsa_meth = NULL;
 101     e->dh_meth = NULL;
 102     e->rand_meth = NULL;
 103     e->ciphers = NULL;
 104     e->digests = NULL;
 105     e->destroy = NULL;
 106     e->init = NULL;
 107     e->finish = NULL;
 108     e->ctrl = NULL;
 109     e->load_privkey = NULL;
 110     e->load_pubkey = NULL;
 111     e->cmd_defns = NULL;
 112     e->flags = 0;
 113 }
 114
 115 int engine_free_util(ENGINE *e, int locked)
 116 {
 117     int i;
 118
 119     if (e == NULL)
 120         return 1;
 121     if (locked)
 122         CRYPTO_atomic_add(&e->struct_ref, -1, &i, global_engine_lock);
 123     else
 124         i = --e->struct_ref;
 125     engine_ref_debug(e, 0, -1)
 126     if (i > 0)
 127         return 1;
 128     REF_ASSERT_ISNT(i < 0);
 129     /* Free up any dynamically allocated public key methods */
 130     engine_pkey_meths_free(e);
 131     engine_pkey_asn1_meths_free(e);
 132     /*
 133      * Give the ENGINE a chance to do any structural cleanup corresponding to
 134      * allocation it did in its constructor (eg. unload error strings)
 135      */
 136     if (e->destroy)
 137         e->destroy(e);
 138     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE, e, &e->ex_data);
 139     OPENSSL_free(e);
 140     return 1;
 141 }
 142
 143 int ENGINE_free(ENGINE *e)
 144 {
 145     return engine_free_util(e, 1);
 146 }
 147
 148 /* Cleanup stuff */
 149
 150 /*
 151  * ENGINE_cleanup() is coded such that anything that does work that will need
 152  * cleanup can register a "cleanup" callback here. That way we don't get
 153  * linker bloat by referring to all *possible* cleanups, but any linker bloat
 154  * into code "X" will cause X's cleanup function to end up here.
 155  */
 156 static STACK_OF(ENGINE_CLEANUP_ITEM) *cleanup_stack = NULL;
 157 static int int_cleanup_check(int create)
 158 {
 159     if (cleanup_stack)
 160         return 1;
 161     if (!create)
 162         return 0;
 163     cleanup_stack = sk_ENGINE_CLEANUP_ITEM_new_null();
 164     return (cleanup_stack ? 1 : 0);
 165 }
 166
 167 static ENGINE_CLEANUP_ITEM *int_cleanup_item(ENGINE_CLEANUP_CB *cb)
 168 {
 169     ENGINE_CLEANUP_ITEM *item = OPENSSL_malloc(sizeof(*item));
 170     if (item == NULL)
 171         return NULL;
 172     item->cb = cb;
 173     return item;
 174 }
 175
 176 void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb)
 177 {
 178     ENGINE_CLEANUP_ITEM *item;
 179     if (!int_cleanup_check(1))
 180         return;
 181     item = int_cleanup_item(cb);
 182     if (item)
 183         sk_ENGINE_CLEANUP_ITEM_insert(cleanup_stack, item, 0);
 184 }
 185
 186 void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb)
 187 {
 188     ENGINE_CLEANUP_ITEM *item;
 189     if (!int_cleanup_check(1))
 190         return;
 191     item = int_cleanup_item(cb);
 192     if (item)
 193         sk_ENGINE_CLEANUP_ITEM_push(cleanup_stack, item);
 194 }
 195
 196 /* The API function that performs all cleanup */
 197 static void engine_cleanup_cb_free(ENGINE_CLEANUP_ITEM *item)
 198 {
 199     (*(item->cb)) ();
 200     OPENSSL_free(item);
 201 }
 202
 203 void ENGINE_cleanup(void)
 204 {
 205     if (int_cleanup_check(0)) {
 206         sk_ENGINE_CLEANUP_ITEM_pop_free(cleanup_stack,
 207                                         engine_cleanup_cb_free);
 208         cleanup_stack = NULL;
 209     }
 210     /*
 211      * FIXME: This should be handled (somehow) through RAND, eg. by it
 212      * registering a cleanup callback.
 213      */
 214     RAND_set_rand_method(NULL);
 215     CRYPTO_THREAD_lock_free(global_engine_lock);
 216 }
 217
 218 /* Now the "ex_data" support */
 219
 220 int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg)
 221 {
 222     return (CRYPTO_set_ex_data(&e->ex_data, idx, arg));
 223 }
 224
 225 void *ENGINE_get_ex_data(const ENGINE *e, int idx)
 226 {
 227     return (CRYPTO_get_ex_data(&e->ex_data, idx));
 228 }
 229
 230 /*
 231  * Functions to get/set an ENGINE's elements - mainly to avoid exposing the
 232  * ENGINE structure itself.
 233  */
 234
 235 int ENGINE_set_id(ENGINE *e, const char *id)
 236 {
 237     if (id == NULL) {
 238         ENGINEerr(ENGINE_F_ENGINE_SET_ID, ERR_R_PASSED_NULL_PARAMETER);
 239         return 0;
 240     }
 241     e->id = id;
 242     return 1;
 243 }
 244
 245 int ENGINE_set_name(ENGINE *e, const char *name)
 246 {
 247     if (name == NULL) {
 248         ENGINEerr(ENGINE_F_ENGINE_SET_NAME, ERR_R_PASSED_NULL_PARAMETER);
 249         return 0;
 250     }
 251     e->name = name;
 252     return 1;
 253 }
 254
 255 int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f)
 256 {
 257     e->destroy = destroy_f;
 258     return 1;
 259 }
 260
 261 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f)
 262 {
 263     e->init = init_f;
 264     return 1;
 265 }
 266
 267 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f)
 268 {
 269     e->finish = finish_f;
 270     return 1;
 271 }
 272
 273 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f)
 274 {
 275     e->ctrl = ctrl_f;
 276     return 1;
 277 }
 278
 279 int ENGINE_set_flags(ENGINE *e, int flags)
 280 {
 281     e->flags = flags;
 282     return 1;
 283 }
 284
 285 int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns)
 286 {
 287     e->cmd_defns = defns;
 288     return 1;
 289 }
 290
 291 const char *ENGINE_get_id(const ENGINE *e)
 292 {
 293     return e->id;
 294 }
 295
 296 const char *ENGINE_get_name(const ENGINE *e)
 297 {
 298     return e->name;
 299 }
 300
 301 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e)
 302 {
 303     return e->destroy;
 304 }
 305
 306 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e)
 307 {
 308     return e->init;
 309 }
 310
 311 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e)
 312 {
 313     return e->finish;
 314 }
 315
 316 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e)
 317 {
 318     return e->ctrl;
 319 }
 320
 321 int ENGINE_get_flags(const ENGINE *e)
 322 {
 323     return e->flags;
 324 }
 325
 326 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e)
 327 {
 328     return e->cmd_defns;
 329 }
 330
 331 /*
 332  * eng_lib.o is pretty much linked into anything that touches ENGINE already,
 333  * so put the "static_state" hack here.
 334  */
 335
 336 static int internal_static_hack = 0;
 337
 338 void *ENGINE_get_static_state(void)
 339 {
 340     return &internal_static_hack;
 341 }