include/openssl/conf.h.in

   1 /*
   2  * {- join("\n * ", @autowarntext) -}
   3  *
   4  * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
   5  *
   6  * Licensed under the Apache License 2.0 (the "License").  You may not use
   7  * this file except in compliance with the License.  You can obtain a copy
   8  * in the file LICENSE in the source distribution or at
   9  * https://www.openssl.org/source/license.html
  10  */
  11
  12 {-
  13 use OpenSSL::stackhash qw(generate_stack_macros generate_lhash_macros);
  14 -}
  15
  16 #ifndef  OPENSSL_CONF_H
  17 # define OPENSSL_CONF_H
  18 # pragma once
  19
  20 # include <openssl/macros.h>
  21 # ifndef OPENSSL_NO_DEPRECATED_3_0
  22 #  define HEADER_CONF_H
  23 # endif
  24
  25 # include <openssl/bio.h>
  26 # include <openssl/lhash.h>
  27 # include <openssl/safestack.h>
  28 # include <openssl/e_os2.h>
  29 # include <openssl/types.h>
  30 # include <openssl/conferr.h>
  31
  32 #ifdef  __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 typedef struct {
  37     char *section;
  38     char *name;
  39     char *value;
  40 } CONF_VALUE;
  41
  42 {-
  43     generate_stack_macros("CONF_VALUE")
  44     .generate_lhash_macros("CONF_VALUE");
  45 -}
  46
  47 struct conf_st;
  48 struct conf_method_st;
  49 typedef struct conf_method_st CONF_METHOD;
  50
  51 struct conf_method_st {
  52     const char *name;
  53     CONF *(*create) (CONF_METHOD *meth);
  54     int (*init) (CONF *conf);
  55     int (*destroy) (CONF *conf);
  56     int (*destroy_data) (CONF *conf);
  57     int (*load_bio) (CONF *conf, BIO *bp, long *eline);
  58     int (*dump) (const CONF *conf, BIO *bp);
  59     int (*is_number) (const CONF *conf, char c);
  60     int (*to_int) (const CONF *conf, char c);
  61     int (*load) (CONF *conf, const char *name, long *eline);
  62 };
  63
  64 /* Module definitions */
  65
  66 typedef struct conf_imodule_st CONF_IMODULE;
  67 typedef struct conf_module_st CONF_MODULE;
  68
  69 STACK_OF(CONF_MODULE);
  70 STACK_OF(CONF_IMODULE);
  71
  72 /* DSO module function typedefs */
  73 typedef int conf_init_func (CONF_IMODULE *md, const CONF *cnf);
  74 typedef void conf_finish_func (CONF_IMODULE *md);
  75
  76 # define CONF_MFLAGS_IGNORE_ERRORS       0x1
  77 # define CONF_MFLAGS_IGNORE_RETURN_CODES 0x2
  78 # define CONF_MFLAGS_SILENT              0x4
  79 # define CONF_MFLAGS_NO_DSO              0x8
  80 # define CONF_MFLAGS_IGNORE_MISSING_FILE 0x10
  81 # define CONF_MFLAGS_DEFAULT_SECTION     0x20
  82
  83 int CONF_set_default_method(CONF_METHOD *meth);
  84 void CONF_set_nconf(CONF *conf, LHASH_OF(CONF_VALUE) *hash);
  85 LHASH_OF(CONF_VALUE) *CONF_load(LHASH_OF(CONF_VALUE) *conf, const char *file,
  86                                 long *eline);
  87 # ifndef OPENSSL_NO_STDIO
  88 LHASH_OF(CONF_VALUE) *CONF_load_fp(LHASH_OF(CONF_VALUE) *conf, FILE *fp,
  89                                    long *eline);
  90 # endif
  91 LHASH_OF(CONF_VALUE) *CONF_load_bio(LHASH_OF(CONF_VALUE) *conf, BIO *bp,
  92                                     long *eline);
  93 STACK_OF(CONF_VALUE) *CONF_get_section(LHASH_OF(CONF_VALUE) *conf,
  94                                        const char *section);
  95 char *CONF_get_string(LHASH_OF(CONF_VALUE) *conf, const char *group,
  96                       const char *name);
  97 long CONF_get_number(LHASH_OF(CONF_VALUE) *conf, const char *group,
  98                      const char *name);
  99 void CONF_free(LHASH_OF(CONF_VALUE) *conf);
 100 #ifndef OPENSSL_NO_STDIO
 101 int CONF_dump_fp(LHASH_OF(CONF_VALUE) *conf, FILE *out);
 102 #endif
 103 int CONF_dump_bio(LHASH_OF(CONF_VALUE) *conf, BIO *out);
 104
 105 DEPRECATEDIN_1_1_0(void OPENSSL_config(const char *config_name))
 106
 107 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
 108 # define OPENSSL_no_config() \
 109     OPENSSL_init_crypto(OPENSSL_INIT_NO_LOAD_CONFIG, NULL)
 110 #endif
 111
 112 /*
 113  * New conf code.  The semantics are different from the functions above. If
 114  * that wasn't the case, the above functions would have been replaced
 115  */
 116
 117 struct conf_st {
 118     CONF_METHOD *meth;
 119     void *meth_data;
 120     LHASH_OF(CONF_VALUE) *data;
 121     unsigned int flag_dollarid:1;
 122     OSSL_LIB_CTX *libctx;
 123 };
 124
 125 CONF *NCONF_new_ex(OSSL_LIB_CTX *libctx, CONF_METHOD *meth);
 126 CONF *NCONF_new(CONF_METHOD *meth);
 127 CONF_METHOD *NCONF_default(void);
 128 DEPRECATEDIN_3_0(CONF_METHOD *NCONF_WIN32(void))
 129 void NCONF_free(CONF *conf);
 130 void NCONF_free_data(CONF *conf);
 131
 132 int NCONF_load(CONF *conf, const char *file, long *eline);
 133 # ifndef OPENSSL_NO_STDIO
 134 int NCONF_load_fp(CONF *conf, FILE *fp, long *eline);
 135 # endif
 136 int NCONF_load_bio(CONF *conf, BIO *bp, long *eline);
 137 STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf,
 138                                         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 #ifndef OPENSSL_NO_STDIO
 143 int NCONF_dump_fp(const CONF *conf, FILE *out);
 144 #endif
 145 int NCONF_dump_bio(const CONF *conf, BIO *out);
 146
 147 #define NCONF_get_number(c,g,n,r) NCONF_get_number_e(c,g,n,r)
 148
 149 /* Module functions */
 150
 151 int CONF_modules_load(const CONF *cnf, const char *appname,
 152                       unsigned long flags);
 153 int CONF_modules_load_file_ex(OSSL_LIB_CTX *libctx, const char *filename,
 154                               const char *appname, unsigned long flags);
 155 int CONF_modules_load_file(const char *filename, const char *appname,
 156                            unsigned long flags);
 157 void CONF_modules_unload(int all);
 158 void CONF_modules_finish(void);
 159 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
 160 # define CONF_modules_free() while(0) continue
 161 #endif
 162 int CONF_module_add(const char *name, conf_init_func *ifunc,
 163                     conf_finish_func *ffunc);
 164
 165 const char *CONF_imodule_get_name(const CONF_IMODULE *md);
 166 const char *CONF_imodule_get_value(const CONF_IMODULE *md);
 167 void *CONF_imodule_get_usr_data(const CONF_IMODULE *md);
 168 void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data);
 169 CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md);
 170 unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md);
 171 void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags);
 172 void *CONF_module_get_usr_data(CONF_MODULE *pmod);
 173 void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data);
 174
 175 char *CONF_get1_default_config_file(void);
 176
 177 int CONF_parse_list(const char *list, int sep, int nospc,
 178                     int (*list_cb) (const char *elem, int len, void *usr),
 179                     void *arg);
 180
 181 void OPENSSL_load_builtin_modules(void);
 182
 183
 184 # ifdef  __cplusplus
 185 }
 186 # endif
 187 #endif