2 * Copyright 2002-2016 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"
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];
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);
183 /* Load a module from a DSO */
184 static CONF_MODULE *module_load_dso(const CONF *cnf,
185 const char *name, const char *value)
188 conf_init_func *ifunc;
189 conf_finish_func *ffunc;
190 const char *path = NULL;
193 /* Look for alternative path in module section */
194 path = NCONF_get_string(cnf, value, "path");
199 dso = DSO_load(NULL, path, NULL, 0);
201 errcode = CONF_R_ERROR_LOADING_DSO;
204 ifunc = (conf_init_func *)DSO_bind_func(dso, DSO_mod_init_name);
206 errcode = CONF_R_MISSING_INIT_FUNCTION;
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);
220 CONFerr(CONF_F_MODULE_LOAD_DSO, errcode);
221 ERR_add_error_data(4, "module=", name, ", path=", path);
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)
229 CONF_MODULE *tmod = NULL;
230 if (supported_modules == NULL)
231 supported_modules = sk_CONF_MODULE_new_null();
232 if (supported_modules == NULL)
234 tmod = OPENSSL_zalloc(sizeof(*tmod));
239 tmod->name = OPENSSL_strdup(name);
241 tmod->finish = ffunc;
242 if (tmod->name == NULL) {
247 if (!sk_CONF_MODULE_push(supported_modules, tmod)) {
248 OPENSSL_free(tmod->name);
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.
262 static CONF_MODULE *module_find(const char *name)
267 p = strrchr(name, '.');
272 nchar = strlen(name);
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)
284 /* initialize a module */
285 static int module_init(CONF_MODULE *pmod, const char *name, const char *value,
290 CONF_IMODULE *imod = NULL;
292 /* Otherwise add initialized module to list */
293 imod = OPENSSL_malloc(sizeof(*imod));
298 imod->name = OPENSSL_strdup(name);
299 imod->value = OPENSSL_strdup(value);
300 imod->usr_data = NULL;
302 if (!imod->name || !imod->value)
305 /* Try to initialize module */
307 ret = pmod->init(imod, cnf);
309 /* Error occurred, exit */
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);
322 if (!sk_CONF_IMODULE_push(initialized_modules, imod)) {
323 CONFerr(CONF_F_MODULE_INIT, ERR_R_MALLOC_FAILURE);
333 /* We've started the module so we'd better finish it */
334 if (pmod->finish && init_called)
339 OPENSSL_free(imod->name);
340 OPENSSL_free(imod->value);
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.
354 void CONF_modules_unload(int all)
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)
365 /* Since we're working in reverse this is OK */
366 (void)sk_CONF_MODULE_delete(supported_modules, i);
369 if (sk_CONF_MODULE_num(supported_modules) == 0) {
370 sk_CONF_MODULE_free(supported_modules);
371 supported_modules = NULL;
375 /* unload a single module */
376 static void module_free(CONF_MODULE *md)
379 OPENSSL_free(md->name);
383 /* finish and free up all modules instances */
385 void CONF_modules_finish(void)
388 while (sk_CONF_IMODULE_num(initialized_modules) > 0) {
389 imod = sk_CONF_IMODULE_pop(initialized_modules);
392 sk_CONF_IMODULE_free(initialized_modules);
393 initialized_modules = NULL;
396 /* finish a module instance */
398 static void module_finish(CONF_IMODULE *imod)
402 if (imod->pmod->finish)
403 imod->pmod->finish(imod);
405 OPENSSL_free(imod->name);
406 OPENSSL_free(imod->value);
410 /* Add a static module to OpenSSL */
412 int CONF_module_add(const char *name, conf_init_func *ifunc,
413 conf_finish_func *ffunc)
415 if (module_add(NULL, name, ifunc, ffunc))
421 void conf_modules_free_int(void)
423 CONF_modules_finish();
424 CONF_modules_unload(1);
427 /* Utility functions */
429 const char *CONF_imodule_get_name(const CONF_IMODULE *md)
434 const char *CONF_imodule_get_value(const CONF_IMODULE *md)
439 void *CONF_imodule_get_usr_data(const CONF_IMODULE *md)
444 void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data)
446 md->usr_data = usr_data;
449 CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md)
454 unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md)
459 void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags)
464 void *CONF_module_get_usr_data(CONF_MODULE *pmod)
466 return pmod->usr_data;
469 void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data)
471 pmod->usr_data = usr_data;
474 /* Return default config file name */
476 char *CONF_get1_default_config_file(void)
481 file = getenv("OPENSSL_CONF");
483 return OPENSSL_strdup(file);
485 len = strlen(X509_get_default_cert_area());
486 #ifndef OPENSSL_SYS_VMS
489 len += strlen(OPENSSL_CONF);
491 file = OPENSSL_malloc(len + 1);
495 OPENSSL_strlcpy(file, X509_get_default_cert_area(), len + 1);
496 #ifndef OPENSSL_SYS_VMS
497 OPENSSL_strlcat(file, "/", len + 1);
499 OPENSSL_strlcat(file, OPENSSL_CONF, len + 1);
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);