lib/param/param.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Generic parameter parsing interface
   4    Copyright (C) Jelmer Vernooij                                          2005
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef _PARAM_H /* _PARAM_H */
  21 #define _PARAM_H
  22
  23 #include <talloc.h>
  24
  25 struct loadparm_s3_helpers;
  26 struct loadparm_substitution;
  27
  28 struct parmlist_entry;
  29
  30 struct param_context {
  31         struct param_section *sections;
  32 };
  33
  34 struct param_section {
  35         const char *name;
  36         struct param_section *prev, *next;
  37         struct parmlist *parameters;
  38 };
  39
  40 struct param_context;
  41 struct smbsrv_connection;
  42
  43 #define Auto (2)
  44
  45 struct loadparm_context;
  46 struct loadparm_service;
  47 struct smbcli_options;
  48 struct smbcli_session_options;
  49 struct gensec_settings;
  50 struct bitmap;
  51 struct file_lists;
  52
  53 #ifdef CONFIG_H_IS_FROM_SAMBA
  54 #include "lib/param/param_proto.h"
  55 #include "lib/param/param_functions.h"
  56 #endif
  57
  58 const char **lpcfg_interfaces(struct loadparm_context *);
  59 const char *lpcfg_realm(struct loadparm_context *);
  60 const char *lpcfg_netbios_name(struct loadparm_context *);
  61 const char *lpcfg_private_dir(struct loadparm_context *);
  62 const char *lpcfg_binddns_dir(struct loadparm_context *);
  63 int lpcfg_server_role(struct loadparm_context *);
  64 int lpcfg_allow_dns_updates(struct loadparm_context *);
  65
  66 void reload_charcnv(struct loadparm_context *lp_ctx);
  67
  68 struct loadparm_service *lpcfg_default_service(struct loadparm_context *lp_ctx);
  69 bool lpcfg_autoloaded(struct loadparm_service *, struct loadparm_service *);
  70
  71 char *lpcfg_tls_keyfile(TALLOC_CTX *mem_ctx, struct loadparm_context *);
  72 char *lpcfg_tls_certfile(TALLOC_CTX *mem_ctx, struct loadparm_context *);
  73 char *lpcfg_tls_cafile(TALLOC_CTX *mem_ctx, struct loadparm_context *);
  74 char *lpcfg_tls_dhpfile(TALLOC_CTX *mem_ctx, struct loadparm_context *);
  75 char *lpcfg_tls_crlfile(TALLOC_CTX *mem_ctx, struct loadparm_context *);
  76
  77 const char *lpcfg_dnsdomain(struct loadparm_context *);
  78
  79 const char *lpcfg_servicename(const struct loadparm_service *service);
  80
  81
  82 const char *lpcfg_get_parametric(struct loadparm_context *lp_ctx,
  83                               struct loadparm_service *service,
  84                               const char *type, const char *option);
  85
  86 const char *lpcfg_parm_string(struct loadparm_context *lp_ctx,
  87                            struct loadparm_service *service, const char *type,
  88                            const char *option);
  89 const char **lpcfg_parm_string_list(TALLOC_CTX *mem_ctx,
  90                                  struct loadparm_context *lp_ctx,
  91                                  struct loadparm_service *service,
  92                                  const char *type,
  93                                  const char *option, const char *separator);
  94 int lpcfg_parm_int(struct loadparm_context *lp_ctx,
  95                 struct loadparm_service *service, const char *type,
  96                 const char *option, int default_v);
  97 int lpcfg_parm_bytes(struct loadparm_context *lp_ctx,
  98                   struct loadparm_service *service, const char *type,
  99                   const char *option, int default_v);
 100 unsigned long lpcfg_parm_ulong(struct loadparm_context *lp_ctx,
 101                             struct loadparm_service *service, const char *type,
 102                             const char *option, unsigned long default_v);
 103 unsigned long long lpcfg_parm_ulonglong(struct loadparm_context *lp_ctx,
 104                                         struct loadparm_service *service,
 105                                         const char *type, const char *option,
 106                                         unsigned long long default_v);
 107 long lpcfg_parm_long(struct loadparm_context *lp_ctx,
 108                      struct loadparm_service *service, const char *type,
 109                      const char *option, long default_v);
 110 double lpcfg_parm_double(struct loadparm_context *lp_ctx,
 111                       struct loadparm_service *service, const char *type,
 112                       const char *option, double default_v);
 113 bool lpcfg_parm_bool(struct loadparm_context *lp_ctx,
 114                      struct loadparm_service *service, const char *type,
 115                      const char *option, bool default_v);
 116 struct loadparm_service *lpcfg_add_service(struct loadparm_context *lp_ctx,
 117                                      const struct loadparm_service *pservice,
 118                                      const char *name);
 119 struct parm_struct *lpcfg_parm_struct(struct loadparm_context *lp_ctx, const char *name);
 120 void *lpcfg_parm_ptr(struct loadparm_context *lp_ctx,
 121                   struct loadparm_service *service, struct parm_struct *parm);
 122 bool lpcfg_parm_is_cmdline(struct loadparm_context *lp_ctx, const char *name);
 123 bool lpcfg_parm_is_unspecified(struct loadparm_context *lp_ctx, const char *name);
 124
 125 bool lpcfg_do_global_parameter(struct loadparm_context *lp_ctx,
 126                             const char *pszParmName, const char *pszParmValue);
 127 bool lpcfg_do_service_parameter(struct loadparm_context *lp_ctx,
 128                              struct loadparm_service *service,
 129                              const char *pszParmName, const char *pszParmValue);
 130
 131 /**
 132  * Process a parameter.
 133  */
 134 bool lpcfg_do_global_parameter_var(struct loadparm_context *lp_ctx,
 135                                 const char *pszParmName, const char *fmt, ...);
 136 bool lpcfg_set_cmdline(struct loadparm_context *lp_ctx, const char *pszParmName,
 137                     const char *pszParmValue);
 138 bool lpcfg_set_option(struct loadparm_context *lp_ctx, const char *option);
 139
 140 /**
 141  * Display the contents of a single services record.
 142  */
 143 bool lpcfg_dump_a_parameter(struct loadparm_context *lp_ctx,
 144                          struct loadparm_service *service,
 145                          const char *parm_name, FILE * f);
 146
 147 /**
 148  * Initialise the global parameter structure.
 149  */
 150 struct loadparm_context *loadparm_init(TALLOC_CTX *mem_ctx);
 151 struct loadparm_context *loadparm_init_global(bool load_default);
 152 const char *lpcfg_configfile(struct loadparm_context *lp_ctx);
 153 bool lpcfg_load_default(struct loadparm_context *lp_ctx);
 154 const char *lp_default_path(void);
 155
 156 /**
 157  * Load the services array from the services file.
 158  *
 159  * Return True on success, False on failure.
 160  */
 161 bool lpcfg_load(struct loadparm_context *lp_ctx, const char *filename);
 162
 163 /**
 164  * Return the max number of services.
 165  */
 166 int lpcfg_numservices(struct loadparm_context *lp_ctx);
 167
 168 /**
 169  * Display the contents of the services array in human-readable form.
 170  */
 171 void lpcfg_dump(struct loadparm_context *lp_ctx, FILE *f, bool show_defaults,
 172              int maxtoprint);
 173
 174 /**
 175  * Display the contents of one service in human-readable form.
 176  */
 177 void lpcfg_dump_one(FILE *f, bool show_defaults, struct loadparm_service *service, struct loadparm_service *sDefault);
 178 struct loadparm_service *lpcfg_servicebynum(struct loadparm_context *lp_ctx,
 179                                          int snum);
 180 struct loadparm_service *lpcfg_service(struct loadparm_context *lp_ctx,
 181                                     const char *service_name);
 182
 183 struct smb_iconv_handle *lpcfg_iconv_handle(struct loadparm_context *lp_ctx);
 184 void lpcfg_smbcli_options(struct loadparm_context *lp_ctx,
 185                          struct smbcli_options *options);
 186 void lpcfg_smbcli_session_options(struct loadparm_context *lp_ctx,
 187                                  struct smbcli_session_options *options);
 188 const char **lpcfg_smb_ports(struct loadparm_context *);
 189 const char *lpcfg_socket_options(struct loadparm_context *);
 190 struct dcerpc_server_info *lpcfg_dcerpc_server_info(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx);
 191 struct gensec_settings *lpcfg_gensec_settings(TALLOC_CTX *, struct loadparm_context *);
 192
 193 /* The following definitions come from param/util.c  */
 194
 195
 196 /**
 197  * @file
 198  * @brief Misc utility functions
 199  */
 200 bool lpcfg_is_mydomain(struct loadparm_context *lp_ctx,
 201                              const char *domain);
 202
 203 bool lpcfg_is_my_domain_or_realm(struct loadparm_context *lp_ctx,
 204                               const char *domain);
 205
 206 /**
 207   see if a string matches either our primary or one of our secondary
 208   netbios aliases. do a case insensitive match
 209 */
 210 bool lpcfg_is_myname(struct loadparm_context *lp_ctx, const char *name);
 211
 212 /**
 213  A useful function for returning a path in the Samba lock directory.
 214 **/
 215 char *lpcfg_lock_path(TALLOC_CTX* mem_ctx, struct loadparm_context *lp_ctx,
 216                          const char *name);
 217
 218 /**
 219  * @brief Returns an absolute path to a file in the directory containing the current config file
 220  *
 221  * @param name File to find, relative to the config file directory.
 222  *
 223  * @retval Pointer to a talloc'ed string containing the full path.
 224  **/
 225 char *lpcfg_config_path(TALLOC_CTX* mem_ctx, struct loadparm_context *lp_ctx,
 226                            const char *name);
 227
 228 /**
 229  * @brief Returns an absolute path to a file in the Samba private directory.
 230  *
 231  * @param name File to find, relative to PRIVATEDIR.
 232  * if name is not relative, then use it as-is
 233  *
 234  * @retval Pointer to a talloc'ed string containing the full path.
 235  **/
 236 char *lpcfg_private_path(TALLOC_CTX* mem_ctx,
 237                             struct loadparm_context *lp_ctx,
 238                             const char *name);
 239
 240 /**
 241  * @brief Returns an absolute path to a NTDB or TDB file in the Samba
 242  * private directory.
 243  *
 244  * @param name File to find, relative to PRIVATEDIR, without .tdb extension.
 245  *
 246  * @retval Pointer to a talloc'ed string containing the full path, for
 247  * use with dbwrap_local_open().
 248  **/
 249 char *lpcfg_private_db_path(TALLOC_CTX *mem_ctx,
 250                             struct loadparm_context *lp_ctx,
 251                             const char *name);
 252
 253 /**
 254   return a path in the smbd.tmp directory, where all temporary file
 255   for smbd go. If NULL is passed for name then return the directory
 256   path itself
 257 */
 258 char *smbd_tmp_path(TALLOC_CTX *mem_ctx,
 259                              struct loadparm_context *lp_ctx,
 260                              const char *name);
 261
 262 const char *lpcfg_imessaging_path(TALLOC_CTX *mem_ctx,
 263                                        struct loadparm_context *lp_ctx);
 264 const char *lpcfg_sam_name(struct loadparm_context *lp_ctx);
 265 const char *lpcfg_sam_dnsname(struct loadparm_context *lp_ctx);
 266
 267 void lpcfg_default_kdc_policy(TALLOC_CTX *mem_ctx,
 268                                 struct loadparm_context *lp_ctx,
 269                                 time_t *svc_tkt_lifetime,
 270                                 time_t *usr_tkt_lifetime,
 271                                 time_t *renewal_lifetime);
 272
 273 int lpcfg_rpc_port_low(struct loadparm_context *lp_ctx);
 274 int lpcfg_rpc_port_high(struct loadparm_context *lp_ctx);
 275
 276 /* The following definitions come from lib/version.c  */
 277
 278 const char *samba_version_string(void);
 279 const char *samba_copyright_string(void);
 280
 281
 282 #endif /* _PARAM_H */