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