lib/libcrypto/engine/eng_lib.c

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