Home | History | Annotate | Download | only in openssl
      1 /* Copyright (C) 1995-1998 Eric Young (eay (at) cryptsoft.com)
      2  * All rights reserved.
      3  *
      4  * This package is an SSL implementation written
      5  * by Eric Young (eay (at) 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 (at) 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 (at) 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 (at) 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)
     66 extern "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 
     82 struct conf_value_st {
     83   char *section;
     84   char *name;
     85   char *value;
     86 };
     87 
     88 struct conf_st {
     89   LHASH_OF(CONF_VALUE) *data;
     90 };
     91 
     92 
     93 /* NCONF_new returns a fresh, empty |CONF|, or NULL on error. The |method|
     94  * argument must be NULL. */
     95 CONF *NCONF_new(void *method);
     96 
     97 /* NCONF_free frees all the data owned by |conf| and then |conf| itself. */
     98 void NCONF_free(CONF *conf);
     99 
    100 /* NCONF_load parses the file named |filename| and adds the values found to
    101  * |conf|. It returns one on success and zero on error. In the event of an
    102  * error, if |out_error_line| is not NULL, |*out_error_line| is set to the
    103  * number of the line that contained the error. */
    104 int NCONF_load(CONF *conf, const char *filename, long *out_error_line);
    105 
    106 /* NCONF_load_bio acts like |NCONF_load| but reads from |bio| rather than from
    107  * a named file. */
    108 int NCONF_load_bio(CONF *conf, BIO *bio, long *out_error_line);
    109 
    110 /* NCONF_get_section returns a stack of values for a given section in |conf|.
    111  * If |section| is NULL, the default section is returned. It returns NULL on
    112  * error. */
    113 STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf, const char *section);
    114 
    115 /* NCONF_get_string returns the value of the key |name|, in section |section|.
    116  * The |section| argument may be NULL to indicate the default section. It
    117  * returns the value or NULL on error. */
    118 const char *NCONF_get_string(const CONF *conf, const char *section,
    119                              const char *name);
    120 
    121 
    122 /* Utility functions */
    123 
    124 /* CONF_parse_list takes a list separated by 'sep' and calls |list_cb| giving
    125  * the start and length of each member, optionally stripping leading and
    126  * trailing whitespace. This can be used to parse comma separated lists for
    127  * example. If |list_cb| returns <= 0, then the iteration is halted and that
    128  * value is returned immediately. Otherwise it returns one. Note that |list_cb|
    129  * may be called on an empty member. */
    130 int CONF_parse_list(const char *list, char sep, int remove_whitespace,
    131                     int (*list_cb)(const char *elem, int len, void *usr),
    132                     void *arg);
    133 
    134 
    135 /* Deprecated functions */
    136 
    137 /* These defines do nothing but are provided to make old code easier to
    138  * compile. */
    139 #define CONF_MFLAGS_DEFAULT_SECTION 0
    140 #define CONF_MFLAGS_IGNORE_MISSING_FILE 0
    141 
    142 typedef struct conf_must_be_null_st CONF_MUST_BE_NULL;
    143 
    144 /* CONF_modules_load_file returns one. |filename| was originally a string, with
    145  * NULL indicating the default. BoringSSL does not support configuration files,
    146  * so this stub emulates the "default" no-op file but intentionally breaks
    147  * compilation of consumers actively attempting to use this subsystem. */
    148 OPENSSL_EXPORT int CONF_modules_load_file(CONF_MUST_BE_NULL *filename,
    149                                           const char *appname,
    150                                           unsigned long flags);
    151 
    152 /* CONF_modules_free does nothing. */
    153 OPENSSL_EXPORT void CONF_modules_free(void);
    154 
    155 
    156 #if defined(__cplusplus)
    157 }  /* extern C */
    158 #endif
    159 
    160 #define CONF_R_LIST_CANNOT_BE_NULL 100
    161 #define CONF_R_MISSING_CLOSE_SQUARE_BRACKET 101
    162 #define CONF_R_MISSING_EQUAL_SIGN 102
    163 #define CONF_R_NO_CLOSE_BRACE 103
    164 #define CONF_R_UNABLE_TO_CREATE_NEW_SECTION 104
    165 #define CONF_R_VARIABLE_HAS_NO_VALUE 105
    166 
    167 #endif  /* OPENSSL_HEADER_THREAD_H */
    168