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