conf.h 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183
  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. #ifndef OPENSSL_HEADER_CONF_H
  57. #define OPENSSL_HEADER_CONF_H
  58. #include <openssl/base.h>
  59. #include <openssl/stack.h>
  60. #include <openssl/lhash.h>
  61. #if defined(__cplusplus)
  62. extern "C" {
  63. #endif
  64. // Config files look like:
  65. //
  66. // # Comment
  67. //
  68. // # This key is in the default section.
  69. // key=value
  70. //
  71. // [section_name]
  72. // key2=value2
  73. //
  74. // Config files are represented by a |CONF|.
  75. struct conf_value_st {
  76. char *section;
  77. char *name;
  78. char *value;
  79. };
  80. DEFINE_STACK_OF(CONF_VALUE)
  81. DECLARE_LHASH_OF(CONF_VALUE)
  82. // NCONF_new returns a fresh, empty |CONF|, or NULL on error. The |method|
  83. // argument must be NULL.
  84. OPENSSL_EXPORT CONF *NCONF_new(void *method);
  85. // NCONF_free frees all the data owned by |conf| and then |conf| itself.
  86. OPENSSL_EXPORT void NCONF_free(CONF *conf);
  87. // NCONF_load parses the file named |filename| and adds the values found to
  88. // |conf|. It returns one on success and zero on error. In the event of an
  89. // error, if |out_error_line| is not NULL, |*out_error_line| is set to the
  90. // number of the line that contained the error.
  91. OPENSSL_EXPORT int NCONF_load(CONF *conf, const char *filename,
  92. long *out_error_line);
  93. // NCONF_load_bio acts like |NCONF_load| but reads from |bio| rather than from
  94. // a named file.
  95. OPENSSL_EXPORT int NCONF_load_bio(CONF *conf, BIO *bio, long *out_error_line);
  96. // NCONF_get_section returns a stack of values for a given section in |conf|.
  97. // If |section| is NULL, the default section is returned. It returns NULL on
  98. // error.
  99. OPENSSL_EXPORT STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf,
  100. const char *section);
  101. // NCONF_get_string returns the value of the key |name|, in section |section|.
  102. // The |section| argument may be NULL to indicate the default section. It
  103. // returns the value or NULL on error.
  104. OPENSSL_EXPORT const char *NCONF_get_string(const CONF *conf,
  105. const char *section,
  106. const char *name);
  107. // Utility functions
  108. // CONF_parse_list takes a list separated by 'sep' and calls |list_cb| giving
  109. // the start and length of each member, optionally stripping leading and
  110. // trailing whitespace. This can be used to parse comma separated lists for
  111. // example. If |list_cb| returns <= 0, then the iteration is halted and that
  112. // value is returned immediately. Otherwise it returns one. Note that |list_cb|
  113. // may be called on an empty member.
  114. int CONF_parse_list(const char *list, char sep, int remove_whitespace,
  115. int (*list_cb)(const char *elem, int len, void *usr),
  116. void *arg);
  117. // Deprecated functions
  118. // These defines do nothing but are provided to make old code easier to
  119. // compile.
  120. #define CONF_MFLAGS_DEFAULT_SECTION 0
  121. #define CONF_MFLAGS_IGNORE_MISSING_FILE 0
  122. // CONF_modules_load_file returns one. BoringSSL is defined to have no config
  123. // file options, thus loading from |filename| always succeeds by doing nothing.
  124. OPENSSL_EXPORT int CONF_modules_load_file(const char *filename,
  125. const char *appname,
  126. unsigned long flags);
  127. // CONF_modules_free does nothing.
  128. OPENSSL_EXPORT void CONF_modules_free(void);
  129. // OPENSSL_config does nothing.
  130. OPENSSL_EXPORT void OPENSSL_config(const char *config_name);
  131. // OPENSSL_no_config does nothing.
  132. OPENSSL_EXPORT void OPENSSL_no_config(void);
  133. #if defined(__cplusplus)
  134. } // extern C
  135. extern "C++" {
  136. BSSL_NAMESPACE_BEGIN
  137. BORINGSSL_MAKE_DELETER(CONF, NCONF_free)
  138. BSSL_NAMESPACE_END
  139. } // extern C++
  140. #endif
  141. #define CONF_R_LIST_CANNOT_BE_NULL 100
  142. #define CONF_R_MISSING_CLOSE_SQUARE_BRACKET 101
  143. #define CONF_R_MISSING_EQUAL_SIGN 102
  144. #define CONF_R_NO_CLOSE_BRACE 103
  145. #define CONF_R_UNABLE_TO_CREATE_NEW_SECTION 104
  146. #define CONF_R_VARIABLE_HAS_NO_VALUE 105
  147. #define CONF_R_VARIABLE_EXPANSION_TOO_LONG 106
  148. #endif // OPENSSL_HEADER_THREAD_H