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_os.h>
79 DECLARE_STACK_OF(CONF_VALUE
)
82 typedef struct conf_st CONF
;
83 struct conf_method_st
;
84 typedef struct conf_method_st CONF_METHOD
;
89 CONF
*(MS_FAR
*create
)(CONF_METHOD
*meth
);
90 int (MS_FAR
*init
)(CONF
*conf
);
91 int (MS_FAR
*destroy
)(CONF
*conf
);
92 int (MS_FAR
*destroy_data
)(CONF
*conf
);
93 int (MS_FAR
*load_bio
)(CONF
*conf
, BIO
*bp
, long *eline
);
94 int (MS_FAR
*dump
)(CONF
*conf
, BIO
*bp
);
95 int (MS_FAR
*is_number
)(CONF
*conf
, char c
);
96 int (MS_FAR
*to_int
)(CONF
*conf
, char c
);
97 int (MS_FAR
*load
)(CONF
*conf
, const char *name
, long *eline
);
100 int CONF_set_default_method(CONF_METHOD
*meth
);
101 LHASH
*CONF_load(LHASH
*conf
,const char *file
,long *eline
);
103 LHASH
*CONF_load_fp(LHASH
*conf
, FILE *fp
,long *eline
);
105 LHASH
*CONF_load_bio(LHASH
*conf
, BIO
*bp
,long *eline
);
106 STACK_OF(CONF_VALUE
) *CONF_get_section(LHASH
*conf
,char *section
);
107 char *CONF_get_string(LHASH
*conf
,char *group
,char *name
);
108 long CONF_get_number(LHASH
*conf
,char *group
,char *name
);
109 void CONF_free(LHASH
*conf
);
110 int CONF_dump_fp(LHASH
*conf
, FILE *out
);
111 int CONF_dump_bio(LHASH
*conf
, BIO
*out
);
112 void ERR_load_CONF_strings(void );
114 /* New conf code. The semantics are different from the functions above.
115 If that wasn't the case, the above functions would have been replaced */
124 CONF
*NCONF_new(CONF_METHOD
*meth
);
125 CONF_METHOD
*NCONF_default();
126 CONF_METHOD
*NCONF_WIN32();
127 #if 0 /* Just to give you an idea of what I have in mind */
128 CONF_METHOD
*NCONF_XML();
130 void NCONF_free(CONF
*conf
);
131 void NCONF_free_data(CONF
*conf
);
133 int NCONF_load(CONF
*conf
,const char *file
,long *eline
);
135 int NCONF_load_fp(CONF
*conf
, FILE *fp
,long *eline
);
137 int NCONF_load_bio(CONF
*conf
, BIO
*bp
,long *eline
);
138 STACK_OF(CONF_VALUE
) *NCONF_get_section(CONF
*conf
,char *section
);
139 char *NCONF_get_string(CONF
*conf
,char *group
,char *name
);
140 int NCONF_get_number_e(CONF
*conf
,char *group
,char *name
,long *result
);
141 int NCONF_dump_fp(CONF
*conf
, FILE *out
);
142 int NCONF_dump_bio(CONF
*conf
, BIO
*out
);
144 #if 0 /* The following function has no error checking,
145 and should therefore be avoided */
146 long NCONF_get_number(CONF
*conf
,char *group
,char *name
);
148 #define NCONF_get_number(c,g,n,r) NCONF_get_number_e(c,g,n,r);
152 /* BEGIN ERROR CODES */
153 /* The following lines are auto generated by the script mkerr.pl. Any changes
154 * made after this point may be overwritten when the script is next run.
157 /* Error codes for the CONF functions. */
159 /* Function codes. */
160 #define CONF_F_CONF_DUMP_FP 104
161 #define CONF_F_CONF_LOAD 100
162 #define CONF_F_CONF_LOAD_BIO 102
163 #define CONF_F_CONF_LOAD_FP 103
164 #define CONF_F_NCONF_DUMP_BIO 105
165 #define CONF_F_NCONF_DUMP_FP 106
166 #define CONF_F_NCONF_GET_NUMBER 107
167 #define CONF_F_NCONF_GET_NUMBER_E 112
168 #define CONF_F_NCONF_GET_SECTION 108
169 #define CONF_F_NCONF_GET_STRING 109
170 #define CONF_F_NCONF_LOAD 113
171 #define CONF_F_NCONF_LOAD_BIO 110
172 #define CONF_F_NCONF_LOAD_FP 114
173 #define CONF_F_NCONF_NEW 111
174 #define CONF_F_STR_COPY 101
177 #define CONF_R_MISSING_CLOSE_SQUARE_BRACKET 100
178 #define CONF_R_MISSING_EQUAL_SIGN 101
179 #define CONF_R_NO_CLOSE_BRACE 102
180 #define CONF_R_NO_CONF 105
181 #define CONF_R_NO_CONF_OR_ENVIRONMENT_VARIABLE 106
182 #define CONF_R_NO_SECTION 107
183 #define CONF_R_NO_VALUE 108
184 #define CONF_R_UNABLE_TO_CREATE_NEW_SECTION 103
185 #define CONF_R_VARIABLE_HAS_NO_VALUE 104