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