conf.h 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246
  1. /* $OpenBSD: conf.h,v 1.16 2022/07/12 14:42:48 kn Exp $ */
  2. /* Copyright (C) 1995-1998 Eric Young ([email protected])
  3. * All rights reserved.
  4. *
  5. * This package is an SSL implementation written
  6. * by Eric Young ([email protected]).
  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 ([email protected]).
  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 ([email protected])"
  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 ([email protected])"
  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. #ifndef HEADER_CONF_H
  59. #define HEADER_CONF_H
  60. #include <openssl/opensslconf.h>
  61. #include <openssl/bio.h>
  62. #include <openssl/lhash.h>
  63. #include <openssl/stack.h>
  64. #include <openssl/safestack.h>
  65. #include <openssl/ossl_typ.h>
  66. #ifdef __cplusplus
  67. extern "C" {
  68. #endif
  69. typedef struct {
  70. char *section;
  71. char *name;
  72. char *value;
  73. } CONF_VALUE;
  74. DECLARE_STACK_OF(CONF_VALUE)
  75. DECLARE_LHASH_OF(CONF_VALUE);
  76. struct conf_st;
  77. struct conf_method_st;
  78. typedef struct conf_method_st CONF_METHOD;
  79. struct conf_method_st {
  80. const char *name;
  81. CONF *(*create)(CONF_METHOD *meth);
  82. int (*init)(CONF *conf);
  83. int (*destroy)(CONF *conf);
  84. int (*destroy_data)(CONF *conf);
  85. int (*load_bio)(CONF *conf, BIO *bp, long *eline);
  86. int (*dump)(const CONF *conf, BIO *bp);
  87. int (*is_number)(const CONF *conf, char c);
  88. int (*to_int)(const CONF *conf, char c);
  89. int (*load)(CONF *conf, const char *name, long *eline);
  90. };
  91. /* Module definitions */
  92. typedef struct conf_imodule_st CONF_IMODULE;
  93. typedef struct conf_module_st CONF_MODULE;
  94. DECLARE_STACK_OF(CONF_MODULE)
  95. DECLARE_STACK_OF(CONF_IMODULE)
  96. /* DSO module function typedefs */
  97. typedef int conf_init_func(CONF_IMODULE *md, const CONF *cnf);
  98. typedef void conf_finish_func(CONF_IMODULE *md);
  99. #define CONF_MFLAGS_IGNORE_ERRORS 0x1
  100. #define CONF_MFLAGS_IGNORE_RETURN_CODES 0x2
  101. #define CONF_MFLAGS_SILENT 0x4
  102. #define CONF_MFLAGS_NO_DSO 0x8
  103. #define CONF_MFLAGS_IGNORE_MISSING_FILE 0x10
  104. #define CONF_MFLAGS_DEFAULT_SECTION 0x20
  105. int CONF_set_default_method(CONF_METHOD *meth);
  106. void CONF_set_nconf(CONF *conf, LHASH_OF(CONF_VALUE) *hash);
  107. LHASH_OF(CONF_VALUE) *CONF_load(LHASH_OF(CONF_VALUE) *conf, const char *file,
  108. long *eline);
  109. LHASH_OF(CONF_VALUE) *CONF_load_fp(LHASH_OF(CONF_VALUE) *conf, FILE *fp,
  110. long *eline);
  111. LHASH_OF(CONF_VALUE) *CONF_load_bio(LHASH_OF(CONF_VALUE) *conf, BIO *bp, long *eline);
  112. STACK_OF(CONF_VALUE) *CONF_get_section(LHASH_OF(CONF_VALUE) *conf,
  113. const char *section);
  114. char *CONF_get_string(LHASH_OF(CONF_VALUE) *conf, const char *group,
  115. const char *name);
  116. long CONF_get_number(LHASH_OF(CONF_VALUE) *conf, const char *group,
  117. const char *name);
  118. void CONF_free(LHASH_OF(CONF_VALUE) *conf);
  119. int CONF_dump_fp(LHASH_OF(CONF_VALUE) *conf, FILE *out);
  120. int CONF_dump_bio(LHASH_OF(CONF_VALUE) *conf, BIO *out);
  121. void OPENSSL_config(const char *config_name);
  122. void OPENSSL_no_config(void);
  123. /* New conf code. The semantics are different from the functions above.
  124. If that wasn't the case, the above functions would have been replaced */
  125. struct conf_st {
  126. CONF_METHOD *meth;
  127. void *meth_data;
  128. LHASH_OF(CONF_VALUE) *data;
  129. };
  130. CONF *NCONF_new(CONF_METHOD *meth);
  131. CONF_METHOD *NCONF_default(void);
  132. CONF_METHOD *NCONF_WIN32(void);
  133. void NCONF_free(CONF *conf);
  134. void NCONF_free_data(CONF *conf);
  135. int NCONF_load(CONF *conf, const char *file, long *eline);
  136. int NCONF_load_fp(CONF *conf, FILE *fp, long *eline);
  137. int NCONF_load_bio(CONF *conf, BIO *bp, long *eline);
  138. STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf, const char *section);
  139. char *NCONF_get_string(const CONF *conf, const char *group, const char *name);
  140. int NCONF_get_number_e(const CONF *conf, const char *group, const char *name,
  141. long *result);
  142. int NCONF_dump_fp(const CONF *conf, FILE *out);
  143. int NCONF_dump_bio(const CONF *conf, BIO *out);
  144. #define NCONF_get_number(c,g,n,r) NCONF_get_number_e(c,g,n,r)
  145. /* Module functions */
  146. int CONF_modules_load(const CONF *cnf, const char *appname,
  147. unsigned long flags);
  148. int CONF_modules_load_file(const char *filename, const char *appname,
  149. unsigned long flags);
  150. void CONF_modules_unload(int all);
  151. void CONF_modules_finish(void);
  152. void CONF_modules_free(void);
  153. int CONF_module_add(const char *name, conf_init_func *ifunc,
  154. conf_finish_func *ffunc);
  155. const char *CONF_imodule_get_name(const CONF_IMODULE *md);
  156. const char *CONF_imodule_get_value(const CONF_IMODULE *md);
  157. void *CONF_imodule_get_usr_data(const CONF_IMODULE *md);
  158. void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data);
  159. CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md);
  160. unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md);
  161. void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags);
  162. void *CONF_module_get_usr_data(CONF_MODULE *pmod);
  163. void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data);
  164. char *CONF_get1_default_config_file(void);
  165. int CONF_parse_list(const char *list, int sep, int nospc,
  166. int (*list_cb)(const char *elem, int len, void *usr), void *arg);
  167. void OPENSSL_load_builtin_modules(void);
  168. void ERR_load_CONF_strings(void);
  169. /* Error codes for the CONF functions. */
  170. /* Function codes. */
  171. #define CONF_F_CONF_DUMP_FP 104
  172. #define CONF_F_CONF_LOAD 100
  173. #define CONF_F_CONF_LOAD_BIO 102
  174. #define CONF_F_CONF_LOAD_FP 103
  175. #define CONF_F_CONF_MODULES_LOAD 116
  176. #define CONF_F_CONF_PARSE_LIST 119
  177. #define CONF_F_DEF_LOAD 120
  178. #define CONF_F_DEF_LOAD_BIO 121
  179. #define CONF_F_MODULE_INIT 115
  180. #define CONF_F_MODULE_LOAD_DSO 117
  181. #define CONF_F_MODULE_RUN 118
  182. #define CONF_F_NCONF_DUMP_BIO 105
  183. #define CONF_F_NCONF_DUMP_FP 106
  184. #define CONF_F_NCONF_GET_NUMBER 107
  185. #define CONF_F_NCONF_GET_NUMBER_E 112
  186. #define CONF_F_NCONF_GET_SECTION 108
  187. #define CONF_F_NCONF_GET_STRING 109
  188. #define CONF_F_NCONF_LOAD 113
  189. #define CONF_F_NCONF_LOAD_BIO 110
  190. #define CONF_F_NCONF_LOAD_FP 114
  191. #define CONF_F_NCONF_NEW 111
  192. #define CONF_F_STR_COPY 101
  193. /* Reason codes. */
  194. #define CONF_R_ERROR_LOADING_DSO 110
  195. #define CONF_R_LIST_CANNOT_BE_NULL 115
  196. #define CONF_R_MISSING_CLOSE_SQUARE_BRACKET 100
  197. #define CONF_R_MISSING_EQUAL_SIGN 101
  198. #define CONF_R_MISSING_FINISH_FUNCTION 111
  199. #define CONF_R_MISSING_INIT_FUNCTION 112
  200. #define CONF_R_MODULE_INITIALIZATION_ERROR 109
  201. #define CONF_R_NO_CLOSE_BRACE 102
  202. #define CONF_R_NO_CONF 105
  203. #define CONF_R_NO_CONF_OR_ENVIRONMENT_VARIABLE 106
  204. #define CONF_R_NO_SECTION 107
  205. #define CONF_R_NO_SUCH_FILE 114
  206. #define CONF_R_NO_VALUE 108
  207. #define CONF_R_UNABLE_TO_CREATE_NEW_SECTION 103
  208. #define CONF_R_UNKNOWN_MODULE_NAME 113
  209. #define CONF_R_VARIABLE_EXPANSION_TOO_LONG 116
  210. #define CONF_R_VARIABLE_HAS_NO_VALUE 104
  211. #ifdef __cplusplus
  212. }
  213. #endif
  214. #endif