crypto/engine/eng_dyn.c

   1 /* crypto/engine/eng_dyn.c */
   2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
   3  * project 2001.
   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
  60 #include <stdio.h>
  61 #include <openssl/crypto.h>
  62 #include "cryptlib.h"
  63 #include "eng_int.h"
  64 #include <openssl/engine.h>
  65 #include <openssl/dso.h>
  66
  67 /* Shared libraries implementing ENGINEs for use by the "dynamic" ENGINE loader
  68  * should implement the hook-up functions with the following prototypes. */
  69
  70 /* Our ENGINE handlers */
  71 static int dynamic_init(ENGINE *e);
  72 static int dynamic_finish(ENGINE *e);
  73 static int dynamic_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)());
  74 /* Predeclare our context type */
  75 typedef struct st_dynamic_data_ctx dynamic_data_ctx;
  76 /* The implementation for the important control command */
  77 static int dynamic_load(ENGINE *e, dynamic_data_ctx *ctx);
  78
  79 #define DYNAMIC_CMD_SO_PATH             ENGINE_CMD_BASE
  80 #define DYNAMIC_CMD_NO_VCHECK           (ENGINE_CMD_BASE + 1)
  81 #define DYNAMIC_CMD_ENGINE_ID           (ENGINE_CMD_BASE + 2)
  82 #define DYNAMIC_CMD_LIST_ADD            (ENGINE_CMD_BASE + 3)
  83 #define DYNAMIC_CMD_LOAD                (ENGINE_CMD_BASE + 4)
  84
  85 /* The constants used when creating the ENGINE */
  86 static const char *engine_dynamic_id = "dynamic";
  87 static const char *engine_dynamic_name = "Dynamic engine loading support";
  88 static const ENGINE_CMD_DEFN dynamic_cmd_defns[] = {
  89         {DYNAMIC_CMD_SO_PATH,
  90                 "SO_PATH",
  91                 "Specifies the path to the new ENGINE shared library",
  92                 ENGINE_CMD_FLAG_STRING},
  93         {DYNAMIC_CMD_NO_VCHECK,
  94                 "NO_VCHECK",
  95                 "Specifies to continue even if version checking fails (boolean)",
  96                 ENGINE_CMD_FLAG_NUMERIC},
  97         {DYNAMIC_CMD_ENGINE_ID,
  98                 "ENGINE_ID",
  99                 "Specifies an ENGINE id name for loading",
 100                 ENGINE_CMD_FLAG_STRING},
 101         {DYNAMIC_CMD_LIST_ADD,
 102                 "LIST_ADD",
 103                 "Whether to add a loaded ENGINE to the internal list (0=no,1=yes,2=mandatory)",
 104                 ENGINE_CMD_FLAG_NUMERIC},
 105         {DYNAMIC_CMD_LOAD,
 106                 "LOAD",
 107                 "Load up the ENGINE specified by other settings",
 108                 ENGINE_CMD_FLAG_NO_INPUT},
 109         {0, NULL, NULL, 0}
 110         };
 111 static const ENGINE_CMD_DEFN dynamic_cmd_defns_empty[] = {
 112         {0, NULL, NULL, 0}
 113         };
 114
 115 /* Loading code stores state inside the ENGINE structure via the "ex_data"
 116  * element. We load all our state into a single structure and use that as a
 117  * single context in the "ex_data" stack. */
 118 struct st_dynamic_data_ctx
 119         {
 120         /* The DSO object we load that supplies the ENGINE code */
 121         DSO *dynamic_dso;
 122         /* The function pointer to the version checking shared library function */
 123         dynamic_v_check_fn v_check;
 124         /* The function pointer to the engine-binding shared library function */
 125         dynamic_bind_engine bind_engine;
 126         /* The default name/path for loading the shared library */
 127         const char *DYNAMIC_LIBNAME;
 128         /* Whether to continue loading on a version check failure */
 129         int no_vcheck;
 130         /* If non-NULL, stipulates the 'id' of the ENGINE to be loaded */
 131         const char *engine_id;
 132         /* If non-zero, a successfully loaded ENGINE should be added to the internal
 133          * ENGINE list. If 2, the add must succeed or the entire load should fail. */
 134         int list_add_value;
 135         /* The symbol name for the version checking function */
 136         const char *DYNAMIC_F1;
 137         /* The symbol name for the "initialise ENGINE structure" function */
 138         const char *DYNAMIC_F2;
 139         };
 140
 141 /* This is the "ex_data" index we obtain and reserve for use with our context
 142  * structure. */
 143 static int dynamic_ex_data_idx = -1;
 144
 145 /* Because our ex_data element may or may not get allocated depending on whether
 146  * a "first-use" occurs before the ENGINE is freed, we have a memory leak
 147  * problem to solve. We can't declare a "new" handler for the ex_data as we
 148  * don't want a dynamic_data_ctx in *all* ENGINE structures of all types (this
 149  * is a bug in the design of CRYPTO_EX_DATA). As such, we just declare a "free"
 150  * handler and that will get called if an ENGINE is being destroyed and there
 151  * was an ex_data element corresponding to our context type. */
 152 static void dynamic_data_ctx_free_func(void *parent, void *ptr,
 153                         CRYPTO_EX_DATA *ad, int idx, long argl, void *argp)
 154         {
 155         if(ptr)
 156                 {
 157                 dynamic_data_ctx *ctx = (dynamic_data_ctx *)ptr;
 158                 if(ctx->dynamic_dso)
 159                         DSO_free(ctx->dynamic_dso);
 160                 OPENSSL_free(ctx);
 161                 }
 162         }
 163
 164 /* Construct the per-ENGINE context. We create it blindly and then use a lock to
 165  * check for a race - if so, all but one of the threads "racing" will have
 166  * wasted their time. The alternative involves creating everything inside the
 167  * lock which is far worse. */
 168 static int dynamic_set_data_ctx(ENGINE *e, dynamic_data_ctx **ctx)
 169         {
 170         dynamic_data_ctx *c;
 171         c = OPENSSL_malloc(sizeof(dynamic_data_ctx));
 172         if(!ctx)
 173                 {
 174                 ENGINEerr(ENGINE_F_SET_DATA_CTX,ERR_R_MALLOC_FAILURE);
 175                 return 0;
 176                 }
 177         memset(c, 0, sizeof(dynamic_data_ctx));
 178         c->dynamic_dso = NULL;
 179         c->v_check = NULL;
 180         c->bind_engine = NULL;
 181         c->DYNAMIC_LIBNAME = NULL;
 182         c->no_vcheck = 0;
 183         c->engine_id = NULL;
 184         c->list_add_value = 0;
 185         c->DYNAMIC_F1 = "v_check";
 186         c->DYNAMIC_F2 = "bind_engine";
 187         CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
 188         if((*ctx = (dynamic_data_ctx *)ENGINE_get_ex_data(e,
 189                                 dynamic_ex_data_idx)) == NULL)
 190                 {
 191                 /* Good, we're the first */
 192                 ENGINE_set_ex_data(e, dynamic_ex_data_idx, c);
 193                 *ctx = c;
 194                 c = NULL;
 195                 }
 196         CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
 197         /* If we lost the race to set the context, c is non-NULL and *ctx is the
 198          * context of the thread that won. */
 199         if(c)
 200                 OPENSSL_free(c);
 201         return 1;
 202         }
 203
 204 /* This function retrieves the context structure from an ENGINE's "ex_data", or
 205  * if it doesn't exist yet, sets it up. */
 206 static dynamic_data_ctx *dynamic_get_data_ctx(ENGINE *e)
 207         {
 208         dynamic_data_ctx *ctx;
 209         if(dynamic_ex_data_idx < 0)
 210                 {
 211                 /* Create and register the ENGINE ex_data, and associate our
 212                  * "free" function with it to ensure any allocated contexts get
 213                  * freed when an ENGINE goes underground. */
 214                 int new_idx = ENGINE_get_ex_new_index(0, NULL, NULL, NULL,
 215                                         dynamic_data_ctx_free_func);
 216                 if(new_idx == -1)
 217                         {
 218                         ENGINEerr(ENGINE_F_DYNAMIC_GET_DATA_CTX,ENGINE_R_NO_INDEX);
 219                         return NULL;
 220                         }
 221                 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
 222                 /* Avoid a race by checking again inside this lock */
 223                 if(dynamic_ex_data_idx < 0)
 224                         {
 225                         /* Good, someone didn't beat us to it */
 226                         dynamic_ex_data_idx = new_idx;
 227                         new_idx = -1;
 228                         }
 229                 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
 230                 /* In theory we could "give back" the index here if
 231                  * (new_idx>-1), but it's not possible and wouldn't gain us much
 232                  * if it were. */
 233                 }
 234         ctx = (dynamic_data_ctx *)ENGINE_get_ex_data(e, dynamic_ex_data_idx);
 235         /* Check if the context needs to be created */
 236         if((ctx == NULL) && !dynamic_set_data_ctx(e, &ctx))
 237                 /* "set_data" will set errors if necessary */
 238                 return NULL;
 239         return ctx;
 240         }
 241
 242 static ENGINE *engine_dynamic(void)
 243         {
 244         ENGINE *ret = ENGINE_new();
 245         if(!ret)
 246                 return NULL;
 247         if(!ENGINE_set_id(ret, engine_dynamic_id) ||
 248                         !ENGINE_set_name(ret, engine_dynamic_name) ||
 249                         !ENGINE_set_init_function(ret, dynamic_init) ||
 250                         !ENGINE_set_finish_function(ret, dynamic_finish) ||
 251                         !ENGINE_set_ctrl_function(ret, dynamic_ctrl) ||
 252                         !ENGINE_set_flags(ret, ENGINE_FLAGS_BY_ID_COPY) ||
 253                         !ENGINE_set_cmd_defns(ret, dynamic_cmd_defns))
 254                 {
 255                 ENGINE_free(ret);
 256                 return NULL;
 257                 }
 258         return ret;
 259         }
 260
 261 void ENGINE_load_dynamic(void)
 262         {
 263         ENGINE *toadd = engine_dynamic();
 264         if(!toadd) return;
 265         ENGINE_add(toadd);
 266         /* If the "add" worked, it gets a structural reference. So either way,
 267          * we release our just-created reference. */
 268         ENGINE_free(toadd);
 269         /* If the "add" didn't work, it was probably a conflict because it was
 270          * already added (eg. someone calling ENGINE_load_blah then calling
 271          * ENGINE_load_builtin_engines() perhaps). */
 272         ERR_clear_error();
 273         }
 274
 275 static int dynamic_init(ENGINE *e)
 276         {
 277         /* We always return failure - the "dyanamic" engine itself can't be used
 278          * for anything. */
 279         return 0;
 280         }
 281
 282 static int dynamic_finish(ENGINE *e)
 283         {
 284         /* This should never be called on account of "dynamic_init" always
 285          * failing. */
 286         return 0;
 287         }
 288
 289 static int dynamic_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)())
 290         {
 291         dynamic_data_ctx *ctx = dynamic_get_data_ctx(e);
 292         int initialised;
 293
 294         if(!ctx)
 295                 {
 296                 ENGINEerr(ENGINE_F_DYNAMIC_CTRL,ENGINE_R_NOT_LOADED);
 297                 return 0;
 298                 }
 299         initialised = ((ctx->dynamic_dso == NULL) ? 0 : 1);
 300         /* All our control commands require the ENGINE to be uninitialised */
 301         if(initialised)
 302                 {
 303                 ENGINEerr(ENGINE_F_DYNAMIC_CTRL,
 304                         ENGINE_R_ALREADY_LOADED);
 305                 return 0;
 306                 }
 307         switch(cmd)
 308                 {
 309         case DYNAMIC_CMD_SO_PATH:
 310                 /* a NULL 'p' or a string of zero-length is the same thing */
 311                 if(p && (strlen((const char *)p) < 1))
 312                         p = NULL;
 313                 ctx->DYNAMIC_LIBNAME = (const char *)p;
 314                 return 1;
 315         case DYNAMIC_CMD_NO_VCHECK:
 316                 ctx->no_vcheck = ((i == 0) ? 0 : 1);
 317                 return 1;
 318         case DYNAMIC_CMD_ENGINE_ID:
 319                 /* a NULL 'p' or a string of zero-length is the same thing */
 320                 if(p && (strlen((const char *)p) < 1))
 321                         p = NULL;
 322                 ctx->engine_id = (const char *)p;
 323                 return 1;
 324         case DYNAMIC_CMD_LIST_ADD:
 325                 if((i < 0) || (i > 2))
 326                         {
 327                         ENGINEerr(ENGINE_F_DYNAMIC_CTRL,
 328                                 ENGINE_R_INVALID_ARGUMENT);
 329                         return 0;
 330                         }
 331                 ctx->list_add_value = (int)i;
 332                 return 1;
 333         case DYNAMIC_CMD_LOAD:
 334                 return dynamic_load(e, ctx);
 335         default:
 336                 break;
 337                 }
 338         ENGINEerr(ENGINE_F_DYNAMIC_CTRL,ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED);
 339         return 0;
 340         }
 341
 342 static int dynamic_load(ENGINE *e, dynamic_data_ctx *ctx)
 343         {
 344         ENGINE cpy;
 345         dynamic_fns fns;
 346
 347         if(!ctx->DYNAMIC_LIBNAME || ((ctx->dynamic_dso = DSO_load(NULL,
 348                                 ctx->DYNAMIC_LIBNAME, NULL, 0)) == NULL))
 349                 {
 350                 ENGINEerr(ENGINE_F_DYNAMIC_LOAD,
 351                         ENGINE_R_DSO_NOT_FOUND);
 352                 return 0;
 353                 }
 354         /* We have to find a bind function otherwise it'll always end badly */
 355         if(!(ctx->bind_engine = (dynamic_bind_engine)DSO_bind_func(
 356                                         ctx->dynamic_dso, ctx->DYNAMIC_F2)))
 357                 {
 358                 ctx->bind_engine = NULL;
 359                 DSO_free(ctx->dynamic_dso);
 360                 ctx->dynamic_dso = NULL;
 361                 ENGINEerr(ENGINE_F_DYNAMIC_LOAD,
 362                         ENGINE_R_DSO_FAILURE);
 363                 return 0;
 364                 }
 365         /* Do we perform version checking? */
 366         if(!ctx->no_vcheck)
 367                 {
 368                 unsigned long vcheck_res = 0;
 369                 /* Now we try to find a version checking function and decide how
 370                  * to cope with failure if/when it fails. */
 371                 ctx->v_check = (dynamic_v_check_fn)DSO_bind_func(
 372                                 ctx->dynamic_dso, ctx->DYNAMIC_F1);
 373                 if(ctx->v_check)
 374                         vcheck_res = ctx->v_check(OSSL_DYNAMIC_VERSION);
 375                 /* We fail if the version checker veto'd the load *or* if it is
 376                  * deferring to us (by returning its version) and we think it is
 377                  * too old. */
 378                 if(vcheck_res < OSSL_DYNAMIC_OLDEST)
 379                         {
 380                         /* Fail */
 381                         ctx->bind_engine = NULL;
 382                         ctx->v_check = NULL;
 383                         DSO_free(ctx->dynamic_dso);
 384                         ctx->dynamic_dso = NULL;
 385                         ENGINEerr(ENGINE_F_DYNAMIC_LOAD,
 386                                 ENGINE_R_VERSION_INCOMPATIBILITY);
 387                         return 0;
 388                         }
 389                 }
 390         /* First binary copy the ENGINE structure so that we can roll back if
 391          * the hand-over fails */
 392         memcpy(&cpy, e, sizeof(ENGINE));
 393         /* Provide the ERR, "ex_data", memory, and locking callbacks so the
 394          * loaded library uses our state rather than its own. FIXME: As noted in
 395          * engine.h, much of this would be simplified if each area of code
 396          * provided its own "summary" structure of all related callbacks. It
 397          * would also increase opaqueness. */
 398         fns.err_fns = ERR_get_implementation();
 399         fns.ex_data_fns = CRYPTO_get_ex_data_implementation();
 400         CRYPTO_get_mem_functions(&fns.mem_fns.malloc_cb,
 401                                 &fns.mem_fns.realloc_cb,
 402                                 &fns.mem_fns.free_cb);
 403         fns.lock_fns.lock_locking_cb = CRYPTO_get_locking_callback();
 404         fns.lock_fns.lock_add_lock_cb = CRYPTO_get_add_lock_callback();
 405         fns.lock_fns.dynlock_create_cb = CRYPTO_get_dynlock_create_callback();
 406         fns.lock_fns.dynlock_lock_cb = CRYPTO_get_dynlock_lock_callback();
 407         fns.lock_fns.dynlock_destroy_cb = CRYPTO_get_dynlock_destroy_callback();
 408         /* Now that we've loaded the dynamic engine, make sure no "dynamic"
 409          * ENGINE elements will show through. */
 410         engine_set_all_null(e);
 411
 412         /* Try to bind the ENGINE onto our own ENGINE structure */
 413         if(!ctx->bind_engine(e, ctx->engine_id, &fns))
 414                 {
 415                 ctx->bind_engine = NULL;
 416                 ctx->v_check = NULL;
 417                 DSO_free(ctx->dynamic_dso);
 418                 ctx->dynamic_dso = NULL;
 419                 ENGINEerr(ENGINE_F_DYNAMIC_LOAD,ENGINE_R_INIT_FAILED);
 420                 /* Copy the original ENGINE structure back */
 421                 memcpy(e, &cpy, sizeof(ENGINE));
 422                 return 0;
 423                 }
 424         /* Do we try to add this ENGINE to the internal list too? */
 425         if(ctx->list_add_value > 0)
 426                 {
 427                 if(!ENGINE_add(e))
 428                         {
 429                         /* Do we tolerate this or fail? */
 430                         if(ctx->list_add_value > 1)
 431                                 {
 432                                 /* Fail - NB: By this time, it's too late to
 433                                  * rollback, and trying to do so allows the
 434                                  * bind_engine() code to have created leaks. We
 435                                  * just have to fail where we are, after the
 436                                  * ENGINE has changed. */
 437                                 ENGINEerr(ENGINE_F_DYNAMIC_LOAD,
 438                                         ENGINE_R_CONFLICTING_ENGINE_ID);
 439                                 return 0;
 440                                 }
 441                         /* Tolerate */
 442                         ERR_clear_error();
 443                         }
 444                 }
 445         return 1;
 446         }