1 /* $OpenBSD: conf.h,v 1.14 2015/02/07 13:19:15 doug Exp $ */
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/opensslconf.h>
63 
64 #include <openssl/bio.h>
65 #include <openssl/lhash.h>
66 #include <openssl/stack.h>
67 #include <openssl/safestack.h>
68 
69 #include <openssl/ossl_typ.h>
70 
71 #ifdef  __cplusplus
72 extern "C" {
73 #endif
74 
75 typedef struct {
76 	char *section;
77 	char *name;
78 	char *value;
79 } CONF_VALUE;
80 
81 DECLARE_STACK_OF(CONF_VALUE)
82 DECLARE_LHASH_OF(CONF_VALUE);
83 
84 struct conf_st;
85 struct conf_method_st;
86 typedef struct conf_method_st CONF_METHOD;
87 
88 struct conf_method_st {
89 	const char *name;
90 	CONF *(*create)(CONF_METHOD *meth);
91 	int (*init)(CONF *conf);
92 	int (*destroy)(CONF *conf);
93 	int (*destroy_data)(CONF *conf);
94 	int (*load_bio)(CONF *conf, BIO *bp, long *eline);
95 	int (*dump)(const CONF *conf, BIO *bp);
96 	int (*is_number)(const CONF *conf, char c);
97 	int (*to_int)(const CONF *conf, char c);
98 	int (*load)(CONF *conf, const char *name, long *eline);
99 };
100 
101 /* Module definitions */
102 
103 typedef struct conf_imodule_st CONF_IMODULE;
104 typedef struct conf_module_st CONF_MODULE;
105 
106 DECLARE_STACK_OF(CONF_MODULE)
107 DECLARE_STACK_OF(CONF_IMODULE)
108 
109 /* DSO module function typedefs */
110 typedef int conf_init_func(CONF_IMODULE *md, const CONF *cnf);
111 typedef void conf_finish_func(CONF_IMODULE *md);
112 
113 #define	CONF_MFLAGS_IGNORE_ERRORS	0x1
114 #define CONF_MFLAGS_IGNORE_RETURN_CODES	0x2
115 #define CONF_MFLAGS_SILENT		0x4
116 #define CONF_MFLAGS_NO_DSO		0x8
117 #define CONF_MFLAGS_IGNORE_MISSING_FILE	0x10
118 #define CONF_MFLAGS_DEFAULT_SECTION	0x20
119 
120 int CONF_set_default_method(CONF_METHOD *meth);
121 void CONF_set_nconf(CONF *conf, LHASH_OF(CONF_VALUE) *hash);
122 LHASH_OF(CONF_VALUE) *CONF_load(LHASH_OF(CONF_VALUE) *conf, const char *file,
123     long *eline);
124 LHASH_OF(CONF_VALUE) *CONF_load_fp(LHASH_OF(CONF_VALUE) *conf, FILE *fp,
125     long *eline);
126 LHASH_OF(CONF_VALUE) *CONF_load_bio(LHASH_OF(CONF_VALUE) *conf, BIO *bp, long *eline);
127 STACK_OF(CONF_VALUE) *CONF_get_section(LHASH_OF(CONF_VALUE) *conf,
128     const char *section);
129 char *CONF_get_string(LHASH_OF(CONF_VALUE) *conf, const char *group,
130     const char *name);
131 long CONF_get_number(LHASH_OF(CONF_VALUE) *conf, const char *group,
132     const char *name);
133 void CONF_free(LHASH_OF(CONF_VALUE) *conf);
134 int CONF_dump_fp(LHASH_OF(CONF_VALUE) *conf, FILE *out);
135 int CONF_dump_bio(LHASH_OF(CONF_VALUE) *conf, BIO *out);
136 
137 void OPENSSL_config(const char *config_name);
138 void OPENSSL_no_config(void);
139 
140 /* New conf code.  The semantics are different from the functions above.
141    If that wasn't the case, the above functions would have been replaced */
142 
143 struct conf_st {
144 	CONF_METHOD *meth;
145 	void *meth_data;
146 	LHASH_OF(CONF_VALUE) *data;
147 };
148 
149 CONF *NCONF_new(CONF_METHOD *meth);
150 CONF_METHOD *NCONF_default(void);
151 CONF_METHOD *NCONF_WIN32(void);
152 void NCONF_free(CONF *conf);
153 void NCONF_free_data(CONF *conf);
154 
155 int NCONF_load(CONF *conf, const char *file, long *eline);
156 int NCONF_load_fp(CONF *conf, FILE *fp, long *eline);
157 int NCONF_load_bio(CONF *conf, BIO *bp, long *eline);
158 STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf, const char *section);
159 char *NCONF_get_string(const CONF *conf, const char *group, const char *name);
160 int NCONF_get_number_e(const CONF *conf, const char *group, const char *name,
161     long *result);
162 int NCONF_dump_fp(const CONF *conf, FILE *out);
163 int NCONF_dump_bio(const CONF *conf, BIO *out);
164 
165 #define NCONF_get_number(c,g,n,r) NCONF_get_number_e(c,g,n,r)
166 
167 /* Module functions */
168 
169 int CONF_modules_load(const CONF *cnf, const char *appname,
170     unsigned long flags);
171 int CONF_modules_load_file(const char *filename, const char *appname,
172     unsigned long flags);
173 void CONF_modules_unload(int all);
174 void CONF_modules_finish(void);
175 void CONF_modules_free(void);
176 int CONF_module_add(const char *name, conf_init_func *ifunc,
177     conf_finish_func *ffunc);
178 
179 const char *CONF_imodule_get_name(const CONF_IMODULE *md);
180 const char *CONF_imodule_get_value(const CONF_IMODULE *md);
181 void *CONF_imodule_get_usr_data(const CONF_IMODULE *md);
182 void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data);
183 CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md);
184 unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md);
185 void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags);
186 void *CONF_module_get_usr_data(CONF_MODULE *pmod);
187 void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data);
188 
189 char *CONF_get1_default_config_file(void);
190 
191 int CONF_parse_list(const char *list, int sep, int nospc,
192     int (*list_cb)(const char *elem, int len, void *usr), void *arg);
193 
194 void OPENSSL_load_builtin_modules(void);
195 
196 /* BEGIN ERROR CODES */
197 /* The following lines are auto generated by the script mkerr.pl. Any changes
198  * made after this point may be overwritten when the script is next run.
199  */
200 void ERR_load_CONF_strings(void);
201 
202 /* Error codes for the CONF functions. */
203 
204 /* Function codes. */
205 #define CONF_F_CONF_DUMP_FP				 104
206 #define CONF_F_CONF_LOAD				 100
207 #define CONF_F_CONF_LOAD_BIO				 102
208 #define CONF_F_CONF_LOAD_FP				 103
209 #define CONF_F_CONF_MODULES_LOAD			 116
210 #define CONF_F_CONF_PARSE_LIST				 119
211 #define CONF_F_DEF_LOAD					 120
212 #define CONF_F_DEF_LOAD_BIO				 121
213 #define CONF_F_MODULE_INIT				 115
214 #define CONF_F_MODULE_LOAD_DSO				 117
215 #define CONF_F_MODULE_RUN				 118
216 #define CONF_F_NCONF_DUMP_BIO				 105
217 #define CONF_F_NCONF_DUMP_FP				 106
218 #define CONF_F_NCONF_GET_NUMBER				 107
219 #define CONF_F_NCONF_GET_NUMBER_E			 112
220 #define CONF_F_NCONF_GET_SECTION			 108
221 #define CONF_F_NCONF_GET_STRING				 109
222 #define CONF_F_NCONF_LOAD				 113
223 #define CONF_F_NCONF_LOAD_BIO				 110
224 #define CONF_F_NCONF_LOAD_FP				 114
225 #define CONF_F_NCONF_NEW				 111
226 #define CONF_F_STR_COPY					 101
227 
228 /* Reason codes. */
229 #define CONF_R_ERROR_LOADING_DSO			 110
230 #define CONF_R_LIST_CANNOT_BE_NULL			 115
231 #define CONF_R_MISSING_CLOSE_SQUARE_BRACKET		 100
232 #define CONF_R_MISSING_EQUAL_SIGN			 101
233 #define CONF_R_MISSING_FINISH_FUNCTION			 111
234 #define CONF_R_MISSING_INIT_FUNCTION			 112
235 #define CONF_R_MODULE_INITIALIZATION_ERROR		 109
236 #define CONF_R_NO_CLOSE_BRACE				 102
237 #define CONF_R_NO_CONF					 105
238 #define CONF_R_NO_CONF_OR_ENVIRONMENT_VARIABLE		 106
239 #define CONF_R_NO_SECTION				 107
240 #define CONF_R_NO_SUCH_FILE				 114
241 #define CONF_R_NO_VALUE					 108
242 #define CONF_R_UNABLE_TO_CREATE_NEW_SECTION		 103
243 #define CONF_R_UNKNOWN_MODULE_NAME			 113
244 #define CONF_R_VARIABLE_HAS_NO_VALUE			 104
245 
246 #ifdef  __cplusplus
247 }
248 #endif
249 #endif
250