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 module deimos.openssl.conf;
60 
61 import deimos.openssl._d_util;
62 
63 public import deimos.openssl.bio;
64 public import deimos.openssl.lhash;
65 public import deimos.openssl.stack;
66 public import deimos.openssl.safestack;
67 public import deimos.openssl.e_os2;
68 
69 public import deimos.openssl.ossl_typ;
70 
71 extern (C):
72 nothrow:
73 
74 struct CONF_VALUE
75 	{
76 	char* section;
77 	char* name;
78 	char* value;
79 	}
80 
81 struct lhash_st_CONF_VALUE;     // declare type to make it compile, needed until this module and lhash.d is uplifted to >= 1.1.0h and supports "DEFINE_LHASH_OF"
82 
83 /+mixin DECLARE_STACK_OF!(CONF_VALUE);+/
84 mixin DECLARE_LHASH_OF!(CONF_VALUE);
85 
86 alias conf_method_st CONF_METHOD;
87 
88 struct conf_method_st
89 	{
90 	const(char)* name;
91 	ExternC!(CONF* function(CONF_METHOD* meth)) create;
92 	ExternC!(int function(CONF* conf)) init_;
93 	ExternC!(int function(CONF* conf)) destroy;
94 	ExternC!(int function(CONF* conf)) destroy_data;
95 	ExternC!(int function(CONF* conf, BIO* bp, c_long* eline)) load_bio;
96 	ExternC!(int function(const(CONF)* conf, BIO* bp)) dump;
97 	ExternC!(int function(const(CONF)* conf, char c)) is_number;
98 	ExternC!(int function(const(CONF)* conf, char c)) to_int;
99 	ExternC!(int function(CONF* conf, const(char)* name, c_long* eline)) load;
100 	};
101 
102 /* Module definitions */
103 
104 struct conf_imodule_st;
105 alias conf_imodule_st CONF_IMODULE;
106 struct conf_module_st;
107 alias conf_module_st CONF_MODULE;
108 
109 /+mixin DECLARE_STACK_OF!(CONF_MODULE);+/
110 /+mixin DECLARE_STACK_OF!(CONF_IMODULE);+/
111 
112 /* DSO module function typedefs */
113 alias typeof(*(ExternC!(int function(CONF_IMODULE* md, const(CONF)* cnf))).init) conf_init_func;
114 alias typeof(*(ExternC!(void function(CONF_IMODULE* md))).init) conf_finish_func;
115 
116 enum CONF_MFLAGS_IGNORE_ERRORS = 0x1;
117 enum CONF_MFLAGS_IGNORE_RETURN_CODES = 0x2;
118 enum CONF_MFLAGS_SILENT = 0x4;
119 enum CONF_MFLAGS_NO_DSO = 0x8;
120 enum CONF_MFLAGS_IGNORE_MISSING_FILE = 0x10;
121 enum CONF_MFLAGS_DEFAULT_SECTION = 0x20;
122 
123 int CONF_set_default_method(CONF_METHOD* meth);
124 void CONF_set_nconf(CONF* conf,LHASH_OF!(CONF_VALUE) *hash);
125 LHASH_OF!(CONF_VALUE) *CONF_load(LHASH_OF!(CONF_VALUE) *conf,const(char)* file,
126 				c_long* eline);
127 version(OPENSSL_NO_FP_API) {} else {
128 LHASH_OF!(CONF_VALUE) *CONF_load_fp(LHASH_OF!(CONF_VALUE) *conf, FILE* fp,
129 				   c_long* eline);
130 }
131 LHASH_OF!(CONF_VALUE) *CONF_load_bio(LHASH_OF!(CONF_VALUE) *conf, BIO* bp,c_long* eline);
132 STACK_OF!(CONF_VALUE) *CONF_get_section(LHASH_OF!(CONF_VALUE) *conf,
133 				       const(char)* section);
134 char* CONF_get_string(LHASH_OF!(CONF_VALUE) *conf,const(char)* group,
135 		      const(char)* name);
136 c_long CONF_get_number(LHASH_OF!(CONF_VALUE) *conf,const(char)* group,
137 		     const(char)* name);
138 void CONF_free(LHASH_OF!(CONF_VALUE) *conf);
139 int CONF_dump_fp(LHASH_OF!(CONF_VALUE) *conf, FILE* out_);
140 int CONF_dump_bio(LHASH_OF!(CONF_VALUE) *conf, BIO* out_);
141 
142 void OPENSSL_config(const(char)* config_name);
143 void OPENSSL_no_config();
144 
145 /* New conf code.  The semantics are different from the functions above.
146    If that wasn't the case, the above functions would have been replaced */
147 
148 struct conf_st
149 	{
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();
157 CONF_METHOD* NCONF_WIN32();
158 version (none) { /* Just to give you an idea of what I have in mind */
159 CONF_METHOD* NCONF_XML();
160 }
161 void NCONF_free(CONF* conf);
162 void NCONF_free_data(CONF* conf);
163 
164 int NCONF_load(CONF* conf,const(char)* file,c_long* eline);
165 version(OPENSSL_NO_FP_API) {} else {
166 int NCONF_load_fp(CONF* conf, FILE* fp,c_long* eline);
167 }
168 int NCONF_load_bio(CONF* conf, BIO* bp,c_long* eline);
169 STACK_OF!(CONF_VALUE) *NCONF_get_section(const(CONF)* conf,const(char)* section);
170 char* NCONF_get_string(const(CONF)* conf,const(char)* group,const(char)* name);
171 int NCONF_get_number_e(const(CONF)* conf,const(char)* group,const(char)* name,
172 		       c_long* result);
173 int NCONF_dump_fp(const(CONF)* conf, FILE* out_);
174 int NCONF_dump_bio(const(CONF)* conf, BIO* out_);
175 
176 version (none) { /* The following function has no error checking,
177 	 and should therefore be avoided */
178 c_long NCONF_get_number(CONF* conf,char* group,char* name);
179 } else {
180 alias NCONF_get_number_e NCONF_get_number;
181 }
182 
183 /* Module functions */
184 
185 int CONF_modules_load(const(CONF)* cnf, const(char)* appname,
186 		      c_ulong flags);
187 int CONF_modules_load_file(const(char)* filename, const(char)* appname,
188 			   c_ulong flags);
189 void CONF_modules_unload(int all);
190 void CONF_modules_finish();
191 void CONF_modules_free();
192 int CONF_module_add(const(char)* name, conf_init_func* ifunc,
193 		    conf_finish_func* ffunc);
194 
195 const(char)* CONF_imodule_get_name(const(CONF_IMODULE)* md);
196 const(char)* CONF_imodule_get_value(const(CONF_IMODULE)* md);
197 void* CONF_imodule_get_usr_data(const(CONF_IMODULE)* md);
198 void CONF_imodule_set_usr_data(CONF_IMODULE* md, void* usr_data);
199 CONF_MODULE* CONF_imodule_get_module(const(CONF_IMODULE)* md);
200 c_ulong CONF_imodule_get_flags(const(CONF_IMODULE)* md);
201 void CONF_imodule_set_flags(CONF_IMODULE* md, c_ulong flags);
202 void* CONF_module_get_usr_data(CONF_MODULE* pmod);
203 void CONF_module_set_usr_data(CONF_MODULE* pmod, void* usr_data);
204 
205 char* CONF_get1_default_config_file();
206 
207 int CONF_parse_list(const(char)* list, int sep, int nospc,
208 	ExternC!(int function(const(char)* elem, int len, void* usr)) list_cb, void* arg);
209 
210 void OPENSSL_load_builtin_modules();
211 
212 /* BEGIN ERROR CODES */
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();
217 
218 /* Error codes for the CONF functions. */
219 
220 /* Function codes. */
221 enum CONF_F_CONF_DUMP_FP = 104;
222 enum CONF_F_CONF_LOAD = 100;
223 enum CONF_F_CONF_LOAD_BIO = 102;
224 enum CONF_F_CONF_LOAD_FP = 103;
225 enum CONF_F_CONF_MODULES_LOAD = 116;
226 enum CONF_F_CONF_PARSE_LIST = 119;
227 enum CONF_F_DEF_LOAD = 120;
228 enum CONF_F_DEF_LOAD_BIO = 121;
229 enum CONF_F_MODULE_INIT = 115;
230 enum CONF_F_MODULE_LOAD_DSO = 117;
231 enum CONF_F_MODULE_RUN = 118;
232 enum CONF_F_NCONF_DUMP_BIO = 105;
233 enum CONF_F_NCONF_DUMP_FP = 106;
234 enum CONF_F_NCONF_GET_NUMBER = 107;
235 enum CONF_F_NCONF_GET_NUMBER_E = 112;
236 enum CONF_F_NCONF_GET_SECTION = 108;
237 enum CONF_F_NCONF_GET_STRING = 109;
238 enum CONF_F_NCONF_LOAD = 113;
239 enum CONF_F_NCONF_LOAD_BIO = 110;
240 enum CONF_F_NCONF_LOAD_FP = 114;
241 enum CONF_F_NCONF_NEW = 111;
242 enum CONF_F_STR_COPY = 101;
243 
244 /* Reason codes. */
245 enum CONF_R_ERROR_LOADING_DSO = 110;
246 enum CONF_R_LIST_CANNOT_BE_NULL = 115;
247 enum CONF_R_MISSING_CLOSE_SQUARE_BRACKET = 100;
248 enum CONF_R_MISSING_EQUAL_SIGN = 101;
249 enum CONF_R_MISSING_FINISH_FUNCTION = 111;
250 enum CONF_R_MISSING_INIT_FUNCTION = 112;
251 enum CONF_R_MODULE_INITIALIZATION_ERROR = 109;
252 enum CONF_R_NO_CLOSE_BRACE = 102;
253 enum CONF_R_NO_CONF = 105;
254 enum CONF_R_NO_CONF_OR_ENVIRONMENT_VARIABLE = 106;
255 enum CONF_R_NO_SECTION = 107;
256 enum CONF_R_NO_SUCH_FILE = 114;
257 enum CONF_R_NO_VALUE = 108;
258 enum CONF_R_UNABLE_TO_CREATE_NEW_SECTION = 103;
259 enum CONF_R_UNKNOWN_MODULE_NAME = 113;
260 enum CONF_R_VARIABLE_HAS_NO_VALUE = 104;