2 * {- join("\n * ", @autowarntext) -}
4 * Copyright 1995-2021 The OpenSSL Project Authors. All Rights Reserved.
6 * Licensed under the Apache License 2.0 (the "License"). You may not use
7 * this file except in compliance with the License. You can obtain a copy
8 * in the file LICENSE in the source distribution or at
9 * https://www.openssl.org/source/license.html
13 use
OpenSSL::stackhash
qw(generate_stack_macros generate_lhash_macros
);
16 #ifndef OPENSSL_CONF_H
17 # define OPENSSL_CONF_H
20 # include <openssl/macros.h>
21 # ifndef OPENSSL_NO_DEPRECATED_3_0
22 # define HEADER_CONF_H
25 # include <openssl/bio.h>
26 # include <openssl/lhash.h>
27 # include <openssl/safestack.h>
28 # include <openssl/e_os2.h>
29 # include <openssl/types.h>
30 # include <openssl/conferr.h>
43 generate_stack_macros("CONF_VALUE")
44 .generate_lhash_macros("CONF_VALUE");
48 struct conf_method_st
;
49 typedef struct conf_method_st CONF_METHOD
;
51 struct conf_method_st
{
53 CONF
*(*create
) (CONF_METHOD
*meth
);
54 int (*init
) (CONF
*conf
);
55 int (*destroy
) (CONF
*conf
);
56 int (*destroy_data
) (CONF
*conf
);
57 int (*load_bio
) (CONF
*conf
, BIO
*bp
, long *eline
);
58 int (*dump
) (const CONF
*conf
, BIO
*bp
);
59 int (*is_number
) (const CONF
*conf
, char c
);
60 int (*to_int
) (const CONF
*conf
, char c
);
61 int (*load
) (CONF
*conf
, const char *name
, long *eline
);
64 /* Module definitions */
66 typedef struct conf_imodule_st CONF_IMODULE
;
67 typedef struct conf_module_st CONF_MODULE
;
69 STACK_OF(CONF_MODULE
);
70 STACK_OF(CONF_IMODULE
);
72 /* DSO module function typedefs */
73 typedef int conf_init_func (CONF_IMODULE
*md
, const CONF
*cnf
);
74 typedef void conf_finish_func (CONF_IMODULE
*md
);
76 # define CONF_MFLAGS_IGNORE_ERRORS 0x1
77 # define CONF_MFLAGS_IGNORE_RETURN_CODES 0x2
78 # define CONF_MFLAGS_SILENT 0x4
79 # define CONF_MFLAGS_NO_DSO 0x8
80 # define CONF_MFLAGS_IGNORE_MISSING_FILE 0x10
81 # define CONF_MFLAGS_DEFAULT_SECTION 0x20
83 int CONF_set_default_method(CONF_METHOD
*meth
);
84 void CONF_set_nconf(CONF
*conf
, LHASH_OF(CONF_VALUE
) *hash
);
85 LHASH_OF(CONF_VALUE
) *CONF_load(LHASH_OF(CONF_VALUE
) *conf
, const char *file
,
87 # ifndef OPENSSL_NO_STDIO
88 LHASH_OF(CONF_VALUE
) *CONF_load_fp(LHASH_OF(CONF_VALUE
) *conf
, FILE *fp
,
91 LHASH_OF(CONF_VALUE
) *CONF_load_bio(LHASH_OF(CONF_VALUE
) *conf
, BIO
*bp
,
93 STACK_OF(CONF_VALUE
) *CONF_get_section(LHASH_OF(CONF_VALUE
) *conf
,
95 char *CONF_get_string(LHASH_OF(CONF_VALUE
) *conf
, const char *group
,
97 long CONF_get_number(LHASH_OF(CONF_VALUE
) *conf
, const char *group
,
99 void CONF_free(LHASH_OF(CONF_VALUE
) *conf
);
100 #ifndef OPENSSL_NO_STDIO
101 int CONF_dump_fp(LHASH_OF(CONF_VALUE
) *conf
, FILE *out
);
103 int CONF_dump_bio(LHASH_OF(CONF_VALUE
) *conf
, BIO
*out
);
104 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
105 OSSL_DEPRECATEDIN_1_1_0
void OPENSSL_config(const char *config_name
);
108 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
109 # define OPENSSL_no_config() \
110 OPENSSL_init_crypto(OPENSSL_INIT_NO_LOAD_CONFIG, NULL)
114 * New conf code. The semantics are different from the functions above. If
115 * that wasn't the case, the above functions would have been replaced
121 LHASH_OF(CONF_VALUE
) *data
;
125 OSSL_LIB_CTX
*libctx
;
128 CONF
*NCONF_new_ex(OSSL_LIB_CTX
*libctx
, CONF_METHOD
*meth
);
129 CONF
*NCONF_new(CONF_METHOD
*meth
);
130 CONF_METHOD
*NCONF_default(void);
131 #ifndef OPENSSL_NO_DEPRECATED_3_0
132 OSSL_DEPRECATEDIN_3_0 CONF_METHOD
*NCONF_WIN32(void);
134 void NCONF_free(CONF
*conf
);
135 void NCONF_free_data(CONF
*conf
);
137 int NCONF_load(CONF
*conf
, const char *file
, long *eline
);
138 # ifndef OPENSSL_NO_STDIO
139 int NCONF_load_fp(CONF
*conf
, FILE *fp
, long *eline
);
141 int NCONF_load_bio(CONF
*conf
, BIO
*bp
, long *eline
);
142 STACK_OF(CONF_VALUE
) *NCONF_get_section(const CONF
*conf
,
143 const char *section
);
144 char *NCONF_get_string(const CONF
*conf
, const char *group
, const char *name
);
145 int NCONF_get_number_e(const CONF
*conf
, const char *group
, const char *name
,
147 #ifndef OPENSSL_NO_STDIO
148 int NCONF_dump_fp(const CONF
*conf
, FILE *out
);
150 int NCONF_dump_bio(const CONF
*conf
, BIO
*out
);
152 #define NCONF_get_number(c,g,n,r) NCONF_get_number_e(c,g,n,r)
154 /* Module functions */
156 int CONF_modules_load(const CONF
*cnf
, const char *appname
,
157 unsigned long flags
);
158 int CONF_modules_load_file_ex(OSSL_LIB_CTX
*libctx
, const char *filename
,
159 const char *appname
, unsigned long flags
);
160 int CONF_modules_load_file(const char *filename
, const char *appname
,
161 unsigned long flags
);
162 void CONF_modules_unload(int all
);
163 void CONF_modules_finish(void);
164 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
165 # define CONF_modules_free() while(0) continue
167 int CONF_module_add(const char *name
, conf_init_func
*ifunc
,
168 conf_finish_func
*ffunc
);
170 const char *CONF_imodule_get_name(const CONF_IMODULE
*md
);
171 const char *CONF_imodule_get_value(const CONF_IMODULE
*md
);
172 void *CONF_imodule_get_usr_data(const CONF_IMODULE
*md
);
173 void CONF_imodule_set_usr_data(CONF_IMODULE
*md
, void *usr_data
);
174 CONF_MODULE
*CONF_imodule_get_module(const CONF_IMODULE
*md
);
175 unsigned long CONF_imodule_get_flags(const CONF_IMODULE
*md
);
176 void CONF_imodule_set_flags(CONF_IMODULE
*md
, unsigned long flags
);
177 void *CONF_module_get_usr_data(CONF_MODULE
*pmod
);
178 void CONF_module_set_usr_data(CONF_MODULE
*pmod
, void *usr_data
);
180 char *CONF_get1_default_config_file(void);
182 int CONF_parse_list(const char *list
, int sep
, int nospc
,
183 int (*list_cb
) (const char *elem
, int len
, void *usr
),
186 void OPENSSL_load_builtin_modules(void);