Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 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) |
| 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 | * |
Steven Valdez | b0b45c6 | 2017-01-17 16:23:54 -0500 | [diff] [blame] | 80 | * Config files are represented by a |CONF|. */ |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 81 | |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 82 | struct conf_value_st { |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 83 | char *section; |
| 84 | char *name; |
| 85 | char *value; |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 86 | }; |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 87 | |
| 88 | struct conf_st { |
| 89 | LHASH_OF(CONF_VALUE) *data; |
| 90 | }; |
| 91 | |
Robert Sloan | 8ff0355 | 2017-06-14 12:40:58 -0700 | [diff] [blame^] | 92 | DEFINE_STACK_OF(CONF_VALUE) |
| 93 | |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 94 | |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 95 | /* NCONF_new returns a fresh, empty |CONF|, or NULL on error. The |method| |
| 96 | * argument must be NULL. */ |
David Benjamin | 4969cc9 | 2016-04-22 15:02:23 -0400 | [diff] [blame] | 97 | OPENSSL_EXPORT CONF *NCONF_new(void *method); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 98 | |
| 99 | /* NCONF_free frees all the data owned by |conf| and then |conf| itself. */ |
David Benjamin | 4969cc9 | 2016-04-22 15:02:23 -0400 | [diff] [blame] | 100 | OPENSSL_EXPORT void NCONF_free(CONF *conf); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 101 | |
| 102 | /* NCONF_load parses the file named |filename| and adds the values found to |
| 103 | * |conf|. It returns one on success and zero on error. In the event of an |
| 104 | * error, if |out_error_line| is not NULL, |*out_error_line| is set to the |
| 105 | * number of the line that contained the error. */ |
| 106 | int NCONF_load(CONF *conf, const char *filename, long *out_error_line); |
| 107 | |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 108 | /* NCONF_load_bio acts like |NCONF_load| but reads from |bio| rather than from |
| 109 | * a named file. */ |
| 110 | int NCONF_load_bio(CONF *conf, BIO *bio, long *out_error_line); |
| 111 | |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 112 | /* NCONF_get_section returns a stack of values for a given section in |conf|. |
| 113 | * If |section| is NULL, the default section is returned. It returns NULL on |
| 114 | * error. */ |
| 115 | STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf, const char *section); |
| 116 | |
| 117 | /* NCONF_get_string returns the value of the key |name|, in section |section|. |
| 118 | * The |section| argument may be NULL to indicate the default section. It |
| 119 | * returns the value or NULL on error. */ |
| 120 | const char *NCONF_get_string(const CONF *conf, const char *section, |
| 121 | const char *name); |
| 122 | |
| 123 | |
| 124 | /* Utility functions */ |
| 125 | |
| 126 | /* CONF_parse_list takes a list separated by 'sep' and calls |list_cb| giving |
| 127 | * the start and length of each member, optionally stripping leading and |
| 128 | * trailing whitespace. This can be used to parse comma separated lists for |
| 129 | * example. If |list_cb| returns <= 0, then the iteration is halted and that |
| 130 | * value is returned immediately. Otherwise it returns one. Note that |list_cb| |
| 131 | * may be called on an empty member. */ |
| 132 | int CONF_parse_list(const char *list, char sep, int remove_whitespace, |
| 133 | int (*list_cb)(const char *elem, int len, void *usr), |
| 134 | void *arg); |
| 135 | |
David Benjamin | 4969cc9 | 2016-04-22 15:02:23 -0400 | [diff] [blame] | 136 | |
| 137 | /* Deprecated functions */ |
| 138 | |
| 139 | /* These defines do nothing but are provided to make old code easier to |
| 140 | * compile. */ |
| 141 | #define CONF_MFLAGS_DEFAULT_SECTION 0 |
| 142 | #define CONF_MFLAGS_IGNORE_MISSING_FILE 0 |
| 143 | |
| 144 | typedef struct conf_must_be_null_st CONF_MUST_BE_NULL; |
| 145 | |
| 146 | /* CONF_modules_load_file returns one. |filename| was originally a string, with |
| 147 | * NULL indicating the default. BoringSSL does not support configuration files, |
| 148 | * so this stub emulates the "default" no-op file but intentionally breaks |
| 149 | * compilation of consumers actively attempting to use this subsystem. */ |
| 150 | OPENSSL_EXPORT int CONF_modules_load_file(CONF_MUST_BE_NULL *filename, |
| 151 | const char *appname, |
| 152 | unsigned long flags); |
| 153 | |
| 154 | /* CONF_modules_free does nothing. */ |
| 155 | OPENSSL_EXPORT void CONF_modules_free(void); |
| 156 | |
| 157 | /* OPENSSL_config does nothing. */ |
| 158 | OPENSSL_EXPORT void OPENSSL_config(CONF_MUST_BE_NULL *config_name); |
| 159 | |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 160 | /* OPENSSL_no_config does nothing. */ |
| 161 | OPENSSL_EXPORT void OPENSSL_no_config(void); |
| 162 | |
David Benjamin | 4969cc9 | 2016-04-22 15:02:23 -0400 | [diff] [blame] | 163 | |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 164 | #if defined(__cplusplus) |
| 165 | } /* extern C */ |
David Benjamin | f0c4a6c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 166 | |
| 167 | extern "C++" { |
| 168 | |
| 169 | namespace bssl { |
| 170 | |
| 171 | BORINGSSL_MAKE_DELETER(CONF, NCONF_free) |
| 172 | |
| 173 | } // namespace bssl |
| 174 | |
| 175 | } /* extern C++ */ |
| 176 | |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 177 | #endif |
| 178 | |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 179 | #define CONF_R_LIST_CANNOT_BE_NULL 100 |
| 180 | #define CONF_R_MISSING_CLOSE_SQUARE_BRACKET 101 |
| 181 | #define CONF_R_MISSING_EQUAL_SIGN 102 |
| 182 | #define CONF_R_NO_CLOSE_BRACE 103 |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 183 | #define CONF_R_UNABLE_TO_CREATE_NEW_SECTION 104 |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 184 | #define CONF_R_VARIABLE_HAS_NO_VALUE 105 |
Robert Sloan | 8ecb7cd | 2017-03-21 09:39:01 -0700 | [diff] [blame] | 185 | #define CONF_R_VARIABLE_EXPANSION_TOO_LONG 106 |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 186 | |
| 187 | #endif /* OPENSSL_HEADER_THREAD_H */ |