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, char *name, 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(char *name);
65 static int module_init(CONF_MODULE *pmod, char *name, char *value,
67 static CONF_MODULE *module_load_dso(const CONF *cnf, char *name, char *value);
69 /* Main function: load modules from a CONF structure */
71 int CONF_modules_load(const CONF *cnf, const char *appname,
74 STACK_OF(CONF_VALUE) *values;
76 char *vsection = NULL;
84 vsection = NCONF_get_string(cnf, NULL, appname);
86 if (!appname || (!vsection && (flags & CONF_MFLAGS_DEFAULT_SECTION)))
87 vsection = NCONF_get_string(cnf, NULL, "openssl_conf");
94 values = NCONF_get_section(cnf, vsection);
99 for (i = 0; i < sk_CONF_VALUE_num(values); i++) {
100 vl = sk_CONF_VALUE_value(values, i);
101 ret = module_run(cnf, vl->name, vl->value, flags);
103 if (!(flags & CONF_MFLAGS_IGNORE_ERRORS))
111 int CONF_modules_load_file(const char *filename, const char *appname,
117 conf = NCONF_new(NULL);
121 if (filename == NULL) {
122 file = CONF_get1_default_config_file();
126 file = (char *)filename;
128 if (NCONF_load(conf, file, NULL) <= 0) {
129 if ((flags & CONF_MFLAGS_IGNORE_MISSING_FILE) &&
130 (ERR_GET_REASON(ERR_peek_last_error()) == CONF_R_NO_SUCH_FILE)) {
137 ret = CONF_modules_load(conf, appname, flags);
140 if (filename == NULL)
147 static int module_run(const CONF *cnf, char *name, char *value,
153 md = module_find(name);
155 /* Module not found: try to load DSO */
156 if (!md && !(flags & CONF_MFLAGS_NO_DSO))
157 md = module_load_dso(cnf, name, value);
160 if (!(flags & CONF_MFLAGS_SILENT)) {
161 CONFerr(CONF_F_MODULE_RUN, CONF_R_UNKNOWN_MODULE_NAME);
162 ERR_add_error_data(2, "module=", name);
167 ret = module_init(md, name, value, cnf);
170 if (!(flags & CONF_MFLAGS_SILENT)) {
171 char rcode[DECIMAL_SIZE(ret) + 1];
172 CONFerr(CONF_F_MODULE_RUN, CONF_R_MODULE_INITIALIZATION_ERROR);
173 BIO_snprintf(rcode, sizeof rcode, "%-8d", ret);
174 ERR_add_error_data(6, "module=", name, ", value=", value,
175 ", retcode=", rcode);
182 /* Load a module from a DSO */
183 static CONF_MODULE *module_load_dso(const CONF *cnf, char *name, char *value)
186 conf_init_func *ifunc;
187 conf_finish_func *ffunc;
191 /* Look for alternative path in module section */
192 path = NCONF_get_string(cnf, value, "path");
197 dso = DSO_load(NULL, path, NULL, 0);
199 errcode = CONF_R_ERROR_LOADING_DSO;
202 ifunc = (conf_init_func *)DSO_bind_func(dso, DSO_mod_init_name);
204 errcode = CONF_R_MISSING_INIT_FUNCTION;
207 ffunc = (conf_finish_func *)DSO_bind_func(dso, DSO_mod_finish_name);
208 /* All OK, add module */
209 md = module_add(dso, name, ifunc, ffunc);
218 CONFerr(CONF_F_MODULE_LOAD_DSO, errcode);
219 ERR_add_error_data(4, "module=", name, ", path=", path);
223 /* add module to list */
224 static CONF_MODULE *module_add(DSO *dso, const char *name,
225 conf_init_func *ifunc, conf_finish_func *ffunc)
227 CONF_MODULE *tmod = NULL;
228 if (supported_modules == NULL)
229 supported_modules = sk_CONF_MODULE_new_null();
230 if (supported_modules == NULL)
232 tmod = OPENSSL_zalloc(sizeof(*tmod));
237 tmod->name = OPENSSL_strdup(name);
239 tmod->finish = ffunc;
240 if (tmod->name == NULL) {
245 if (!sk_CONF_MODULE_push(supported_modules, tmod)) {
246 OPENSSL_free(tmod->name);
255 * Find a module from the list. We allow module names of the form
256 * modname.XXXX to just search for modname to allow the same module to be
257 * initialized more than once.
260 static CONF_MODULE *module_find(char *name)
265 p = strrchr(name, '.');
270 nchar = strlen(name);
272 for (i = 0; i < sk_CONF_MODULE_num(supported_modules); i++) {
273 tmod = sk_CONF_MODULE_value(supported_modules, i);
274 if (strncmp(tmod->name, name, nchar) == 0)
282 /* initialize a module */
283 static int module_init(CONF_MODULE *pmod, char *name, char *value,
288 CONF_IMODULE *imod = NULL;
290 /* Otherwise add initialized module to list */
291 imod = OPENSSL_malloc(sizeof(*imod));
296 imod->name = OPENSSL_strdup(name);
297 imod->value = OPENSSL_strdup(value);
298 imod->usr_data = NULL;
300 if (!imod->name || !imod->value)
303 /* Try to initialize module */
305 ret = pmod->init(imod, cnf);
307 /* Error occurred, exit */
312 if (initialized_modules == NULL) {
313 initialized_modules = sk_CONF_IMODULE_new_null();
314 if (!initialized_modules) {
315 CONFerr(CONF_F_MODULE_INIT, ERR_R_MALLOC_FAILURE);
320 if (!sk_CONF_IMODULE_push(initialized_modules, imod)) {
321 CONFerr(CONF_F_MODULE_INIT, ERR_R_MALLOC_FAILURE);
331 /* We've started the module so we'd better finish it */
332 if (pmod->finish && init_called)
337 OPENSSL_free(imod->name);
338 OPENSSL_free(imod->value);
347 * Unload any dynamic modules that have a link count of zero: i.e. have no
348 * active initialized modules. If 'all' is set then all modules are unloaded
349 * including static ones.
352 void CONF_modules_unload(int all)
356 CONF_modules_finish();
357 /* unload modules in reverse order */
358 for (i = sk_CONF_MODULE_num(supported_modules) - 1; i >= 0; i--) {
359 md = sk_CONF_MODULE_value(supported_modules, i);
360 /* If static or in use and 'all' not set ignore it */
361 if (((md->links > 0) || !md->dso) && !all)
363 /* Since we're working in reverse this is OK */
364 (void)sk_CONF_MODULE_delete(supported_modules, i);
367 if (sk_CONF_MODULE_num(supported_modules) == 0) {
368 sk_CONF_MODULE_free(supported_modules);
369 supported_modules = NULL;
373 /* unload a single module */
374 static void module_free(CONF_MODULE *md)
377 OPENSSL_free(md->name);
381 /* finish and free up all modules instances */
383 void CONF_modules_finish(void)
386 while (sk_CONF_IMODULE_num(initialized_modules) > 0) {
387 imod = sk_CONF_IMODULE_pop(initialized_modules);
390 sk_CONF_IMODULE_free(initialized_modules);
391 initialized_modules = NULL;
394 /* finish a module instance */
396 static void module_finish(CONF_IMODULE *imod)
400 if (imod->pmod->finish)
401 imod->pmod->finish(imod);
403 OPENSSL_free(imod->name);
404 OPENSSL_free(imod->value);
408 /* Add a static module to OpenSSL */
410 int CONF_module_add(const char *name, conf_init_func *ifunc,
411 conf_finish_func *ffunc)
413 if (module_add(NULL, name, ifunc, ffunc))
419 void conf_modules_free_int(void)
421 CONF_modules_finish();
422 CONF_modules_unload(1);
425 /* Utility functions */
427 const char *CONF_imodule_get_name(const CONF_IMODULE *md)
432 const char *CONF_imodule_get_value(const CONF_IMODULE *md)
437 void *CONF_imodule_get_usr_data(const CONF_IMODULE *md)
442 void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data)
444 md->usr_data = usr_data;
447 CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md)
452 unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md)
457 void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags)
462 void *CONF_module_get_usr_data(CONF_MODULE *pmod)
464 return pmod->usr_data;
467 void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data)
469 pmod->usr_data = usr_data;
472 /* Return default config file name */
474 char *CONF_get1_default_config_file(void)
479 file = getenv("OPENSSL_CONF");
481 return OPENSSL_strdup(file);
483 len = strlen(X509_get_default_cert_area());
484 #ifndef OPENSSL_SYS_VMS
487 len += strlen(OPENSSL_CONF);
489 file = OPENSSL_malloc(len + 1);
493 OPENSSL_strlcpy(file, X509_get_default_cert_area(), len + 1);
494 #ifndef OPENSSL_SYS_VMS
495 OPENSSL_strlcat(file, "/", len + 1);
497 OPENSSL_strlcat(file, OPENSSL_CONF, len + 1);
503 * This function takes a list separated by 'sep' and calls the callback
504 * function giving the start and length of each member optionally stripping
505 * leading and trailing whitespace. This can be used to parse comma separated
509 int CONF_parse_list(const char *list_, int sep, int nospc,
510 int (*list_cb) (const char *elem, int len, void *usr),
514 const char *lstart, *tmpend, *p;
517 CONFerr(CONF_F_CONF_PARSE_LIST, CONF_R_LIST_CANNOT_BE_NULL);
524 while (*lstart && isspace((unsigned char)*lstart))
527 p = strchr(lstart, sep);
528 if (p == lstart || !*lstart)
529 ret = list_cb(NULL, 0, arg);
534 tmpend = lstart + strlen(lstart) - 1;
536 while (isspace((unsigned char)*tmpend))
539 ret = list_cb(lstart, tmpend - lstart + 1, arg);