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 struct loadparm_s3_helpers;
  24
  25 struct parmlist_entry;
  26
  27 struct param_context {
  28         struct param_section *sections;
  29 };
  30
  31 struct param_section {
  32         const char *name;
  33         struct param_section *prev, *next;
  34         struct parmlist *parameters;
  35 };
  36
  37 struct param_context;
  38 struct smbsrv_connection;
  39
  40 #define Auto (2)
  41
  42 struct loadparm_context;
  43 struct loadparm_service;
  44 struct smbcli_options;
  45 struct smbcli_session_options;
  46 struct gensec_settings;
  47 struct bitmap;
  48 struct file_lists;
  49
  50 #ifdef CONFIG_H_IS_FROM_SAMBA
  51 #include "lib/param/param_proto.h"
  52 #include "lib/param/param_functions.h"
  53 #endif
  54
  55 const char **lpcfg_interfaces(struct loadparm_context *);
  56 const char *lpcfg_realm(struct loadparm_context *);
  57 const char *lpcfg_netbios_name(struct loadparm_context *);
  58 const char *lpcfg_private_dir(struct loadparm_context *);
  59 int lpcfg_server_role(struct loadparm_context *);
  60 int lpcfg_allow_dns_updates(struct loadparm_context *);
  61
  62 void reload_charcnv(struct loadparm_context *lp_ctx);
  63
  64 struct loadparm_service *lpcfg_default_service(struct loadparm_context *lp_ctx);
  65 bool lpcfg_autoloaded(struct loadparm_service *, struct loadparm_service *);
  66
  67 char *lpcfg_tls_keyfile(TALLOC_CTX *mem_ctx, struct loadparm_context *);
  68 char *lpcfg_tls_certfile(TALLOC_CTX *mem_ctx, struct loadparm_context *);
  69 char *lpcfg_tls_cafile(TALLOC_CTX *mem_ctx, struct loadparm_context *);
  70 char *lpcfg_tls_dhpfile(TALLOC_CTX *mem_ctx, struct loadparm_context *);
  71 char *lpcfg_tls_crlfile(TALLOC_CTX *mem_ctx, struct loadparm_context *);
  72
  73 const char *lpcfg_dnsdomain(struct loadparm_context *);
  74
  75 const char *lpcfg_servicename(const struct loadparm_service *service);
  76
  77
  78 const char *lpcfg_get_parametric(struct loadparm_context *lp_ctx,
  79                               struct loadparm_service *service,
  80                               const char *type, const char *option);
  81
  82 const char *lpcfg_parm_string(struct loadparm_context *lp_ctx,
  83                            struct loadparm_service *service, const char *type,
  84                            const char *option);
  85 const char **lpcfg_parm_string_list(TALLOC_CTX *mem_ctx,
  86                                  struct loadparm_context *lp_ctx,
  87                                  struct loadparm_service *service,
  88                                  const char *type,
  89                                  const char *option, const char *separator);
  90 int lpcfg_parm_int(struct loadparm_context *lp_ctx,
  91                 struct loadparm_service *service, const char *type,
  92                 const char *option, int default_v);
  93 int lpcfg_parm_bytes(struct loadparm_context *lp_ctx,
  94                   struct loadparm_service *service, const char *type,
  95                   const char *option, int default_v);
  96 unsigned long lpcfg_parm_ulong(struct loadparm_context *lp_ctx,
  97                             struct loadparm_service *service, const char *type,
  98                             const char *option, unsigned long default_v);
  99 unsigned long long lpcfg_parm_ulonglong(struct loadparm_context *lp_ctx,
 100                                         struct loadparm_service *service,
 101                                         const char *type, const char *option,
 102                                         unsigned long long default_v);
 103 long lpcfg_parm_long(struct loadparm_context *lp_ctx,
 104                      struct loadparm_service *service, const char *type,
 105                      const char *option, long default_v);
 106 double lpcfg_parm_double(struct loadparm_context *lp_ctx,
 107                       struct loadparm_service *service, const char *type,
 108                       const char *option, double default_v);
 109 bool lpcfg_parm_bool(struct loadparm_context *lp_ctx,
 110                      struct loadparm_service *service, const char *type,
 111                      const char *option, bool default_v);
 112 struct loadparm_service *lpcfg_add_service(struct loadparm_context *lp_ctx,
 113                                      const struct loadparm_service *pservice,
 114                                      const char *name);
 115 bool lpcfg_add_home(struct loadparm_context *lp_ctx,
 116                  const char *pszHomename,
 117                  struct loadparm_service *default_service,
 118                  const char *user, const char *pszHomedir);
 119 bool lpcfg_add_printer(struct loadparm_context *lp_ctx,
 120                     const char *pszPrintername,
 121                     struct loadparm_service *default_service);
 122 struct parm_struct *lpcfg_parm_struct(struct loadparm_context *lp_ctx, const char *name);
 123 void *lpcfg_parm_ptr(struct loadparm_context *lp_ctx,
 124                   struct loadparm_service *service, struct parm_struct *parm);
 125 bool lpcfg_parm_is_cmdline(struct loadparm_context *lp_ctx, const char *name);
 126 bool lpcfg_file_list_changed(struct loadparm_context *lp_ctx);
 127
 128 bool lpcfg_do_global_parameter(struct loadparm_context *lp_ctx,
 129                             const char *pszParmName, const char *pszParmValue);
 130 bool lpcfg_do_service_parameter(struct loadparm_context *lp_ctx,
 131                              struct loadparm_service *service,
 132                              const char *pszParmName, const char *pszParmValue);
 133
 134 /**
 135  * Process a parameter.
 136  */
 137 bool lpcfg_do_global_parameter_var(struct loadparm_context *lp_ctx,
 138                                 const char *pszParmName, const char *fmt, ...);
 139 bool lpcfg_set_cmdline(struct loadparm_context *lp_ctx, const char *pszParmName,
 140                     const char *pszParmValue);
 141 bool lpcfg_set_option(struct loadparm_context *lp_ctx, const char *option);
 142
 143 /**
 144  * Display the contents of a single services record.
 145  */
 146 bool lpcfg_dump_a_parameter(struct loadparm_context *lp_ctx,
 147                          struct loadparm_service *service,
 148                          const char *parm_name, FILE * f);
 149
 150 /**
 151  * Unload unused services.
 152  */
 153 void lpcfg_killunused(struct loadparm_context *lp_ctx,
 154                    struct smbsrv_connection *smb,
 155                    bool (*snumused) (struct smbsrv_connection *, int));
 156
 157 /**
 158  * Initialise the global parameter structure.
 159  */
 160 struct loadparm_context *loadparm_init(TALLOC_CTX *mem_ctx);
 161 struct loadparm_context *loadparm_init_global(bool load_default);
 162 const char *lpcfg_configfile(struct loadparm_context *lp_ctx);
 163 bool lpcfg_load_default(struct loadparm_context *lp_ctx);
 164 const char *lp_default_path(void);
 165
 166 /**
 167  * Load the services array from the services file.
 168  *
 169  * Return True on success, False on failure.
 170  */
 171 bool lpcfg_load(struct loadparm_context *lp_ctx, const char *filename);
 172
 173 /**
 174  * Return the max number of services.
 175  */
 176 int lpcfg_numservices(struct loadparm_context *lp_ctx);
 177
 178 /**
 179  * Display the contents of the services array in human-readable form.
 180  */
 181 void lpcfg_dump(struct loadparm_context *lp_ctx, FILE *f, bool show_defaults,
 182              int maxtoprint);
 183
 184 /**
 185  * Display the contents of one service in human-readable form.
 186  */
 187 void lpcfg_dump_one(FILE *f, bool show_defaults, struct loadparm_service *service, struct loadparm_service *sDefault);
 188 struct loadparm_service *lpcfg_servicebynum(struct loadparm_context *lp_ctx,
 189                                          int snum);
 190 struct loadparm_service *lpcfg_service(struct loadparm_context *lp_ctx,
 191                                     const char *service_name);
 192
 193 /**
 194  * A useful volume label function.
 195  */
 196 const char *lp_cfg_volume_label(struct loadparm_service *service, struct loadparm_service *sDefault);
 197
 198 /**
 199  * If we are PDC then prefer us as DMB
 200  */
 201 const char *lpcfg_printername(struct loadparm_service *service, struct loadparm_service *sDefault);
 202
 203 /**
 204  * Return the max print jobs per queue.
 205  */
 206 int lpcfg_maxprintjobs(struct loadparm_service *service, struct loadparm_service *sDefault);
 207 struct smb_iconv_handle *lpcfg_iconv_handle(struct loadparm_context *lp_ctx);
 208 void lpcfg_smbcli_options(struct loadparm_context *lp_ctx,
 209                          struct smbcli_options *options);
 210 void lpcfg_smbcli_session_options(struct loadparm_context *lp_ctx,
 211                                  struct smbcli_session_options *options);
 212 const char **lpcfg_smb_ports(struct loadparm_context *);
 213 const char *lpcfg_socket_options(struct loadparm_context *);
 214 struct dcerpc_server_info *lpcfg_dcerpc_server_info(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx);
 215 struct gensec_settings *lpcfg_gensec_settings(TALLOC_CTX *, struct loadparm_context *);
 216
 217 /* The following definitions come from param/util.c  */
 218
 219
 220 /**
 221  * @file
 222  * @brief Misc utility functions
 223  */
 224 bool lpcfg_is_mydomain(struct loadparm_context *lp_ctx,
 225                              const char *domain);
 226
 227 bool lpcfg_is_my_domain_or_realm(struct loadparm_context *lp_ctx,
 228                               const char *domain);
 229
 230 /**
 231   see if a string matches either our primary or one of our secondary
 232   netbios aliases. do a case insensitive match
 233 */
 234 bool lpcfg_is_myname(struct loadparm_context *lp_ctx, const char *name);
 235
 236 /**
 237  A useful function for returning a path in the Samba lock directory.
 238 **/
 239 char *lpcfg_lock_path(TALLOC_CTX* mem_ctx, struct loadparm_context *lp_ctx,
 240                          const char *name);
 241
 242 /**
 243  * @brief Returns an absolute path to a file in the directory containing the current config file
 244  *
 245  * @param name File to find, relative to the config file directory.
 246  *
 247  * @retval Pointer to a talloc'ed string containing the full path.
 248  **/
 249 char *lpcfg_config_path(TALLOC_CTX* mem_ctx, struct loadparm_context *lp_ctx,
 250                            const char *name);
 251
 252 /**
 253  * @brief Returns an absolute path to a file in the Samba private directory.
 254  *
 255  * @param name File to find, relative to PRIVATEDIR.
 256  * if name is not relative, then use it as-is
 257  *
 258  * @retval Pointer to a talloc'ed string containing the full path.
 259  **/
 260 char *lpcfg_private_path(TALLOC_CTX* mem_ctx,
 261                             struct loadparm_context *lp_ctx,
 262                             const char *name);
 263
 264 /**
 265  * @brief Returns an absolute path to a NTDB or TDB file in the Samba
 266  * private directory.
 267  *
 268  * @param name File to find, relative to PRIVATEDIR, without .tdb extension.
 269  *
 270  * @retval Pointer to a talloc'ed string containing the full path, for
 271  * use with dbwrap_local_open().
 272  **/
 273 char *lpcfg_private_db_path(TALLOC_CTX *mem_ctx,
 274                             struct loadparm_context *lp_ctx,
 275                             const char *name);
 276
 277 /**
 278   return a path in the smbd.tmp directory, where all temporary file
 279   for smbd go. If NULL is passed for name then return the directory
 280   path itself
 281 */
 282 char *smbd_tmp_path(TALLOC_CTX *mem_ctx,
 283                              struct loadparm_context *lp_ctx,
 284                              const char *name);
 285
 286 const char *lpcfg_imessaging_path(TALLOC_CTX *mem_ctx,
 287                                        struct loadparm_context *lp_ctx);
 288 const char *lpcfg_sam_name(struct loadparm_context *lp_ctx);
 289 const char *lpcfg_sam_dnsname(struct loadparm_context *lp_ctx);
 290
 291 void lpcfg_default_kdc_policy(struct loadparm_context *lp_ctx,
 292                                 time_t *svc_tkt_lifetime,
 293                                 time_t *usr_tkt_lifetime,
 294                                 time_t *renewal_lifetime);
 295
 296 int lpcfg_rpc_port_low(struct loadparm_context *lp_ctx);
 297 int lpcfg_rpc_port_high(struct loadparm_context *lp_ctx);
 298
 299 /* The following definitions come from lib/version.c  */
 300
 301 const char *samba_version_string(void);
 302
 303
 304 #endif /* _PARAM_H */