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