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