Debian Codegraph @

Cryptlib/Include/openssl/conf.h

raw
1 /* crypto/conf/conf.h */
2 /* Copyright (C) 1995-1998 Eric Young ([email protected])
3 * All rights reserved.
4 *
5 * This package is an SSL implementation written
6 * by Eric Young ([email protected]).
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 ([email protected]).
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 ([email protected])"
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 ([email protected])"
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 DECLARE_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 DECLARE_STACK_OF(CONF_MODULE)
106 DECLARE_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 # ifndef OPENSSL_NO_STDIO
122 LHASH_OF(CONF_VALUE) *CONF_load(LHASH_OF(CONF_VALUE) *conf, const char *file,
123 long *eline);
124 # endif
125 # ifndef OPENSSL_NO_FP_API
126 LHASH_OF(CONF_VALUE) *CONF_load_fp(LHASH_OF(CONF_VALUE) *conf, FILE *fp,
127 long *eline);
128 # endif
129 LHASH_OF(CONF_VALUE) *CONF_load_bio(LHASH_OF(CONF_VALUE) *conf, BIO *bp,
130 long *eline);
131 STACK_OF(CONF_VALUE) *CONF_get_section(LHASH_OF(CONF_VALUE) *conf,
132 const char *section);
133 char *CONF_get_string(LHASH_OF(CONF_VALUE) *conf, const char *group,
134 const char *name);
135 long CONF_get_number(LHASH_OF(CONF_VALUE) *conf, const char *group,
136 const char *name);
137 void CONF_free(LHASH_OF(CONF_VALUE) *conf);
138 # ifndef OPENSSL_NO_FP_API
139 int CONF_dump_fp(LHASH_OF(CONF_VALUE) *conf, FILE *out);
140 # endif
141 int CONF_dump_bio(LHASH_OF(CONF_VALUE) *conf, BIO *out);
142
143 void OPENSSL_config(const char *config_name);
144 void OPENSSL_no_config(void);
145
146 /*
147 * New conf code. The semantics are different from the functions above. If
148 * that wasn't the case, the above functions would have been replaced
149 */
150
151 struct conf_st {
152 CONF_METHOD *meth;
153 void *meth_data;
154 LHASH_OF(CONF_VALUE) *data;
155 };
156
157 CONF *NCONF_new(CONF_METHOD *meth);
158 CONF_METHOD *NCONF_default(void);
159 CONF_METHOD *NCONF_WIN32(void);
160 # if 0 /* Just to give you an idea of what I have in
161 * mind */
162 CONF_METHOD *NCONF_XML(void);
163 # endif
164 void NCONF_free(CONF *conf);
165 void NCONF_free_data(CONF *conf);
166
167 # ifndef OPENSSL_NO_STDIO
168 int NCONF_load(CONF *conf, const char *file, long *eline);
169 # endif
170 # ifndef OPENSSL_NO_FP_API
171 int NCONF_load_fp(CONF *conf, FILE *fp, long *eline);
172 # endif
173 int NCONF_load_bio(CONF *conf, BIO *bp, long *eline);
174 STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf,
175 const char *section);
176 char *NCONF_get_string(const CONF *conf, const char *group, const char *name);
177 int NCONF_get_number_e(const CONF *conf, const char *group, const char *name,
178 long *result);
179 # ifndef OPENSSL_NO_FP_API
180 int NCONF_dump_fp(const CONF *conf, FILE *out);
181 # endif
182 int NCONF_dump_bio(const CONF *conf, BIO *out);
183
184 # if 0 /* The following function has no error
185 * checking, and should therefore be avoided */
186 long NCONF_get_number(CONF *conf, char *group, char *name);
187 # else
188 # define NCONF_get_number(c,g,n,r) NCONF_get_number_e(c,g,n,r)
189 # endif
190
191 /* Module functions */
192
193 int CONF_modules_load(const CONF *cnf, const char *appname,
194 unsigned long flags);
195 # ifndef OPENSSL_NO_STDIO
196 int CONF_modules_load_file(const char *filename, const char *appname,
197 unsigned long flags);
198 # endif
199 void CONF_modules_unload(int all);
200 void CONF_modules_finish(void);
201 void CONF_modules_free(void);
202 int CONF_module_add(const char *name, conf_init_func *ifunc,
203 conf_finish_func *ffunc);
204
205 const char *CONF_imodule_get_name(const CONF_IMODULE *md);
206 const char *CONF_imodule_get_value(const CONF_IMODULE *md);
207 void *CONF_imodule_get_usr_data(const CONF_IMODULE *md);
208 void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data);
209 CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md);
210 unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md);
211 void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags);
212 void *CONF_module_get_usr_data(CONF_MODULE *pmod);
213 void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data);
214
215 char *CONF_get1_default_config_file(void);
216
217 int CONF_parse_list(const char *list, int sep, int nospc,
218 int (*list_cb) (const char *elem, int len, void *usr),
219 void *arg);
220
221 void OPENSSL_load_builtin_modules(void);
222
223 /* BEGIN ERROR CODES */
224 /*
225 * The following lines are auto generated by the script mkerr.pl. Any changes
226 * made after this point may be overwritten when the script is next run.
227 */
228 void ERR_load_CONF_strings(void);
229
230 /* Error codes for the CONF functions. */
231
232 /* Function codes. */
233 # define CONF_F_CONF_DUMP_FP 104
234 # define CONF_F_CONF_LOAD 100
235 # define CONF_F_CONF_LOAD_BIO 102
236 # define CONF_F_CONF_LOAD_FP 103
237 # define CONF_F_CONF_MODULES_LOAD 116
238 # define CONF_F_CONF_PARSE_LIST 119
239 # define CONF_F_DEF_LOAD 120
240 # define CONF_F_DEF_LOAD_BIO 121
241 # define CONF_F_MODULE_INIT 115
242 # define CONF_F_MODULE_LOAD_DSO 117
243 # define CONF_F_MODULE_RUN 118
244 # define CONF_F_NCONF_DUMP_BIO 105
245 # define CONF_F_NCONF_DUMP_FP 106
246 # define CONF_F_NCONF_GET_NUMBER 107
247 # define CONF_F_NCONF_GET_NUMBER_E 112
248 # define CONF_F_NCONF_GET_SECTION 108
249 # define CONF_F_NCONF_GET_STRING 109
250 # define CONF_F_NCONF_LOAD 113
251 # define CONF_F_NCONF_LOAD_BIO 110
252 # define CONF_F_NCONF_LOAD_FP 114
253 # define CONF_F_NCONF_NEW 111
254 # define CONF_F_STR_COPY 101
255
256 /* Reason codes. */
257 # define CONF_R_ERROR_LOADING_DSO 110
258 # define CONF_R_LIST_CANNOT_BE_NULL 115
259 # define CONF_R_MISSING_CLOSE_SQUARE_BRACKET 100
260 # define CONF_R_MISSING_EQUAL_SIGN 101
261 # define CONF_R_MISSING_FINISH_FUNCTION 111
262 # define CONF_R_MISSING_INIT_FUNCTION 112
263 # define CONF_R_MODULE_INITIALIZATION_ERROR 109
264 # define CONF_R_NO_CLOSE_BRACE 102
265 # define CONF_R_NO_CONF 105
266 # define CONF_R_NO_CONF_OR_ENVIRONMENT_VARIABLE 106
267 # define CONF_R_NO_SECTION 107
268 # define CONF_R_NO_SUCH_FILE 114
269 # define CONF_R_NO_VALUE 108
270 # define CONF_R_UNABLE_TO_CREATE_NEW_SECTION 103
271 # define CONF_R_UNKNOWN_MODULE_NAME 113
272 # define CONF_R_VARIABLE_HAS_NO_VALUE 104
273
274 #ifdef __cplusplus
275 }
276 #endif
277 #endif