crypto/engine/eng_lib.c

   1 /* crypto/engine/eng_lib.c */
   2 /*
   3  * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project
   4  * 2000.
   5  */
   6 /* ====================================================================
   7  * Copyright (c) 1999-2001 The OpenSSL Project.  All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  *
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  *
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in
  18  *    the documentation and/or other materials provided with the
  19  *    distribution.
  20  *
  21  * 3. All advertising materials mentioning features or use of this
  22  *    software must display the following acknowledgment:
  23  *    "This product includes software developed by the OpenSSL Project
  24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  25  *
  26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  27  *    endorse or promote products derived from this software without
  28  *    prior written permission. For written permission, please contact
  29  *    licensing@OpenSSL.org.
  30  *
  31  * 5. Products derived from this software may not be called "OpenSSL"
  32  *    nor may "OpenSSL" appear in their names without prior written
  33  *    permission of the OpenSSL Project.
  34  *
  35  * 6. Redistributions of any form whatsoever must retain the following
  36  *    acknowledgment:
  37  *    "This product includes software developed by the OpenSSL Project
  38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  51  * OF THE POSSIBILITY OF SUCH DAMAGE.
  52  * ====================================================================
  53  *
  54  * This product includes cryptographic software written by Eric Young
  55  * (eay@cryptsoft.com).  This product includes software written by Tim
  56  * Hudson (tjh@cryptsoft.com).
  57  *
  58  */
  59
  60 #include "eng_int.h"
  61 #include <openssl/rand.h>
  62
  63 /* The "new"/"free" stuff first */
  64
  65 ENGINE *ENGINE_new(void)
  66 {
  67     ENGINE *ret;
  68
  69     ret = OPENSSL_zalloc(sizeof(*ret));
  70     if (ret == NULL) {
  71         ENGINEerr(ENGINE_F_ENGINE_NEW, ERR_R_MALLOC_FAILURE);
  72         return NULL;
  73     }
  74     ret->struct_ref = 1;
  75     engine_ref_debug(ret, 0, 1)
  76         CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE, ret, &ret->ex_data);
  77     return ret;
  78 }
  79
  80 /*
  81  * Placed here (close proximity to ENGINE_new) so that modifications to the
  82  * elements of the ENGINE structure are more likely to be caught and changed
  83  * here.
  84  */
  85 void engine_set_all_null(ENGINE *e)
  86 {
  87     e->id = NULL;
  88     e->name = NULL;
  89     e->rsa_meth = NULL;
  90     e->dsa_meth = NULL;
  91     e->dh_meth = NULL;
  92     e->rand_meth = NULL;
  93     e->store_meth = NULL;
  94     e->ciphers = NULL;
  95     e->digests = NULL;
  96     e->destroy = NULL;
  97     e->init = NULL;
  98     e->finish = NULL;
  99     e->ctrl = NULL;
 100     e->load_privkey = NULL;
 101     e->load_pubkey = NULL;
 102     e->cmd_defns = NULL;
 103     e->flags = 0;
 104 }
 105
 106 int engine_free_util(ENGINE *e, int locked)
 107 {
 108     int i;
 109
 110     if (e == NULL)
 111         return 1;
 112     if (locked)
 113         i = CRYPTO_add(&e->struct_ref, -1, CRYPTO_LOCK_ENGINE);
 114     else
 115         i = --e->struct_ref;
 116     engine_ref_debug(e, 0, -1)
 117     if (i > 0)
 118         return 1;
 119 #ifdef REF_CHECK
 120     if (i < 0) {
 121         fprintf(stderr, "ENGINE_free, bad structural reference count\n");
 122         abort();
 123     }
 124 #endif
 125     /* Free up any dynamically allocated public key methods */
 126     engine_pkey_meths_free(e);
 127     engine_pkey_asn1_meths_free(e);
 128     /*
 129      * Give the ENGINE a chance to do any structural cleanup corresponding to
 130      * allocation it did in its constructor (eg. unload error strings)
 131      */
 132     if (e->destroy)
 133         e->destroy(e);
 134     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE, e, &e->ex_data);
 135     OPENSSL_free(e);
 136     return 1;
 137 }
 138
 139 int ENGINE_free(ENGINE *e)
 140 {
 141     return engine_free_util(e, 1);
 142 }
 143
 144 /* Cleanup stuff */
 145
 146 /*
 147  * ENGINE_cleanup() is coded such that anything that does work that will need
 148  * cleanup can register a "cleanup" callback here. That way we don't get
 149  * linker bloat by referring to all *possible* cleanups, but any linker bloat
 150  * into code "X" will cause X's cleanup function to end up here.
 151  */
 152 static STACK_OF(ENGINE_CLEANUP_ITEM) *cleanup_stack = NULL;
 153 static int int_cleanup_check(int create)
 154 {
 155     if (cleanup_stack)
 156         return 1;
 157     if (!create)
 158         return 0;
 159     cleanup_stack = sk_ENGINE_CLEANUP_ITEM_new_null();
 160     return (cleanup_stack ? 1 : 0);
 161 }
 162
 163 static ENGINE_CLEANUP_ITEM *int_cleanup_item(ENGINE_CLEANUP_CB *cb)
 164 {
 165     ENGINE_CLEANUP_ITEM *item = OPENSSL_malloc(sizeof(*item));
 166     if (item == NULL)
 167         return NULL;
 168     item->cb = cb;
 169     return item;
 170 }
 171
 172 void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb)
 173 {
 174     ENGINE_CLEANUP_ITEM *item;
 175     if (!int_cleanup_check(1))
 176         return;
 177     item = int_cleanup_item(cb);
 178     if (item)
 179         sk_ENGINE_CLEANUP_ITEM_insert(cleanup_stack, item, 0);
 180 }
 181
 182 void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb)
 183 {
 184     ENGINE_CLEANUP_ITEM *item;
 185     if (!int_cleanup_check(1))
 186         return;
 187     item = int_cleanup_item(cb);
 188     if (item)
 189         sk_ENGINE_CLEANUP_ITEM_push(cleanup_stack, item);
 190 }
 191
 192 /* The API function that performs all cleanup */
 193 static void engine_cleanup_cb_free(ENGINE_CLEANUP_ITEM *item)
 194 {
 195     (*(item->cb)) ();
 196     OPENSSL_free(item);
 197 }
 198
 199 void ENGINE_cleanup(void)
 200 {
 201     if (int_cleanup_check(0)) {
 202         sk_ENGINE_CLEANUP_ITEM_pop_free(cleanup_stack,
 203                                         engine_cleanup_cb_free);
 204         cleanup_stack = NULL;
 205     }
 206     /*
 207      * FIXME: This should be handled (somehow) through RAND, eg. by it
 208      * registering a cleanup callback.
 209      */
 210     RAND_set_rand_method(NULL);
 211 }
 212
 213 /* Now the "ex_data" support */
 214
 215 int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg)
 216 {
 217     return (CRYPTO_set_ex_data(&e->ex_data, idx, arg));
 218 }
 219
 220 void *ENGINE_get_ex_data(const ENGINE *e, int idx)
 221 {
 222     return (CRYPTO_get_ex_data(&e->ex_data, idx));
 223 }
 224
 225 /*
 226  * Functions to get/set an ENGINE's elements - mainly to avoid exposing the
 227  * ENGINE structure itself.
 228  */
 229
 230 int ENGINE_set_id(ENGINE *e, const char *id)
 231 {
 232     if (id == NULL) {
 233         ENGINEerr(ENGINE_F_ENGINE_SET_ID, ERR_R_PASSED_NULL_PARAMETER);
 234         return 0;
 235     }
 236     e->id = id;
 237     return 1;
 238 }
 239
 240 int ENGINE_set_name(ENGINE *e, const char *name)
 241 {
 242     if (name == NULL) {
 243         ENGINEerr(ENGINE_F_ENGINE_SET_NAME, ERR_R_PASSED_NULL_PARAMETER);
 244         return 0;
 245     }
 246     e->name = name;
 247     return 1;
 248 }
 249
 250 int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f)
 251 {
 252     e->destroy = destroy_f;
 253     return 1;
 254 }
 255
 256 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f)
 257 {
 258     e->init = init_f;
 259     return 1;
 260 }
 261
 262 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f)
 263 {
 264     e->finish = finish_f;
 265     return 1;
 266 }
 267
 268 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f)
 269 {
 270     e->ctrl = ctrl_f;
 271     return 1;
 272 }
 273
 274 int ENGINE_set_flags(ENGINE *e, int flags)
 275 {
 276     e->flags = flags;
 277     return 1;
 278 }
 279
 280 int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns)
 281 {
 282     e->cmd_defns = defns;
 283     return 1;
 284 }
 285
 286 const char *ENGINE_get_id(const ENGINE *e)
 287 {
 288     return e->id;
 289 }
 290
 291 const char *ENGINE_get_name(const ENGINE *e)
 292 {
 293     return e->name;
 294 }
 295
 296 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e)
 297 {
 298     return e->destroy;
 299 }
 300
 301 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e)
 302 {
 303     return e->init;
 304 }
 305
 306 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e)
 307 {
 308     return e->finish;
 309 }
 310
 311 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e)
 312 {
 313     return e->ctrl;
 314 }
 315
 316 int ENGINE_get_flags(const ENGINE *e)
 317 {
 318     return e->flags;
 319 }
 320
 321 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e)
 322 {
 323     return e->cmd_defns;
 324 }
 325
 326 /*
 327  * eng_lib.o is pretty much linked into anything that touches ENGINE already,
 328  * so put the "static_state" hack here.
 329  */
 330
 331 static int internal_static_hack = 0;
 332
 333 void *ENGINE_get_static_state(void)
 334 {
 335     return &internal_static_hack;
 336 }