crypto/conf/conf_mod.c

   1 /*
   2  * Written by Stephen Henson (steve@openssl.org) for the OpenSSL project
   3  * 2001.
   4  */
   5 /* ====================================================================
   6  * Copyright (c) 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 <stdio.h>
  60 #include <ctype.h>
  61 #include <openssl/crypto.h>
  62 #include "internal/cryptlib.h"
  63 #include <openssl/conf.h>
  64 #include <openssl/dso.h>
  65 #include <openssl/x509.h>
  66
  67 #define DSO_mod_init_name "OPENSSL_init"
  68 #define DSO_mod_finish_name "OPENSSL_finish"
  69
  70 /*
  71  * This structure contains a data about supported modules. entries in this
  72  * table correspond to either dynamic or static modules.
  73  */
  74
  75 struct conf_module_st {
  76     /* DSO of this module or NULL if static */
  77     DSO *dso;
  78     /* Name of the module */
  79     char *name;
  80     /* Init function */
  81     conf_init_func *init;
  82     /* Finish function */
  83     conf_finish_func *finish;
  84     /* Number of successfully initialized modules */
  85     int links;
  86     void *usr_data;
  87 };
  88
  89 /*
  90  * This structure contains information about modules that have been
  91  * successfully initialized. There may be more than one entry for a given
  92  * module.
  93  */
  94
  95 struct conf_imodule_st {
  96     CONF_MODULE *pmod;
  97     char *name;
  98     char *value;
  99     unsigned long flags;
 100     void *usr_data;
 101 };
 102
 103 static STACK_OF(CONF_MODULE) *supported_modules = NULL;
 104 static STACK_OF(CONF_IMODULE) *initialized_modules = NULL;
 105
 106 static void module_free(CONF_MODULE *md);
 107 static void module_finish(CONF_IMODULE *imod);
 108 static int module_run(const CONF *cnf, char *name, char *value,
 109                       unsigned long flags);
 110 static CONF_MODULE *module_add(DSO *dso, const char *name,
 111                                conf_init_func *ifunc,
 112                                conf_finish_func *ffunc);
 113 static CONF_MODULE *module_find(char *name);
 114 static int module_init(CONF_MODULE *pmod, char *name, char *value,
 115                        const CONF *cnf);
 116 static CONF_MODULE *module_load_dso(const CONF *cnf, char *name, char *value,
 117                                     unsigned long flags);
 118
 119 /* Main function: load modules from a CONF structure */
 120
 121 int CONF_modules_load(const CONF *cnf, const char *appname,
 122                       unsigned long flags)
 123 {
 124     STACK_OF(CONF_VALUE) *values;
 125     CONF_VALUE *vl;
 126     char *vsection = NULL;
 127
 128     int ret, i;
 129
 130     if (!cnf)
 131         return 1;
 132
 133     if (appname)
 134         vsection = NCONF_get_string(cnf, NULL, appname);
 135
 136     if (!appname || (!vsection && (flags & CONF_MFLAGS_DEFAULT_SECTION)))
 137         vsection = NCONF_get_string(cnf, NULL, "openssl_conf");
 138
 139     if (!vsection) {
 140         ERR_clear_error();
 141         return 1;
 142     }
 143
 144     values = NCONF_get_section(cnf, vsection);
 145
 146     if (!values)
 147         return 0;
 148
 149     for (i = 0; i < sk_CONF_VALUE_num(values); i++) {
 150         vl = sk_CONF_VALUE_value(values, i);
 151         ret = module_run(cnf, vl->name, vl->value, flags);
 152         if (ret <= 0)
 153             if (!(flags & CONF_MFLAGS_IGNORE_ERRORS))
 154                 return ret;
 155     }
 156
 157     return 1;
 158
 159 }
 160
 161 int CONF_modules_load_file(const char *filename, const char *appname,
 162                            unsigned long flags)
 163 {
 164     char *file = NULL;
 165     CONF *conf = NULL;
 166     int ret = 0;
 167     conf = NCONF_new(NULL);
 168     if (conf == NULL)
 169         goto err;
 170
 171     if (filename == NULL) {
 172         file = CONF_get1_default_config_file();
 173         if (!file)
 174             goto err;
 175     } else
 176         file = (char *)filename;
 177
 178     if (NCONF_load(conf, file, NULL) <= 0) {
 179         if ((flags & CONF_MFLAGS_IGNORE_MISSING_FILE) &&
 180             (ERR_GET_REASON(ERR_peek_last_error()) == CONF_R_NO_SUCH_FILE)) {
 181             ERR_clear_error();
 182             ret = 1;
 183         }
 184         goto err;
 185     }
 186
 187     ret = CONF_modules_load(conf, appname, flags);
 188
 189  err:
 190     if (filename == NULL)
 191         OPENSSL_free(file);
 192     NCONF_free(conf);
 193
 194     return ret;
 195 }
 196
 197 static int module_run(const CONF *cnf, char *name, char *value,
 198                       unsigned long flags)
 199 {
 200     CONF_MODULE *md;
 201     int ret;
 202
 203     md = module_find(name);
 204
 205     /* Module not found: try to load DSO */
 206     if (!md && !(flags & CONF_MFLAGS_NO_DSO))
 207         md = module_load_dso(cnf, name, value, flags);
 208
 209     if (!md) {
 210         if (!(flags & CONF_MFLAGS_SILENT)) {
 211             CONFerr(CONF_F_MODULE_RUN, CONF_R_UNKNOWN_MODULE_NAME);
 212             ERR_add_error_data(2, "module=", name);
 213         }
 214         return -1;
 215     }
 216
 217     ret = module_init(md, name, value, cnf);
 218
 219     if (ret <= 0) {
 220         if (!(flags & CONF_MFLAGS_SILENT)) {
 221             char rcode[DECIMAL_SIZE(ret) + 1];
 222             CONFerr(CONF_F_MODULE_RUN, CONF_R_MODULE_INITIALIZATION_ERROR);
 223             BIO_snprintf(rcode, sizeof rcode, "%-8d", ret);
 224             ERR_add_error_data(6, "module=", name, ", value=", value,
 225                                ", retcode=", rcode);
 226         }
 227     }
 228
 229     return ret;
 230 }
 231
 232 /* Load a module from a DSO */
 233 static CONF_MODULE *module_load_dso(const CONF *cnf, char *name, char *value,
 234                                     unsigned long flags)
 235 {
 236     DSO *dso = NULL;
 237     conf_init_func *ifunc;
 238     conf_finish_func *ffunc;
 239     char *path = NULL;
 240     int errcode = 0;
 241     CONF_MODULE *md;
 242     /* Look for alternative path in module section */
 243     path = NCONF_get_string(cnf, value, "path");
 244     if (!path) {
 245         ERR_clear_error();
 246         path = name;
 247     }
 248     dso = DSO_load(NULL, path, NULL, 0);
 249     if (!dso) {
 250         errcode = CONF_R_ERROR_LOADING_DSO;
 251         goto err;
 252     }
 253     ifunc = (conf_init_func *)DSO_bind_func(dso, DSO_mod_init_name);
 254     if (!ifunc) {
 255         errcode = CONF_R_MISSING_INIT_FUNCTION;
 256         goto err;
 257     }
 258     ffunc = (conf_finish_func *)DSO_bind_func(dso, DSO_mod_finish_name);
 259     /* All OK, add module */
 260     md = module_add(dso, name, ifunc, ffunc);
 261
 262     if (!md)
 263         goto err;
 264
 265     return md;
 266
 267  err:
 268     DSO_free(dso);
 269     CONFerr(CONF_F_MODULE_LOAD_DSO, errcode);
 270     ERR_add_error_data(4, "module=", name, ", path=", path);
 271     return NULL;
 272 }
 273
 274 /* add module to list */
 275 static CONF_MODULE *module_add(DSO *dso, const char *name,
 276                                conf_init_func *ifunc, conf_finish_func *ffunc)
 277 {
 278     CONF_MODULE *tmod = NULL;
 279     if (supported_modules == NULL)
 280         supported_modules = sk_CONF_MODULE_new_null();
 281     if (supported_modules == NULL)
 282         return NULL;
 283     tmod = OPENSSL_zalloc(sizeof(*tmod));
 284     if (tmod == NULL)
 285         return NULL;
 286
 287     tmod->dso = dso;
 288     tmod->name = OPENSSL_strdup(name);
 289     tmod->init = ifunc;
 290     tmod->finish = ffunc;
 291
 292     if (!sk_CONF_MODULE_push(supported_modules, tmod)) {
 293         OPENSSL_free(tmod);
 294         return NULL;
 295     }
 296
 297     return tmod;
 298 }
 299
 300 /*
 301  * Find a module from the list. We allow module names of the form
 302  * modname.XXXX to just search for modname to allow the same module to be
 303  * initialized more than once.
 304  */
 305
 306 static CONF_MODULE *module_find(char *name)
 307 {
 308     CONF_MODULE *tmod;
 309     int i, nchar;
 310     char *p;
 311     p = strrchr(name, '.');
 312
 313     if (p)
 314         nchar = p - name;
 315     else
 316         nchar = strlen(name);
 317
 318     for (i = 0; i < sk_CONF_MODULE_num(supported_modules); i++) {
 319         tmod = sk_CONF_MODULE_value(supported_modules, i);
 320         if (strncmp(tmod->name, name, nchar) == 0)
 321             return tmod;
 322     }
 323
 324     return NULL;
 325
 326 }
 327
 328 /* initialize a module */
 329 static int module_init(CONF_MODULE *pmod, char *name, char *value,
 330                        const CONF *cnf)
 331 {
 332     int ret = 1;
 333     int init_called = 0;
 334     CONF_IMODULE *imod = NULL;
 335
 336     /* Otherwise add initialized module to list */
 337     imod = OPENSSL_malloc(sizeof(*imod));
 338     if (imod == NULL)
 339         goto err;
 340
 341     imod->pmod = pmod;
 342     imod->name = OPENSSL_strdup(name);
 343     imod->value = OPENSSL_strdup(value);
 344     imod->usr_data = NULL;
 345
 346     if (!imod->name || !imod->value)
 347         goto memerr;
 348
 349     /* Try to initialize module */
 350     if (pmod->init) {
 351         ret = pmod->init(imod, cnf);
 352         init_called = 1;
 353         /* Error occurred, exit */
 354         if (ret <= 0)
 355             goto err;
 356     }
 357
 358     if (initialized_modules == NULL) {
 359         initialized_modules = sk_CONF_IMODULE_new_null();
 360         if (!initialized_modules) {
 361             CONFerr(CONF_F_MODULE_INIT, ERR_R_MALLOC_FAILURE);
 362             goto err;
 363         }
 364     }
 365
 366     if (!sk_CONF_IMODULE_push(initialized_modules, imod)) {
 367         CONFerr(CONF_F_MODULE_INIT, ERR_R_MALLOC_FAILURE);
 368         goto err;
 369     }
 370
 371     pmod->links++;
 372
 373     return ret;
 374
 375  err:
 376
 377     /* We've started the module so we'd better finish it */
 378     if (pmod->finish && init_called)
 379         pmod->finish(imod);
 380
 381  memerr:
 382     if (imod) {
 383         OPENSSL_free(imod->name);
 384         OPENSSL_free(imod->value);
 385         OPENSSL_free(imod);
 386     }
 387
 388     return -1;
 389
 390 }
 391
 392 /*
 393  * Unload any dynamic modules that have a link count of zero: i.e. have no
 394  * active initialized modules. If 'all' is set then all modules are unloaded
 395  * including static ones.
 396  */
 397
 398 void CONF_modules_unload(int all)
 399 {
 400     int i;
 401     CONF_MODULE *md;
 402     CONF_modules_finish();
 403     /* unload modules in reverse order */
 404     for (i = sk_CONF_MODULE_num(supported_modules) - 1; i >= 0; i--) {
 405         md = sk_CONF_MODULE_value(supported_modules, i);
 406         /* If static or in use and 'all' not set ignore it */
 407         if (((md->links > 0) || !md->dso) && !all)
 408             continue;
 409         /* Since we're working in reverse this is OK */
 410         (void)sk_CONF_MODULE_delete(supported_modules, i);
 411         module_free(md);
 412     }
 413     if (sk_CONF_MODULE_num(supported_modules) == 0) {
 414         sk_CONF_MODULE_free(supported_modules);
 415         supported_modules = NULL;
 416     }
 417 }
 418
 419 /* unload a single module */
 420 static void module_free(CONF_MODULE *md)
 421 {
 422     DSO_free(md->dso);
 423     OPENSSL_free(md->name);
 424     OPENSSL_free(md);
 425 }
 426
 427 /* finish and free up all modules instances */
 428
 429 void CONF_modules_finish(void)
 430 {
 431     CONF_IMODULE *imod;
 432     while (sk_CONF_IMODULE_num(initialized_modules) > 0) {
 433         imod = sk_CONF_IMODULE_pop(initialized_modules);
 434         module_finish(imod);
 435     }
 436     sk_CONF_IMODULE_free(initialized_modules);
 437     initialized_modules = NULL;
 438 }
 439
 440 /* finish a module instance */
 441
 442 static void module_finish(CONF_IMODULE *imod)
 443 {
 444     if (!imod)
 445         return;
 446     if (imod->pmod->finish)
 447         imod->pmod->finish(imod);
 448     imod->pmod->links--;
 449     OPENSSL_free(imod->name);
 450     OPENSSL_free(imod->value);
 451     OPENSSL_free(imod);
 452 }
 453
 454 /* Add a static module to OpenSSL */
 455
 456 int CONF_module_add(const char *name, conf_init_func *ifunc,
 457                     conf_finish_func *ffunc)
 458 {
 459     if (module_add(NULL, name, ifunc, ffunc))
 460         return 1;
 461     else
 462         return 0;
 463 }
 464
 465 void CONF_modules_free(void)
 466 {
 467     CONF_modules_finish();
 468     CONF_modules_unload(1);
 469 }
 470
 471 /* Utility functions */
 472
 473 const char *CONF_imodule_get_name(const CONF_IMODULE *md)
 474 {
 475     return md->name;
 476 }
 477
 478 const char *CONF_imodule_get_value(const CONF_IMODULE *md)
 479 {
 480     return md->value;
 481 }
 482
 483 void *CONF_imodule_get_usr_data(const CONF_IMODULE *md)
 484 {
 485     return md->usr_data;
 486 }
 487
 488 void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data)
 489 {
 490     md->usr_data = usr_data;
 491 }
 492
 493 CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md)
 494 {
 495     return md->pmod;
 496 }
 497
 498 unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md)
 499 {
 500     return md->flags;
 501 }
 502
 503 void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags)
 504 {
 505     md->flags = flags;
 506 }
 507
 508 void *CONF_module_get_usr_data(CONF_MODULE *pmod)
 509 {
 510     return pmod->usr_data;
 511 }
 512
 513 void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data)
 514 {
 515     pmod->usr_data = usr_data;
 516 }
 517
 518 /* Return default config file name */
 519
 520 char *CONF_get1_default_config_file(void)
 521 {
 522     char *file;
 523     int len;
 524
 525     file = getenv("OPENSSL_CONF");
 526     if (file)
 527         return OPENSSL_strdup(file);
 528
 529     len = strlen(X509_get_default_cert_area());
 530 #ifndef OPENSSL_SYS_VMS
 531     len++;
 532 #endif
 533     len += strlen(OPENSSL_CONF);
 534
 535     file = OPENSSL_malloc(len + 1);
 536
 537     if (file == NULL)
 538         return NULL;
 539     OPENSSL_strlcpy(file, X509_get_default_cert_area(), len + 1);
 540 #ifndef OPENSSL_SYS_VMS
 541     OPENSSL_strlcat(file, "/", len + 1);
 542 #endif
 543     OPENSSL_strlcat(file, OPENSSL_CONF, len + 1);
 544
 545     return file;
 546 }
 547
 548 /*
 549  * This function takes a list separated by 'sep' and calls the callback
 550  * function giving the start and length of each member optionally stripping
 551  * leading and trailing whitespace. This can be used to parse comma separated
 552  * lists for example.
 553  */
 554
 555 int CONF_parse_list(const char *list_, int sep, int nospc,
 556                     int (*list_cb) (const char *elem, int len, void *usr),
 557                     void *arg)
 558 {
 559     int ret;
 560     const char *lstart, *tmpend, *p;
 561
 562     if (list_ == NULL) {
 563         CONFerr(CONF_F_CONF_PARSE_LIST, CONF_R_LIST_CANNOT_BE_NULL);
 564         return 0;
 565     }
 566
 567     lstart = list_;
 568     for (;;) {
 569         if (nospc) {
 570             while (*lstart && isspace((unsigned char)*lstart))
 571                 lstart++;
 572         }
 573         p = strchr(lstart, sep);
 574         if (p == lstart || !*lstart)
 575             ret = list_cb(NULL, 0, arg);
 576         else {
 577             if (p)
 578                 tmpend = p - 1;
 579             else
 580                 tmpend = lstart + strlen(lstart) - 1;
 581             if (nospc) {
 582                 while (isspace((unsigned char)*tmpend))
 583                     tmpend--;
 584             }
 585             ret = list_cb(lstart, tmpend - lstart + 1, arg);
 586         }
 587         if (ret <= 0)
 588             return ret;
 589         if (p == NULL)
 590             return 1;
 591         lstart = p + 1;
 592     }
 593 }