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