source4/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 param_opt {
  24         struct param_opt *prev, *next;
  25         char *key;
  26         char *value;
  27         int flags;
  28 };
  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 param_opt *parameters;
  38 };
  39
  40 struct param_context;
  41 struct smbsrv_connection;
  42
  43 #define Auto (2)
  44
  45 typedef NTSTATUS (*init_module_fn) (void);
  46
  47 enum server_role {
  48         ROLE_STANDALONE=0,
  49         ROLE_DOMAIN_MEMBER=1,
  50         ROLE_DOMAIN_CONTROLLER=2,
  51 };
  52
  53 enum announce_as {/* Types of machine we can announce as. */
  54         ANNOUNCE_AS_NT_SERVER=1,
  55         ANNOUNCE_AS_WIN95=2,
  56         ANNOUNCE_AS_WFW=3,
  57         ANNOUNCE_AS_NT_WORKSTATION=4
  58 };
  59
  60 struct loadparm_context;
  61 struct loadparm_service;
  62 struct smbcli_options;
  63
  64 void reload_charcnv(struct loadparm_context *lp_ctx);
  65
  66 extern struct loadparm_context *global_loadparm;
  67
  68 struct loadparm_service *lp_default_service(struct loadparm_context *lp_ctx);
  69 struct parm_struct *lp_parm_table(void);
  70 int lp_server_role(struct loadparm_context *);
  71 const char **lp_smb_ports(struct loadparm_context *);
  72 int lp_nbt_port(struct loadparm_context *);
  73 int lp_dgram_port(struct loadparm_context *);
  74 int lp_cldap_port(struct loadparm_context *);
  75 int lp_krb5_port(struct loadparm_context *);
  76 int lp_kpasswd_port(struct loadparm_context *);
  77 int lp_web_port(struct loadparm_context *);
  78 const char *lp_swat_directory(struct loadparm_context *);
  79 bool lp_tls_enabled(struct loadparm_context *);
  80 const char *lp_tls_keyfile(struct loadparm_context *);
  81 const char *lp_tls_certfile(struct loadparm_context *);
  82 const char *lp_tls_cafile(struct loadparm_context *);
  83 const char *lp_tls_crlfile(struct loadparm_context *);
  84 const char *lp_tls_dhpfile(struct loadparm_context *);
  85 const char *lp_share_backend(struct loadparm_context *);
  86 const char *lp_sam_url(struct loadparm_context *);
  87 const char *lp_idmap_url(struct loadparm_context *);
  88 const char *lp_secrets_url(struct loadparm_context *);
  89 const char *lp_spoolss_url(struct loadparm_context *);
  90 const char *lp_wins_config_url(struct loadparm_context *);
  91 const char *lp_wins_url(struct loadparm_context *);
  92 const char *lp_winbind_separator(struct loadparm_context *);
  93 const char *lp_winbindd_socket_directory(struct loadparm_context *);
  94 const char *lp_winbindd_privileged_socket_directory(struct loadparm_context *);
  95 const char *lp_template_shell(struct loadparm_context *);
  96 const char *lp_template_homedir(struct loadparm_context *);
  97 bool lp_winbind_sealed_pipes(struct loadparm_context *);
  98 bool lp_idmap_trusted_only(struct loadparm_context *);
  99 const char *lp_private_dir(struct loadparm_context *);
 100 const char *lp_serverstring(struct loadparm_context *);
 101 const char *lp_lockdir(struct loadparm_context *);
 102 const char *lp_modulesdir(struct loadparm_context *);
 103 const char *lp_setupdir(struct loadparm_context *);
 104 const char *lp_ncalrpc_dir(struct loadparm_context *);
 105 const char *lp_dos_charset(struct loadparm_context *);
 106 const char *lp_unix_charset(struct loadparm_context *);
 107 const char *lp_display_charset(struct loadparm_context *);
 108 const char *lp_piddir(struct loadparm_context *);
 109 const char **lp_dcerpc_endpoint_servers(struct loadparm_context *);
 110 const char **lp_server_services(struct loadparm_context *);
 111 const char *lp_ntptr_providor(struct loadparm_context *);
 112 const char *lp_auto_services(struct loadparm_context *);
 113 const char *lp_passwd_chat(struct loadparm_context *);
 114 const char **lp_passwordserver(struct loadparm_context *);
 115 const char **lp_name_resolve_order(struct loadparm_context *);
 116 const char *lp_realm(struct loadparm_context *);
 117 const char *lp_socket_options(struct loadparm_context *);
 118 const char *lp_workgroup(struct loadparm_context *);
 119 const char *lp_netbios_name(struct loadparm_context *);
 120 const char *lp_netbios_scope(struct loadparm_context *);
 121 const char **lp_wins_server_list(struct loadparm_context *);
 122 const char **lp_interfaces(struct loadparm_context *);
 123 const char *lp_socket_address(struct loadparm_context *);
 124 const char **lp_netbios_aliases(struct loadparm_context *);
 125 bool lp_disable_netbios(struct loadparm_context *);
 126 bool lp_wins_support(struct loadparm_context *);
 127 bool lp_wins_dns_proxy(struct loadparm_context *);
 128 const char *lp_wins_hook(struct loadparm_context *);
 129 bool lp_local_master(struct loadparm_context *);
 130 bool lp_readraw(struct loadparm_context *);
 131 bool lp_large_readwrite(struct loadparm_context *);
 132 bool lp_writeraw(struct loadparm_context *);
 133 bool lp_null_passwords(struct loadparm_context *);
 134 bool lp_obey_pam_restrictions(struct loadparm_context *);
 135 bool lp_encrypted_passwords(struct loadparm_context *);
 136 bool lp_time_server(struct loadparm_context *);
 137 bool lp_bind_interfaces_only(struct loadparm_context *);
 138 bool lp_unicode(struct loadparm_context *);
 139 bool lp_nt_status_support(struct loadparm_context *);
 140 bool lp_lanman_auth(struct loadparm_context *);
 141 bool lp_ntlm_auth(struct loadparm_context *);
 142 bool lp_client_plaintext_auth(struct loadparm_context *);
 143 bool lp_client_lanman_auth(struct loadparm_context *);
 144 bool lp_client_ntlmv2_auth(struct loadparm_context *);
 145 bool lp_client_use_spnego_principal(struct loadparm_context *);
 146 bool lp_host_msdfs(struct loadparm_context *);
 147 bool lp_unix_extensions(struct loadparm_context *);
 148 bool lp_use_spnego(struct loadparm_context *);
 149 bool lp_rpc_big_endian(struct loadparm_context *);
 150 int lp_max_wins_ttl(struct loadparm_context *);
 151 int lp_min_wins_ttl(struct loadparm_context *);
 152 int lp_maxmux(struct loadparm_context *);
 153 int lp_max_xmit(struct loadparm_context *);
 154 int lp_passwordlevel(struct loadparm_context *);
 155 int lp_srv_maxprotocol(struct loadparm_context *);
 156 int lp_srv_minprotocol(struct loadparm_context *);
 157 int lp_cli_maxprotocol(struct loadparm_context *);
 158 int lp_cli_minprotocol(struct loadparm_context *);
 159 int lp_security(struct loadparm_context *);
 160 bool lp_paranoid_server_security(struct loadparm_context *);
 161 int lp_announce_as(struct loadparm_context *);
 162 const char **lp_js_include(struct loadparm_context *);
 163
 164 const char *lp_servicename(const struct loadparm_service *service);
 165 const char *lp_pathname(struct loadparm_service *, struct loadparm_service *);
 166 const char **lp_hostsallow(struct loadparm_service *, struct loadparm_service *);
 167 const char **lp_hostsdeny(struct loadparm_service *, struct loadparm_service *);
 168 const char *lp_comment(struct loadparm_service *, struct loadparm_service *);
 169 const char *lp_fstype(struct loadparm_service *, struct loadparm_service *);
 170 const char **lp_ntvfs_handler(struct loadparm_service *, struct loadparm_service *);
 171 bool lp_msdfs_root(struct loadparm_service *, struct loadparm_service *);
 172 bool lp_browseable(struct loadparm_service *, struct loadparm_service *);
 173 bool lp_readonly(struct loadparm_service *, struct loadparm_service *);
 174 bool lp_print_ok(struct loadparm_service *, struct loadparm_service *);
 175 bool lp_map_hidden(struct loadparm_service *, struct loadparm_service *);
 176 bool lp_map_archive(struct loadparm_service *, struct loadparm_service *);
 177 bool lp_strict_locking(struct loadparm_service *, struct loadparm_service *);
 178 bool lp_oplocks(struct loadparm_service *, struct loadparm_service *);
 179 bool lp_strict_sync(struct loadparm_service *, struct loadparm_service *);
 180 bool lp_ci_filesystem(struct loadparm_service *, struct loadparm_service *);
 181 bool lp_map_system(struct loadparm_service *, struct loadparm_service *);
 182 int lp_max_connections(struct loadparm_service *, struct loadparm_service *);
 183 int lp_csc_policy(struct loadparm_service *, struct loadparm_service *);
 184 int lp_create_mask(struct loadparm_service *, struct loadparm_service *);
 185 int lp_force_create_mode(struct loadparm_service *, struct loadparm_service *);
 186 int lp_dir_mask(struct loadparm_service *, struct loadparm_service *);
 187 int lp_force_dir_mode(struct loadparm_service *, struct loadparm_service *);
 188 int lp_server_signing(struct loadparm_context *);
 189 int lp_client_signing(struct loadparm_context *);
 190 const char *lp_ntp_signd_socket_directory(struct loadparm_context *);
 191
 192 const char *lp_get_parametric(struct loadparm_context *lp_ctx,
 193                               struct loadparm_service *service,
 194                               const char *type, const char *option);
 195
 196 const char *lp_parm_string(struct loadparm_context *lp_ctx,
 197                            struct loadparm_service *service, const char *type,
 198                            const char *option);
 199 const char **lp_parm_string_list(TALLOC_CTX *mem_ctx,
 200                                  struct loadparm_context *lp_ctx,
 201                                  struct loadparm_service *service,
 202                                  const char *type,
 203                                  const char *option, const char *separator);
 204 int lp_parm_int(struct loadparm_context *lp_ctx,
 205                 struct loadparm_service *service, const char *type,
 206                 const char *option, int default_v);
 207 int lp_parm_bytes(struct loadparm_context *lp_ctx,
 208                   struct loadparm_service *service, const char *type,
 209                   const char *option, int default_v);
 210 unsigned long lp_parm_ulong(struct loadparm_context *lp_ctx,
 211                             struct loadparm_service *service, const char *type,
 212                             const char *option, unsigned long default_v);
 213 double lp_parm_double(struct loadparm_context *lp_ctx,
 214                       struct loadparm_service *service, const char *type,
 215                       const char *option, double default_v);
 216 bool lp_parm_bool(struct loadparm_context *lp_ctx,
 217                   struct loadparm_service *service, const char *type,
 218                   const char *option, bool default_v);
 219 struct loadparm_service *lp_add_service(struct loadparm_context *lp_ctx,
 220                                      const struct loadparm_service *pservice,
 221                                      const char *name);
 222 bool lp_add_home(struct loadparm_context *lp_ctx,
 223                  const char *pszHomename,
 224                  struct loadparm_service *default_service,
 225                  const char *user, const char *pszHomedir);
 226 bool lp_add_printer(struct loadparm_context *lp_ctx,
 227                     const char *pszPrintername,
 228                     struct loadparm_service *default_service);
 229 struct parm_struct *lp_parm_struct(const char *name);
 230 void *lp_parm_ptr(struct loadparm_context *lp_ctx,
 231                   struct loadparm_service *service, struct parm_struct *parm);
 232 bool lp_file_list_changed(struct loadparm_context *lp_ctx);
 233
 234 bool lp_do_global_parameter(struct loadparm_context *lp_ctx,
 235                             const char *pszParmName, const char *pszParmValue);
 236 bool lp_do_service_parameter(struct loadparm_context *lp_ctx,
 237                              struct loadparm_service *service,
 238                              const char *pszParmName, const char *pszParmValue);
 239
 240 /**
 241  * Process a parameter.
 242  */
 243 bool lp_do_global_parameter_var(struct loadparm_context *lp_ctx,
 244                                 const char *pszParmName, const char *fmt, ...);
 245 bool lp_set_cmdline(struct loadparm_context *lp_ctx, const char *pszParmName,
 246                     const char *pszParmValue);
 247 bool lp_set_option(struct loadparm_context *lp_ctx, const char *option);
 248
 249 /**
 250  * Display the contents of a single services record.
 251  */
 252 bool lp_dump_a_parameter(struct loadparm_context *lp_ctx,
 253                          struct loadparm_service *service,
 254                          const char *parm_name, FILE * f);
 255
 256 /**
 257  * Return info about the next service  in a service. snum==-1 gives the globals.
 258  * Return NULL when out of parameters.
 259  */
 260 struct parm_struct *lp_next_parameter(struct loadparm_context *lp_ctx, int snum, int *i,
 261                                       int allparameters);
 262
 263 /**
 264  * Unload unused services.
 265  */
 266 void lp_killunused(struct loadparm_context *lp_ctx,
 267                    struct smbsrv_connection *smb,
 268                    bool (*snumused) (struct smbsrv_connection *, int));
 269
 270 /**
 271  * Initialise the global parameter structure.
 272  */
 273 struct loadparm_context *loadparm_init(TALLOC_CTX *mem_ctx);
 274 const char *lp_configfile(struct loadparm_context *lp_ctx);
 275 bool lp_load_default(struct loadparm_context *lp_ctx);
 276
 277 /**
 278  * Load the services array from the services file.
 279  *
 280  * Return True on success, False on failure.
 281  */
 282 bool lp_load(struct loadparm_context *lp_ctx, const char *filename);
 283
 284 /**
 285  * Return the max number of services.
 286  */
 287 int lp_numservices(struct loadparm_context *lp_ctx);
 288
 289 /**
 290  * Display the contents of the services array in human-readable form.
 291  */
 292 void lp_dump(struct loadparm_context *lp_ctx, FILE *f, bool show_defaults,
 293              int maxtoprint);
 294
 295 /**
 296  * Display the contents of one service in human-readable form.
 297  */
 298 void lp_dump_one(FILE *f, bool show_defaults, struct loadparm_service *service, struct loadparm_service *sDefault);
 299 struct loadparm_service *lp_servicebynum(struct loadparm_context *lp_ctx,
 300                                          int snum);
 301 struct loadparm_service *lp_service(struct loadparm_context *lp_ctx,
 302                                     const char *service_name);
 303
 304 /**
 305  * A useful volume label function.
 306  */
 307 const char *volume_label(struct loadparm_service *service, struct loadparm_service *sDefault);
 308
 309 /**
 310  * If we are PDC then prefer us as DMB
 311  */
 312 const char *lp_printername(struct loadparm_service *service, struct loadparm_service *sDefault);
 313
 314 /**
 315  * Return the max print jobs per queue.
 316  */
 317 int lp_maxprintjobs(struct loadparm_service *service, struct loadparm_service *sDefault);
 318 struct smb_iconv_convenience *lp_iconv_convenience(struct loadparm_context *lp_ctx);
 319 void lp_smbcli_options(struct loadparm_context *lp_ctx,
 320                          struct smbcli_options *options);
 321
 322 /* The following definitions come from param/generic.c  */
 323
 324 struct param_section *param_get_section(struct param_context *ctx, const char *name);
 325 struct param_opt *param_section_get(struct param_section *section,
 326                                     const char *name);
 327 struct param_opt *param_get (struct param_context *ctx, const char *name, const char *section_name);
 328 struct param_section *param_add_section(struct param_context *ctx, const char *section_name);
 329 struct param_opt *param_get_add(struct param_context *ctx, const char *name, const char *section_name);
 330 const char *param_get_string(struct param_context *ctx, const char *param, const char *section);
 331 int param_set_string(struct param_context *ctx, const char *param, const char *value, const char *section);
 332 const char **param_get_string_list(struct param_context *ctx, const char *param, const char *separator, const char *section);
 333 int param_set_string_list(struct param_context *ctx, const char *param, const char **list, const char *section);
 334 int param_get_int(struct param_context *ctx, const char *param, int default_v, const char *section);
 335 void param_set_int(struct param_context *ctx, const char *param, int value, const char *section);
 336 unsigned long param_get_ulong(struct param_context *ctx, const char *param, unsigned long default_v, const char *section);
 337 void param_set_ulong(struct param_context *ctx, const char *name, unsigned long value, const char *section);
 338 struct param_context *param_init(TALLOC_CTX *mem_ctx);
 339 int param_read(struct param_context *ctx, const char *fn);
 340 int param_use(struct loadparm_context *lp_ctx, struct param_context *ctx);
 341 int param_write(struct param_context *ctx, const char *fn);
 342
 343 /* The following definitions come from param/util.c  */
 344
 345
 346 /**
 347  * @file
 348  * @brief Misc utility functions
 349  */
 350 bool lp_is_mydomain(struct loadparm_context *lp_ctx,
 351                              const char *domain);
 352
 353 /**
 354   see if a string matches either our primary or one of our secondary
 355   netbios aliases. do a case insensitive match
 356 */
 357 bool lp_is_myname(struct loadparm_context *lp_ctx, const char *name);
 358
 359 /**
 360  A useful function for returning a path in the Samba lock directory.
 361 **/
 362 char *lock_path(TALLOC_CTX* mem_ctx, struct loadparm_context *lp_ctx,
 363                          const char *name);
 364
 365 /**
 366  * @brief Returns an absolute path to a file in the directory containing the current config file
 367  *
 368  * @param name File to find, relative to the config file directory.
 369  *
 370  * @retval Pointer to a talloc'ed string containing the full path.
 371  **/
 372 char *config_path(TALLOC_CTX* mem_ctx, struct loadparm_context *lp_ctx,
 373                            const char *name);
 374
 375 /**
 376  * @brief Returns an absolute path to a file in the Samba private directory.
 377  *
 378  * @param name File to find, relative to PRIVATEDIR.
 379  * if name is not relative, then use it as-is
 380  *
 381  * @retval Pointer to a talloc'ed string containing the full path.
 382  **/
 383 char *private_path(TALLOC_CTX* mem_ctx,
 384                             struct loadparm_context *lp_ctx,
 385                             const char *name);
 386
 387 /**
 388   return a path in the smbd.tmp directory, where all temporary file
 389   for smbd go. If NULL is passed for name then return the directory
 390   path itself
 391 */
 392 char *smbd_tmp_path(TALLOC_CTX *mem_ctx,
 393                              struct loadparm_context *lp_ctx,
 394                              const char *name);
 395
 396 /**
 397  * Obtain the init function from a shared library file
 398  */
 399 init_module_fn load_module(TALLOC_CTX *mem_ctx, const char *path);
 400
 401 /**
 402  * Obtain list of init functions from the modules in the specified
 403  * directory
 404  */
 405 init_module_fn *load_modules(TALLOC_CTX *mem_ctx, const char *path);
 406
 407 /**
 408  * Run the specified init functions.
 409  *
 410  * @return true if all functions ran successfully, false otherwise
 411  */
 412 bool run_init_functions(init_module_fn *fns);
 413
 414 /**
 415  * Load the initialization functions from DSO files for a specific subsystem.
 416  *
 417  * Will return an array of function pointers to initialization functions
 418  */
 419 init_module_fn *load_samba_modules(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx, const char *subsystem);
 420 const char *lp_messaging_path(TALLOC_CTX *mem_ctx,
 421                                        struct loadparm_context *lp_ctx);
 422 struct smb_iconv_convenience *smb_iconv_convenience_init_lp(TALLOC_CTX *mem_ctx,
 423                                                          struct loadparm_context *lp_ctx);
 424
 425 /* The following definitions come from lib/version.c  */
 426
 427 const char *samba_version_string(void);
 428
 429
 430 #endif /* _PARAM_H */