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