crypto/engine/eng_table.c

   1 /* ====================================================================
   2  * Copyright (c) 2001 The OpenSSL Project.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  *
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in
  13  *    the documentation and/or other materials provided with the
  14  *    distribution.
  15  *
  16  * 3. All advertising materials mentioning features or use of this
  17  *    software must display the following acknowledgment:
  18  *    "This product includes software developed by the OpenSSL Project
  19  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  20  *
  21  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  22  *    endorse or promote products derived from this software without
  23  *    prior written permission. For written permission, please contact
  24  *    licensing@OpenSSL.org.
  25  *
  26  * 5. Products derived from this software may not be called "OpenSSL"
  27  *    nor may "OpenSSL" appear in their names without prior written
  28  *    permission of the OpenSSL Project.
  29  *
  30  * 6. Redistributions of any form whatsoever must retain the following
  31  *    acknowledgment:
  32  *    "This product includes software developed by the OpenSSL Project
  33  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  34  *
  35  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  36  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  37  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  38  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  41  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  44  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  45  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  46  * OF THE POSSIBILITY OF SUCH DAMAGE.
  47  * ====================================================================
  48  *
  49  * This product includes cryptographic software written by Eric Young
  50  * (eay@cryptsoft.com).  This product includes software written by Tim
  51  * Hudson (tjh@cryptsoft.com).
  52  *
  53  */
  54
  55 #include "internal/cryptlib.h"
  56 #include <openssl/evp.h>
  57 #include <openssl/lhash.h>
  58 #include "eng_int.h"
  59
  60 /* The type of the items in the table */
  61 struct st_engine_pile {
  62     /* The 'nid' of this algorithm/mode */
  63     int nid;
  64     /* ENGINEs that implement this algorithm/mode. */
  65     STACK_OF(ENGINE) *sk;
  66     /* The default ENGINE to perform this algorithm/mode. */
  67     ENGINE *funct;
  68     /*
  69      * Zero if 'sk' is newer than the cached 'funct', non-zero otherwise
  70      */
  71     int uptodate;
  72 };
  73
  74 /* The type exposed in eng_int.h */
  75 struct st_engine_table {
  76     LHASH_OF(ENGINE_PILE) piles;
  77 };                              /* ENGINE_TABLE */
  78
  79 typedef struct st_engine_pile_doall {
  80     engine_table_doall_cb *cb;
  81     void *arg;
  82 } ENGINE_PILE_DOALL;
  83
  84 /* Global flags (ENGINE_TABLE_FLAG_***). */
  85 static unsigned int table_flags = 0;
  86
  87 /* API function manipulating 'table_flags' */
  88 unsigned int ENGINE_get_table_flags(void)
  89 {
  90     return table_flags;
  91 }
  92
  93 void ENGINE_set_table_flags(unsigned int flags)
  94 {
  95     table_flags = flags;
  96 }
  97
  98 /* Internal functions for the "piles" hash table */
  99 static unsigned long engine_pile_hash(const ENGINE_PILE *c)
 100 {
 101     return c->nid;
 102 }
 103
 104 static int engine_pile_cmp(const ENGINE_PILE *a, const ENGINE_PILE *b)
 105 {
 106     return a->nid - b->nid;
 107 }
 108
 109 static int int_table_check(ENGINE_TABLE **t, int create)
 110 {
 111     LHASH_OF(ENGINE_PILE) *lh;
 112
 113     if (*t)
 114         return 1;
 115     if (!create)
 116         return 0;
 117     if ((lh = lh_ENGINE_PILE_new(engine_pile_hash, engine_pile_cmp)) == NULL)
 118         return 0;
 119     *t = (ENGINE_TABLE *)lh;
 120     return 1;
 121 }
 122
 123 /*
 124  * Privately exposed (via eng_int.h) functions for adding and/or removing
 125  * ENGINEs from the implementation table
 126  */
 127 int engine_table_register(ENGINE_TABLE **table, ENGINE_CLEANUP_CB *cleanup,
 128                           ENGINE *e, const int *nids, int num_nids,
 129                           int setdefault)
 130 {
 131     int ret = 0, added = 0;
 132     ENGINE_PILE tmplate, *fnd;
 133     CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
 134     if (!(*table))
 135         added = 1;
 136     if (!int_table_check(table, 1))
 137         goto end;
 138     if (added)
 139         /* The cleanup callback needs to be added */
 140         engine_cleanup_add_first(cleanup);
 141     while (num_nids--) {
 142         tmplate.nid = *nids;
 143         fnd = lh_ENGINE_PILE_retrieve(&(*table)->piles, &tmplate);
 144         if (!fnd) {
 145             fnd = OPENSSL_malloc(sizeof(*fnd));
 146             if (fnd == NULL)
 147                 goto end;
 148             fnd->uptodate = 1;
 149             fnd->nid = *nids;
 150             fnd->sk = sk_ENGINE_new_null();
 151             if (!fnd->sk) {
 152                 OPENSSL_free(fnd);
 153                 goto end;
 154             }
 155             fnd->funct = NULL;
 156             (void)lh_ENGINE_PILE_insert(&(*table)->piles, fnd);
 157         }
 158         /* A registration shouldn't add duplciate entries */
 159         (void)sk_ENGINE_delete_ptr(fnd->sk, e);
 160         /*
 161          * if 'setdefault', this ENGINE goes to the head of the list
 162          */
 163         if (!sk_ENGINE_push(fnd->sk, e))
 164             goto end;
 165         /* "touch" this ENGINE_PILE */
 166         fnd->uptodate = 0;
 167         if (setdefault) {
 168             if (!engine_unlocked_init(e)) {
 169                 ENGINEerr(ENGINE_F_ENGINE_TABLE_REGISTER,
 170                           ENGINE_R_INIT_FAILED);
 171                 goto end;
 172             }
 173             if (fnd->funct)
 174                 engine_unlocked_finish(fnd->funct, 0);
 175             fnd->funct = e;
 176             fnd->uptodate = 1;
 177         }
 178         nids++;
 179     }
 180     ret = 1;
 181  end:
 182     CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
 183     return ret;
 184 }
 185
 186 static void int_unregister_cb_doall_arg(ENGINE_PILE *pile, ENGINE *e)
 187 {
 188     int n;
 189     /* Iterate the 'c->sk' stack removing any occurrence of 'e' */
 190     while ((n = sk_ENGINE_find(pile->sk, e)) >= 0) {
 191         (void)sk_ENGINE_delete(pile->sk, n);
 192         pile->uptodate = 0;
 193     }
 194     if (pile->funct == e) {
 195         engine_unlocked_finish(e, 0);
 196         pile->funct = NULL;
 197     }
 198 }
 199
 200 static IMPLEMENT_LHASH_DOALL_ARG_FN(int_unregister_cb, ENGINE_PILE, ENGINE)
 201
 202 void engine_table_unregister(ENGINE_TABLE **table, ENGINE *e)
 203 {
 204     CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
 205     if (int_table_check(table, 0))
 206         lh_ENGINE_PILE_doall_arg(&(*table)->piles,
 207                                  LHASH_DOALL_ARG_FN(int_unregister_cb),
 208                                  ENGINE, e);
 209     CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
 210 }
 211
 212 static void int_cleanup_cb_doall(ENGINE_PILE *p)
 213 {
 214     if (!p)
 215         return;
 216     sk_ENGINE_free(p->sk);
 217     if (p->funct)
 218         engine_unlocked_finish(p->funct, 0);
 219     OPENSSL_free(p);
 220 }
 221
 222 void engine_table_cleanup(ENGINE_TABLE **table)
 223 {
 224     CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
 225     if (*table) {
 226         lh_ENGINE_PILE_doall(&(*table)->piles, int_cleanup_cb_doall);
 227         lh_ENGINE_PILE_free(&(*table)->piles);
 228         *table = NULL;
 229     }
 230     CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
 231 }
 232
 233 /* return a functional reference for a given 'nid' */
 234 #ifndef ENGINE_TABLE_DEBUG
 235 ENGINE *engine_table_select(ENGINE_TABLE **table, int nid)
 236 #else
 237 ENGINE *engine_table_select_tmp(ENGINE_TABLE **table, int nid, const char *f,
 238                                 int l)
 239 #endif
 240 {
 241     ENGINE *ret = NULL;
 242     ENGINE_PILE tmplate, *fnd = NULL;
 243     int initres, loop = 0;
 244
 245     if (!(*table)) {
 246 #ifdef ENGINE_TABLE_DEBUG
 247         fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, nothing "
 248                 "registered!\n", f, l, nid);
 249 #endif
 250         return NULL;
 251     }
 252     ERR_set_mark();
 253     CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
 254     /*
 255      * Check again inside the lock otherwise we could race against cleanup
 256      * operations. But don't worry about a fprintf(stderr).
 257      */
 258     if (!int_table_check(table, 0))
 259         goto end;
 260     tmplate.nid = nid;
 261     fnd = lh_ENGINE_PILE_retrieve(&(*table)->piles, &tmplate);
 262     if (!fnd)
 263         goto end;
 264     if (fnd->funct && engine_unlocked_init(fnd->funct)) {
 265 #ifdef ENGINE_TABLE_DEBUG
 266         fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, using "
 267                 "ENGINE '%s' cached\n", f, l, nid, fnd->funct->id);
 268 #endif
 269         ret = fnd->funct;
 270         goto end;
 271     }
 272     if (fnd->uptodate) {
 273         ret = fnd->funct;
 274         goto end;
 275     }
 276  trynext:
 277     ret = sk_ENGINE_value(fnd->sk, loop++);
 278     if (!ret) {
 279 #ifdef ENGINE_TABLE_DEBUG
 280         fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, no "
 281                 "registered implementations would initialise\n", f, l, nid);
 282 #endif
 283         goto end;
 284     }
 285     /* Try to initialise the ENGINE? */
 286     if ((ret->funct_ref > 0) || !(table_flags & ENGINE_TABLE_FLAG_NOINIT))
 287         initres = engine_unlocked_init(ret);
 288     else
 289         initres = 0;
 290     if (initres) {
 291         /* Update 'funct' */
 292         if ((fnd->funct != ret) && engine_unlocked_init(ret)) {
 293             /* If there was a previous default we release it. */
 294             if (fnd->funct)
 295                 engine_unlocked_finish(fnd->funct, 0);
 296             fnd->funct = ret;
 297 #ifdef ENGINE_TABLE_DEBUG
 298             fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, "
 299                     "setting default to '%s'\n", f, l, nid, ret->id);
 300 #endif
 301         }
 302 #ifdef ENGINE_TABLE_DEBUG
 303         fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, using "
 304                 "newly initialised '%s'\n", f, l, nid, ret->id);
 305 #endif
 306         goto end;
 307     }
 308     goto trynext;
 309  end:
 310     /*
 311      * If it failed, it is unlikely to succeed again until some future
 312      * registrations have taken place. In all cases, we cache.
 313      */
 314     if (fnd)
 315         fnd->uptodate = 1;
 316 #ifdef ENGINE_TABLE_DEBUG
 317     if (ret)
 318         fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, caching "
 319                 "ENGINE '%s'\n", f, l, nid, ret->id);
 320     else
 321         fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, caching "
 322                 "'no matching ENGINE'\n", f, l, nid);
 323 #endif
 324     CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
 325     /*
 326      * Whatever happened, any failed init()s are not failures in this
 327      * context, so clear our error state.
 328      */
 329     ERR_pop_to_mark();
 330     return ret;
 331 }
 332
 333 /* Table enumeration */
 334
 335 static void int_cb_doall_arg(ENGINE_PILE *pile, ENGINE_PILE_DOALL *dall)
 336 {
 337     dall->cb(pile->nid, pile->sk, pile->funct, dall->arg);
 338 }
 339
 340 static IMPLEMENT_LHASH_DOALL_ARG_FN(int_cb, ENGINE_PILE, ENGINE_PILE_DOALL)
 341
 342 void engine_table_doall(ENGINE_TABLE *table, engine_table_doall_cb *cb,
 343                         void *arg)
 344 {
 345     ENGINE_PILE_DOALL dall;
 346     dall.cb = cb;
 347     dall.arg = arg;
 348     if (table)
 349         lh_ENGINE_PILE_doall_arg(&table->piles,
 350                                  LHASH_DOALL_ARG_FN(int_cb),
 351                                  ENGINE_PILE_DOALL, &dall);
 352 }