crypto/engine/eng_lib.c

   1 /* crypto/engine/eng_lib.c */
   2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
   3  * project 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 <openssl/crypto.h>
  60 #include "cryptlib.h"
  61 #include "eng_int.h"
  62 #include <openssl/rand.h> /* FIXME: This shouldn't be needed */
  63 #include <openssl/engine.h>
  64
  65 /* The "new"/"free" stuff first */
  66
  67 ENGINE *ENGINE_new(void)
  68         {
  69         ENGINE *ret;
  70
  71         ret = (ENGINE *)OPENSSL_malloc(sizeof(ENGINE));
  72         if(ret == NULL)
  73                 {
  74                 ENGINEerr(ENGINE_F_ENGINE_NEW, ERR_R_MALLOC_FAILURE);
  75                 return NULL;
  76                 }
  77         memset(ret, 0, sizeof(ENGINE));
  78         ret->struct_ref = 1;
  79         engine_ref_debug(ret, 0, 1)
  80         CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE, ret, &ret->ex_data);
  81         return ret;
  82         }
  83
  84 int engine_free_util(ENGINE *e, int locked)
  85         {
  86         int i;
  87
  88         if(e == NULL)
  89                 {
  90                 ENGINEerr(ENGINE_F_ENGINE_FREE,
  91                         ERR_R_PASSED_NULL_PARAMETER);
  92                 return 0;
  93                 }
  94         if(locked)
  95                 i = CRYPTO_add(&e->struct_ref,-1,CRYPTO_LOCK_ENGINE);
  96         else
  97                 i = --e->struct_ref;
  98         engine_ref_debug(e, 0, -1)
  99         if (i > 0) return 1;
 100 #ifdef REF_CHECK
 101         if (i < 0)
 102                 {
 103                 fprintf(stderr,"ENGINE_free, bad structural reference count\n");
 104                 abort();
 105                 }
 106 #endif
 107         /* Give the ENGINE a chance to do any structural cleanup corresponding
 108          * to allocation it did in its constructor (eg. unload error strings) */
 109         if(e->destroy)
 110                 e->destroy(e);
 111         CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE, e, &e->ex_data);
 112         OPENSSL_free(e);
 113         return 1;
 114         }
 115
 116 int ENGINE_free(ENGINE *e)
 117         {
 118         return engine_free_util(e, 1);
 119         }
 120
 121 /* Cleanup stuff */
 122
 123 /* ENGINE_cleanup() is coded such that anything that does work that will need
 124  * cleanup can register a "cleanup" callback here. That way we don't get linker
 125  * bloat by referring to all *possible* cleanups, but any linker bloat into code
 126  * "X" will cause X's cleanup function to end up here. */
 127 static STACK_OF(ENGINE_CLEANUP_ITEM) *cleanup_stack = NULL;
 128 static int int_cleanup_check(int create)
 129         {
 130         if(cleanup_stack) return 1;
 131         if(!create) return 0;
 132         cleanup_stack = sk_ENGINE_CLEANUP_ITEM_new_null();
 133         return (cleanup_stack ? 1 : 0);
 134         }
 135 static ENGINE_CLEANUP_ITEM *int_cleanup_item(ENGINE_CLEANUP_CB *cb)
 136         {
 137         ENGINE_CLEANUP_ITEM *item = OPENSSL_malloc(sizeof(
 138                                         ENGINE_CLEANUP_ITEM));
 139         if(!item) return NULL;
 140         item->cb = cb;
 141         return item;
 142         }
 143 void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb)
 144         {
 145         ENGINE_CLEANUP_ITEM *item;
 146         if(!int_cleanup_check(1)) return;
 147         item = int_cleanup_item(cb);
 148         if(item)
 149                 sk_ENGINE_CLEANUP_ITEM_insert(cleanup_stack, item, 0);
 150         }
 151 void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb)
 152         {
 153         ENGINE_CLEANUP_ITEM *item;
 154         if(!int_cleanup_check(1)) return;
 155         item = int_cleanup_item(cb);
 156         if(item)
 157                 sk_ENGINE_CLEANUP_ITEM_push(cleanup_stack, item);
 158         }
 159 /* The API function that performs all cleanup */
 160 void ENGINE_cleanup(void)
 161         {
 162         if(int_cleanup_check(0))
 163                 {
 164                 int loop = 0, num = sk_ENGINE_CLEANUP_ITEM_num(cleanup_stack);
 165                 while(loop < num)
 166                         {
 167                         ENGINE_CLEANUP_ITEM *item = sk_ENGINE_CLEANUP_ITEM_value(
 168                                         cleanup_stack, loop++);
 169                         (*(item->cb))();
 170                         OPENSSL_free(item);
 171                         }
 172                 sk_ENGINE_CLEANUP_ITEM_free(cleanup_stack);
 173                 cleanup_stack = NULL;
 174                 }
 175         /* FIXME: This should be handled (somehow) through RAND, eg. by it
 176          * registering a cleanup callback. */
 177         RAND_set_rand_method(NULL);
 178         }
 179
 180 /* Now the "ex_data" support */
 181
 182 int ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
 183                 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func)
 184         {
 185         return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_ENGINE, argl, argp,
 186                         new_func, dup_func, free_func);
 187         }
 188
 189 int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg)
 190         {
 191         return(CRYPTO_set_ex_data(&e->ex_data, idx, arg));
 192         }
 193
 194 void *ENGINE_get_ex_data(const ENGINE *e, int idx)
 195         {
 196         return(CRYPTO_get_ex_data(&e->ex_data, idx));
 197         }
 198
 199 /* Functions to get/set an ENGINE's elements - mainly to avoid exposing the
 200  * ENGINE structure itself. */
 201
 202 int ENGINE_set_id(ENGINE *e, const char *id)
 203         {
 204         if(id == NULL)
 205                 {
 206                 ENGINEerr(ENGINE_F_ENGINE_SET_ID,
 207                         ERR_R_PASSED_NULL_PARAMETER);
 208                 return 0;
 209                 }
 210         e->id = id;
 211         return 1;
 212         }
 213
 214 int ENGINE_set_name(ENGINE *e, const char *name)
 215         {
 216         if(name == NULL)
 217                 {
 218                 ENGINEerr(ENGINE_F_ENGINE_SET_NAME,
 219                         ERR_R_PASSED_NULL_PARAMETER);
 220                 return 0;
 221                 }
 222         e->name = name;
 223         return 1;
 224         }
 225
 226 int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f)
 227         {
 228         e->destroy = destroy_f;
 229         return 1;
 230         }
 231
 232 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f)
 233         {
 234         e->init = init_f;
 235         return 1;
 236         }
 237
 238 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f)
 239         {
 240         e->finish = finish_f;
 241         return 1;
 242         }
 243
 244 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f)
 245         {
 246         e->ctrl = ctrl_f;
 247         return 1;
 248         }
 249
 250 int ENGINE_set_flags(ENGINE *e, int flags)
 251         {
 252         e->flags = flags;
 253         return 1;
 254         }
 255
 256 int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns)
 257         {
 258         e->cmd_defns = defns;
 259         return 1;
 260         }
 261
 262 const char *ENGINE_get_id(const ENGINE *e)
 263         {
 264         return e->id;
 265         }
 266
 267 const char *ENGINE_get_name(const ENGINE *e)
 268         {
 269         return e->name;
 270         }
 271
 272 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e)
 273         {
 274         return e->destroy;
 275         }
 276
 277 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e)
 278         {
 279         return e->init;
 280         }
 281
 282 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e)
 283         {
 284         return e->finish;
 285         }
 286
 287 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e)
 288         {
 289         return e->ctrl;
 290         }
 291
 292 int ENGINE_get_flags(const ENGINE *e)
 293         {
 294         return e->flags;
 295         }
 296
 297 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e)
 298         {
 299         return e->cmd_defns;
 300         }