2 * Copyright 2002-2018 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
10 #include "internal/cryptlib.h"
13 #include <openssl/crypto.h>
14 #include "internal/conf.h"
15 #include "internal/dso.h"
16 #include <openssl/x509.h>
18 #define DSO_mod_init_name "OPENSSL_init"
19 #define DSO_mod_finish_name "OPENSSL_finish"
22 * This structure contains a data about supported modules. entries in this
23 * table correspond to either dynamic or static modules.
26 struct conf_module_st {
27 /* DSO of this module or NULL if static */
29 /* Name of the module */
34 conf_finish_func *finish;
35 /* Number of successfully initialized modules */
41 * This structure contains information about modules that have been
42 * successfully initialized. There may be more than one entry for a given
46 struct conf_imodule_st {
54 static STACK_OF(CONF_MODULE) *supported_modules = NULL;
55 static STACK_OF(CONF_IMODULE) *initialized_modules = NULL;
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,
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,
67 static CONF_MODULE *module_load_dso(const CONF *cnf, const char *name,
70 /* Main function: load modules from a CONF structure */
72 int CONF_modules_load(const CONF *cnf, const char *appname,
75 STACK_OF(CONF_VALUE) *values;
77 char *vsection = NULL;
85 vsection = NCONF_get_string(cnf, NULL, appname);
87 if (!appname || (!vsection && (flags & CONF_MFLAGS_DEFAULT_SECTION)))
88 vsection = NCONF_get_string(cnf, NULL, "openssl_conf");
95 values = NCONF_get_section(cnf, vsection);
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);
104 if (!(flags & CONF_MFLAGS_IGNORE_ERRORS))
112 int CONF_modules_load_file(const char *filename, const char *appname,
118 conf = NCONF_new(NULL);
122 if (filename == NULL) {
123 file = CONF_get1_default_config_file();
127 file = (char *)filename;
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)) {
138 ret = CONF_modules_load(conf, appname, flags);
141 if (filename == NULL)
148 static int module_run(const CONF *cnf, const char *name, const char *value,
154 md = module_find(name);
156 /* Module not found: try to load DSO */
157 if (!md && !(flags & CONF_MFLAGS_NO_DSO))
158 md = module_load_dso(cnf, name, value);
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);
168 ret = module_init(md, name, value, cnf);
171 if (!(flags & CONF_MFLAGS_SILENT)) {
172 char rcode[DECIMAL_SIZE(ret) + 1];
174 CONFerr(CONF_F_MODULE_RUN, CONF_R_MODULE_INITIALIZATION_ERROR);
175 BIO_snprintf(rcode, sizeof(rcode), "%-8d", ret);
176 ERR_add_error_data(6, "module=", name, ", value=", value,
177 ", retcode=", rcode);
184 /* Load a module from a DSO */
185 static CONF_MODULE *module_load_dso(const CONF *cnf,
186 const char *name, const char *value)
189 conf_init_func *ifunc;
190 conf_finish_func *ffunc;
191 const char *path = NULL;
194 /* Look for alternative path in module section */
195 path = NCONF_get_string(cnf, value, "path");
200 dso = DSO_load(NULL, path, NULL, 0);
202 errcode = CONF_R_ERROR_LOADING_DSO;
205 ifunc = (conf_init_func *)DSO_bind_func(dso, DSO_mod_init_name);
207 errcode = CONF_R_MISSING_INIT_FUNCTION;
210 ffunc = (conf_finish_func *)DSO_bind_func(dso, DSO_mod_finish_name);
211 /* All OK, add module */
212 md = module_add(dso, name, ifunc, ffunc);
221 CONFerr(CONF_F_MODULE_LOAD_DSO, errcode);
222 ERR_add_error_data(4, "module=", name, ", path=", path);
226 /* add module to list */
227 static CONF_MODULE *module_add(DSO *dso, const char *name,
228 conf_init_func *ifunc, conf_finish_func *ffunc)
230 CONF_MODULE *tmod = NULL;
231 if (supported_modules == NULL)
232 supported_modules = sk_CONF_MODULE_new_null();
233 if (supported_modules == NULL)
235 if ((tmod = OPENSSL_zalloc(sizeof(*tmod))) == NULL) {
236 CONFerr(CONF_F_MODULE_ADD, ERR_R_MALLOC_FAILURE);
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 if ((file = ossl_safe_getenv("OPENSSL_CONF")) != NULL)
484 return OPENSSL_strdup(file);
486 len = strlen(X509_get_default_cert_area());
487 #ifndef OPENSSL_SYS_VMS
491 len += strlen(OPENSSL_CONF);
493 file = OPENSSL_malloc(len + 1);
497 BIO_snprintf(file, len + 1, "%s%s%s", X509_get_default_cert_area(),
504 * This function takes a list separated by 'sep' and calls the callback
505 * function giving the start and length of each member optionally stripping
506 * leading and trailing whitespace. This can be used to parse comma separated
510 int CONF_parse_list(const char *list_, int sep, int nospc,
511 int (*list_cb) (const char *elem, int len, void *usr),
515 const char *lstart, *tmpend, *p;
518 CONFerr(CONF_F_CONF_PARSE_LIST, CONF_R_LIST_CANNOT_BE_NULL);
525 while (*lstart && isspace((unsigned char)*lstart))
528 p = strchr(lstart, sep);
529 if (p == lstart || !*lstart)
530 ret = list_cb(NULL, 0, arg);
535 tmpend = lstart + strlen(lstart) - 1;
537 while (isspace((unsigned char)*tmpend))
540 ret = list_cb(lstart, tmpend - lstart + 1, arg);