xref: /openssl/include/openssl/conf.h.in (revision eab9dbbd) 
1/*
2 * {- join("\n * ", @autowarntext) -}
3 *
4 * Copyright 1995-2021 The OpenSSL Project Authors. All Rights Reserved.
5 *
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
10 */
11
12{-
13use OpenSSL::stackhash qw(generate_stack_macros generate_lhash_macros);
14-}
15
16#ifndef  OPENSSL_CONF_H
17# define OPENSSL_CONF_H
18# pragma once
19
20# include <openssl/macros.h>
21# ifndef OPENSSL_NO_DEPRECATED_3_0
22#  define HEADER_CONF_H
23# endif
24
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>
31# ifndef OPENSSL_NO_STDIO
32#  include <stdio.h>
33# endif
34
35#ifdef  __cplusplus
36extern "C" {
37#endif
38
39typedef struct {
40    char *section;
41    char *name;
42    char *value;
43} CONF_VALUE;
44
45{-
46    generate_stack_macros("CONF_VALUE")
47    .generate_lhash_macros("CONF_VALUE");
48-}
49
50struct conf_st;
51struct conf_method_st;
52typedef struct conf_method_st CONF_METHOD;
53
54# ifndef OPENSSL_NO_DEPRECATED_3_0
55#  include <openssl/conftypes.h>
56# endif
57
58/* Module definitions */
59typedef struct conf_imodule_st CONF_IMODULE;
60typedef struct conf_module_st CONF_MODULE;
61
62STACK_OF(CONF_MODULE);
63STACK_OF(CONF_IMODULE);
64
65/* DSO module function typedefs */
66typedef int conf_init_func (CONF_IMODULE *md, const CONF *cnf);
67typedef void conf_finish_func (CONF_IMODULE *md);
68
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
75
76int CONF_set_default_method(CONF_METHOD *meth);
77void CONF_set_nconf(CONF *conf, LHASH_OF(CONF_VALUE) *hash);
78LHASH_OF(CONF_VALUE) *CONF_load(LHASH_OF(CONF_VALUE) *conf, const char *file,
79                                long *eline);
80# ifndef OPENSSL_NO_STDIO
81LHASH_OF(CONF_VALUE) *CONF_load_fp(LHASH_OF(CONF_VALUE) *conf, FILE *fp,
82                                   long *eline);
83# endif
84LHASH_OF(CONF_VALUE) *CONF_load_bio(LHASH_OF(CONF_VALUE) *conf, BIO *bp,
85                                    long *eline);
86STACK_OF(CONF_VALUE) *CONF_get_section(LHASH_OF(CONF_VALUE) *conf,
87                                       const char *section);
88char *CONF_get_string(LHASH_OF(CONF_VALUE) *conf, const char *group,
89                      const char *name);
90long CONF_get_number(LHASH_OF(CONF_VALUE) *conf, const char *group,
91                     const char *name);
92void CONF_free(LHASH_OF(CONF_VALUE) *conf);
93#ifndef OPENSSL_NO_STDIO
94int CONF_dump_fp(LHASH_OF(CONF_VALUE) *conf, FILE *out);
95#endif
96int CONF_dump_bio(LHASH_OF(CONF_VALUE) *conf, BIO *out);
97#ifndef OPENSSL_NO_DEPRECATED_1_1_0
98OSSL_DEPRECATEDIN_1_1_0 void OPENSSL_config(const char *config_name);
99#endif
100
101#ifndef OPENSSL_NO_DEPRECATED_1_1_0
102# define OPENSSL_no_config() \
103    OPENSSL_init_crypto(OPENSSL_INIT_NO_LOAD_CONFIG, NULL)
104#endif
105
106/*
107 * New conf code.  The semantics are different from the functions above. If
108 * that wasn't the case, the above functions would have been replaced
109 */
110
111CONF *NCONF_new_ex(OSSL_LIB_CTX *libctx, CONF_METHOD *meth);
112OSSL_LIB_CTX *NCONF_get0_libctx(const CONF *conf);
113CONF *NCONF_new(CONF_METHOD *meth);
114CONF_METHOD *NCONF_default(void);
115#ifndef OPENSSL_NO_DEPRECATED_3_0
116OSSL_DEPRECATEDIN_3_0 CONF_METHOD *NCONF_WIN32(void);
117#endif
118void NCONF_free(CONF *conf);
119void NCONF_free_data(CONF *conf);
120
121int NCONF_load(CONF *conf, const char *file, long *eline);
122# ifndef OPENSSL_NO_STDIO
123int NCONF_load_fp(CONF *conf, FILE *fp, long *eline);
124# endif
125int NCONF_load_bio(CONF *conf, BIO *bp, long *eline);
126STACK_OF(OPENSSL_CSTRING) *NCONF_get_section_names(const CONF *conf);
127STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf,
128                                        const char *section);
129char *NCONF_get_string(const CONF *conf, const char *group, const char *name);
130int NCONF_get_number_e(const CONF *conf, const char *group, const char *name,
131                       long *result);
132#ifndef OPENSSL_NO_STDIO
133int NCONF_dump_fp(const CONF *conf, FILE *out);
134#endif
135int NCONF_dump_bio(const CONF *conf, BIO *out);
136
137#define NCONF_get_number(c,g,n,r) NCONF_get_number_e(c,g,n,r)
138
139/* Module functions */
140
141int CONF_modules_load(const CONF *cnf, const char *appname,
142                      unsigned long flags);
143int CONF_modules_load_file_ex(OSSL_LIB_CTX *libctx, const char *filename,
144                              const char *appname, unsigned long flags);
145int CONF_modules_load_file(const char *filename, const char *appname,
146                           unsigned long flags);
147void CONF_modules_unload(int all);
148void CONF_modules_finish(void);
149#ifndef OPENSSL_NO_DEPRECATED_1_1_0
150# define CONF_modules_free() while(0) continue
151#endif
152int CONF_module_add(const char *name, conf_init_func *ifunc,
153                    conf_finish_func *ffunc);
154
155const char *CONF_imodule_get_name(const CONF_IMODULE *md);
156const char *CONF_imodule_get_value(const CONF_IMODULE *md);
157void *CONF_imodule_get_usr_data(const CONF_IMODULE *md);
158void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data);
159CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md);
160unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md);
161void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags);
162void *CONF_module_get_usr_data(CONF_MODULE *pmod);
163void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data);
164
165char *CONF_get1_default_config_file(void);
166
167int CONF_parse_list(const char *list, int sep, int nospc,
168                    int (*list_cb) (const char *elem, int len, void *usr),
169                    void *arg);
170
171void OPENSSL_load_builtin_modules(void);
172
173
174# ifdef  __cplusplus
175}
176# endif
177#endif
178