1/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2 * All rights reserved.
3 *
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
7 *
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to.  The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14 *
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
21 *
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
24 * are met:
25 * 1. Redistributions of source code must retain the copyright
26 *    notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 *    notice, this list of conditions and the following disclaimer in the
29 *    documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 *    must display the following acknowledgement:
32 *    "This product includes cryptographic software written by
33 *     Eric Young (eay@cryptsoft.com)"
34 *    The word 'cryptographic' can be left out if the rouines from the library
35 *    being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 *    the apps directory (application code) you must include an acknowledgement:
38 *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39 *
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50 * SUCH DAMAGE.
51 *
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed.  i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.] */
56
57#ifndef OPENSSL_HEADER_CONF_H
58#define OPENSSL_HEADER_CONF_H
59
60#include <openssl/base.h>
61
62#include <openssl/stack.h>
63#include <openssl/lhash.h>
64
65#if defined(__cplusplus)
66extern "C" {
67#endif
68
69
70/* Config files look like:
71 *
72 *   # Comment
73 *
74 *   # This key is in the default section.
75 *   key=value
76 *
77 *   [section_name]
78 *   key2=value2
79 *
80 * Config files are representated by a |CONF|. */
81
82typedef struct {
83  char *section;
84  char *name;
85  char *value;
86} CONF_VALUE;
87
88struct conf_st {
89  LHASH_OF(CONF_VALUE) *data;
90};
91
92
93/* NCONF_new returns a fresh, empty |CONF|, or NULL on error. */
94CONF *NCONF_new(void);
95
96/* NCONF_free frees all the data owned by |conf| and then |conf| itself. */
97void NCONF_free(CONF *conf);
98
99/* NCONF_load parses the file named |filename| and adds the values found to
100 * |conf|. It returns one on success and zero on error. In the event of an
101 * error, if |out_error_line| is not NULL, |*out_error_line| is set to the
102 * number of the line that contained the error. */
103int NCONF_load(CONF *conf, const char *filename, long *out_error_line);
104
105/* NCONF_get_section returns a stack of values for a given section in |conf|.
106 * If |section| is NULL, the default section is returned. It returns NULL on
107 * error. */
108STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf, const char *section);
109
110/* NCONF_get_string returns the value of the key |name|, in section |section|.
111 * The |section| argument may be NULL to indicate the default section. It
112 * returns the value or NULL on error. */
113const char *NCONF_get_string(const CONF *conf, const char *section,
114                             const char *name);
115
116
117/* Utility functions */
118
119/* CONF_parse_list takes a list separated by 'sep' and calls |list_cb| giving
120 * the start and length of each member, optionally stripping leading and
121 * trailing whitespace. This can be used to parse comma separated lists for
122 * example. If |list_cb| returns <= 0, then the iteration is halted and that
123 * value is returned immediately. Otherwise it returns one. */
124int CONF_parse_list(const char *list, char sep, int remove_whitespace,
125                    int (*list_cb)(const char *elem, int len, void *usr),
126                    void *arg);
127
128#if defined(__cplusplus)
129}  /* extern C */
130#endif
131
132#define CONF_F_CONF_parse_list 100
133#define CONF_F_str_copy 101
134#define CONF_F_def_load_bio 102
135#define CONF_F_NCONF_load 103
136#define CONF_R_MISSING_EQUAL_SIGN 100
137#define CONF_R_LIST_CANNOT_BE_NULL 101
138#define CONF_R_NO_CLOSE_BRACE 102
139#define CONF_R_VARIABLE_HAS_NO_VALUE 103
140#define CONF_R_UNABLE_TO_CREATE_NEW_SECTION 104
141#define CONF_R_MISSING_CLOSE_SQUARE_BRACKET 105
142
143#endif  /* OPENSSL_HEADER_THREAD_H */
144