dns_server: Remove parameter 'dns recursive queries' and base this on 'dns forwarder'
[Samba/gebeck_regimport.git] / lib / param / loadparm.c
blob990dd294b9114de1c0b2df5dfc8b53e28aa911cf
1 /*
2 Unix SMB/CIFS implementation.
3 Parameter loading functions
4 Copyright (C) Karl Auer 1993-1998
6 Largely re-written by Andrew Tridgell, September 1994
8 Copyright (C) Simo Sorce 2001
9 Copyright (C) Alexander Bokovoy 2002
10 Copyright (C) Stefan (metze) Metzmacher 2002
11 Copyright (C) Jim McDonough (jmcd@us.ibm.com) 2003.
12 Copyright (C) James Myers 2003 <myersjj@samba.org>
13 Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007
14 Copyright (C) Andrew Bartlett 2011-2012
16 This program is free software; you can redistribute it and/or modify
17 it under the terms of the GNU General Public License as published by
18 the Free Software Foundation; either version 3 of the License, or
19 (at your option) any later version.
21 This program is distributed in the hope that it will be useful,
22 but WITHOUT ANY WARRANTY; without even the implied warranty of
23 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 GNU General Public License for more details.
26 You should have received a copy of the GNU General Public License
27 along with this program. If not, see <http://www.gnu.org/licenses/>.
31 * Load parameters.
33 * This module provides suitable callback functions for the params
34 * module. It builds the internal table of service details which is
35 * then used by the rest of the server.
37 * To add a parameter:
39 * 1) add it to the global or service structure definition
40 * 2) add it to the parm_table
41 * 3) add it to the list of available functions (eg: using FN_GLOBAL_STRING())
42 * 4) If it's a global then initialise it in init_globals. If a local
43 * (ie. service) parameter then initialise it in the sDefault structure
46 * Notes:
47 * The configuration file is processed sequentially for speed. It is NOT
48 * accessed randomly as happens in 'real' Windows. For this reason, there
49 * is a fair bit of sequence-dependent code here - ie., code which assumes
50 * that certain things happen before others. In particular, the code which
51 * happens at the boundary between sections is delicately poised, so be
52 * careful!
56 #include "includes.h"
57 #include "version.h"
58 #include "dynconfig/dynconfig.h"
59 #include "system/time.h"
60 #include "system/locale.h"
61 #include "system/network.h" /* needed for TCP_NODELAY */
62 #include "../lib/util/dlinklist.h"
63 #include "lib/param/param.h"
64 #include "lib/param/loadparm.h"
65 #include "auth/gensec/gensec.h"
66 #include "lib/param/s3_param.h"
67 #include "lib/util/bitmap.h"
68 #include "libcli/smb/smb_constants.h"
70 #define standard_sub_basic talloc_strdup
72 static bool do_parameter(const char *, const char *, void *);
73 static bool defaults_saved = false;
75 #define LOADPARM_EXTRA_GLOBALS \
76 struct parmlist_entry *param_opt; \
77 char *szRealm; \
78 char *szConfigFile; \
79 int iminreceivefile; \
80 char *szPrintcapname; \
81 int CupsEncrypt; \
82 int iPreferredMaster; \
83 char *szLdapMachineSuffix; \
84 char *szLdapUserSuffix; \
85 char *szLdapIdmapSuffix; \
86 char *szLdapGroupSuffix; \
87 char *szUsershareTemplateShare; \
88 char *szIdmapUID; \
89 char *szIdmapGID; \
90 int winbindMaxDomainConnections; \
91 int ismb2_max_credits; \
92 char *tls_keyfile; \
93 char *tls_certfile; \
94 char *tls_cafile; \
95 char *tls_crlfile; \
96 char *tls_dhpfile; \
97 char *loglevel; \
98 char *panic_action;
100 #include "lib/param/param_global.h"
102 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
104 /* we don't need a special handler for "dos charset" and "unix charset" */
105 #define handle_dos_charset NULL
106 #define handle_charset NULL
108 /* these are parameter handlers which are not needed in the
109 * non-source3 code
111 #define handle_netbios_aliases NULL
112 #define handle_printing NULL
113 #define handle_ldap_debug_level NULL
114 #define handle_idmap_backend NULL
115 #define handle_idmap_uid NULL
116 #define handle_idmap_gid NULL
118 #ifndef N_
119 #define N_(x) x
120 #endif
122 /* prototypes for the special type handlers */
123 static bool handle_include(struct loadparm_context *lp_ctx, int unused,
124 const char *pszParmValue, char **ptr);
125 static bool handle_realm(struct loadparm_context *lp_ctx, int unused,
126 const char *pszParmValue, char **ptr);
127 static bool handle_copy(struct loadparm_context *lp_ctx, int unused,
128 const char *pszParmValue, char **ptr);
129 static bool handle_debug_list(struct loadparm_context *lp_ctx, int unused,
130 const char *pszParmValue, char **ptr);
131 static bool handle_logfile(struct loadparm_context *lp_ctx, int unused,
132 const char *pszParmValue, char **ptr);
134 #include "lib/param/param_table.c"
136 /* local variables */
137 struct loadparm_context {
138 const char *szConfigFile;
139 struct loadparm_global *globals;
140 struct loadparm_service **services;
141 struct loadparm_service *sDefault;
142 struct smb_iconv_handle *iconv_handle;
143 int iNumServices;
144 struct loadparm_service *currentService;
145 bool bInGlobalSection;
146 struct file_lists {
147 struct file_lists *next;
148 char *name;
149 char *subfname;
150 time_t modtime;
151 } *file_lists;
152 unsigned int flags[NUMPARAMETERS];
153 bool loaded;
154 bool refuse_free;
155 bool global; /* Is this the global context, which may set
156 * global variables such as debug level etc? */
157 const struct loadparm_s3_helpers *s3_fns;
161 struct loadparm_service *lpcfg_default_service(struct loadparm_context *lp_ctx)
163 if (lp_ctx->s3_fns) {
164 return lp_ctx->s3_fns->get_default_loadparm_service();
166 return lp_ctx->sDefault;
170 * Convenience routine to grab string parameters into temporary memory
171 * and run standard_sub_basic on them.
173 * The buffers can be written to by
174 * callers without affecting the source string.
177 static const char *lp_string(const char *s)
179 #if 0 /* until REWRITE done to make thread-safe */
180 size_t len = s ? strlen(s) : 0;
181 char *ret;
182 #endif
184 /* The follow debug is useful for tracking down memory problems
185 especially if you have an inner loop that is calling a lp_*()
186 function that returns a string. Perhaps this debug should be
187 present all the time? */
189 #if 0
190 DEBUG(10, ("lp_string(%s)\n", s));
191 #endif
193 #if 0 /* until REWRITE done to make thread-safe */
194 if (!lp_talloc)
195 lp_talloc = talloc_init("lp_talloc");
197 ret = talloc_array(lp_talloc, char, len + 100); /* leave room for substitution */
199 if (!ret)
200 return NULL;
202 if (!s)
203 *ret = 0;
204 else
205 strlcpy(ret, s, len);
207 if (trim_string(ret, "\"", "\"")) {
208 if (strchr(ret,'"') != NULL)
209 strlcpy(ret, s, len);
212 standard_sub_basic(ret,len+100);
213 return (ret);
214 #endif
215 return s;
219 In this section all the functions that are used to access the
220 parameters from the rest of the program are defined
224 * the creation of separate lpcfg_*() and lp_*() functions is to allow
225 * for code compatibility between existing Samba4 and Samba3 code.
228 /* this global context supports the lp_*() function varients */
229 static struct loadparm_context *global_loadparm_context;
231 #define lpcfg_default_service global_loadparm_context->sDefault
232 #define lpcfg_global_service(i) global_loadparm_context->services[i]
234 #define FN_GLOBAL_STRING(fn_name,var_name) \
235 _PUBLIC_ const char *lpcfg_ ## fn_name(struct loadparm_context *lp_ctx) { \
236 if (lp_ctx == NULL) return NULL; \
237 if (lp_ctx->s3_fns) { \
238 SMB_ASSERT(lp_ctx->s3_fns->fn_name); \
239 return lp_ctx->s3_fns->fn_name(); \
241 return lp_ctx->globals->var_name ? lp_string(lp_ctx->globals->var_name) : ""; \
244 #define FN_GLOBAL_CONST_STRING(fn_name,var_name) \
245 _PUBLIC_ const char *lpcfg_ ## fn_name(struct loadparm_context *lp_ctx) {\
246 if (lp_ctx == NULL) return NULL; \
247 if (lp_ctx->s3_fns) { \
248 SMB_ASSERT(lp_ctx->s3_fns->fn_name); \
249 return lp_ctx->s3_fns->fn_name(); \
251 return lp_ctx->globals->var_name ? lp_string(lp_ctx->globals->var_name) : ""; \
254 #define FN_GLOBAL_LIST(fn_name,var_name) \
255 _PUBLIC_ const char **lpcfg_ ## fn_name(struct loadparm_context *lp_ctx) { \
256 if (lp_ctx == NULL) return NULL; \
257 if (lp_ctx->s3_fns) { \
258 SMB_ASSERT(lp_ctx->s3_fns->fn_name); \
259 return lp_ctx->s3_fns->fn_name(); \
261 return lp_ctx->globals->var_name; \
264 #define FN_GLOBAL_BOOL(fn_name,var_name) \
265 _PUBLIC_ bool lpcfg_ ## fn_name(struct loadparm_context *lp_ctx) {\
266 if (lp_ctx == NULL) return false; \
267 if (lp_ctx->s3_fns) { \
268 SMB_ASSERT(lp_ctx->s3_fns->fn_name); \
269 return lp_ctx->s3_fns->fn_name(); \
271 return lp_ctx->globals->var_name; \
274 #define FN_GLOBAL_INTEGER(fn_name,var_name) \
275 _PUBLIC_ int lpcfg_ ## fn_name(struct loadparm_context *lp_ctx) { \
276 if (lp_ctx->s3_fns) { \
277 SMB_ASSERT(lp_ctx->s3_fns->fn_name); \
278 return lp_ctx->s3_fns->fn_name(); \
280 return lp_ctx->globals->var_name; \
283 /* Local parameters don't need the ->s3_fns because the struct
284 * loadparm_service is shared and lpcfg_service() checks the ->s3_fns
285 * hook */
286 #define FN_LOCAL_STRING(fn_name,val) \
287 _PUBLIC_ const char *lpcfg_ ## fn_name(struct loadparm_service *service, \
288 struct loadparm_service *sDefault) { \
289 return(lp_string((const char *)((service != NULL && service->val != NULL) ? service->val : sDefault->val))); \
292 #define FN_LOCAL_CONST_STRING(fn_name,val) FN_LOCAL_STRING(fn_name, val)
294 #define FN_LOCAL_LIST(fn_name,val) \
295 _PUBLIC_ const char **lpcfg_ ## fn_name(struct loadparm_service *service, \
296 struct loadparm_service *sDefault) {\
297 return(const char **)(service != NULL && service->val != NULL? service->val : sDefault->val); \
300 #define FN_LOCAL_PARM_BOOL(fn_name, val) FN_LOCAL_BOOL(fn_name, val)
302 #define FN_LOCAL_BOOL(fn_name,val) \
303 _PUBLIC_ bool lpcfg_ ## fn_name(struct loadparm_service *service, \
304 struct loadparm_service *sDefault) { \
305 return((service != NULL)? service->val : sDefault->val); \
308 #define FN_LOCAL_INTEGER(fn_name,val) \
309 _PUBLIC_ int lpcfg_ ## fn_name(struct loadparm_service *service, \
310 struct loadparm_service *sDefault) { \
311 return((service != NULL)? service->val : sDefault->val); \
314 #define FN_LOCAL_PARM_INTEGER(fn_name, val) FN_LOCAL_INTEGER(fn_name, val)
316 #define FN_LOCAL_CHAR(fn_name,val) \
317 _PUBLIC_ char lpcfg_ ## fn_name(struct loadparm_service *service, \
318 struct loadparm_service *sDefault) { \
319 return((service != NULL)? service->val : sDefault->val); \
322 #include "lib/param/param_functions.c"
324 /* These functions remain only in lib/param for now */
325 FN_GLOBAL_BOOL(readraw, bReadRaw)
326 FN_GLOBAL_BOOL(writeraw, bWriteRaw)
327 FN_GLOBAL_CONST_STRING(cachedir, szCacheDir)
328 FN_GLOBAL_CONST_STRING(statedir, szStateDir)
330 /* local prototypes */
331 static int map_parameter(const char *pszParmName);
332 static struct loadparm_service *getservicebyname(struct loadparm_context *lp_ctx,
333 const char *pszServiceName);
334 static void copy_service(struct loadparm_service *pserviceDest,
335 struct loadparm_service *pserviceSource,
336 struct bitmap *pcopymapDest);
337 static bool lpcfg_service_ok(struct loadparm_service *service);
338 static bool do_section(const char *pszSectionName, void *);
339 static void init_copymap(struct loadparm_service *pservice);
341 /* This is a helper function for parametrical options support. */
342 /* It returns a pointer to parametrical option value if it exists or NULL otherwise */
343 /* Actual parametrical functions are quite simple */
344 const char *lpcfg_get_parametric(struct loadparm_context *lp_ctx,
345 struct loadparm_service *service,
346 const char *type, const char *option)
348 char *vfskey_tmp = NULL;
349 char *vfskey = NULL;
350 struct parmlist_entry *data;
352 if (lp_ctx == NULL)
353 return NULL;
355 if (lp_ctx->s3_fns) {
356 return lp_ctx->s3_fns->get_parametric(service, type, option);
359 data = (service == NULL ? lp_ctx->globals->param_opt : service->param_opt);
361 vfskey_tmp = talloc_asprintf(NULL, "%s:%s", type, option);
362 if (vfskey_tmp == NULL) return NULL;
363 vfskey = strlower_talloc(NULL, vfskey_tmp);
364 talloc_free(vfskey_tmp);
366 while (data) {
367 if (strcmp(data->key, vfskey) == 0) {
368 talloc_free(vfskey);
369 return data->value;
371 data = data->next;
374 if (service != NULL) {
375 /* Try to fetch the same option but from globals */
376 /* but only if we are not already working with globals */
377 for (data = lp_ctx->globals->param_opt; data;
378 data = data->next) {
379 if (strcmp(data->key, vfskey) == 0) {
380 talloc_free(vfskey);
381 return data->value;
386 talloc_free(vfskey);
388 return NULL;
393 * convenience routine to return int parameters.
395 static int lp_int(const char *s)
398 if (!s) {
399 DEBUG(0,("lp_int(%s): is called with NULL!\n",s));
400 return -1;
403 return strtol(s, NULL, 0);
407 * convenience routine to return unsigned long parameters.
409 static unsigned long lp_ulong(const char *s)
412 if (!s) {
413 DEBUG(0,("lp_ulong(%s): is called with NULL!\n",s));
414 return -1;
417 return strtoul(s, NULL, 0);
421 * convenience routine to return unsigned long parameters.
423 static long lp_long(const char *s)
426 if (!s) {
427 DEBUG(0,("lp_long(%s): is called with NULL!\n",s));
428 return -1;
431 return strtol(s, NULL, 0);
435 * convenience routine to return unsigned long parameters.
437 static double lp_double(const char *s)
440 if (!s) {
441 DEBUG(0,("lp_double(%s): is called with NULL!\n",s));
442 return -1;
445 return strtod(s, NULL);
449 * convenience routine to return boolean parameters.
451 static bool lp_bool(const char *s)
453 bool ret = false;
455 if (!s) {
456 DEBUG(0,("lp_bool(%s): is called with NULL!\n",s));
457 return false;
460 if (!set_boolean(s, &ret)) {
461 DEBUG(0,("lp_bool(%s): value is not boolean!\n",s));
462 return false;
465 return ret;
470 * Return parametric option from a given service. Type is a part of option before ':'
471 * Parametric option has following syntax: 'Type: option = value'
472 * Returned value is allocated in 'lp_talloc' context
475 const char *lpcfg_parm_string(struct loadparm_context *lp_ctx,
476 struct loadparm_service *service, const char *type,
477 const char *option)
479 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
481 if (value)
482 return lp_string(value);
484 return NULL;
488 * Return parametric option from a given service. Type is a part of option before ':'
489 * Parametric option has following syntax: 'Type: option = value'
490 * Returned value is allocated in 'lp_talloc' context
493 const char **lpcfg_parm_string_list(TALLOC_CTX *mem_ctx,
494 struct loadparm_context *lp_ctx,
495 struct loadparm_service *service,
496 const char *type,
497 const char *option, const char *separator)
499 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
501 if (value != NULL)
502 return (const char **)str_list_make(mem_ctx, value, separator);
504 return NULL;
508 * Return parametric option from a given service. Type is a part of option before ':'
509 * Parametric option has following syntax: 'Type: option = value'
512 int lpcfg_parm_int(struct loadparm_context *lp_ctx,
513 struct loadparm_service *service, const char *type,
514 const char *option, int default_v)
516 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
518 if (value)
519 return lp_int(value);
521 return default_v;
525 * Return parametric option from a given service. Type is a part of
526 * option before ':'.
527 * Parametric option has following syntax: 'Type: option = value'.
530 int lpcfg_parm_bytes(struct loadparm_context *lp_ctx,
531 struct loadparm_service *service, const char *type,
532 const char *option, int default_v)
534 uint64_t bval;
536 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
538 if (value && conv_str_size_error(value, &bval)) {
539 if (bval <= INT_MAX) {
540 return (int)bval;
544 return default_v;
548 * Return parametric option from a given service.
549 * Type is a part of option before ':'
550 * Parametric option has following syntax: 'Type: option = value'
552 unsigned long lpcfg_parm_ulong(struct loadparm_context *lp_ctx,
553 struct loadparm_service *service, const char *type,
554 const char *option, unsigned long default_v)
556 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
558 if (value)
559 return lp_ulong(value);
561 return default_v;
564 long lpcfg_parm_long(struct loadparm_context *lp_ctx,
565 struct loadparm_service *service, const char *type,
566 const char *option, long default_v)
568 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
570 if (value)
571 return lp_long(value);
573 return default_v;
576 double lpcfg_parm_double(struct loadparm_context *lp_ctx,
577 struct loadparm_service *service, const char *type,
578 const char *option, double default_v)
580 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
582 if (value != NULL)
583 return lp_double(value);
585 return default_v;
589 * Return parametric option from a given service. Type is a part of option before ':'
590 * Parametric option has following syntax: 'Type: option = value'
593 bool lpcfg_parm_bool(struct loadparm_context *lp_ctx,
594 struct loadparm_service *service, const char *type,
595 const char *option, bool default_v)
597 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
599 if (value != NULL)
600 return lp_bool(value);
602 return default_v;
607 * Initialise a service to the defaults.
610 static struct loadparm_service *init_service(TALLOC_CTX *mem_ctx, struct loadparm_service *sDefault)
612 struct loadparm_service *pservice =
613 talloc_zero(mem_ctx, struct loadparm_service);
614 copy_service(pservice, sDefault, NULL);
615 return pservice;
619 * Set a string value, deallocating any existing space, and allocing the space
620 * for the string
622 static bool lpcfg_string_set(TALLOC_CTX *mem_ctx, char **dest, const char *src)
624 talloc_free(*dest);
626 if (src == NULL)
627 src = "";
629 *dest = talloc_strdup(mem_ctx, src);
630 if ((*dest) == NULL) {
631 DEBUG(0,("Out of memory in string_set\n"));
632 return false;
635 return true;
639 * Set a string value, deallocating any existing space, and allocing the space
640 * for the string
642 static bool lpcfg_string_set_upper(TALLOC_CTX *mem_ctx, char **dest, const char *src)
644 talloc_free(*dest);
646 if (src == NULL)
647 src = "";
649 *dest = strupper_talloc(mem_ctx, src);
650 if ((*dest) == NULL) {
651 DEBUG(0,("Out of memory in string_set_upper\n"));
652 return false;
655 return true;
661 * Add a new service to the services array initialising it with the given
662 * service.
665 struct loadparm_service *lpcfg_add_service(struct loadparm_context *lp_ctx,
666 const struct loadparm_service *pservice,
667 const char *name)
669 int i;
670 struct loadparm_service tservice;
671 int num_to_alloc = lp_ctx->iNumServices + 1;
672 struct parmlist_entry *data, *pdata;
674 if (pservice == NULL) {
675 pservice = lp_ctx->sDefault;
678 tservice = *pservice;
680 /* it might already exist */
681 if (name) {
682 struct loadparm_service *service = getservicebyname(lp_ctx,
683 name);
684 if (service != NULL) {
685 /* Clean all parametric options for service */
686 /* They will be added during parsing again */
687 data = service->param_opt;
688 while (data) {
689 pdata = data->next;
690 talloc_free(data);
691 data = pdata;
693 service->param_opt = NULL;
694 return service;
698 /* find an invalid one */
699 for (i = 0; i < lp_ctx->iNumServices; i++)
700 if (lp_ctx->services[i] == NULL)
701 break;
703 /* if not, then create one */
704 if (i == lp_ctx->iNumServices) {
705 struct loadparm_service **tsp;
707 tsp = talloc_realloc(lp_ctx, lp_ctx->services, struct loadparm_service *, num_to_alloc);
709 if (!tsp) {
710 DEBUG(0,("lpcfg_add_service: failed to enlarge services!\n"));
711 return NULL;
712 } else {
713 lp_ctx->services = tsp;
714 lp_ctx->services[lp_ctx->iNumServices] = NULL;
717 lp_ctx->iNumServices++;
720 lp_ctx->services[i] = init_service(lp_ctx->services, lp_ctx->sDefault);
721 if (lp_ctx->services[i] == NULL) {
722 DEBUG(0,("lpcfg_add_service: out of memory!\n"));
723 return NULL;
725 copy_service(lp_ctx->services[i], &tservice, NULL);
726 if (name != NULL)
727 lpcfg_string_set(lp_ctx->services[i], &lp_ctx->services[i]->szService, name);
728 return lp_ctx->services[i];
732 * Add a new home service, with the specified home directory, defaults coming
733 * from service ifrom.
736 bool lpcfg_add_home(struct loadparm_context *lp_ctx,
737 const char *pszHomename,
738 struct loadparm_service *default_service,
739 const char *user, const char *pszHomedir)
741 struct loadparm_service *service;
743 service = lpcfg_add_service(lp_ctx, default_service, pszHomename);
745 if (service == NULL)
746 return false;
748 if (!(*(default_service->szPath))
749 || strequal(default_service->szPath, lp_ctx->sDefault->szPath)) {
750 service->szPath = talloc_strdup(service, pszHomedir);
751 } else {
752 service->szPath = string_sub_talloc(service, lpcfg_pathname(default_service, lp_ctx->sDefault), "%H", pszHomedir);
755 if (!(*(service->comment))) {
756 service->comment = talloc_asprintf(service, "Home directory of %s", user);
758 service->bAvailable = default_service->bAvailable;
759 service->bBrowseable = default_service->bBrowseable;
761 DEBUG(3, ("adding home's share [%s] for user '%s' at '%s'\n",
762 pszHomename, user, service->szPath));
764 return true;
768 * Add a new printer service, with defaults coming from service iFrom.
771 bool lpcfg_add_printer(struct loadparm_context *lp_ctx,
772 const char *pszPrintername,
773 struct loadparm_service *default_service)
775 const char *comment = "From Printcap";
776 struct loadparm_service *service;
777 service = lpcfg_add_service(lp_ctx, default_service, pszPrintername);
779 if (service == NULL)
780 return false;
782 /* note that we do NOT default the availability flag to True - */
783 /* we take it from the default service passed. This allows all */
784 /* dynamic printers to be disabled by disabling the [printers] */
785 /* entry (if/when the 'available' keyword is implemented!). */
787 /* the printer name is set to the service name. */
788 lpcfg_string_set(service, &service->szPrintername, pszPrintername);
789 lpcfg_string_set(service, &service->comment, comment);
790 service->bBrowseable = default_service->bBrowseable;
791 /* Printers cannot be read_only. */
792 service->bRead_only = false;
793 /* Printer services must be printable. */
794 service->bPrint_ok = true;
796 DEBUG(3, ("adding printer service %s\n", pszPrintername));
798 return true;
802 * Map a parameter's string representation to something we can use.
803 * Returns False if the parameter string is not recognised, else TRUE.
806 static int map_parameter(const char *pszParmName)
808 int iIndex;
810 if (*pszParmName == '-')
811 return -1;
813 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
814 if (strwicmp(parm_table[iIndex].label, pszParmName) == 0)
815 return iIndex;
817 /* Warn only if it isn't parametric option */
818 if (strchr(pszParmName, ':') == NULL)
819 DEBUG(0, ("Unknown parameter encountered: \"%s\"\n", pszParmName));
820 /* We do return 'fail' for parametric options as well because they are
821 stored in different storage
823 return -1;
828 return the parameter structure for a parameter
830 struct parm_struct *lpcfg_parm_struct(struct loadparm_context *lp_ctx, const char *name)
832 int parmnum;
834 if (lp_ctx->s3_fns) {
835 return lp_ctx->s3_fns->get_parm_struct(name);
838 parmnum = map_parameter(name);
839 if (parmnum == -1) return NULL;
840 return &parm_table[parmnum];
844 return the parameter pointer for a parameter
846 void *lpcfg_parm_ptr(struct loadparm_context *lp_ctx,
847 struct loadparm_service *service, struct parm_struct *parm)
849 if (lp_ctx->s3_fns) {
850 return lp_ctx->s3_fns->get_parm_ptr(service, parm);
853 if (service == NULL) {
854 if (parm->p_class == P_LOCAL)
855 return ((char *)lp_ctx->sDefault)+parm->offset;
856 else if (parm->p_class == P_GLOBAL)
857 return ((char *)lp_ctx->globals)+parm->offset;
858 else return NULL;
859 } else {
860 return ((char *)service) + parm->offset;
865 return the parameter pointer for a parameter
867 bool lpcfg_parm_is_cmdline(struct loadparm_context *lp_ctx, const char *name)
869 int parmnum;
871 if (lp_ctx->s3_fns) {
872 struct parm_struct *parm = lp_ctx->s3_fns->get_parm_struct(name);
873 if (parm) {
874 return parm->flags & FLAG_CMDLINE;
876 return false;
879 parmnum = map_parameter(name);
880 if (parmnum == -1) return false;
882 return lp_ctx->flags[parmnum] & FLAG_CMDLINE;
886 * Find a service by name. Otherwise works like get_service.
889 static struct loadparm_service *getservicebyname(struct loadparm_context *lp_ctx,
890 const char *pszServiceName)
892 int iService;
894 if (lp_ctx->s3_fns) {
895 return lp_ctx->s3_fns->get_service(pszServiceName);
898 for (iService = lp_ctx->iNumServices - 1; iService >= 0; iService--)
899 if (lp_ctx->services[iService] != NULL &&
900 strwicmp(lp_ctx->services[iService]->szService, pszServiceName) == 0) {
901 return lp_ctx->services[iService];
904 return NULL;
908 * Copy a service structure to another.
909 * If pcopymapDest is NULL then copy all fields
912 static void copy_service(struct loadparm_service *pserviceDest,
913 struct loadparm_service *pserviceSource,
914 struct bitmap *pcopymapDest)
916 int i;
917 bool bcopyall = (pcopymapDest == NULL);
918 struct parmlist_entry *data, *pdata, *paramo;
919 bool not_added;
921 for (i = 0; parm_table[i].label; i++)
922 if (parm_table[i].p_class == P_LOCAL &&
923 (bcopyall || bitmap_query(pcopymapDest, i))) {
924 void *src_ptr =
925 ((char *)pserviceSource) + parm_table[i].offset;
926 void *dest_ptr =
927 ((char *)pserviceDest) + parm_table[i].offset;
929 switch (parm_table[i].type) {
930 case P_BOOL:
931 *(bool *)dest_ptr = *(bool *)src_ptr;
932 break;
934 case P_INTEGER:
935 case P_BYTES:
936 case P_OCTAL:
937 case P_ENUM:
938 *(int *)dest_ptr = *(int *)src_ptr;
939 break;
941 case P_STRING:
942 lpcfg_string_set(pserviceDest,
943 (char **)dest_ptr,
944 *(char **)src_ptr);
945 break;
947 case P_USTRING:
948 lpcfg_string_set_upper(pserviceDest,
949 (char **)dest_ptr,
950 *(char **)src_ptr);
951 break;
952 case P_LIST:
953 *(const char ***)dest_ptr = (const char **)str_list_copy(pserviceDest,
954 *(const char ***)src_ptr);
955 break;
956 default:
957 break;
961 if (bcopyall) {
962 init_copymap(pserviceDest);
963 if (pserviceSource->copymap)
964 bitmap_copy(pserviceDest->copymap,
965 pserviceSource->copymap);
968 data = pserviceSource->param_opt;
969 while (data) {
970 not_added = true;
971 pdata = pserviceDest->param_opt;
972 /* Traverse destination */
973 while (pdata) {
974 /* If we already have same option, override it */
975 if (strcmp(pdata->key, data->key) == 0) {
976 talloc_free(pdata->value);
977 pdata->value = talloc_strdup(pdata,
978 data->value);
979 not_added = false;
980 break;
982 pdata = pdata->next;
984 if (not_added) {
985 paramo = talloc_zero(pserviceDest, struct parmlist_entry);
986 if (paramo == NULL)
987 smb_panic("OOM");
988 paramo->key = talloc_strdup(paramo, data->key);
989 paramo->value = talloc_strdup(paramo, data->value);
990 DLIST_ADD(pserviceDest->param_opt, paramo);
992 data = data->next;
997 * Check a service for consistency. Return False if the service is in any way
998 * incomplete or faulty, else True.
1000 static bool lpcfg_service_ok(struct loadparm_service *service)
1002 bool bRetval;
1004 bRetval = true;
1005 if (service->szService[0] == '\0') {
1006 DEBUG(0, ("The following message indicates an internal error:\n"));
1007 DEBUG(0, ("No service name in service entry.\n"));
1008 bRetval = false;
1011 /* The [printers] entry MUST be printable. I'm all for flexibility, but */
1012 /* I can't see why you'd want a non-printable printer service... */
1013 if (strwicmp(service->szService, PRINTERS_NAME) == 0) {
1014 if (!service->bPrint_ok) {
1015 DEBUG(0, ("WARNING: [%s] service MUST be printable!\n",
1016 service->szService));
1017 service->bPrint_ok = true;
1019 /* [printers] service must also be non-browsable. */
1020 if (service->bBrowseable)
1021 service->bBrowseable = false;
1024 /* If a service is flagged unavailable, log the fact at level 0. */
1025 if (!service->bAvailable)
1026 DEBUG(1, ("NOTE: Service %s is flagged unavailable.\n",
1027 service->szService));
1029 return bRetval;
1033 /*******************************************************************
1034 Keep a linked list of all config files so we know when one has changed
1035 it's date and needs to be reloaded.
1036 ********************************************************************/
1038 static void add_to_file_list(struct loadparm_context *lp_ctx,
1039 const char *fname, const char *subfname)
1041 struct file_lists *f = lp_ctx->file_lists;
1043 while (f) {
1044 if (f->name && !strcmp(f->name, fname))
1045 break;
1046 f = f->next;
1049 if (!f) {
1050 f = talloc(lp_ctx, struct file_lists);
1051 if (!f)
1052 return;
1053 f->next = lp_ctx->file_lists;
1054 f->name = talloc_strdup(f, fname);
1055 if (!f->name) {
1056 talloc_free(f);
1057 return;
1059 f->subfname = talloc_strdup(f, subfname);
1060 if (!f->subfname) {
1061 talloc_free(f);
1062 return;
1064 lp_ctx->file_lists = f;
1065 f->modtime = file_modtime(subfname);
1066 } else {
1067 time_t t = file_modtime(subfname);
1068 if (t)
1069 f->modtime = t;
1073 /*******************************************************************
1074 Check if a config file has changed date.
1075 ********************************************************************/
1076 bool lpcfg_file_list_changed(struct loadparm_context *lp_ctx)
1078 struct file_lists *f;
1079 DEBUG(6, ("lp_file_list_changed()\n"));
1081 for (f = lp_ctx->file_lists; f != NULL; f = f->next) {
1082 char *n2;
1083 time_t mod_time;
1085 n2 = standard_sub_basic(lp_ctx, f->name);
1087 DEBUGADD(6, ("file %s -> %s last mod_time: %s\n",
1088 f->name, n2, ctime(&f->modtime)));
1090 mod_time = file_modtime(n2);
1092 if (mod_time && ((f->modtime != mod_time) || (f->subfname == NULL) || (strcmp(n2, f->subfname) != 0))) {
1093 DEBUGADD(6, ("file %s modified: %s\n", n2,
1094 ctime(&mod_time)));
1095 f->modtime = mod_time;
1096 talloc_free(f->subfname);
1097 f->subfname = talloc_strdup(f, n2);
1098 return true;
1101 return false;
1104 /***************************************************************************
1105 Handle the "realm" parameter
1106 ***************************************************************************/
1108 static bool handle_realm(struct loadparm_context *lp_ctx, int unused,
1109 const char *pszParmValue, char **ptr)
1111 lpcfg_string_set(lp_ctx, ptr, pszParmValue);
1113 talloc_free(lp_ctx->globals->szRealm_upper);
1114 talloc_free(lp_ctx->globals->szRealm_lower);
1116 lp_ctx->globals->szRealm_upper = strupper_talloc(lp_ctx, pszParmValue);
1117 lp_ctx->globals->szRealm_lower = strlower_talloc(lp_ctx, pszParmValue);
1119 return true;
1122 /***************************************************************************
1123 Handle the include operation.
1124 ***************************************************************************/
1126 static bool handle_include(struct loadparm_context *lp_ctx, int unused,
1127 const char *pszParmValue, char **ptr)
1129 char *fname = standard_sub_basic(lp_ctx, pszParmValue);
1131 add_to_file_list(lp_ctx, pszParmValue, fname);
1133 lpcfg_string_set(lp_ctx, ptr, fname);
1135 if (file_exist(fname))
1136 return pm_process(fname, do_section, do_parameter, lp_ctx);
1138 DEBUG(2, ("Can't find include file %s\n", fname));
1140 return false;
1143 /***************************************************************************
1144 Handle the interpretation of the copy parameter.
1145 ***************************************************************************/
1147 static bool handle_copy(struct loadparm_context *lp_ctx, int unused,
1148 const char *pszParmValue, char **ptr)
1150 bool bRetval;
1151 struct loadparm_service *serviceTemp;
1153 lpcfg_string_set(lp_ctx, ptr, pszParmValue);
1155 bRetval = false;
1157 DEBUG(3, ("Copying service from service %s\n", pszParmValue));
1159 if ((serviceTemp = getservicebyname(lp_ctx, pszParmValue)) != NULL) {
1160 if (serviceTemp == lp_ctx->currentService) {
1161 DEBUG(0, ("Can't copy service %s - unable to copy self!\n", pszParmValue));
1162 } else {
1163 copy_service(lp_ctx->currentService,
1164 serviceTemp,
1165 lp_ctx->currentService->copymap);
1166 bRetval = true;
1168 } else {
1169 DEBUG(0, ("Unable to copy service - source not found: %s\n",
1170 pszParmValue));
1171 bRetval = false;
1174 return bRetval;
1177 static bool handle_debug_list(struct loadparm_context *lp_ctx, int unused,
1178 const char *pszParmValue, char **ptr)
1181 lpcfg_string_set(lp_ctx, ptr, pszParmValue);
1182 if (lp_ctx->global) {
1183 return debug_parse_levels(pszParmValue);
1185 return true;
1188 static bool handle_logfile(struct loadparm_context *lp_ctx, int unused,
1189 const char *pszParmValue, char **ptr)
1191 debug_set_logfile(pszParmValue);
1192 if (lp_ctx->global) {
1193 lpcfg_string_set(lp_ctx, ptr, pszParmValue);
1195 return true;
1198 /***************************************************************************
1199 Initialise a copymap.
1200 ***************************************************************************/
1202 static void init_copymap(struct loadparm_service *pservice)
1204 int i;
1206 TALLOC_FREE(pservice->copymap);
1208 pservice->copymap = bitmap_talloc(NULL, NUMPARAMETERS);
1209 if (!pservice->copymap)
1210 DEBUG(0,
1211 ("Couldn't allocate copymap!! (size %d)\n",
1212 (int)NUMPARAMETERS));
1213 else
1214 for (i = 0; i < NUMPARAMETERS; i++)
1215 bitmap_set(pservice->copymap, i);
1219 * Process a parametric option
1221 static bool lp_do_parameter_parametric(struct loadparm_context *lp_ctx,
1222 struct loadparm_service *service,
1223 const char *pszParmName,
1224 const char *pszParmValue, int flags)
1226 struct parmlist_entry *paramo, *data;
1227 char *name;
1228 TALLOC_CTX *mem_ctx;
1230 while (isspace((unsigned char)*pszParmName)) {
1231 pszParmName++;
1234 name = strlower_talloc(lp_ctx, pszParmName);
1235 if (!name) return false;
1237 if (service == NULL) {
1238 data = lp_ctx->globals->param_opt;
1239 mem_ctx = lp_ctx->globals;
1240 } else {
1241 data = service->param_opt;
1242 mem_ctx = service;
1245 /* Traverse destination */
1246 for (paramo=data; paramo; paramo=paramo->next) {
1247 /* If we already have the option set, override it unless
1248 it was a command line option and the new one isn't */
1249 if (strcmp(paramo->key, name) == 0) {
1250 if ((paramo->priority & FLAG_CMDLINE) &&
1251 !(flags & FLAG_CMDLINE)) {
1252 talloc_free(name);
1253 return true;
1256 talloc_free(paramo->value);
1257 paramo->value = talloc_strdup(paramo, pszParmValue);
1258 paramo->priority = flags;
1259 talloc_free(name);
1260 return true;
1264 paramo = talloc_zero(mem_ctx, struct parmlist_entry);
1265 if (!paramo)
1266 smb_panic("OOM");
1267 paramo->key = talloc_strdup(paramo, name);
1268 paramo->value = talloc_strdup(paramo, pszParmValue);
1269 paramo->priority = flags;
1270 if (service == NULL) {
1271 DLIST_ADD(lp_ctx->globals->param_opt, paramo);
1272 } else {
1273 DLIST_ADD(service->param_opt, paramo);
1276 talloc_free(name);
1278 return true;
1281 static bool set_variable(TALLOC_CTX *mem_ctx, int parmnum, void *parm_ptr,
1282 const char *pszParmName, const char *pszParmValue,
1283 struct loadparm_context *lp_ctx, bool on_globals)
1285 int i;
1286 /* if it is a special case then go ahead */
1287 if (parm_table[parmnum].special) {
1288 bool ret;
1289 ret = parm_table[parmnum].special(lp_ctx, -1, pszParmValue,
1290 (char **)parm_ptr);
1291 if (!ret) {
1292 return false;
1294 goto mark_non_default;
1297 /* now switch on the type of variable it is */
1298 switch (parm_table[parmnum].type)
1300 case P_BOOL: {
1301 bool b;
1302 if (!set_boolean(pszParmValue, &b)) {
1303 DEBUG(0,("lp_do_parameter(%s): value is not boolean!\n", pszParmValue));
1304 return false;
1306 *(bool *)parm_ptr = b;
1308 break;
1310 case P_BOOLREV: {
1311 bool b;
1312 if (!set_boolean(pszParmValue, &b)) {
1313 DEBUG(0,("lp_do_parameter(%s): value is not boolean!\n", pszParmValue));
1314 return false;
1316 *(bool *)parm_ptr = !b;
1318 break;
1320 case P_INTEGER:
1321 *(int *)parm_ptr = atoi(pszParmValue);
1322 break;
1324 case P_CHAR:
1325 *(char *)parm_ptr = *pszParmValue;
1326 break;
1328 case P_OCTAL:
1329 *(int *)parm_ptr = strtol(pszParmValue, NULL, 8);
1330 break;
1332 case P_BYTES:
1334 uint64_t val;
1335 if (conv_str_size_error(pszParmValue, &val)) {
1336 if (val <= INT_MAX) {
1337 *(int *)parm_ptr = (int)val;
1338 break;
1342 DEBUG(0,("lp_do_parameter(%s): value is not "
1343 "a valid size specifier!\n", pszParmValue));
1344 return false;
1347 case P_CMDLIST:
1348 *(const char ***)parm_ptr = (const char **)str_list_make(mem_ctx,
1349 pszParmValue, NULL);
1350 break;
1351 case P_LIST:
1353 char **new_list = str_list_make(mem_ctx,
1354 pszParmValue, NULL);
1355 for (i=0; new_list[i]; i++) {
1356 if (*(const char ***)parm_ptr != NULL &&
1357 new_list[i][0] == '+' &&
1358 new_list[i][1])
1360 if (!str_list_check(*(const char ***)parm_ptr,
1361 &new_list[i][1])) {
1362 *(const char ***)parm_ptr = str_list_add(*(const char ***)parm_ptr,
1363 &new_list[i][1]);
1365 } else if (*(const char ***)parm_ptr != NULL &&
1366 new_list[i][0] == '-' &&
1367 new_list[i][1])
1369 str_list_remove(*(const char ***)parm_ptr,
1370 &new_list[i][1]);
1371 } else {
1372 if (i != 0) {
1373 DEBUG(0, ("Unsupported list syntax for: %s = %s\n",
1374 pszParmName, pszParmValue));
1375 return false;
1377 *(const char ***)parm_ptr = (const char **) new_list;
1378 break;
1381 break;
1383 case P_STRING:
1384 lpcfg_string_set(mem_ctx, (char **)parm_ptr, pszParmValue);
1385 break;
1387 case P_USTRING:
1388 lpcfg_string_set_upper(mem_ctx, (char **)parm_ptr, pszParmValue);
1389 break;
1391 case P_ENUM:
1392 for (i = 0; parm_table[parmnum].enum_list[i].name; i++) {
1393 if (strequal
1394 (pszParmValue,
1395 parm_table[parmnum].enum_list[i].name)) {
1396 *(int *)parm_ptr =
1397 parm_table[parmnum].
1398 enum_list[i].value;
1399 break;
1402 if (!parm_table[parmnum].enum_list[i].name) {
1403 DEBUG(0,("Unknown enumerated value '%s' for '%s'\n",
1404 pszParmValue, pszParmName));
1405 return false;
1407 break;
1409 case P_SEP:
1410 break;
1413 mark_non_default:
1414 if (on_globals && (lp_ctx->flags[parmnum] & FLAG_DEFAULT)) {
1415 lp_ctx->flags[parmnum] &= ~FLAG_DEFAULT;
1416 /* we have to also unset FLAG_DEFAULT on aliases */
1417 for (i=parmnum-1;i>=0 && parm_table[i].offset == parm_table[parmnum].offset;i--) {
1418 lp_ctx->flags[i] &= ~FLAG_DEFAULT;
1420 for (i=parmnum+1;i<NUMPARAMETERS && parm_table[i].offset == parm_table[parmnum].offset;i++) {
1421 lp_ctx->flags[i] &= ~FLAG_DEFAULT;
1424 return true;
1428 bool lpcfg_do_global_parameter(struct loadparm_context *lp_ctx,
1429 const char *pszParmName, const char *pszParmValue)
1431 int parmnum = map_parameter(pszParmName);
1432 void *parm_ptr;
1434 if (parmnum < 0) {
1435 if (strchr(pszParmName, ':')) {
1436 return lp_do_parameter_parametric(lp_ctx, NULL, pszParmName, pszParmValue, 0);
1438 DEBUG(0, ("Ignoring unknown parameter \"%s\"\n", pszParmName));
1439 return true;
1442 /* if the flag has been set on the command line, then don't allow override,
1443 but don't report an error */
1444 if (lp_ctx->flags[parmnum] & FLAG_CMDLINE) {
1445 return true;
1448 parm_ptr = lpcfg_parm_ptr(lp_ctx, NULL, &parm_table[parmnum]);
1450 return set_variable(lp_ctx->globals, parmnum, parm_ptr,
1451 pszParmName, pszParmValue, lp_ctx, true);
1454 bool lpcfg_do_service_parameter(struct loadparm_context *lp_ctx,
1455 struct loadparm_service *service,
1456 const char *pszParmName, const char *pszParmValue)
1458 void *parm_ptr;
1459 int i;
1460 int parmnum = map_parameter(pszParmName);
1462 if (parmnum < 0) {
1463 if (strchr(pszParmName, ':')) {
1464 return lp_do_parameter_parametric(lp_ctx, service, pszParmName, pszParmValue, 0);
1466 DEBUG(0, ("Ignoring unknown parameter \"%s\"\n", pszParmName));
1467 return true;
1470 /* if the flag has been set on the command line, then don't allow override,
1471 but don't report an error */
1472 if (lp_ctx->flags[parmnum] & FLAG_CMDLINE) {
1473 return true;
1476 if (parm_table[parmnum].p_class == P_GLOBAL) {
1477 DEBUG(0,
1478 ("Global parameter %s found in service section!\n",
1479 pszParmName));
1480 return true;
1482 parm_ptr = ((char *)service) + parm_table[parmnum].offset;
1484 if (!service->copymap)
1485 init_copymap(service);
1487 /* this handles the aliases - set the copymap for other
1488 * entries with the same data pointer */
1489 for (i = 0; parm_table[i].label; i++)
1490 if (parm_table[i].offset == parm_table[parmnum].offset &&
1491 parm_table[i].p_class == parm_table[parmnum].p_class)
1492 bitmap_clear(service->copymap, i);
1494 return set_variable(service, parmnum, parm_ptr, pszParmName,
1495 pszParmValue, lp_ctx, false);
1499 * Process a parameter.
1502 static bool do_parameter(const char *pszParmName, const char *pszParmValue,
1503 void *userdata)
1505 struct loadparm_context *lp_ctx = (struct loadparm_context *)userdata;
1507 if (lp_ctx->bInGlobalSection)
1508 return lpcfg_do_global_parameter(lp_ctx, pszParmName,
1509 pszParmValue);
1510 else
1511 return lpcfg_do_service_parameter(lp_ctx, lp_ctx->currentService,
1512 pszParmName, pszParmValue);
1516 variable argument do parameter
1518 bool lpcfg_do_global_parameter_var(struct loadparm_context *lp_ctx, const char *pszParmName, const char *fmt, ...) PRINTF_ATTRIBUTE(3, 4);
1519 bool lpcfg_do_global_parameter_var(struct loadparm_context *lp_ctx,
1520 const char *pszParmName, const char *fmt, ...)
1522 char *s;
1523 bool ret;
1524 va_list ap;
1526 va_start(ap, fmt);
1527 s = talloc_vasprintf(NULL, fmt, ap);
1528 va_end(ap);
1529 ret = lpcfg_do_global_parameter(lp_ctx, pszParmName, s);
1530 talloc_free(s);
1531 return ret;
1536 set a parameter from the commandline - this is called from command line parameter
1537 parsing code. It sets the parameter then marks the parameter as unable to be modified
1538 by smb.conf processing
1540 bool lpcfg_set_cmdline(struct loadparm_context *lp_ctx, const char *pszParmName,
1541 const char *pszParmValue)
1543 int parmnum;
1544 int i;
1546 if (lp_ctx->s3_fns) {
1547 return lp_ctx->s3_fns->set_cmdline(pszParmName, pszParmValue);
1550 parmnum = map_parameter(pszParmName);
1552 while (isspace((unsigned char)*pszParmValue)) pszParmValue++;
1555 if (parmnum < 0 && strchr(pszParmName, ':')) {
1556 /* set a parametric option */
1557 return lp_do_parameter_parametric(lp_ctx, NULL, pszParmName,
1558 pszParmValue, FLAG_CMDLINE);
1561 if (parmnum < 0) {
1562 DEBUG(0,("Unknown option '%s'\n", pszParmName));
1563 return false;
1566 /* reset the CMDLINE flag in case this has been called before */
1567 lp_ctx->flags[parmnum] &= ~FLAG_CMDLINE;
1569 if (!lpcfg_do_global_parameter(lp_ctx, pszParmName, pszParmValue)) {
1570 return false;
1573 lp_ctx->flags[parmnum] |= FLAG_CMDLINE;
1575 /* we have to also set FLAG_CMDLINE on aliases */
1576 for (i=parmnum-1;i>=0 && parm_table[i].offset == parm_table[parmnum].offset;i--) {
1577 lp_ctx->flags[i] |= FLAG_CMDLINE;
1579 for (i=parmnum+1;i<NUMPARAMETERS && parm_table[i].offset == parm_table[parmnum].offset;i++) {
1580 lp_ctx->flags[i] |= FLAG_CMDLINE;
1583 return true;
1587 set a option from the commandline in 'a=b' format. Use to support --option
1589 bool lpcfg_set_option(struct loadparm_context *lp_ctx, const char *option)
1591 char *p, *s;
1592 bool ret;
1594 s = talloc_strdup(NULL, option);
1595 if (!s) {
1596 return false;
1599 p = strchr(s, '=');
1600 if (!p) {
1601 talloc_free(s);
1602 return false;
1605 *p = 0;
1607 ret = lpcfg_set_cmdline(lp_ctx, s, p+1);
1608 talloc_free(s);
1609 return ret;
1613 #define BOOLSTR(b) ((b) ? "Yes" : "No")
1616 * Print a parameter of the specified type.
1619 static void print_parameter(struct parm_struct *p, void *ptr, FILE * f)
1621 /* For the seperation of lists values that we print below */
1622 const char *list_sep = ", ";
1623 int i;
1624 switch (p->type)
1626 case P_ENUM:
1627 for (i = 0; p->enum_list[i].name; i++) {
1628 if (*(int *)ptr == p->enum_list[i].value) {
1629 fprintf(f, "%s",
1630 p->enum_list[i].name);
1631 break;
1634 break;
1636 case P_BOOL:
1637 fprintf(f, "%s", BOOLSTR(*(bool *)ptr));
1638 break;
1640 case P_BOOLREV:
1641 fprintf(f, "%s", BOOLSTR(!*(bool *)ptr));
1642 break;
1644 case P_INTEGER:
1645 case P_BYTES:
1646 fprintf(f, "%d", *(int *)ptr);
1647 break;
1649 case P_CHAR:
1650 fprintf(f, "%c", *(char *)ptr);
1651 break;
1653 case P_OCTAL: {
1654 int val = *(int *)ptr;
1655 if (val == -1) {
1656 fprintf(f, "-1");
1657 } else {
1658 fprintf(f, "0%o", val);
1660 break;
1663 case P_CMDLIST:
1664 list_sep = " ";
1665 /* fall through */
1666 case P_LIST:
1667 if ((char ***)ptr && *(char ***)ptr) {
1668 char **list = *(char ***)ptr;
1669 for (; *list; list++) {
1670 /* surround strings with whitespace in double quotes */
1671 if (*(list+1) == NULL) {
1672 /* last item, no extra separator */
1673 list_sep = "";
1675 if ( strchr_m( *list, ' ' ) ) {
1676 fprintf(f, "\"%s\"%s", *list, list_sep);
1677 } else {
1678 fprintf(f, "%s%s", *list, list_sep);
1682 break;
1684 case P_STRING:
1685 case P_USTRING:
1686 if (*(char **)ptr) {
1687 fprintf(f, "%s", *(char **)ptr);
1689 break;
1690 case P_SEP:
1691 break;
1696 * Check if two parameters are equal.
1699 static bool equal_parameter(parm_type type, void *ptr1, void *ptr2)
1701 switch (type) {
1702 case P_BOOL:
1703 case P_BOOLREV:
1704 return (*((bool *)ptr1) == *((bool *)ptr2));
1706 case P_INTEGER:
1707 case P_ENUM:
1708 case P_OCTAL:
1709 case P_BYTES:
1710 return (*((int *)ptr1) == *((int *)ptr2));
1712 case P_CHAR:
1713 return (*((char *)ptr1) == *((char *)ptr2));
1715 case P_LIST:
1716 case P_CMDLIST:
1717 return str_list_equal(*(const char ***)ptr1, *(const char ***)ptr2);
1719 case P_STRING:
1720 case P_USTRING:
1722 char *p1 = *(char **)ptr1, *p2 = *(char **)ptr2;
1723 if (p1 && !*p1)
1724 p1 = NULL;
1725 if (p2 && !*p2)
1726 p2 = NULL;
1727 return (p1 == p2 || strequal(p1, p2));
1729 case P_SEP:
1730 break;
1732 return false;
1736 * Process a new section (service).
1738 * At this stage all sections are services.
1739 * Later we'll have special sections that permit server parameters to be set.
1740 * Returns True on success, False on failure.
1743 static bool do_section(const char *pszSectionName, void *userdata)
1745 struct loadparm_context *lp_ctx = (struct loadparm_context *)userdata;
1746 bool bRetval;
1747 bool isglobal = ((strwicmp(pszSectionName, GLOBAL_NAME) == 0) ||
1748 (strwicmp(pszSectionName, GLOBAL_NAME2) == 0));
1749 bRetval = false;
1751 /* if we've just struck a global section, note the fact. */
1752 lp_ctx->bInGlobalSection = isglobal;
1754 /* check for multiple global sections */
1755 if (lp_ctx->bInGlobalSection) {
1756 DEBUG(4, ("Processing section \"[%s]\"\n", pszSectionName));
1757 return true;
1760 /* if we have a current service, tidy it up before moving on */
1761 bRetval = true;
1763 if (lp_ctx->currentService != NULL)
1764 bRetval = lpcfg_service_ok(lp_ctx->currentService);
1766 /* if all is still well, move to the next record in the services array */
1767 if (bRetval) {
1768 /* We put this here to avoid an odd message order if messages are */
1769 /* issued by the post-processing of a previous section. */
1770 DEBUG(4, ("Processing section \"[%s]\"\n", pszSectionName));
1772 if ((lp_ctx->currentService = lpcfg_add_service(lp_ctx, lp_ctx->sDefault,
1773 pszSectionName))
1774 == NULL) {
1775 DEBUG(0, ("Failed to add a new service\n"));
1776 return false;
1780 return bRetval;
1785 * Determine if a particular base parameter is currently set to the default value.
1788 static bool is_default(struct loadparm_service *sDefault, int i)
1790 void *def_ptr = ((char *)sDefault) + parm_table[i].offset;
1791 if (!defaults_saved)
1792 return false;
1793 switch (parm_table[i].type) {
1794 case P_CMDLIST:
1795 case P_LIST:
1796 return str_list_equal((const char **)parm_table[i].def.lvalue,
1797 (const char **)def_ptr);
1798 case P_STRING:
1799 case P_USTRING:
1800 return strequal(parm_table[i].def.svalue,
1801 *(char **)def_ptr);
1802 case P_BOOL:
1803 case P_BOOLREV:
1804 return parm_table[i].def.bvalue ==
1805 *(bool *)def_ptr;
1806 case P_INTEGER:
1807 case P_CHAR:
1808 case P_OCTAL:
1809 case P_BYTES:
1810 case P_ENUM:
1811 return parm_table[i].def.ivalue ==
1812 *(int *)def_ptr;
1813 case P_SEP:
1814 break;
1816 return false;
1820 *Display the contents of the global structure.
1823 static void dump_globals(struct loadparm_context *lp_ctx, FILE *f,
1824 bool show_defaults)
1826 int i;
1827 struct parmlist_entry *data;
1829 fprintf(f, "# Global parameters\n[global]\n");
1831 for (i = 0; parm_table[i].label; i++)
1832 if (parm_table[i].p_class == P_GLOBAL &&
1833 (i == 0 || (parm_table[i].offset != parm_table[i - 1].offset))) {
1834 if (!show_defaults && (lp_ctx->flags[i] & FLAG_DEFAULT))
1835 continue;
1836 fprintf(f, "\t%s = ", parm_table[i].label);
1837 print_parameter(&parm_table[i], lpcfg_parm_ptr(lp_ctx, NULL, &parm_table[i]), f);
1838 fprintf(f, "\n");
1840 if (lp_ctx->globals->param_opt != NULL) {
1841 for (data = lp_ctx->globals->param_opt; data;
1842 data = data->next) {
1843 if (!show_defaults && (data->priority & FLAG_DEFAULT)) {
1844 continue;
1846 fprintf(f, "\t%s = %s\n", data->key, data->value);
1853 * Display the contents of a single services record.
1856 static void dump_a_service(struct loadparm_service * pService, struct loadparm_service *sDefault, FILE * f,
1857 unsigned int *flags)
1859 int i;
1860 struct parmlist_entry *data;
1862 if (pService != sDefault)
1863 fprintf(f, "\n[%s]\n", pService->szService);
1865 for (i = 0; parm_table[i].label; i++) {
1866 if (parm_table[i].p_class == P_LOCAL &&
1867 (*parm_table[i].label != '-') &&
1868 (i == 0 || (parm_table[i].offset != parm_table[i - 1].offset)))
1870 if (pService == sDefault) {
1871 if (flags && (flags[i] & FLAG_DEFAULT)) {
1872 continue;
1874 if (defaults_saved) {
1875 if (is_default(sDefault, i)) {
1876 continue;
1879 } else {
1880 if (equal_parameter(parm_table[i].type,
1881 ((char *)pService) +
1882 parm_table[i].offset,
1883 ((char *)sDefault) +
1884 parm_table[i].offset))
1885 continue;
1888 fprintf(f, "\t%s = ", parm_table[i].label);
1889 print_parameter(&parm_table[i],
1890 ((char *)pService) + parm_table[i].offset, f);
1891 fprintf(f, "\n");
1894 if (pService->param_opt != NULL) {
1895 for (data = pService->param_opt; data; data = data->next) {
1896 fprintf(f, "\t%s = %s\n", data->key, data->value);
1901 bool lpcfg_dump_a_parameter(struct loadparm_context *lp_ctx,
1902 struct loadparm_service *service,
1903 const char *parm_name, FILE * f)
1905 struct parm_struct *parm;
1906 void *ptr;
1908 parm = lpcfg_parm_struct(lp_ctx, parm_name);
1909 if (!parm) {
1910 return false;
1913 ptr = lpcfg_parm_ptr(lp_ctx, service,parm);
1915 print_parameter(parm, ptr, f);
1916 fprintf(f, "\n");
1917 return true;
1921 * Return info about the next parameter in a service.
1922 * snum==-1 gives the globals.
1923 * Return NULL when out of parameters.
1927 struct parm_struct *lpcfg_next_parameter(struct loadparm_context *lp_ctx, int snum, int *i,
1928 int allparameters)
1930 if (snum == -1) {
1931 /* do the globals */
1932 for (; parm_table[*i].label; (*i)++) {
1933 if ((*parm_table[*i].label == '-'))
1934 continue;
1936 if ((*i) > 0
1937 && (parm_table[*i].offset ==
1938 parm_table[(*i) - 1].offset)
1939 && (parm_table[*i].p_class ==
1940 parm_table[(*i) - 1].p_class))
1941 continue;
1943 return &parm_table[(*i)++];
1945 } else {
1946 struct loadparm_service *pService = lp_ctx->services[snum];
1948 for (; parm_table[*i].label; (*i)++) {
1949 if (parm_table[*i].p_class == P_LOCAL &&
1950 (*parm_table[*i].label != '-') &&
1951 ((*i) == 0 ||
1952 (parm_table[*i].offset !=
1953 parm_table[(*i) - 1].offset)))
1955 if (allparameters ||
1956 !equal_parameter(parm_table[*i].type,
1957 ((char *)pService) +
1958 parm_table[*i].offset,
1959 ((char *)lp_ctx->sDefault) +
1960 parm_table[*i].offset))
1962 return &parm_table[(*i)++];
1968 return NULL;
1973 * Auto-load some home services.
1975 static void lpcfg_add_auto_services(struct loadparm_context *lp_ctx,
1976 const char *str)
1978 return;
1983 * Unload unused services.
1986 void lpcfg_killunused(struct loadparm_context *lp_ctx,
1987 struct smbsrv_connection *smb,
1988 bool (*snumused) (struct smbsrv_connection *, int))
1990 int i;
1991 for (i = 0; i < lp_ctx->iNumServices; i++) {
1992 if (lp_ctx->services[i] == NULL)
1993 continue;
1995 if (!snumused || !snumused(smb, i)) {
1996 talloc_free(lp_ctx->services[i]);
1997 lp_ctx->services[i] = NULL;
2003 static int lpcfg_destructor(struct loadparm_context *lp_ctx)
2005 struct parmlist_entry *data;
2007 if (lp_ctx->refuse_free) {
2008 /* someone is trying to free the
2009 global_loadparm_context.
2010 We can't allow that. */
2011 return -1;
2014 if (lp_ctx->globals->param_opt != NULL) {
2015 struct parmlist_entry *next;
2016 for (data = lp_ctx->globals->param_opt; data; data=next) {
2017 next = data->next;
2018 if (data->priority & FLAG_CMDLINE) continue;
2019 DLIST_REMOVE(lp_ctx->globals->param_opt, data);
2020 talloc_free(data);
2024 return 0;
2028 * Initialise the global parameter structure.
2030 * Note that most callers should use loadparm_init_global() instead
2032 struct loadparm_context *loadparm_init(TALLOC_CTX *mem_ctx)
2034 int i;
2035 char *myname;
2036 struct loadparm_context *lp_ctx;
2037 struct parmlist_entry *parm;
2038 char *logfile;
2040 lp_ctx = talloc_zero(mem_ctx, struct loadparm_context);
2041 if (lp_ctx == NULL)
2042 return NULL;
2044 talloc_set_destructor(lp_ctx, lpcfg_destructor);
2045 lp_ctx->bInGlobalSection = true;
2046 lp_ctx->globals = talloc_zero(lp_ctx, struct loadparm_global);
2047 lp_ctx->sDefault = talloc_zero(lp_ctx, struct loadparm_service);
2049 lp_ctx->sDefault->iMaxPrintJobs = 1000;
2050 lp_ctx->sDefault->bAvailable = true;
2051 lp_ctx->sDefault->bBrowseable = true;
2052 lp_ctx->sDefault->bRead_only = true;
2053 lp_ctx->sDefault->bMap_archive = true;
2054 lp_ctx->sDefault->iStrictLocking = true;
2055 lp_ctx->sDefault->bOpLocks = true;
2056 lp_ctx->sDefault->iCreate_mask = 0744;
2057 lp_ctx->sDefault->iCreate_force_mode = 0000;
2058 lp_ctx->sDefault->iDir_mask = 0755;
2059 lp_ctx->sDefault->iDir_force_mode = 0000;
2061 DEBUG(3, ("Initialising global parameters\n"));
2063 for (i = 0; parm_table[i].label; i++) {
2064 if ((parm_table[i].type == P_STRING ||
2065 parm_table[i].type == P_USTRING) &&
2066 !(lp_ctx->flags[i] & FLAG_CMDLINE)) {
2067 char **r;
2068 if (parm_table[i].p_class == P_LOCAL) {
2069 r = (char **)(((char *)lp_ctx->sDefault) + parm_table[i].offset);
2070 } else {
2071 r = (char **)(((char *)lp_ctx->globals) + parm_table[i].offset);
2073 *r = talloc_strdup(lp_ctx, "");
2077 logfile = talloc_asprintf(lp_ctx, "%s/log.samba", dyn_LOGFILEBASE);
2078 lpcfg_do_global_parameter(lp_ctx, "log file", logfile);
2079 talloc_free(logfile);
2081 lpcfg_do_global_parameter(lp_ctx, "log level", "0");
2083 lpcfg_do_global_parameter(lp_ctx, "share backend", "classic");
2085 lpcfg_do_global_parameter(lp_ctx, "server role", "auto");
2086 lpcfg_do_global_parameter(lp_ctx, "domain logons", "No");
2087 lpcfg_do_global_parameter(lp_ctx, "domain master", "Auto");
2089 /* options that can be set on the command line must be initialised via
2090 the slower lpcfg_do_global_parameter() to ensure that FLAG_CMDLINE is obeyed */
2091 #ifdef TCP_NODELAY
2092 lpcfg_do_global_parameter(lp_ctx, "socket options", "TCP_NODELAY");
2093 #endif
2094 lpcfg_do_global_parameter(lp_ctx, "workgroup", DEFAULT_WORKGROUP);
2095 myname = get_myname(lp_ctx);
2096 lpcfg_do_global_parameter(lp_ctx, "netbios name", myname);
2097 talloc_free(myname);
2098 lpcfg_do_global_parameter(lp_ctx, "name resolve order", "wins host bcast");
2100 lpcfg_do_global_parameter(lp_ctx, "fstype", "NTFS");
2102 lpcfg_do_global_parameter(lp_ctx, "ntvfs handler", "unixuid default");
2103 lpcfg_do_global_parameter(lp_ctx, "max connections", "-1");
2105 lpcfg_do_global_parameter(lp_ctx, "dcerpc endpoint servers", "epmapper wkssvc rpcecho samr netlogon lsarpc spoolss drsuapi dssetup unixinfo browser eventlog6 backupkey dnsserver");
2106 lpcfg_do_global_parameter(lp_ctx, "server services", "s3fs rpc nbt wrepl ldap cldap kdc drepl winbind ntp_signd kcc dnsupdate dns");
2107 /* the winbind method for domain controllers is for both RODC
2108 auth forwarding and for trusted domains */
2109 lpcfg_do_global_parameter(lp_ctx, "private dir", dyn_PRIVATE_DIR);
2110 lpcfg_do_global_parameter(lp_ctx, "registry:HKEY_LOCAL_MACHINE", "hklm.ldb");
2112 /* This hive should be dynamically generated by Samba using
2113 data from the sam, but for the moment leave it in a tdb to
2114 keep regedt32 from popping up an annoying dialog. */
2115 lpcfg_do_global_parameter(lp_ctx, "registry:HKEY_USERS", "hku.ldb");
2117 /* using UTF8 by default allows us to support all chars */
2118 lpcfg_do_global_parameter(lp_ctx, "unix charset", "UTF8");
2120 /* Use codepage 850 as a default for the dos character set */
2121 lpcfg_do_global_parameter(lp_ctx, "dos charset", "CP850");
2124 * Allow the default PASSWD_CHAT to be overridden in local.h.
2126 lpcfg_do_global_parameter(lp_ctx, "passwd chat", DEFAULT_PASSWD_CHAT);
2128 lpcfg_do_global_parameter(lp_ctx, "pid directory", dyn_PIDDIR);
2129 lpcfg_do_global_parameter(lp_ctx, "lock dir", dyn_LOCKDIR);
2130 lpcfg_do_global_parameter(lp_ctx, "state directory", dyn_STATEDIR);
2131 lpcfg_do_global_parameter(lp_ctx, "cache directory", dyn_CACHEDIR);
2132 lpcfg_do_global_parameter(lp_ctx, "ncalrpc dir", dyn_NCALRPCDIR);
2134 lpcfg_do_global_parameter(lp_ctx, "nbt client socket address", "");
2135 lpcfg_do_global_parameter_var(lp_ctx, "server string",
2136 "Samba %s", SAMBA_VERSION_STRING);
2138 lpcfg_do_global_parameter(lp_ctx, "password server", "*");
2140 lpcfg_do_global_parameter(lp_ctx, "max mux", "50");
2141 lpcfg_do_global_parameter(lp_ctx, "max xmit", "12288");
2142 lpcfg_do_global_parameter(lp_ctx, "host msdfs", "true");
2144 lpcfg_do_global_parameter(lp_ctx, "password level", "0");
2145 lpcfg_do_global_parameter(lp_ctx, "LargeReadwrite", "True");
2146 lpcfg_do_global_parameter(lp_ctx, "server min protocol", "CORE");
2147 lpcfg_do_global_parameter(lp_ctx, "server max protocol", "NT1");
2148 lpcfg_do_global_parameter(lp_ctx, "client min protocol", "CORE");
2149 lpcfg_do_global_parameter(lp_ctx, "client max protocol", "NT1");
2150 lpcfg_do_global_parameter(lp_ctx, "security", "AUTO");
2151 lpcfg_do_global_parameter(lp_ctx, "EncryptPasswords", "True");
2152 lpcfg_do_global_parameter(lp_ctx, "ReadRaw", "True");
2153 lpcfg_do_global_parameter(lp_ctx, "WriteRaw", "True");
2154 lpcfg_do_global_parameter(lp_ctx, "NullPasswords", "False");
2155 lpcfg_do_global_parameter(lp_ctx, "ObeyPamRestrictions", "False");
2157 lpcfg_do_global_parameter(lp_ctx, "TimeServer", "False");
2158 lpcfg_do_global_parameter(lp_ctx, "BindInterfacesOnly", "False");
2159 lpcfg_do_global_parameter(lp_ctx, "Unicode", "True");
2160 lpcfg_do_global_parameter(lp_ctx, "ClientLanManAuth", "False");
2161 lpcfg_do_global_parameter(lp_ctx, "ClientNTLMv2Auth", "True");
2162 lpcfg_do_global_parameter(lp_ctx, "LanmanAuth", "False");
2163 lpcfg_do_global_parameter(lp_ctx, "NTLMAuth", "True");
2164 lpcfg_do_global_parameter(lp_ctx, "client use spnego principal", "False");
2166 lpcfg_do_global_parameter(lp_ctx, "UnixExtensions", "False");
2168 lpcfg_do_global_parameter(lp_ctx, "PreferredMaster", "Auto");
2169 lpcfg_do_global_parameter(lp_ctx, "LocalMaster", "True");
2171 lpcfg_do_global_parameter(lp_ctx, "wins support", "False");
2172 lpcfg_do_global_parameter(lp_ctx, "dns proxy", "True");
2174 lpcfg_do_global_parameter(lp_ctx, "winbind separator", "\\");
2175 lpcfg_do_global_parameter(lp_ctx, "winbind sealed pipes", "True");
2176 lpcfg_do_global_parameter(lp_ctx, "winbindd socket directory", dyn_WINBINDD_SOCKET_DIR);
2177 #if _SAMBA_BUILD_ >= 4
2178 lpcfg_do_global_parameter(lp_ctx, "winbindd privileged socket directory", dyn_WINBINDD_PRIVILEGED_SOCKET_DIR);
2179 lpcfg_do_global_parameter(lp_ctx, "ntp signd socket directory", dyn_NTP_SIGND_SOCKET_DIR);
2180 lpcfg_do_global_parameter_var(lp_ctx, "dns update command", "%s/samba_dnsupdate", dyn_SCRIPTSBINDIR);
2181 lpcfg_do_global_parameter_var(lp_ctx, "spn update command", "%s/samba_spnupdate", dyn_SCRIPTSBINDIR);
2182 lpcfg_do_global_parameter_var(lp_ctx, "samba kcc command",
2183 "%s/samba_kcc", dyn_SCRIPTSBINDIR);
2184 #endif
2185 lpcfg_do_global_parameter(lp_ctx, "template shell", "/bin/false");
2186 lpcfg_do_global_parameter(lp_ctx, "template homedir", "/home/%WORKGROUP%/%ACCOUNTNAME%");
2188 lpcfg_do_global_parameter(lp_ctx, "client signing", "default");
2189 lpcfg_do_global_parameter(lp_ctx, "server signing", "default");
2191 lpcfg_do_global_parameter(lp_ctx, "use spnego", "True");
2193 lpcfg_do_global_parameter(lp_ctx, "use mmap", "True");
2195 lpcfg_do_global_parameter(lp_ctx, "smb ports", "445 139");
2196 lpcfg_do_global_parameter(lp_ctx, "nbt port", "137");
2197 lpcfg_do_global_parameter(lp_ctx, "dgram port", "138");
2198 lpcfg_do_global_parameter(lp_ctx, "cldap port", "389");
2199 lpcfg_do_global_parameter(lp_ctx, "krb5 port", "88");
2200 lpcfg_do_global_parameter(lp_ctx, "kpasswd port", "464");
2201 lpcfg_do_global_parameter(lp_ctx, "web port", "901");
2203 lpcfg_do_global_parameter(lp_ctx, "nt status support", "True");
2205 lpcfg_do_global_parameter(lp_ctx, "max wins ttl", "518400"); /* 6 days */
2206 lpcfg_do_global_parameter(lp_ctx, "min wins ttl", "10");
2208 lpcfg_do_global_parameter(lp_ctx, "tls enabled", "True");
2209 lpcfg_do_global_parameter(lp_ctx, "tls keyfile", "tls/key.pem");
2210 lpcfg_do_global_parameter(lp_ctx, "tls certfile", "tls/cert.pem");
2211 lpcfg_do_global_parameter(lp_ctx, "tls cafile", "tls/ca.pem");
2212 lpcfg_do_global_parameter(lp_ctx, "prefork children:smb", "4");
2214 lpcfg_do_global_parameter(lp_ctx, "rndc command", "/usr/sbin/rndc");
2215 lpcfg_do_global_parameter(lp_ctx, "nsupdate command", "/usr/bin/nsupdate -g");
2217 lpcfg_do_global_parameter(lp_ctx, "allow dns updates", "secure only");
2218 lpcfg_do_global_parameter(lp_ctx, "dns forwarder", "");
2220 for (i = 0; parm_table[i].label; i++) {
2221 if (!(lp_ctx->flags[i] & FLAG_CMDLINE)) {
2222 lp_ctx->flags[i] |= FLAG_DEFAULT;
2226 for (parm=lp_ctx->globals->param_opt; parm; parm=parm->next) {
2227 if (!(parm->priority & FLAG_CMDLINE)) {
2228 parm->priority |= FLAG_DEFAULT;
2232 return lp_ctx;
2236 * Initialise the global parameter structure.
2238 struct loadparm_context *loadparm_init_global(bool load_default)
2240 if (global_loadparm_context == NULL) {
2241 global_loadparm_context = loadparm_init(NULL);
2243 if (global_loadparm_context == NULL) {
2244 return NULL;
2246 global_loadparm_context->global = true;
2247 if (load_default && !global_loadparm_context->loaded) {
2248 lpcfg_load_default(global_loadparm_context);
2250 global_loadparm_context->refuse_free = true;
2251 return global_loadparm_context;
2255 * Initialise the global parameter structure.
2257 struct loadparm_context *loadparm_init_s3(TALLOC_CTX *mem_ctx,
2258 const struct loadparm_s3_helpers *s3_fns)
2260 struct loadparm_context *loadparm_context = talloc_zero(mem_ctx, struct loadparm_context);
2261 if (!loadparm_context) {
2262 return NULL;
2264 loadparm_context->s3_fns = s3_fns;
2265 return loadparm_context;
2268 const char *lpcfg_configfile(struct loadparm_context *lp_ctx)
2270 return lp_ctx->szConfigFile;
2273 const char *lp_default_path(void)
2275 if (getenv("SMB_CONF_PATH"))
2276 return getenv("SMB_CONF_PATH");
2277 else
2278 return dyn_CONFIGFILE;
2282 * Update the internal state of a loadparm context after settings
2283 * have changed.
2285 static bool lpcfg_update(struct loadparm_context *lp_ctx)
2287 struct debug_settings settings;
2288 lpcfg_add_auto_services(lp_ctx, lpcfg_auto_services(lp_ctx));
2290 if (!lp_ctx->globals->szWINSservers && lp_ctx->globals->bWINSsupport) {
2291 lpcfg_do_global_parameter(lp_ctx, "wins server", "127.0.0.1");
2294 if (!lp_ctx->global) {
2295 return true;
2298 panic_action = lp_ctx->globals->panic_action;
2300 reload_charcnv(lp_ctx);
2302 ZERO_STRUCT(settings);
2303 /* Add any more debug-related smb.conf parameters created in
2304 * future here */
2305 settings.timestamp_logs = true;
2306 debug_set_settings(&settings);
2308 /* FIXME: This is a bit of a hack, but we can't use a global, since
2309 * not everything that uses lp also uses the socket library */
2310 if (lpcfg_parm_bool(lp_ctx, NULL, "socket", "testnonblock", false)) {
2311 setenv("SOCKET_TESTNONBLOCK", "1", 1);
2312 } else {
2313 unsetenv("SOCKET_TESTNONBLOCK");
2316 return true;
2319 bool lpcfg_load_default(struct loadparm_context *lp_ctx)
2321 const char *path;
2323 path = lp_default_path();
2325 if (!file_exist(path)) {
2326 /* We allow the default smb.conf file to not exist,
2327 * basically the equivalent of an empty file. */
2328 return lpcfg_update(lp_ctx);
2331 return lpcfg_load(lp_ctx, path);
2335 * Load the services array from the services file.
2337 * Return True on success, False on failure.
2339 bool lpcfg_load(struct loadparm_context *lp_ctx, const char *filename)
2341 char *n2;
2342 bool bRetval;
2344 filename = talloc_strdup(lp_ctx, filename);
2346 lp_ctx->szConfigFile = filename;
2348 if (lp_ctx->s3_fns) {
2349 return lp_ctx->s3_fns->load(filename);
2352 lp_ctx->bInGlobalSection = true;
2353 n2 = standard_sub_basic(lp_ctx, lp_ctx->szConfigFile);
2354 DEBUG(2, ("lpcfg_load: refreshing parameters from %s\n", n2));
2356 add_to_file_list(lp_ctx, lp_ctx->szConfigFile, n2);
2358 /* We get sections first, so have to start 'behind' to make up */
2359 lp_ctx->currentService = NULL;
2360 bRetval = pm_process(n2, do_section, do_parameter, lp_ctx);
2362 /* finish up the last section */
2363 DEBUG(4, ("pm_process() returned %s\n", BOOLSTR(bRetval)));
2364 if (bRetval)
2365 if (lp_ctx->currentService != NULL)
2366 bRetval = lpcfg_service_ok(lp_ctx->currentService);
2368 bRetval = bRetval && lpcfg_update(lp_ctx);
2370 /* we do this unconditionally, so that it happens even
2371 for a missing smb.conf */
2372 reload_charcnv(lp_ctx);
2374 if (bRetval == true) {
2375 /* set this up so that any child python tasks will
2376 find the right smb.conf */
2377 setenv("SMB_CONF_PATH", filename, 1);
2379 /* set the context used by the lp_*() function
2380 varients */
2381 global_loadparm_context = lp_ctx;
2382 lp_ctx->loaded = true;
2385 return bRetval;
2389 * Return the max number of services.
2392 int lpcfg_numservices(struct loadparm_context *lp_ctx)
2394 if (lp_ctx->s3_fns) {
2395 return lp_ctx->s3_fns->get_numservices();
2398 return lp_ctx->iNumServices;
2402 * Display the contents of the services array in human-readable form.
2405 void lpcfg_dump(struct loadparm_context *lp_ctx, FILE *f, bool show_defaults,
2406 int maxtoprint)
2408 int iService;
2410 if (lp_ctx->s3_fns) {
2411 lp_ctx->s3_fns->dump(f, show_defaults, maxtoprint);
2412 return;
2415 defaults_saved = !show_defaults;
2417 dump_globals(lp_ctx, f, show_defaults);
2419 dump_a_service(lp_ctx->sDefault, lp_ctx->sDefault, f, lp_ctx->flags);
2421 for (iService = 0; iService < maxtoprint; iService++)
2422 lpcfg_dump_one(f, show_defaults, lp_ctx->services[iService], lp_ctx->sDefault);
2426 * Display the contents of one service in human-readable form.
2428 void lpcfg_dump_one(FILE *f, bool show_defaults, struct loadparm_service *service, struct loadparm_service *sDefault)
2430 if (service != NULL) {
2431 if (service->szService[0] == '\0')
2432 return;
2433 dump_a_service(service, sDefault, f, NULL);
2437 struct loadparm_service *lpcfg_servicebynum(struct loadparm_context *lp_ctx,
2438 int snum)
2440 if (lp_ctx->s3_fns) {
2441 return lp_ctx->s3_fns->get_servicebynum(snum);
2444 return lp_ctx->services[snum];
2447 struct loadparm_service *lpcfg_service(struct loadparm_context *lp_ctx,
2448 const char *service_name)
2450 int iService;
2451 char *serviceName;
2453 if (lp_ctx->s3_fns) {
2454 return lp_ctx->s3_fns->get_service(service_name);
2457 for (iService = lp_ctx->iNumServices - 1; iService >= 0; iService--) {
2458 if (lp_ctx->services[iService] &&
2459 lp_ctx->services[iService]->szService) {
2461 * The substitution here is used to support %U is
2462 * service names
2464 serviceName = standard_sub_basic(
2465 lp_ctx->services[iService],
2466 lp_ctx->services[iService]->szService);
2467 if (strequal(serviceName, service_name)) {
2468 talloc_free(serviceName);
2469 return lp_ctx->services[iService];
2471 talloc_free(serviceName);
2475 DEBUG(7,("lpcfg_servicenumber: couldn't find %s\n", service_name));
2476 return NULL;
2479 const char *lpcfg_servicename(const struct loadparm_service *service)
2481 return lp_string((const char *)service->szService);
2485 * A useful volume label function.
2487 const char *lpcfg_volume_label(struct loadparm_service *service, struct loadparm_service *sDefault)
2489 const char *ret;
2490 ret = lp_string((const char *)((service != NULL && service->volume != NULL) ?
2491 service->volume : sDefault->volume));
2492 if (!*ret)
2493 return lpcfg_servicename(service);
2494 return ret;
2498 * If we are PDC then prefer us as DMB
2500 const char *lpcfg_printername(struct loadparm_service *service, struct loadparm_service *sDefault)
2502 const char *ret;
2503 ret = lp_string((const char *)((service != NULL && service->szPrintername != NULL) ?
2504 service->szPrintername : sDefault->szPrintername));
2505 if (ret == NULL || (ret != NULL && *ret == '\0'))
2506 ret = lpcfg_servicename(service);
2508 return ret;
2513 * Return the max print jobs per queue.
2515 int lpcfg_maxprintjobs(struct loadparm_service *service, struct loadparm_service *sDefault)
2517 int maxjobs = (service != NULL) ? service->iMaxPrintJobs : sDefault->iMaxPrintJobs;
2518 if (maxjobs <= 0 || maxjobs >= PRINT_MAX_JOBID)
2519 maxjobs = PRINT_MAX_JOBID - 1;
2521 return maxjobs;
2524 struct smb_iconv_handle *lpcfg_iconv_handle(struct loadparm_context *lp_ctx)
2526 if (lp_ctx == NULL) {
2527 return get_iconv_handle();
2529 return lp_ctx->iconv_handle;
2532 _PUBLIC_ void reload_charcnv(struct loadparm_context *lp_ctx)
2534 struct smb_iconv_handle *old_ic = lp_ctx->iconv_handle;
2535 if (!lp_ctx->global) {
2536 return;
2539 if (old_ic == NULL) {
2540 old_ic = global_iconv_handle;
2542 lp_ctx->iconv_handle = smb_iconv_handle_reinit_lp(lp_ctx, lp_ctx, old_ic);
2543 global_iconv_handle = lp_ctx->iconv_handle;
2546 _PUBLIC_ char *lpcfg_tls_keyfile(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx)
2548 return lpcfg_private_path(mem_ctx, lp_ctx, lp_ctx->globals->tls_keyfile);
2551 _PUBLIC_ char *lpcfg_tls_certfile(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx)
2553 return lpcfg_private_path(mem_ctx, lp_ctx, lp_ctx->globals->tls_certfile);
2556 _PUBLIC_ char *lpcfg_tls_cafile(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx)
2558 return lpcfg_private_path(mem_ctx, lp_ctx, lp_ctx->globals->tls_cafile);
2561 _PUBLIC_ char *lpcfg_tls_crlfile(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx)
2563 return lpcfg_private_path(mem_ctx, lp_ctx, lp_ctx->globals->tls_crlfile);
2566 _PUBLIC_ char *lpcfg_tls_dhpfile(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx)
2568 return lpcfg_private_path(mem_ctx, lp_ctx, lp_ctx->globals->tls_dhpfile);
2571 struct gensec_settings *lpcfg_gensec_settings(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx)
2573 struct gensec_settings *settings = talloc_zero(mem_ctx, struct gensec_settings);
2574 if (settings == NULL)
2575 return NULL;
2576 SMB_ASSERT(lp_ctx != NULL);
2577 settings->lp_ctx = talloc_reference(settings, lp_ctx);
2578 settings->target_hostname = lpcfg_parm_string(lp_ctx, NULL, "gensec", "target_hostname");
2579 return settings;
2582 int lpcfg_server_role(struct loadparm_context *lp_ctx)
2584 int domain_master = lpcfg__domain_master(lp_ctx);
2586 return lp_find_server_role(lpcfg__server_role(lp_ctx),
2587 lpcfg__security(lp_ctx),
2588 lpcfg__domain_logons(lp_ctx),
2589 (domain_master == true) ||
2590 (domain_master == Auto));
2593 int lpcfg_security(struct loadparm_context *lp_ctx)
2595 return lp_find_security(lpcfg__server_role(lp_ctx),
2596 lpcfg__security(lp_ctx));