2 * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (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 #ifndef OPENSSL_CONF_H
11 # define OPENSSL_CONF_H
14 # include <openssl/macros.h>
15 # ifndef OPENSSL_NO_DEPRECATED_3_0
16 # define HEADER_CONF_H
19 # include <openssl/bio.h>
20 # include <openssl/lhash.h>
21 # include <openssl/safestack.h>
22 # include <openssl/e_os2.h>
23 # include <openssl/types.h>
24 # include <openssl/conferr.h>
36 DEFINE_OR_DECLARE_STACK_OF(CONF_VALUE
)
38 DEFINE_LHASH_OF(CONF_VALUE
);
41 struct conf_method_st
;
42 typedef struct conf_method_st CONF_METHOD
;
44 struct conf_method_st
{
46 CONF
*(*create
) (CONF_METHOD
*meth
);
47 int (*init
) (CONF
*conf
);
48 int (*destroy
) (CONF
*conf
);
49 int (*destroy_data
) (CONF
*conf
);
50 int (*load_bio
) (CONF
*conf
, BIO
*bp
, long *eline
);
51 int (*dump
) (const CONF
*conf
, BIO
*bp
);
52 int (*is_number
) (const CONF
*conf
, char c
);
53 int (*to_int
) (const CONF
*conf
, char c
);
54 int (*load
) (CONF
*conf
, const char *name
, long *eline
);
57 /* Module definitions */
59 typedef struct conf_imodule_st CONF_IMODULE
;
60 typedef struct conf_module_st CONF_MODULE
;
62 STACK_OF(CONF_MODULE
);
63 STACK_OF(CONF_IMODULE
);
65 /* DSO module function typedefs */
66 typedef int conf_init_func (CONF_IMODULE
*md
, const CONF
*cnf
);
67 typedef void conf_finish_func (CONF_IMODULE
*md
);
69 # define CONF_MFLAGS_IGNORE_ERRORS 0x1
70 # define CONF_MFLAGS_IGNORE_RETURN_CODES 0x2
71 # define CONF_MFLAGS_SILENT 0x4
72 # define CONF_MFLAGS_NO_DSO 0x8
73 # define CONF_MFLAGS_IGNORE_MISSING_FILE 0x10
74 # define CONF_MFLAGS_DEFAULT_SECTION 0x20
76 int CONF_set_default_method(CONF_METHOD
*meth
);
77 void CONF_set_nconf(CONF
*conf
, LHASH_OF(CONF_VALUE
) *hash
);
78 LHASH_OF(CONF_VALUE
) *CONF_load(LHASH_OF(CONF_VALUE
) *conf
, const char *file
,
80 # ifndef OPENSSL_NO_STDIO
81 LHASH_OF(CONF_VALUE
) *CONF_load_fp(LHASH_OF(CONF_VALUE
) *conf
, FILE *fp
,
84 LHASH_OF(CONF_VALUE
) *CONF_load_bio(LHASH_OF(CONF_VALUE
) *conf
, BIO
*bp
,
86 STACK_OF(CONF_VALUE
) *CONF_get_section(LHASH_OF(CONF_VALUE
) *conf
,
88 char *CONF_get_string(LHASH_OF(CONF_VALUE
) *conf
, const char *group
,
90 long CONF_get_number(LHASH_OF(CONF_VALUE
) *conf
, const char *group
,
92 void CONF_free(LHASH_OF(CONF_VALUE
) *conf
);
93 #ifndef OPENSSL_NO_STDIO
94 int CONF_dump_fp(LHASH_OF(CONF_VALUE
) *conf
, FILE *out
);
96 int CONF_dump_bio(LHASH_OF(CONF_VALUE
) *conf
, BIO
*out
);
98 DEPRECATEDIN_1_1_0(void OPENSSL_config(const char *config_name
))
100 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
101 # define OPENSSL_no_config() \
102 OPENSSL_init_crypto(OPENSSL_INIT_NO_LOAD_CONFIG, NULL)
106 * New conf code. The semantics are different from the functions above. If
107 * that wasn't the case, the above functions would have been replaced
113 LHASH_OF(CONF_VALUE
) *data
;
114 unsigned int flag_dollarid
:1;
118 CONF
*NCONF_new_with_libctx(OPENSSL_CTX
*libctx
, CONF_METHOD
*meth
);
119 CONF
*NCONF_new(CONF_METHOD
*meth
);
120 CONF_METHOD
*NCONF_default(void);
121 DEPRECATEDIN_3_0(CONF_METHOD
*NCONF_WIN32(void))
122 void NCONF_free(CONF
*conf
);
123 void NCONF_free_data(CONF
*conf
);
125 int NCONF_load(CONF
*conf
, const char *file
, long *eline
);
126 # ifndef OPENSSL_NO_STDIO
127 int NCONF_load_fp(CONF
*conf
, FILE *fp
, long *eline
);
129 int NCONF_load_bio(CONF
*conf
, BIO
*bp
, long *eline
);
130 STACK_OF(CONF_VALUE
) *NCONF_get_section(const CONF
*conf
,
131 const char *section
);
132 char *NCONF_get_string(const CONF
*conf
, const char *group
, const char *name
);
133 int NCONF_get_number_e(const CONF
*conf
, const char *group
, const char *name
,
135 #ifndef OPENSSL_NO_STDIO
136 int NCONF_dump_fp(const CONF
*conf
, FILE *out
);
138 int NCONF_dump_bio(const CONF
*conf
, BIO
*out
);
140 #define NCONF_get_number(c,g,n,r) NCONF_get_number_e(c,g,n,r)
142 /* Module functions */
144 int CONF_modules_load(const CONF
*cnf
, const char *appname
,
145 unsigned long flags
);
146 int CONF_modules_load_file_with_libctx(OPENSSL_CTX
*libctx
, const char *filename
,
147 const char *appname
, unsigned long flags
);
148 int CONF_modules_load_file(const char *filename
, const char *appname
,
149 unsigned long flags
);
150 void CONF_modules_unload(int all
);
151 void CONF_modules_finish(void);
152 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
153 # define CONF_modules_free() while(0) continue
155 int CONF_module_add(const char *name
, conf_init_func
*ifunc
,
156 conf_finish_func
*ffunc
);
158 const char *CONF_imodule_get_name(const CONF_IMODULE
*md
);
159 const char *CONF_imodule_get_value(const CONF_IMODULE
*md
);
160 void *CONF_imodule_get_usr_data(const CONF_IMODULE
*md
);
161 void CONF_imodule_set_usr_data(CONF_IMODULE
*md
, void *usr_data
);
162 CONF_MODULE
*CONF_imodule_get_module(const CONF_IMODULE
*md
);
163 unsigned long CONF_imodule_get_flags(const CONF_IMODULE
*md
);
164 void CONF_imodule_set_flags(CONF_IMODULE
*md
, unsigned long flags
);
165 void *CONF_module_get_usr_data(CONF_MODULE
*pmod
);
166 void CONF_module_set_usr_data(CONF_MODULE
*pmod
, void *usr_data
);
168 char *CONF_get1_default_config_file(void);
170 int CONF_parse_list(const char *list
, int sep
, int nospc
,
171 int (*list_cb
) (const char *elem
, int len
, void *usr
),
174 void OPENSSL_load_builtin_modules(void);