diff options
Diffstat (limited to 'source4/param/param.h')
| -rw-r--r-- | source4/param/param.h | 361 |
1 files changed, 360 insertions, 1 deletions
diff --git a/source4/param/param.h b/source4/param/param.h index 84f864edaa..0b276cdff2 100644 --- a/source4/param/param.h +++ b/source4/param/param.h @@ -61,8 +61,367 @@ struct loadparm_context; struct loadparm_service; struct smbcli_options; -#include "param/proto.h" +void reload_charcnv(struct loadparm_context *lp_ctx); extern struct loadparm_context *global_loadparm; +struct loadparm_service *lp_default_service(struct loadparm_context *lp_ctx); +struct parm_struct *lp_parm_table(void); +int lp_server_role(struct loadparm_context *); +const char **lp_smb_ports(struct loadparm_context *); +int lp_nbt_port(struct loadparm_context *); +int lp_dgram_port(struct loadparm_context *); +int lp_cldap_port(struct loadparm_context *); +int lp_krb5_port(struct loadparm_context *); +int lp_kpasswd_port(struct loadparm_context *); +int lp_web_port(struct loadparm_context *); +const char *lp_swat_directory(struct loadparm_context *); +bool lp_tls_enabled(struct loadparm_context *); +const char *lp_tls_keyfile(struct loadparm_context *); +const char *lp_tls_certfile(struct loadparm_context *); +const char *lp_tls_cafile(struct loadparm_context *); +const char *lp_tls_crlfile(struct loadparm_context *); +const char *lp_tls_dhpfile(struct loadparm_context *); +const char *lp_share_backend(struct loadparm_context *); +const char *lp_sam_url(struct loadparm_context *); +const char *lp_idmap_url(struct loadparm_context *); +const char *lp_secrets_url(struct loadparm_context *); +const char *lp_spoolss_url(struct loadparm_context *); +const char *lp_wins_config_url(struct loadparm_context *); +const char *lp_wins_url(struct loadparm_context *); +const char *lp_winbind_separator(struct loadparm_context *); +const char *lp_winbindd_socket_directory(struct loadparm_context *); +const char *lp_template_shell(struct loadparm_context *); +const char *lp_template_homedir(struct loadparm_context *); +bool lp_winbind_sealed_pipes(struct loadparm_context *); +bool lp_idmap_trusted_only(struct loadparm_context *); +const char *lp_private_dir(struct loadparm_context *); +const char *lp_serverstring(struct loadparm_context *); +const char *lp_lockdir(struct loadparm_context *); +const char *lp_modulesdir(struct loadparm_context *); +const char *lp_setupdir(struct loadparm_context *); +const char *lp_ncalrpc_dir(struct loadparm_context *); +const char *lp_dos_charset(struct loadparm_context *); +const char *lp_unix_charset(struct loadparm_context *); +const char *lp_display_charset(struct loadparm_context *); +const char *lp_piddir(struct loadparm_context *); +const char **lp_dcerpc_endpoint_servers(struct loadparm_context *); +const char **lp_server_services(struct loadparm_context *); +const char *lp_ntptr_providor(struct loadparm_context *); +const char *lp_auto_services(struct loadparm_context *); +const char *lp_passwd_chat(struct loadparm_context *); +const char **lp_passwordserver(struct loadparm_context *); +const char **lp_name_resolve_order(struct loadparm_context *); +const char *lp_realm(struct loadparm_context *); +const char *lp_socket_options(struct loadparm_context *); +const char *lp_workgroup(struct loadparm_context *); +const char *lp_netbios_name(struct loadparm_context *); +const char *lp_netbios_scope(struct loadparm_context *); +const char **lp_wins_server_list(struct loadparm_context *); +const char **lp_interfaces(struct loadparm_context *); +const char *lp_socket_address(struct loadparm_context *); +const char **lp_netbios_aliases(struct loadparm_context *); +bool lp_disable_netbios(struct loadparm_context *); +bool lp_wins_support(struct loadparm_context *); +bool lp_wins_dns_proxy(struct loadparm_context *); +const char *lp_wins_hook(struct loadparm_context *); +bool lp_local_master(struct loadparm_context *); +bool lp_readraw(struct loadparm_context *); +bool lp_large_readwrite(struct loadparm_context *); +bool lp_writeraw(struct loadparm_context *); +bool lp_null_passwords(struct loadparm_context *); +bool lp_obey_pam_restrictions(struct loadparm_context *); +bool lp_encrypted_passwords(struct loadparm_context *); +bool lp_time_server(struct loadparm_context *); +bool lp_bind_interfaces_only(struct loadparm_context *); +bool lp_unicode(struct loadparm_context *); +bool lp_nt_status_support(struct loadparm_context *); +bool lp_lanman_auth(struct loadparm_context *); +bool lp_ntlm_auth(struct loadparm_context *); +bool lp_client_plaintext_auth(struct loadparm_context *); +bool lp_client_lanman_auth(struct loadparm_context *); +bool lp_client_ntlmv2_auth(struct loadparm_context *); +bool lp_client_use_spnego_principal(struct loadparm_context *); +bool lp_host_msdfs(struct loadparm_context *); +bool lp_unix_extensions(struct loadparm_context *); +bool lp_use_spnego(struct loadparm_context *); +bool lp_rpc_big_endian(struct loadparm_context *); +int lp_max_wins_ttl(struct loadparm_context *); +int lp_min_wins_ttl(struct loadparm_context *); +int lp_maxmux(struct loadparm_context *); +int lp_max_xmit(struct loadparm_context *); +int lp_passwordlevel(struct loadparm_context *); +int lp_srv_maxprotocol(struct loadparm_context *); +int lp_srv_minprotocol(struct loadparm_context *); +int lp_cli_maxprotocol(struct loadparm_context *); +int lp_cli_minprotocol(struct loadparm_context *); +int lp_security(struct loadparm_context *); +bool lp_paranoid_server_security(struct loadparm_context *); +int lp_announce_as(struct loadparm_context *); +const char **lp_js_include(struct loadparm_context *); + +const char *lp_servicename(const struct loadparm_service *service); +const char *lp_pathname(struct loadparm_service *, struct loadparm_service *); +const char **lp_hostsallow(struct loadparm_service *, struct loadparm_service *); +const char **lp_hostsdeny(struct loadparm_service *, struct loadparm_service *); +const char *lp_comment(struct loadparm_service *, struct loadparm_service *); +const char *lp_fstype(struct loadparm_service *, struct loadparm_service *); +const char **lp_ntvfs_handler(struct loadparm_service *, struct loadparm_service *); +bool lp_msdfs_root(struct loadparm_service *, struct loadparm_service *); +bool lp_browseable(struct loadparm_service *, struct loadparm_service *); +bool lp_readonly(struct loadparm_service *, struct loadparm_service *); +bool lp_print_ok(struct loadparm_service *, struct loadparm_service *); +bool lp_map_hidden(struct loadparm_service *, struct loadparm_service *); +bool lp_map_archive(struct loadparm_service *, struct loadparm_service *); +bool lp_strict_locking(struct loadparm_service *, struct loadparm_service *); +bool lp_oplocks(struct loadparm_service *, struct loadparm_service *); +bool lp_strict_sync(struct loadparm_service *, struct loadparm_service *); +bool lp_ci_filesystem(struct loadparm_service *, struct loadparm_service *); +bool lp_map_system(struct loadparm_service *, struct loadparm_service *); +int lp_max_connections(struct loadparm_service *, struct loadparm_service *); +int lp_csc_policy(struct loadparm_service *, struct loadparm_service *); +int lp_create_mask(struct loadparm_service *, struct loadparm_service *); +int lp_force_create_mode(struct loadparm_service *, struct loadparm_service *); +int lp_dir_mask(struct loadparm_service *, struct loadparm_service *); +int lp_force_dir_mode(struct loadparm_service *, struct loadparm_service *); +int lp_server_signing(struct loadparm_context *); +int lp_client_signing(struct loadparm_context *); +const char *lp_get_parametric(struct loadparm_context *lp_ctx, + struct loadparm_service *service, + const char *type, const char *option); + +const char *lp_parm_string(struct loadparm_context *lp_ctx, + struct loadparm_service *service, const char *type, + const char *option); +const char **lp_parm_string_list(TALLOC_CTX *mem_ctx, + struct loadparm_context *lp_ctx, + struct loadparm_service *service, + const char *type, + const char *option, const char *separator); +int lp_parm_int(struct loadparm_context *lp_ctx, + struct loadparm_service *service, const char *type, + const char *option, int default_v); +int lp_parm_bytes(struct loadparm_context *lp_ctx, + struct loadparm_service *service, const char *type, + const char *option, int default_v); +unsigned long lp_parm_ulong(struct loadparm_context *lp_ctx, + struct loadparm_service *service, const char *type, + const char *option, unsigned long default_v); +double lp_parm_double(struct loadparm_context *lp_ctx, + struct loadparm_service *service, const char *type, + const char *option, double default_v); +bool lp_parm_bool(struct loadparm_context *lp_ctx, + struct loadparm_service *service, const char *type, + const char *option, bool default_v); +struct loadparm_service *lp_add_service(struct loadparm_context *lp_ctx, + const struct loadparm_service *pservice, + const char *name); +bool lp_add_home(struct loadparm_context *lp_ctx, + const char *pszHomename, + struct loadparm_service *default_service, + const char *user, const char *pszHomedir); +bool lp_add_printer(struct loadparm_context *lp_ctx, + const char *pszPrintername, + struct loadparm_service *default_service); +struct parm_struct *lp_parm_struct(const char *name); +void *lp_parm_ptr(struct loadparm_context *lp_ctx, + struct loadparm_service *service, struct parm_struct *parm); +bool lp_file_list_changed(struct loadparm_context *lp_ctx); + +bool lp_do_global_parameter(struct loadparm_context *lp_ctx, + const char *pszParmName, const char *pszParmValue); +bool lp_do_service_parameter(struct loadparm_context *lp_ctx, + struct loadparm_service *service, + const char *pszParmName, const char *pszParmValue); + +/** + * Process a parameter. + */ +bool lp_do_global_parameter_var(struct loadparm_context *lp_ctx, + const char *pszParmName, const char *fmt, ...); +bool lp_set_cmdline(struct loadparm_context *lp_ctx, const char *pszParmName, + const char *pszParmValue); +bool lp_set_option(struct loadparm_context *lp_ctx, const char *option); + +/** + * Display the contents of a single services record. + */ +bool lp_dump_a_parameter(struct loadparm_context *lp_ctx, + struct loadparm_service *service, + const char *parm_name, FILE * f); + +/** + * Return info about the next service in a service. snum==-1 gives the globals. + * Return NULL when out of parameters. + */ +struct parm_struct *lp_next_parameter(struct loadparm_context *lp_ctx, int snum, int *i, + int allparameters); + +/** + * Unload unused services. + */ +void lp_killunused(struct loadparm_context *lp_ctx, + struct smbsrv_connection *smb, + bool (*snumused) (struct smbsrv_connection *, int)); + +/** + * Initialise the global parameter structure. + */ +struct loadparm_context *loadparm_init(TALLOC_CTX *mem_ctx); +const char *lp_configfile(struct loadparm_context *lp_ctx); +bool lp_load_default(struct loadparm_context *lp_ctx); + +/** + * Load the services array from the services file. + * + * Return True on success, False on failure. + */ +bool lp_load(struct loadparm_context *lp_ctx, const char *filename); + +/** + * Return the max number of services. + */ +int lp_numservices(struct loadparm_context *lp_ctx); + +/** + * Display the contents of the services array in human-readable form. + */ +void lp_dump(struct loadparm_context *lp_ctx, FILE *f, bool show_defaults, + int maxtoprint); + +/** + * Display the contents of one service in human-readable form. + */ +void lp_dump_one(FILE *f, bool show_defaults, struct loadparm_service *service, struct loadparm_service *sDefault); +struct loadparm_service *lp_servicebynum(struct loadparm_context *lp_ctx, + int snum); +struct loadparm_service *lp_service(struct loadparm_context *lp_ctx, + const char *service_name); + +/** + * A useful volume label function. + */ +const char *volume_label(struct loadparm_service *service, struct loadparm_service *sDefault); + +/** + * If we are PDC then prefer us as DMB + */ +const char *lp_printername(struct loadparm_service *service, struct loadparm_service *sDefault); + +/** + * Return the max print jobs per queue. + */ +int lp_maxprintjobs(struct loadparm_service *service, struct loadparm_service *sDefault); +struct smb_iconv_convenience *lp_iconv_convenience(struct loadparm_context *lp_ctx); +void lp_smbcli_options(struct loadparm_context *lp_ctx, + struct smbcli_options *options); + +/* The following definitions come from param/generic.c */ + +struct param_section *param_get_section(struct param_context *ctx, const char *name); +struct param_opt *param_section_get(struct param_section *section, + const char *name); +struct param_opt *param_get (struct param_context *ctx, const char *name, const char *section_name); +struct param_section *param_add_section(struct param_context *ctx, const char *section_name); +struct param_opt *param_get_add(struct param_context *ctx, const char *name, const char *section_name); +const char *param_get_string(struct param_context *ctx, const char *param, const char *section); +int param_set_string(struct param_context *ctx, const char *param, const char *value, const char *section); +const char **param_get_string_list(struct param_context *ctx, const char *param, const char *separator, const char *section); +int param_set_string_list(struct param_context *ctx, const char *param, const char **list, const char *section); +int param_get_int(struct param_context *ctx, const char *param, int default_v, const char *section); +void param_set_int(struct param_context *ctx, const char *param, int value, const char *section); +unsigned long param_get_ulong(struct param_context *ctx, const char *param, unsigned long default_v, const char *section); +void param_set_ulong(struct param_context *ctx, const char *name, unsigned long value, const char *section); +struct param_context *param_init(TALLOC_CTX *mem_ctx); +int param_read(struct param_context *ctx, const char *fn); +int param_use(struct loadparm_context *lp_ctx, struct param_context *ctx); +int param_write(struct param_context *ctx, const char *fn); + +/* The following definitions come from param/util.c */ + + +/** + * @file + * @brief Misc utility functions + */ +bool lp_is_mydomain(struct loadparm_context *lp_ctx, + const char *domain); + +/** + see if a string matches either our primary or one of our secondary + netbios aliases. do a case insensitive match +*/ +bool lp_is_myname(struct loadparm_context *lp_ctx, const char *name); + +/** + A useful function for returning a path in the Samba lock directory. +**/ +char *lock_path(TALLOC_CTX* mem_ctx, struct loadparm_context *lp_ctx, + const char *name); + +/** + * @brief Returns an absolute path to a file in the directory containing the current config file + * + * @param name File to find, relative to the config file directory. + * + * @retval Pointer to a talloc'ed string containing the full path. + **/ +char *config_path(TALLOC_CTX* mem_ctx, struct loadparm_context *lp_ctx, + const char *name); + +/** + * @brief Returns an absolute path to a file in the Samba private directory. + * + * @param name File to find, relative to PRIVATEDIR. + * if name is not relative, then use it as-is + * + * @retval Pointer to a talloc'ed string containing the full path. + **/ +char *private_path(TALLOC_CTX* mem_ctx, + struct loadparm_context *lp_ctx, + const char *name); + +/** + return a path in the smbd.tmp directory, where all temporary file + for smbd go. If NULL is passed for name then return the directory + path itself +*/ +char *smbd_tmp_path(TALLOC_CTX *mem_ctx, + struct loadparm_context *lp_ctx, + const char *name); + +/** + * Obtain the init function from a shared library file + */ +init_module_fn load_module(TALLOC_CTX *mem_ctx, const char *path); + +/** + * Obtain list of init functions from the modules in the specified + * directory + */ +init_module_fn *load_modules(TALLOC_CTX *mem_ctx, const char *path); + +/** + * Run the specified init functions. + * + * @return true if all functions ran successfully, false otherwise + */ +bool run_init_functions(init_module_fn *fns); + +/** + * Load the initialization functions from DSO files for a specific subsystem. + * + * Will return an array of function pointers to initialization functions + */ +init_module_fn *load_samba_modules(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx, const char *subsystem); +const char *lp_messaging_path(TALLOC_CTX *mem_ctx, + struct loadparm_context *lp_ctx); +struct smb_iconv_convenience *smb_iconv_convenience_init_lp(TALLOC_CTX *mem_ctx, + struct loadparm_context *lp_ctx); + +/* The following definitions come from lib/version.c */ + +const char *samba_version_string(void); + + #endif /* _PARAM_H */ |