2 * Copyright 2002-2017 The OpenSSL Project Authors. All Rights Reserved.
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
12 #include <openssl/crypto.h>
13 #include "internal/cryptlib.h"
15 #include "internal/conf.h"
16 #include "internal/dso.h"
17 #include <openssl/x509.h>
19 #define DSO_mod_init_name "OPENSSL_init"
20 #define DSO_mod_finish_name "OPENSSL_finish"
23 * This structure contains a data about supported modules. entries in this
24 * table correspond to either dynamic or static modules.
27 struct conf_module_st {
28 /* DSO of this module or NULL if static */
30 /* Name of the module */
35 conf_finish_func *finish;
36 /* Number of successfully initialized modules */
42 * This structure contains information about modules that have been
43 * successfully initialized. There may be more than one entry for a given
47 struct conf_imodule_st {
55 static STACK_OF(CONF_MODULE) *supported_modules = NULL;
56 static STACK_OF(CONF_IMODULE) *initialized_modules = NULL;
58 static void module_free(CONF_MODULE *md);
59 static void module_finish(CONF_IMODULE *imod);
60 static int module_run(const CONF *cnf, const char *name, const char *value,
62 static CONF_MODULE *module_add(DSO *dso, const char *name,
63 conf_init_func *ifunc,
64 conf_finish_func *ffunc);
65 static CONF_MODULE *module_find(const char *name);
66 static int module_init(CONF_MODULE *pmod, const char *name, const char *value,
68 static CONF_MODULE *module_load_dso(const CONF *cnf, const char *name,
71 /* Main function: load modules from a CONF structure */
73 int CONF_modules_load(const CONF *cnf, const char *appname,
76 STACK_OF(CONF_VALUE) *values;
78 char *vsection = NULL;
86 vsection = NCONF_get_string(cnf, NULL, appname);
88 if (!appname || (!vsection && (flags & CONF_MFLAGS_DEFAULT_SECTION)))
89 vsection = NCONF_get_string(cnf, NULL, "openssl_conf");
96 values = NCONF_get_section(cnf, vsection);
101 for (i = 0; i < sk_CONF_VALUE_num(values); i++) {
102 vl = sk_CONF_VALUE_value(values, i);
103 ret = module_run(cnf, vl->name, vl->value, flags);
105 if (!(flags & CONF_MFLAGS_IGNORE_ERRORS))
113 int CONF_modules_load_file(const char *filename, const char *appname,
119 conf = NCONF_new(NULL);
123 if (filename == NULL) {
124 file = CONF_get1_default_config_file();
128 file = (char *)filename;
130 if (NCONF_load(conf, file, NULL) <= 0) {
131 if ((flags & CONF_MFLAGS_IGNORE_MISSING_FILE) &&
132 (ERR_GET_REASON(ERR_peek_last_error()) == CONF_R_NO_SUCH_FILE)) {
139 ret = CONF_modules_load(conf, appname, flags);
142 if (filename == NULL)
149 static int module_run(const CONF *cnf, const char *name, const char *value,
155 md = module_find(name);
157 /* Module not found: try to load DSO */
158 if (!md && !(flags & CONF_MFLAGS_NO_DSO))
159 md = module_load_dso(cnf, name, value);
162 if (!(flags & CONF_MFLAGS_SILENT)) {
163 CONFerr(CONF_F_MODULE_RUN, CONF_R_UNKNOWN_MODULE_NAME);
164 ERR_add_error_data(2, "module=", name);
169 ret = module_init(md, name, value, cnf);
172 if (!(flags & CONF_MFLAGS_SILENT)) {
173 char rcode[DECIMAL_SIZE(ret) + 1];
175 CONFerr(CONF_F_MODULE_RUN, CONF_R_MODULE_INITIALIZATION_ERROR);
176 BIO_snprintf(rcode, sizeof(rcode), "%-8d", ret);
177 ERR_add_error_data(6, "module=", name, ", value=", value,
178 ", retcode=", rcode);
185 /* Load a module from a DSO */
186 static CONF_MODULE *module_load_dso(const CONF *cnf,
187 const char *name, const char *value)
190 conf_init_func *ifunc;
191 conf_finish_func *ffunc;
192 const char *path = NULL;
195 /* Look for alternative path in module section */
196 path = NCONF_get_string(cnf, value, "path");
201 dso = DSO_load(NULL, path, NULL, 0);
203 errcode = CONF_R_ERROR_LOADING_DSO;
206 ifunc = (conf_init_func *)DSO_bind_func(dso, DSO_mod_init_name);
208 errcode = CONF_R_MISSING_INIT_FUNCTION;
211 ffunc = (conf_finish_func *)DSO_bind_func(dso, DSO_mod_finish_name);
212 /* All OK, add module */
213 md = module_add(dso, name, ifunc, ffunc);
222 CONFerr(CONF_F_MODULE_LOAD_DSO, errcode);
223 ERR_add_error_data(4, "module=", name, ", path=", path);
227 /* add module to list */
228 static CONF_MODULE *module_add(DSO *dso, const char *name,
229 conf_init_func *ifunc, conf_finish_func *ffunc)
231 CONF_MODULE *tmod = NULL;
232 if (supported_modules == NULL)
233 supported_modules = sk_CONF_MODULE_new_null();
234 if (supported_modules == NULL)
236 tmod = OPENSSL_zalloc(sizeof(*tmod));
241 tmod->name = OPENSSL_strdup(name);
243 tmod->finish = ffunc;
244 if (tmod->name == NULL) {
249 if (!sk_CONF_MODULE_push(supported_modules, tmod)) {
250 OPENSSL_free(tmod->name);
259 * Find a module from the list. We allow module names of the form
260 * modname.XXXX to just search for modname to allow the same module to be
261 * initialized more than once.
264 static CONF_MODULE *module_find(const char *name)
269 p = strrchr(name, '.');
274 nchar = strlen(name);
276 for (i = 0; i < sk_CONF_MODULE_num(supported_modules); i++) {
277 tmod = sk_CONF_MODULE_value(supported_modules, i);
278 if (strncmp(tmod->name, name, nchar) == 0)
286 /* initialize a module */
287 static int module_init(CONF_MODULE *pmod, const char *name, const char *value,
292 CONF_IMODULE *imod = NULL;
294 /* Otherwise add initialized module to list */
295 imod = OPENSSL_malloc(sizeof(*imod));
300 imod->name = OPENSSL_strdup(name);
301 imod->value = OPENSSL_strdup(value);
302 imod->usr_data = NULL;
304 if (!imod->name || !imod->value)
307 /* Try to initialize module */
309 ret = pmod->init(imod, cnf);
311 /* Error occurred, exit */
316 if (initialized_modules == NULL) {
317 initialized_modules = sk_CONF_IMODULE_new_null();
318 if (!initialized_modules) {
319 CONFerr(CONF_F_MODULE_INIT, ERR_R_MALLOC_FAILURE);
324 if (!sk_CONF_IMODULE_push(initialized_modules, imod)) {
325 CONFerr(CONF_F_MODULE_INIT, ERR_R_MALLOC_FAILURE);
335 /* We've started the module so we'd better finish it */
336 if (pmod->finish && init_called)
341 OPENSSL_free(imod->name);
342 OPENSSL_free(imod->value);
351 * Unload any dynamic modules that have a link count of zero: i.e. have no
352 * active initialized modules. If 'all' is set then all modules are unloaded
353 * including static ones.
356 void CONF_modules_unload(int all)
360 CONF_modules_finish();
361 /* unload modules in reverse order */
362 for (i = sk_CONF_MODULE_num(supported_modules) - 1; i >= 0; i--) {
363 md = sk_CONF_MODULE_value(supported_modules, i);
364 /* If static or in use and 'all' not set ignore it */
365 if (((md->links > 0) || !md->dso) && !all)
367 /* Since we're working in reverse this is OK */
368 (void)sk_CONF_MODULE_delete(supported_modules, i);
371 if (sk_CONF_MODULE_num(supported_modules) == 0) {
372 sk_CONF_MODULE_free(supported_modules);
373 supported_modules = NULL;
377 /* unload a single module */
378 static void module_free(CONF_MODULE *md)
381 OPENSSL_free(md->name);
385 /* finish and free up all modules instances */
387 void CONF_modules_finish(void)
390 while (sk_CONF_IMODULE_num(initialized_modules) > 0) {
391 imod = sk_CONF_IMODULE_pop(initialized_modules);
394 sk_CONF_IMODULE_free(initialized_modules);
395 initialized_modules = NULL;
398 /* finish a module instance */
400 static void module_finish(CONF_IMODULE *imod)
404 if (imod->pmod->finish)
405 imod->pmod->finish(imod);
407 OPENSSL_free(imod->name);
408 OPENSSL_free(imod->value);
412 /* Add a static module to OpenSSL */
414 int CONF_module_add(const char *name, conf_init_func *ifunc,
415 conf_finish_func *ffunc)
417 if (module_add(NULL, name, ifunc, ffunc))
423 void conf_modules_free_int(void)
425 CONF_modules_finish();
426 CONF_modules_unload(1);
429 /* Utility functions */
431 const char *CONF_imodule_get_name(const CONF_IMODULE *md)
436 const char *CONF_imodule_get_value(const CONF_IMODULE *md)
441 void *CONF_imodule_get_usr_data(const CONF_IMODULE *md)
446 void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data)
448 md->usr_data = usr_data;
451 CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md)
456 unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md)
461 void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags)
466 void *CONF_module_get_usr_data(CONF_MODULE *pmod)
468 return pmod->usr_data;
471 void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data)
473 pmod->usr_data = usr_data;
476 /* Return default config file name */
478 char *CONF_get1_default_config_file(void)
480 char *file, *sep = "";
483 file = getenv("OPENSSL_CONF");
485 return OPENSSL_strdup(file);
487 len = strlen(X509_get_default_cert_area());
488 #ifndef OPENSSL_SYS_VMS
492 len += strlen(OPENSSL_CONF);
494 file = OPENSSL_malloc(len + 1);
498 BIO_snprintf(file, len + 1, "%s%s%s", X509_get_default_cert_area(),
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
511 int CONF_parse_list(const char *list_, int sep, int nospc,
512 int (*list_cb) (const char *elem, int len, void *usr),
516 const char *lstart, *tmpend, *p;
519 CONFerr(CONF_F_CONF_PARSE_LIST, CONF_R_LIST_CANNOT_BE_NULL);
526 while (*lstart && isspace((unsigned char)*lstart))
529 p = strchr(lstart, sep);
530 if (p == lstart || !*lstart)
531 ret = list_cb(NULL, 0, arg);
536 tmpend = lstart + strlen(lstart) - 1;
538 while (isspace((unsigned char)*tmpend))
541 ret = list_cb(lstart, tmpend - lstart + 1, arg);