24e9dee49fe8d39012f1d0397bc366d829513377
[openssl.git] / include / openssl / conf.h
1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.]
56  */
57
58 #ifndef  HEADER_CONF_H
59 # define HEADER_CONF_H
60
61 # include <openssl/bio.h>
62 # include <openssl/lhash.h>
63 # include <openssl/stack.h>
64 # include <openssl/safestack.h>
65 # include <openssl/e_os2.h>
66
67 # include <openssl/ossl_typ.h>
68
69 #ifdef  __cplusplus
70 extern "C" {
71 #endif
72
73 typedef struct {
74     char *section;
75     char *name;
76     char *value;
77 } CONF_VALUE;
78
79 DEFINE_STACK_OF(CONF_VALUE)
80 DEFINE_LHASH_OF(CONF_VALUE);
81
82 struct conf_st;
83 struct conf_method_st;
84 typedef struct conf_method_st CONF_METHOD;
85
86 struct conf_method_st {
87     const char *name;
88     CONF *(*create) (CONF_METHOD *meth);
89     int (*init) (CONF *conf);
90     int (*destroy) (CONF *conf);
91     int (*destroy_data) (CONF *conf);
92     int (*load_bio) (CONF *conf, BIO *bp, long *eline);
93     int (*dump) (const CONF *conf, BIO *bp);
94     int (*is_number) (const CONF *conf, char c);
95     int (*to_int) (const CONF *conf, char c);
96     int (*load) (CONF *conf, const char *name, long *eline);
97 };
98
99 /* Module definitions */
100
101 typedef struct conf_imodule_st CONF_IMODULE;
102 typedef struct conf_module_st CONF_MODULE;
103
104 DEFINE_STACK_OF(CONF_MODULE)
105 DEFINE_STACK_OF(CONF_IMODULE)
106
107 /* DSO module function typedefs */
108 typedef int conf_init_func (CONF_IMODULE *md, const CONF *cnf);
109 typedef void conf_finish_func (CONF_IMODULE *md);
110
111 # define CONF_MFLAGS_IGNORE_ERRORS       0x1
112 # define CONF_MFLAGS_IGNORE_RETURN_CODES 0x2
113 # define CONF_MFLAGS_SILENT              0x4
114 # define CONF_MFLAGS_NO_DSO              0x8
115 # define CONF_MFLAGS_IGNORE_MISSING_FILE 0x10
116 # define CONF_MFLAGS_DEFAULT_SECTION     0x20
117
118 int CONF_set_default_method(CONF_METHOD *meth);
119 void CONF_set_nconf(CONF *conf, LHASH_OF(CONF_VALUE) *hash);
120 LHASH_OF(CONF_VALUE) *CONF_load(LHASH_OF(CONF_VALUE) *conf, const char *file,
121                                 long *eline);
122 # ifndef OPENSSL_NO_STDIO
123 LHASH_OF(CONF_VALUE) *CONF_load_fp(LHASH_OF(CONF_VALUE) *conf, FILE *fp,
124                                    long *eline);
125 # endif
126 LHASH_OF(CONF_VALUE) *CONF_load_bio(LHASH_OF(CONF_VALUE) *conf, BIO *bp,
127                                     long *eline);
128 STACK_OF(CONF_VALUE) *CONF_get_section(LHASH_OF(CONF_VALUE) *conf,
129                                        const char *section);
130 char *CONF_get_string(LHASH_OF(CONF_VALUE) *conf, const char *group,
131                       const char *name);
132 long CONF_get_number(LHASH_OF(CONF_VALUE) *conf, const char *group,
133                      const char *name);
134 void CONF_free(LHASH_OF(CONF_VALUE) *conf);
135 #ifndef OPENSSL_NO_STDIO
136 int CONF_dump_fp(LHASH_OF(CONF_VALUE) *conf, FILE *out);
137 #endif
138 int CONF_dump_bio(LHASH_OF(CONF_VALUE) *conf, BIO *out);
139
140 DEPRECATEDIN_1_1_0(void OPENSSL_config(const char *config_name))
141
142 #if OPENSSL_API_COMPAT < 0x10100000L
143 # define OPENSSL_no_config() \
144     OPENSSL_init_crypto(OPENSSL_INIT_NO_LOAD_CONFIG, NULL)
145 #endif
146
147 /*
148  * New conf code.  The semantics are different from the functions above. If
149  * that wasn't the case, the above functions would have been replaced
150  */
151
152 struct conf_st {
153     CONF_METHOD *meth;
154     void *meth_data;
155     LHASH_OF(CONF_VALUE) *data;
156 };
157
158 CONF *NCONF_new(CONF_METHOD *meth);
159 CONF_METHOD *NCONF_default(void);
160 CONF_METHOD *NCONF_WIN32(void);
161 void NCONF_free(CONF *conf);
162 void NCONF_free_data(CONF *conf);
163
164 int NCONF_load(CONF *conf, const char *file, long *eline);
165 # ifndef OPENSSL_NO_STDIO
166 int NCONF_load_fp(CONF *conf, FILE *fp, long *eline);
167 # endif
168 int NCONF_load_bio(CONF *conf, BIO *bp, long *eline);
169 STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf,
170                                         const char *section);
171 char *NCONF_get_string(const CONF *conf, const char *group, const char *name);
172 int NCONF_get_number_e(const CONF *conf, const char *group, const char *name,
173                        long *result);
174 #ifndef OPENSSL_NO_STDIO
175 int NCONF_dump_fp(const CONF *conf, FILE *out);
176 #endif
177 int NCONF_dump_bio(const CONF *conf, BIO *out);
178
179 #define NCONF_get_number(c,g,n,r) NCONF_get_number_e(c,g,n,r)
180
181 /* Module functions */
182
183 int CONF_modules_load(const CONF *cnf, const char *appname,
184                       unsigned long flags);
185 int CONF_modules_load_file(const char *filename, const char *appname,
186                            unsigned long flags);
187 void CONF_modules_unload(int all);
188 void CONF_modules_finish(void);
189 void CONF_modules_free(void);
190 int CONF_module_add(const char *name, conf_init_func *ifunc,
191                     conf_finish_func *ffunc);
192
193 const char *CONF_imodule_get_name(const CONF_IMODULE *md);
194 const char *CONF_imodule_get_value(const CONF_IMODULE *md);
195 void *CONF_imodule_get_usr_data(const CONF_IMODULE *md);
196 void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data);
197 CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md);
198 unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md);
199 void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags);
200 void *CONF_module_get_usr_data(CONF_MODULE *pmod);
201 void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data);
202
203 char *CONF_get1_default_config_file(void);
204
205 int CONF_parse_list(const char *list, int sep, int nospc,
206                     int (*list_cb) (const char *elem, int len, void *usr),
207                     void *arg);
208
209 void OPENSSL_load_builtin_modules(void);
210
211 /* BEGIN ERROR CODES */
212 /*
213  * The following lines are auto generated by the script mkerr.pl. Any changes
214  * made after this point may be overwritten when the script is next run.
215  */
216 void ERR_load_CONF_strings(void);
217
218 /* Error codes for the CONF functions. */
219
220 /* Function codes. */
221 # define CONF_F_CONF_DUMP_FP                              104
222 # define CONF_F_CONF_LOAD                                 100
223 # define CONF_F_CONF_LOAD_BIO                             102
224 # define CONF_F_CONF_LOAD_FP                              103
225 # define CONF_F_CONF_MODULES_LOAD                         116
226 # define CONF_F_CONF_PARSE_LIST                           119
227 # define CONF_F_DEF_LOAD                                  120
228 # define CONF_F_DEF_LOAD_BIO                              121
229 # define CONF_F_MODULE_INIT                               115
230 # define CONF_F_MODULE_LOAD_DSO                           117
231 # define CONF_F_MODULE_RUN                                118
232 # define CONF_F_NCONF_DUMP_BIO                            105
233 # define CONF_F_NCONF_DUMP_FP                             106
234 # define CONF_F_NCONF_GET_NUMBER                          107
235 # define CONF_F_NCONF_GET_NUMBER_E                        112
236 # define CONF_F_NCONF_GET_SECTION                         108
237 # define CONF_F_NCONF_GET_STRING                          109
238 # define CONF_F_NCONF_LOAD                                113
239 # define CONF_F_NCONF_LOAD_BIO                            110
240 # define CONF_F_NCONF_LOAD_FP                             114
241 # define CONF_F_NCONF_NEW                                 111
242 # define CONF_F_STR_COPY                                  101
243
244 /* Reason codes. */
245 # define CONF_R_ERROR_LOADING_DSO                         110
246 # define CONF_R_LIST_CANNOT_BE_NULL                       115
247 # define CONF_R_MISSING_CLOSE_SQUARE_BRACKET              100
248 # define CONF_R_MISSING_EQUAL_SIGN                        101
249 # define CONF_R_MISSING_FINISH_FUNCTION                   111
250 # define CONF_R_MISSING_INIT_FUNCTION                     112
251 # define CONF_R_MODULE_INITIALIZATION_ERROR               109
252 # define CONF_R_NO_CLOSE_BRACE                            102
253 # define CONF_R_NO_CONF                                   105
254 # define CONF_R_NO_CONF_OR_ENVIRONMENT_VARIABLE           106
255 # define CONF_R_NO_SECTION                                107
256 # define CONF_R_NO_SUCH_FILE                              114
257 # define CONF_R_NO_VALUE                                  108
258 # define CONF_R_UNABLE_TO_CREATE_NEW_SECTION              103
259 # define CONF_R_UNKNOWN_MODULE_NAME                       113
260 # define CONF_R_VARIABLE_HAS_NO_VALUE                     104
261
262 #ifdef  __cplusplus
263 }
264 #endif
265 #endif