Oops. The pkcs8 man page wasn't finished: this is an updated version
[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 #ifdef  __cplusplus
63 extern "C" {
64 #endif
65
66 #include <openssl/bio.h>
67 #include <openssl/lhash.h>
68 #include <openssl/stack.h>
69 #include <openssl/safestack.h>
70
71 typedef struct
72         {
73         char *section;
74         char *name;
75         char *value;
76         } CONF_VALUE;
77
78 DECLARE_STACK_OF(CONF_VALUE)
79
80 LHASH *CONF_load(LHASH *conf,const char *file,long *eline);
81 LHASH *CONF_load_fp(LHASH *conf, FILE *fp,long *eline);
82 LHASH *CONF_load_bio(LHASH *conf, BIO *bp,long *eline);
83 STACK_OF(CONF_VALUE) *CONF_get_section(LHASH *conf,char *section);
84 char *CONF_get_string(LHASH *conf,char *group,char *name);
85 long CONF_get_number(LHASH *conf,char *group,char *name);
86 void CONF_free(LHASH *conf);
87 void ERR_load_CONF_strings(void );
88
89
90 /* BEGIN ERROR CODES */
91 /* The following lines are auto generated by the script mkerr.pl. Any changes
92  * made after this point may be overwritten when the script is next run.
93  */
94
95 /* Error codes for the CONF functions. */
96
97 /* Function codes. */
98 #define CONF_F_CONF_LOAD                                 100
99 #define CONF_F_CONF_LOAD_BIO                             102
100 #define CONF_F_CONF_LOAD_FP                              103
101 #define CONF_F_STR_COPY                                  101
102
103 /* Reason codes. */
104 #define CONF_R_MISSING_CLOSE_SQUARE_BRACKET              100
105 #define CONF_R_MISSING_EQUAL_SIGN                        101
106 #define CONF_R_NO_CLOSE_BRACE                            102
107 #define CONF_R_UNABLE_TO_CREATE_NEW_SECTION              103
108 #define CONF_R_VARIABLE_HAS_NO_VALUE                     104
109
110 #ifdef  __cplusplus
111 }
112 #endif
113 #endif
114