1 /* Copyright (C) 1995-1998 Eric Young ([email protected]) 2 * All rights reserved. 3 * 4 * This package is an SSL implementation written 5 * by Eric Young ([email protected]). 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 ([email protected]). 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 ([email protected])" 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 ([email protected])" 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. 71 // 72 // This library handles OpenSSL's config files, which look like: 73 // 74 // # Comment 75 // 76 // # This key is in the default section. 77 // key=value 78 // 79 // [section_name] 80 // key2=value2 81 // 82 // Config files are represented by a |CONF|. Use of this module is strongly 83 // discouraged. It is a remnant of the OpenSSL command-line tool. Parsing an 84 // untrusted input as a config file risks string injection and denial of service 85 // vulnerabilities. 86 87 88 struct conf_value_st { 89 char *section; 90 char *name; 91 char *value; 92 }; 93 94 DEFINE_STACK_OF(CONF_VALUE) 95 DECLARE_LHASH_OF(CONF_VALUE) 96 97 98 // NCONF_new returns a fresh, empty |CONF|, or NULL on error. The |method| 99 // argument must be NULL. 100 OPENSSL_EXPORT CONF *NCONF_new(void *method); 101 102 // NCONF_free frees all the data owned by |conf| and then |conf| itself. 103 OPENSSL_EXPORT void NCONF_free(CONF *conf); 104 105 // NCONF_load parses the file named |filename| and adds the values found to 106 // |conf|. It returns one on success and zero on error. In the event of an 107 // error, if |out_error_line| is not NULL, |*out_error_line| is set to the 108 // number of the line that contained the error. 109 OPENSSL_EXPORT int NCONF_load(CONF *conf, const char *filename, 110 long *out_error_line); 111 112 // NCONF_load_bio acts like |NCONF_load| but reads from |bio| rather than from 113 // a named file. 114 OPENSSL_EXPORT int NCONF_load_bio(CONF *conf, BIO *bio, long *out_error_line); 115 116 // NCONF_get_section returns a stack of values for a given section in |conf|. 117 // If |section| is NULL, the default section is returned. It returns NULL on 118 // error. 119 OPENSSL_EXPORT const STACK_OF(CONF_VALUE) *NCONF_get_section( 120 const CONF *conf, const char *section); 121 122 // NCONF_get_string returns the value of the key |name|, in section |section|. 123 // The |section| argument may be NULL to indicate the default section. It 124 // returns the value or NULL on error. 125 OPENSSL_EXPORT const char *NCONF_get_string(const CONF *conf, 126 const char *section, 127 const char *name); 128 129 130 // Deprecated functions 131 132 // These defines do nothing but are provided to make old code easier to 133 // compile. 134 #define CONF_MFLAGS_DEFAULT_SECTION 0 135 #define CONF_MFLAGS_IGNORE_MISSING_FILE 0 136 137 // CONF_modules_load_file returns one. BoringSSL is defined to have no config 138 // file options, thus loading from |filename| always succeeds by doing nothing. 139 OPENSSL_EXPORT int CONF_modules_load_file(const char *filename, 140 const char *appname, 141 unsigned long flags); 142 143 // CONF_modules_free does nothing. 144 OPENSSL_EXPORT void CONF_modules_free(void); 145 146 // OPENSSL_config does nothing. 147 OPENSSL_EXPORT void OPENSSL_config(const char *config_name); 148 149 // OPENSSL_no_config does nothing. 150 OPENSSL_EXPORT void OPENSSL_no_config(void); 151 152 153 #if defined(__cplusplus) 154 } // extern C 155 156 extern "C++" { 157 158 BSSL_NAMESPACE_BEGIN 159 160 BORINGSSL_MAKE_DELETER(CONF, NCONF_free) 161 162 BSSL_NAMESPACE_END 163 164 } // extern C++ 165 166 #endif 167 168 #define CONF_R_LIST_CANNOT_BE_NULL 100 169 #define CONF_R_MISSING_CLOSE_SQUARE_BRACKET 101 170 #define CONF_R_MISSING_EQUAL_SIGN 102 171 #define CONF_R_NO_CLOSE_BRACE 103 172 #define CONF_R_UNABLE_TO_CREATE_NEW_SECTION 104 173 #define CONF_R_VARIABLE_HAS_NO_VALUE 105 174 #define CONF_R_VARIABLE_EXPANSION_TOO_LONG 106 175 #define CONF_R_VARIABLE_EXPANSION_NOT_SUPPORTED 107 176 177 #endif // OPENSSL_HEADER_THREAD_H 178