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