56b5f5c216f8081e445ea0f49e8c129fa25d9831
[openssl.git] / crypto / conf / conf.h
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 #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_os.h>
67
68 #ifdef  __cplusplus
69 extern "C" {
70 #endif
71
72 typedef struct
73         {
74         char *section;
75         char *name;
76         char *value;
77         } CONF_VALUE;
78
79 DECLARE_STACK_OF(CONF_VALUE)
80
81 struct conf_st;
82 typedef struct conf_st CONF;
83 struct conf_method_st;
84 typedef struct conf_method_st CONF_METHOD;
85
86 struct conf_method_st
87         {
88         const char *name;
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)(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         };
98
99 int CONF_set_default_method(CONF_METHOD *meth);
100 LHASH *CONF_load(LHASH *conf,const char *file,long *eline);
101 #ifndef NO_FP_API
102 LHASH *CONF_load_fp(LHASH *conf, FILE *fp,long *eline);
103 #endif
104 LHASH *CONF_load_bio(LHASH *conf, BIO *bp,long *eline);
105 STACK_OF(CONF_VALUE) *CONF_get_section(LHASH *conf,char *section);
106 char *CONF_get_string(LHASH *conf,char *group,char *name);
107 long CONF_get_number(LHASH *conf,char *group,char *name);
108 void CONF_free(LHASH *conf);
109 void CONF_dump(LHASH *conf, BIO *out);
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 );
113
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 */
116
117 struct conf_st
118         {
119         CONF_METHOD *meth;
120         void *meth_data;
121         LHASH *data;
122         };
123
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();
129 #endif
130 void NCONF_free(CONF *conf);
131 void NCONF_free_data(CONF *conf);
132
133 int NCONF_load(CONF *conf,const char *file,long *eline);
134 #ifndef NO_FP_API
135 int NCONF_load_fp(CONF *conf, FILE *fp,long *eline);
136 #endif
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 long NCONF_get_number(CONF *conf,char *group,char *name);
141 int NCONF_dump_fp(CONF *conf, FILE *out);
142 int NCONF_dump_bio(CONF *conf, BIO *out);
143
144
145 /* BEGIN ERROR CODES */
146 /* The following lines are auto generated by the script mkerr.pl. Any changes
147  * made after this point may be overwritten when the script is next run.
148  */
149
150 /* Error codes for the CONF functions. */
151
152 /* Function codes. */
153 #define CONF_F_CONF_DUMP_FP                              104
154 #define CONF_F_CONF_LOAD                                 100
155 #define CONF_F_CONF_LOAD_BIO                             102
156 #define CONF_F_CONF_LOAD_FP                              103
157 #define CONF_F_NCONF_DUMP_BIO                            105
158 #define CONF_F_NCONF_DUMP_FP                             106
159 #define CONF_F_NCONF_GET_NUMBER                          107
160 #define CONF_F_NCONF_GET_SECTION                         108
161 #define CONF_F_NCONF_GET_STRING                          109
162 #define CONF_F_NCONF_LOAD_BIO                            110
163 #define CONF_F_NCONF_NEW                                 111
164 #define CONF_F_STR_COPY                                  101
165
166 /* Reason codes. */
167 #define CONF_R_MISSING_CLOSE_SQUARE_BRACKET              100
168 #define CONF_R_MISSING_EQUAL_SIGN                        101
169 #define CONF_R_NO_CLOSE_BRACE                            102
170 #define CONF_R_NO_CONF                                   105
171 #define CONF_R_UNABLE_TO_CREATE_NEW_SECTION              103
172 #define CONF_R_VARIABLE_HAS_NO_VALUE                     104
173
174 #ifdef  __cplusplus
175 }
176 #endif
177 #endif
178