crypto/conf/conf_mod.c

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