1 /* crypto/conf/conf.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
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.
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).
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.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
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)"
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
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.]
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>
79 DECLARE_STACK_OF(CONF_VALUE)
80 DECLARE_STACK_OF(CONF_MODULE)
81 DECLARE_STACK_OF(CONF_IMODULE)
84 typedef struct conf_st CONF;
85 struct conf_method_st;
86 typedef struct conf_method_st CONF_METHOD;
91 CONF *(*create)(CONF_METHOD *meth);
92 int (*init)(CONF *conf);
93 int (*destroy)(CONF *conf);
94 int (*destroy_data)(CONF *conf);
95 int (*load_bio)(CONF *conf, BIO *bp, long *eline);
96 int (*dump)(CONF *conf, BIO *bp);
97 int (*is_number)(CONF *conf, char c);
98 int (*to_int)(CONF *conf, char c);
99 int (*load)(CONF *conf, const char *name, long *eline);
102 /* Module definitions */
104 typedef struct conf_imodule_st CONF_IMODULE;
105 typedef struct conf_module_st CONF_MODULE;
107 /* DSO module function typedefs */
108 typedef int conf_init_func(CONF_IMODULE *md, CONF *cnf);
109 typedef void conf_finish_func(CONF_IMODULE *md);
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
116 int CONF_set_default_method(CONF_METHOD *meth);
117 void CONF_set_nconf(CONF *conf,LHASH *hash);
118 LHASH *CONF_load(LHASH *conf,const char *file,long *eline);
119 #ifndef OPENSSL_NO_FP_API
120 LHASH *CONF_load_fp(LHASH *conf, FILE *fp,long *eline);
122 LHASH *CONF_load_bio(LHASH *conf, BIO *bp,long *eline);
123 STACK_OF(CONF_VALUE) *CONF_get_section(LHASH *conf,char *section);
124 char *CONF_get_string(LHASH *conf,char *group,char *name);
125 long CONF_get_number(LHASH *conf,char *group,char *name);
126 void CONF_free(LHASH *conf);
127 int CONF_dump_fp(LHASH *conf, FILE *out);
128 int CONF_dump_bio(LHASH *conf, BIO *out);
130 /* New conf code. The semantics are different from the functions above.
131 If that wasn't the case, the above functions would have been replaced */
140 CONF *NCONF_new(CONF_METHOD *meth);
141 CONF_METHOD *NCONF_default();
142 CONF_METHOD *NCONF_WIN32();
143 #if 0 /* Just to give you an idea of what I have in mind */
144 CONF_METHOD *NCONF_XML();
146 void NCONF_free(CONF *conf);
147 void NCONF_free_data(CONF *conf);
149 int NCONF_load(CONF *conf,const char *file,long *eline);
150 #ifndef OPENSSL_NO_FP_API
151 int NCONF_load_fp(CONF *conf, FILE *fp,long *eline);
153 int NCONF_load_bio(CONF *conf, BIO *bp,long *eline);
154 STACK_OF(CONF_VALUE) *NCONF_get_section(CONF *conf,char *section);
155 char *NCONF_get_string(CONF *conf,char *group,char *name);
156 int NCONF_get_number_e(CONF *conf,char *group,char *name,long *result);
157 int NCONF_dump_fp(CONF *conf, FILE *out);
158 int NCONF_dump_bio(CONF *conf, BIO *out);
160 #if 0 /* The following function has no error checking,
161 and should therefore be avoided */
162 long NCONF_get_number(CONF *conf,char *group,char *name);
164 #define NCONF_get_number(c,g,n,r) NCONF_get_number_e(c,g,n,r)
167 /* Module functions */
169 int CONF_modules_load(CONF *cnf, char *appname, unsigned long flags);
170 int CONF_modules_load_file(char *filename, char *appname, unsigned long flags);
171 void CONF_modules_unload(int all);
172 void CONF_modules_finish(void);
173 int CONF_module_add(char *name, conf_init_func *ifunc, conf_finish_func *ffunc);
175 char *CONF_imodule_get_name(CONF_IMODULE *md);
176 char *CONF_imodule_get_value(CONF_IMODULE *md);
177 void *CONF_imodule_get_usr_data(CONF_IMODULE *md);
178 void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data);
179 CONF_MODULE *CONF_imodule_get_module(CONF_IMODULE *md);
180 unsigned long CONF_imodule_get_flags(CONF_IMODULE *md);
181 void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags);
182 void *CONF_module_get_usr_data(CONF_MODULE *pmod);
183 void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data);
185 /* BEGIN ERROR CODES */
186 /* The following lines are auto generated by the script mkerr.pl. Any changes
187 * made after this point may be overwritten when the script is next run.
189 void ERR_load_CONF_strings(void);
190 /* Error codes for the CONF functions. */
192 /* Function codes. */
193 #define CONF_F_CONF_DUMP_FP 104
194 #define CONF_F_CONF_LOAD 100
195 #define CONF_F_CONF_LOAD_BIO 102
196 #define CONF_F_CONF_LOAD_FP 103
197 #define CONF_F_CONF_MODULES_LOAD 116
198 #define CONF_F_MODULE_INIT 115
199 #define CONF_F_MODULE_LOAD_DSO 117
200 #define CONF_F_MODULE_RUN 118
201 #define CONF_F_NCONF_DUMP_BIO 105
202 #define CONF_F_NCONF_DUMP_FP 106
203 #define CONF_F_NCONF_GET_NUMBER 107
204 #define CONF_F_NCONF_GET_NUMBER_E 112
205 #define CONF_F_NCONF_GET_SECTION 108
206 #define CONF_F_NCONF_GET_STRING 109
207 #define CONF_F_NCONF_LOAD 113
208 #define CONF_F_NCONF_LOAD_BIO 110
209 #define CONF_F_NCONF_LOAD_FP 114
210 #define CONF_F_NCONF_NEW 111
211 #define CONF_F_STR_COPY 101
214 #define CONF_R_ERROR_LOADING_DSO 110
215 #define CONF_R_MISSING_CLOSE_SQUARE_BRACKET 100
216 #define CONF_R_MISSING_EQUAL_SIGN 101
217 #define CONF_R_MISSING_FINISH_FUNCTION 111
218 #define CONF_R_MISSING_INIT_FUNCTION 112
219 #define CONF_R_MODULE_INITIALIZATION_ERROR 109
220 #define CONF_R_NO_CLOSE_BRACE 102
221 #define CONF_R_NO_CONF 105
222 #define CONF_R_NO_CONF_OR_ENVIRONMENT_VARIABLE 106
223 #define CONF_R_NO_SECTION 107
224 #define CONF_R_NO_VALUE 108
225 #define CONF_R_UNABLE_TO_CREATE_NEW_SECTION 103
226 #define CONF_R_UNKNOWN_MODULE_NAME 113
227 #define CONF_R_VARIABLE_HAS_NO_VALUE 104