s3:param: add a comment
[Samba/gebeck_regimport.git] / source3 / param / loadparm.c
blob961a002eb19bf26062a2512bdacb3301f8be2459
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) Michael Adam 2008
13 Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007
14 Copyright (C) Andrew Bartlett 2011
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 "system/filesys.h"
58 #include "util_tdb.h"
59 #include "lib/param/loadparm.h"
60 #include "printing.h"
61 #include "lib/smbconf/smbconf.h"
62 #include "lib/smbconf/smbconf_init.h"
64 #include "ads.h"
65 #include "../librpc/gen_ndr/svcctl.h"
66 #include "intl.h"
67 #include "../libcli/smb/smb_signing.h"
68 #include "dbwrap/dbwrap.h"
69 #include "dbwrap/dbwrap_rbt.h"
70 #include "../lib/util/bitmap.h"
72 #ifdef HAVE_SYS_SYSCTL_H
73 #include <sys/sysctl.h>
74 #endif
76 #ifdef HAVE_HTTPCONNECTENCRYPT
77 #include <cups/http.h>
78 #endif
80 #ifdef CLUSTER_SUPPORT
81 #include "ctdb_private.h"
82 #endif
84 bool bLoaded = false;
86 extern userdom_struct current_user_info;
88 /* the special value for the include parameter
89 * to be interpreted not as a file name but to
90 * trigger loading of the global smb.conf options
91 * from registry. */
92 #ifndef INCLUDE_REGISTRY_NAME
93 #define INCLUDE_REGISTRY_NAME "registry"
94 #endif
96 static bool in_client = false; /* Not in the client by default */
97 static struct smbconf_csn conf_last_csn;
99 static int config_backend = CONFIG_BACKEND_FILE;
101 /* some helpful bits */
102 #define LP_SNUM_OK(i) (((i) >= 0) && ((i) < iNumServices) && (ServicePtrs != NULL) && ServicePtrs[(i)]->valid)
103 #define VALID(i) (ServicePtrs != NULL && ServicePtrs[i]->valid)
105 #define USERSHARE_VALID 1
106 #define USERSHARE_PENDING_DELETE 2
108 static bool defaults_saved = false;
110 #define LOADPARM_EXTRA_GLOBALS \
111 struct parmlist_entry *param_opt; \
112 char *szRealm; \
113 char *loglevel; \
114 int iminreceivefile; \
115 char *szPrintcapname; \
116 int CupsEncrypt; \
117 int iPreferredMaster; \
118 char *szLdapMachineSuffix; \
119 char *szLdapUserSuffix; \
120 char *szLdapIdmapSuffix; \
121 char *szLdapGroupSuffix; \
122 char *szStateDir; \
123 char *szCacheDir; \
124 char *szUsershareTemplateShare; \
125 char *szIdmapUID; \
126 char *szIdmapGID; \
127 char *szIdmapBackend; \
128 int winbindMaxDomainConnections; \
129 int ismb2_max_credits; \
130 char *tls_keyfile; \
131 char *tls_certfile; \
132 char *tls_cafile; \
133 char *tls_crlfile; \
134 char *tls_dhpfile; \
135 int bPreferredMaster;
137 #include "param/param_global.h"
139 static struct loadparm_global Globals;
141 /* This is a default service used to prime a services structure */
142 static struct loadparm_service sDefault =
144 .valid = true,
145 .autoloaded = false,
146 .usershare = 0,
147 .usershare_last_mod = {0, 0},
148 .szService = NULL,
149 .szPath = NULL,
150 .szUsername = NULL,
151 .szInvalidUsers = NULL,
152 .szValidUsers = NULL,
153 .szAdminUsers = NULL,
154 .szCopy = NULL,
155 .szInclude = NULL,
156 .szPreExec = NULL,
157 .szPostExec = NULL,
158 .szRootPreExec = NULL,
159 .szRootPostExec = NULL,
160 .szCupsOptions = NULL,
161 .szPrintcommand = NULL,
162 .szLpqcommand = NULL,
163 .szLprmcommand = NULL,
164 .szLppausecommand = NULL,
165 .szLpresumecommand = NULL,
166 .szQueuepausecommand = NULL,
167 .szQueueresumecommand = NULL,
168 .szPrintername = NULL,
169 .szPrintjobUsername = NULL,
170 .szDontdescend = NULL,
171 .szHostsallow = NULL,
172 .szHostsdeny = NULL,
173 .szMagicScript = NULL,
174 .szMagicOutput = NULL,
175 .szVetoFiles = NULL,
176 .szHideFiles = NULL,
177 .szVetoOplockFiles = NULL,
178 .comment = NULL,
179 .force_user = NULL,
180 .force_group = NULL,
181 .readlist = NULL,
182 .writelist = NULL,
183 .volume = NULL,
184 .fstype = NULL,
185 .szVfsObjects = NULL,
186 .szMSDfsProxy = NULL,
187 .szAioWriteBehind = NULL,
188 .szDfree = NULL,
189 .iMinPrintSpace = 0,
190 .iMaxPrintJobs = 1000,
191 .iMaxReportedPrintJobs = 0,
192 .iWriteCacheSize = 0,
193 .iCreate_mask = 0744,
194 .iCreate_force_mode = 0,
195 .iDir_mask = 0755,
196 .iDir_force_mode = 0,
197 .iMaxConnections = 0,
198 .iDefaultCase = CASE_LOWER,
199 .iPrinting = DEFAULT_PRINTING,
200 .iOplockContentionLimit = 2,
201 .iCSCPolicy = 0,
202 .iBlock_size = 1024,
203 .iDfreeCacheTime = 0,
204 .bPreexecClose = false,
205 .bRootpreexecClose = false,
206 .iCaseSensitive = Auto,
207 .bCasePreserve = true,
208 .bShortCasePreserve = true,
209 .bHideDotFiles = true,
210 .bHideSpecialFiles = false,
211 .bHideUnReadable = false,
212 .bHideUnWriteableFiles = false,
213 .bBrowseable = true,
214 .bAccessBasedShareEnum = false,
215 .bAvailable = true,
216 .bRead_only = true,
217 .bNo_set_dir = true,
218 .bGuest_only = false,
219 .bAdministrative_share = false,
220 .bGuest_ok = false,
221 .bPrint_ok = false,
222 .bPrintNotifyBackchannel = true,
223 .bMap_system = false,
224 .bMap_hidden = false,
225 .bMap_archive = true,
226 .bStoreDosAttributes = false,
227 .bDmapiSupport = false,
228 .bLocking = true,
229 .iStrictLocking = Auto,
230 .bPosixLocking = true,
231 .bOpLocks = true,
232 .bKernelOplocks = false,
233 .bLevel2OpLocks = true,
234 .bOnlyUser = false,
235 .bMangledNames = true,
236 .bWidelinks = false,
237 .bSymlinks = true,
238 .bSyncAlways = false,
239 .bStrictAllocate = false,
240 .bStrictSync = false,
241 .magic_char = '~',
242 .copymap = NULL,
243 .bDeleteReadonly = false,
244 .bFakeOplocks = false,
245 .bDeleteVetoFiles = false,
246 .bDosFilemode = false,
247 .bDosFiletimes = true,
248 .bDosFiletimeResolution = false,
249 .bFakeDirCreateTimes = false,
250 .bBlockingLocks = true,
251 .bInheritPerms = false,
252 .bInheritACLS = false,
253 .bInheritOwner = false,
254 .bMSDfsRoot = false,
255 .bUseClientDriver = false,
256 .bDefaultDevmode = true,
257 .bForcePrintername = false,
258 .bNTAclSupport = true,
259 .bForceUnknownAclUser = false,
260 .bUseSendfile = false,
261 .bProfileAcls = false,
262 .bMap_acl_inherit = false,
263 .bAfs_Share = false,
264 .bEASupport = false,
265 .bAclCheckPermissions = true,
266 .bAclMapFullControl = true,
267 .bAclGroupControl = false,
268 .bChangeNotify = true,
269 .bKernelChangeNotify = true,
270 .iallocation_roundup_size = SMB_ROUNDUP_ALLOCATION_SIZE,
271 .iAioReadSize = 0,
272 .iAioWriteSize = 0,
273 .iMap_readonly = MAP_READONLY_YES,
274 #ifdef BROKEN_DIRECTORY_HANDLING
275 .iDirectoryNameCacheSize = 0,
276 #else
277 .iDirectoryNameCacheSize = 100,
278 #endif
279 .ismb_encrypt = SMB_SIGNING_DEFAULT,
280 .bKernelShareModes = true,
281 .bDurableHandles = true,
282 .param_opt = NULL,
283 .dummy = ""
286 /* local variables */
287 static struct loadparm_service **ServicePtrs = NULL;
288 static int iNumServices = 0;
289 static int iServiceIndex = 0;
290 static struct db_context *ServiceHash;
291 static int *invalid_services = NULL;
292 static int num_invalid_services = 0;
293 static bool bInGlobalSection = true;
294 static bool bGlobalOnly = false;
296 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
298 /* prototypes for the special type handlers */
299 static bool handle_include(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr);
300 static bool handle_copy(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr);
301 static bool handle_idmap_backend(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr);
302 static bool handle_idmap_uid(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr);
303 static bool handle_idmap_gid(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr);
304 static bool handle_debug_list(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr );
305 static bool handle_realm(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr );
306 static bool handle_netbios_aliases(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr );
307 static bool handle_charset(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr );
308 static bool handle_dos_charset(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr );
309 static bool handle_printing(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr);
310 static bool handle_ldap_debug_level(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr);
312 /* these are parameter handlers which are not needed in the
313 * source3 code
316 #define handle_logfile NULL
318 static void set_allowed_client_auth(void);
320 static void add_to_file_list(const char *fname, const char *subfname);
321 static bool lp_set_cmdline_helper(const char *pszParmName, const char *pszParmValue, bool store_values);
322 static void free_param_opts(struct parmlist_entry **popts);
324 #include "lib/param/param_table.c"
326 /* this is used to prevent lots of mallocs of size 1 */
327 static const char null_string[] = "";
330 Set a string value, allocing the space for the string
333 static bool string_init(char **dest,const char *src)
335 size_t l;
337 if (!src)
338 src = "";
340 l = strlen(src);
342 if (l == 0) {
343 *dest = discard_const_p(char, null_string);
344 } else {
345 (*dest) = SMB_STRDUP(src);
346 if ((*dest) == NULL) {
347 DEBUG(0,("Out of memory in string_init\n"));
348 return false;
351 return(true);
355 Free a string value.
358 static void string_free(char **s)
360 if (!s || !(*s))
361 return;
362 if (*s == null_string)
363 *s = NULL;
364 SAFE_FREE(*s);
368 Set a string value, deallocating any existing space, and allocing the space
369 for the string
372 static bool string_set(char **dest,const char *src)
374 string_free(dest);
375 return(string_init(dest,src));
378 /***************************************************************************
379 Initialise the sDefault parameter structure for the printer values.
380 ***************************************************************************/
382 static void init_printer_values(struct loadparm_service *pService)
384 /* choose defaults depending on the type of printing */
385 switch (pService->iPrinting) {
386 case PRINT_BSD:
387 case PRINT_AIX:
388 case PRINT_LPRNT:
389 case PRINT_LPROS2:
390 string_set(&pService->szLpqcommand, "lpq -P'%p'");
391 string_set(&pService->szLprmcommand, "lprm -P'%p' %j");
392 string_set(&pService->szPrintcommand, "lpr -r -P'%p' %s");
393 break;
395 case PRINT_LPRNG:
396 case PRINT_PLP:
397 string_set(&pService->szLpqcommand, "lpq -P'%p'");
398 string_set(&pService->szLprmcommand, "lprm -P'%p' %j");
399 string_set(&pService->szPrintcommand, "lpr -r -P'%p' %s");
400 string_set(&pService->szQueuepausecommand, "lpc stop '%p'");
401 string_set(&pService->szQueueresumecommand, "lpc start '%p'");
402 string_set(&pService->szLppausecommand, "lpc hold '%p' %j");
403 string_set(&pService->szLpresumecommand, "lpc release '%p' %j");
404 break;
406 case PRINT_CUPS:
407 case PRINT_IPRINT:
408 /* set the lpq command to contain the destination printer
409 name only. This is used by cups_queue_get() */
410 string_set(&pService->szLpqcommand, "%p");
411 string_set(&pService->szLprmcommand, "");
412 string_set(&pService->szPrintcommand, "");
413 string_set(&pService->szLppausecommand, "");
414 string_set(&pService->szLpresumecommand, "");
415 string_set(&pService->szQueuepausecommand, "");
416 string_set(&pService->szQueueresumecommand, "");
417 break;
419 case PRINT_SYSV:
420 case PRINT_HPUX:
421 string_set(&pService->szLpqcommand, "lpstat -o%p");
422 string_set(&pService->szLprmcommand, "cancel %p-%j");
423 string_set(&pService->szPrintcommand, "lp -c -d%p %s; rm %s");
424 string_set(&pService->szQueuepausecommand, "disable %p");
425 string_set(&pService->szQueueresumecommand, "enable %p");
426 #ifndef HPUX
427 string_set(&pService->szLppausecommand, "lp -i %p-%j -H hold");
428 string_set(&pService->szLpresumecommand, "lp -i %p-%j -H resume");
429 #endif /* HPUX */
430 break;
432 case PRINT_QNX:
433 string_set(&pService->szLpqcommand, "lpq -P%p");
434 string_set(&pService->szLprmcommand, "lprm -P%p %j");
435 string_set(&pService->szPrintcommand, "lp -r -P%p %s");
436 break;
438 #if defined(DEVELOPER) || defined(ENABLE_SELFTEST)
440 case PRINT_TEST:
441 case PRINT_VLP: {
442 const char *tdbfile;
443 TALLOC_CTX *tmp_ctx = talloc_stackframe();
444 char *tmp;
446 tdbfile = talloc_asprintf(
447 tmp_ctx, "tdbfile=%s",
448 lp_parm_const_string(-1, "vlp", "tdbfile",
449 "/tmp/vlp.tdb"));
450 if (tdbfile == NULL) {
451 tdbfile="tdbfile=/tmp/vlp.tdb";
454 tmp = talloc_asprintf(tmp_ctx, "vlp %s print %%p %%s",
455 tdbfile);
456 string_set(&pService->szPrintcommand,
457 tmp ? tmp : "vlp print %p %s");
459 tmp = talloc_asprintf(tmp_ctx, "vlp %s lpq %%p",
460 tdbfile);
461 string_set(&pService->szLpqcommand,
462 tmp ? tmp : "vlp lpq %p");
464 tmp = talloc_asprintf(tmp_ctx, "vlp %s lprm %%p %%j",
465 tdbfile);
466 string_set(&pService->szLprmcommand,
467 tmp ? tmp : "vlp lprm %p %j");
469 tmp = talloc_asprintf(tmp_ctx, "vlp %s lppause %%p %%j",
470 tdbfile);
471 string_set(&pService->szLppausecommand,
472 tmp ? tmp : "vlp lppause %p %j");
474 tmp = talloc_asprintf(tmp_ctx, "vlp %s lpresume %%p %%j",
475 tdbfile);
476 string_set(&pService->szLpresumecommand,
477 tmp ? tmp : "vlp lpresume %p %j");
479 tmp = talloc_asprintf(tmp_ctx, "vlp %s queuepause %%p",
480 tdbfile);
481 string_set(&pService->szQueuepausecommand,
482 tmp ? tmp : "vlp queuepause %p");
484 tmp = talloc_asprintf(tmp_ctx, "vlp %s queueresume %%p",
485 tdbfile);
486 string_set(&pService->szQueueresumecommand,
487 tmp ? tmp : "vlp queueresume %p");
488 TALLOC_FREE(tmp_ctx);
490 break;
492 #endif /* DEVELOPER */
497 * Function to return the default value for the maximum number of open
498 * file descriptors permitted. This function tries to consult the
499 * kernel-level (sysctl) and ulimit (getrlimit()) values and goes
500 * the smaller of those.
502 static int max_open_files(void)
504 int sysctl_max = MAX_OPEN_FILES;
505 int rlimit_max = MAX_OPEN_FILES;
507 #ifdef HAVE_SYSCTLBYNAME
509 size_t size = sizeof(sysctl_max);
510 sysctlbyname("kern.maxfilesperproc", &sysctl_max, &size, NULL,
513 #endif
515 #if (defined(HAVE_GETRLIMIT) && defined(RLIMIT_NOFILE))
517 struct rlimit rl;
519 ZERO_STRUCT(rl);
521 if (getrlimit(RLIMIT_NOFILE, &rl) == 0)
522 rlimit_max = rl.rlim_cur;
524 #if defined(RLIM_INFINITY)
525 if(rl.rlim_cur == RLIM_INFINITY)
526 rlimit_max = MAX_OPEN_FILES;
527 #endif
529 #endif
531 if (sysctl_max < MIN_OPEN_FILES_WINDOWS) {
532 DEBUG(2,("max_open_files: increasing sysctl_max (%d) to "
533 "minimum Windows limit (%d)\n",
534 sysctl_max,
535 MIN_OPEN_FILES_WINDOWS));
536 sysctl_max = MIN_OPEN_FILES_WINDOWS;
539 if (rlimit_max < MIN_OPEN_FILES_WINDOWS) {
540 DEBUG(2,("rlimit_max: increasing rlimit_max (%d) to "
541 "minimum Windows limit (%d)\n",
542 rlimit_max,
543 MIN_OPEN_FILES_WINDOWS));
544 rlimit_max = MIN_OPEN_FILES_WINDOWS;
547 return MIN(sysctl_max, rlimit_max);
551 * Common part of freeing allocated data for one parameter.
553 static void free_one_parameter_common(void *parm_ptr,
554 struct parm_struct parm)
556 if ((parm.type == P_STRING) ||
557 (parm.type == P_USTRING))
559 string_free((char**)parm_ptr);
560 } else if (parm.type == P_LIST) {
561 TALLOC_FREE(*((char***)parm_ptr));
566 * Free the allocated data for one parameter for a share
567 * given as a service struct.
569 static void free_one_parameter(struct loadparm_service *service,
570 struct parm_struct parm)
572 void *parm_ptr;
574 if (parm.p_class != P_LOCAL) {
575 return;
578 parm_ptr = lp_parm_ptr(service, &parm);
580 free_one_parameter_common(parm_ptr, parm);
584 * Free the allocated parameter data of a share given
585 * as a service struct.
587 static void free_parameters(struct loadparm_service *service)
589 uint32_t i;
591 for (i=0; parm_table[i].label; i++) {
592 free_one_parameter(service, parm_table[i]);
597 * Free the allocated data for one parameter for a given share
598 * specified by an snum.
600 static void free_one_parameter_by_snum(int snum, struct parm_struct parm)
602 void *parm_ptr;
604 if (snum < 0) {
605 parm_ptr = lp_parm_ptr(NULL, &parm);
606 } else if (parm.p_class != P_LOCAL) {
607 return;
608 } else {
609 parm_ptr = lp_local_ptr_by_snum(snum, &parm);
612 free_one_parameter_common(parm_ptr, parm);
616 * Free the allocated parameter data for a share specified
617 * by an snum.
619 static void free_parameters_by_snum(int snum)
621 uint32_t i;
623 for (i=0; parm_table[i].label; i++) {
624 free_one_parameter_by_snum(snum, parm_table[i]);
629 * Free the allocated global parameters.
631 static void free_global_parameters(void)
633 free_param_opts(&Globals.param_opt);
634 free_parameters_by_snum(GLOBAL_SECTION_SNUM);
635 TALLOC_FREE(Globals.ctx);
638 static int map_parameter(const char *pszParmName);
640 struct lp_stored_option {
641 struct lp_stored_option *prev, *next;
642 const char *label;
643 const char *value;
646 static struct lp_stored_option *stored_options;
649 save options set by lp_set_cmdline() into a list. This list is
650 re-applied when we do a globals reset, so that cmdline set options
651 are sticky across reloads of smb.conf
653 static bool store_lp_set_cmdline(const char *pszParmName, const char *pszParmValue)
655 struct lp_stored_option *entry, *entry_next;
656 for (entry = stored_options; entry != NULL; entry = entry_next) {
657 entry_next = entry->next;
658 if (strcmp(pszParmName, entry->label) == 0) {
659 DLIST_REMOVE(stored_options, entry);
660 talloc_free(entry);
661 break;
665 entry = talloc(NULL, struct lp_stored_option);
666 if (!entry) {
667 return false;
670 entry->label = talloc_strdup(entry, pszParmName);
671 if (!entry->label) {
672 talloc_free(entry);
673 return false;
676 entry->value = talloc_strdup(entry, pszParmValue);
677 if (!entry->value) {
678 talloc_free(entry);
679 return false;
682 DLIST_ADD_END(stored_options, entry, struct lp_stored_option);
684 return true;
687 static bool apply_lp_set_cmdline(void)
689 struct lp_stored_option *entry = NULL;
690 for (entry = stored_options; entry != NULL; entry = entry->next) {
691 if (!lp_set_cmdline_helper(entry->label, entry->value, false)) {
692 DEBUG(0, ("Failed to re-apply cmdline parameter %s = %s\n",
693 entry->label, entry->value));
694 return false;
697 return true;
700 /***************************************************************************
701 Initialise the global parameter structure.
702 ***************************************************************************/
704 static void init_globals(bool reinit_globals)
706 static bool done_init = false;
707 char *s = NULL;
708 int i;
710 /* If requested to initialize only once and we've already done it... */
711 if (!reinit_globals && done_init) {
712 /* ... then we have nothing more to do */
713 return;
716 if (!done_init) {
717 /* The logfile can be set before this is invoked. Free it if so. */
718 if (Globals.logfile != NULL) {
719 string_free(&Globals.logfile);
720 Globals.logfile = NULL;
722 done_init = true;
723 } else {
724 free_global_parameters();
727 /* This memset and the free_global_parameters() above will
728 * wipe out smb.conf options set with lp_set_cmdline(). The
729 * apply_lp_set_cmdline() call puts these values back in the
730 * table once the defaults are set */
731 ZERO_STRUCT(Globals);
733 Globals.ctx = talloc_new(NULL);
735 for (i = 0; parm_table[i].label; i++) {
736 if ((parm_table[i].type == P_STRING ||
737 parm_table[i].type == P_USTRING))
739 string_set((char **)lp_parm_ptr(NULL, &parm_table[i]), "");
744 string_set(&sDefault.fstype, FSTYPE_STRING);
745 string_set(&sDefault.szPrintjobUsername, "%U");
747 init_printer_values(&sDefault);
750 DEBUG(3, ("Initialising global parameters\n"));
752 /* Must manually force to upper case here, as this does not go via the handler */
753 string_set(&Globals.szNetbiosName, myhostname_upper());
755 string_set(&Globals.szSMBPasswdFile, get_dyn_SMB_PASSWD_FILE());
756 string_set(&Globals.szPrivateDir, get_dyn_PRIVATE_DIR());
758 /* use the new 'hash2' method by default, with a prefix of 1 */
759 string_set(&Globals.szManglingMethod, "hash2");
760 Globals.mangle_prefix = 1;
762 string_set(&Globals.szGuestaccount, GUEST_ACCOUNT);
764 /* using UTF8 by default allows us to support all chars */
765 string_set(&Globals.unix_charset, DEFAULT_UNIX_CHARSET);
767 /* Use codepage 850 as a default for the dos character set */
768 string_set(&Globals.dos_charset, DEFAULT_DOS_CHARSET);
771 * Allow the default PASSWD_CHAT to be overridden in local.h.
773 string_set(&Globals.szPasswdChat, DEFAULT_PASSWD_CHAT);
775 string_set(&Globals.szWorkgroup, DEFAULT_WORKGROUP);
777 string_set(&Globals.szPasswdProgram, "");
778 string_set(&Globals.szLockDir, get_dyn_LOCKDIR());
779 string_set(&Globals.szStateDir, get_dyn_STATEDIR());
780 string_set(&Globals.szCacheDir, get_dyn_CACHEDIR());
781 string_set(&Globals.szPidDir, get_dyn_PIDDIR());
782 string_set(&Globals.nbt_client_socket_address, "0.0.0.0");
784 * By default support explicit binding to broadcast
785 * addresses.
787 Globals.bNmbdBindExplicitBroadcast = true;
789 if (asprintf(&s, "Samba %s", samba_version_string()) < 0) {
790 smb_panic("init_globals: ENOMEM");
792 string_set(&Globals.szServerString, s);
793 SAFE_FREE(s);
794 #ifdef DEVELOPER
795 string_set(&Globals.szPanicAction, "/bin/sleep 999999999");
796 #endif
798 string_set(&Globals.socket_options, DEFAULT_SOCKET_OPTIONS);
800 string_set(&Globals.szLogonDrive, "");
801 /* %N is the NIS auto.home server if -DAUTOHOME is used, else same as %L */
802 string_set(&Globals.szLogonHome, "\\\\%N\\%U");
803 string_set(&Globals.szLogonPath, "\\\\%N\\%U\\profile");
805 Globals.szNameResolveOrder = (const char **)str_list_make_v3(NULL, "lmhosts wins host bcast", NULL);
806 string_set(&Globals.szPasswordServer, "*");
808 Globals.AlgorithmicRidBase = BASE_RID;
810 Globals.bLoadPrinters = true;
811 Globals.PrintcapCacheTime = 750; /* 12.5 minutes */
813 Globals.ConfigBackend = config_backend;
814 Globals.server_role = ROLE_AUTO;
816 /* Was 65535 (0xFFFF). 0x4101 matches W2K and causes major speed improvements... */
817 /* Discovered by 2 days of pain by Don McCall @ HP :-). */
818 Globals.max_xmit = 0x4104;
819 Globals.max_mux = 50; /* This is *needed* for profile support. */
820 Globals.lpqcachetime = 30; /* changed to handle large print servers better -- jerry */
821 Globals.bDisableSpoolss = false;
822 Globals.iMaxSmbdProcesses = 0;/* no limit specified */
823 Globals.pwordlevel = 0;
824 Globals.unamelevel = 0;
825 Globals.deadtime = 0;
826 Globals.getwd_cache = true;
827 Globals.bLargeReadwrite = true;
828 Globals.max_log_size = 5000;
829 Globals.max_open_files = max_open_files();
830 Globals.open_files_db_hash_size = SMB_OPEN_DATABASE_TDB_HASH_SIZE;
831 Globals.srv_maxprotocol = PROTOCOL_SMB3_00;
832 Globals.srv_minprotocol = PROTOCOL_LANMAN1;
833 Globals.security = SEC_USER;
834 Globals.bEncryptPasswords = true;
835 Globals.clientSchannel = Auto;
836 Globals.serverSchannel = Auto;
837 Globals.bReadRaw = true;
838 Globals.bWriteRaw = true;
839 Globals.bNullPasswords = false;
840 Globals.bObeyPamRestrictions = false;
841 Globals.syslog = 1;
842 Globals.bSyslogOnly = false;
843 Globals.bTimestampLogs = true;
844 string_set(&Globals.loglevel, "0");
845 Globals.bDebugPrefixTimestamp = false;
846 Globals.bDebugHiresTimestamp = true;
847 Globals.bDebugPid = false;
848 Globals.bDebugUid = false;
849 Globals.bDebugClass = false;
850 Globals.bEnableCoreFiles = true;
851 Globals.max_ttl = 60 * 60 * 24 * 3; /* 3 days default. */
852 Globals.max_wins_ttl = 60 * 60 * 24 * 6; /* 6 days default. */
853 Globals.min_wins_ttl = 60 * 60 * 6; /* 6 hours default. */
854 Globals.machine_password_timeout = 60 * 60 * 24 * 7; /* 7 days default. */
855 Globals.lm_announce = Auto; /* = Auto: send only if LM clients found */
856 Globals.lm_interval = 60;
857 #if (defined(HAVE_NETGROUP) && defined(WITH_AUTOMOUNT))
858 Globals.bNISHomeMap = false;
859 #ifdef WITH_NISPLUS_HOME
860 string_set(&Globals.szNISHomeMapName, "auto_home.org_dir");
861 #else
862 string_set(&Globals.szNISHomeMapName, "auto.home");
863 #endif
864 #endif
865 Globals.bTimeServer = false;
866 Globals.bBindInterfacesOnly = false;
867 Globals.bUnixPasswdSync = false;
868 Globals.bPamPasswordChange = false;
869 Globals.bPasswdChatDebug = false;
870 Globals.iPasswdChatTimeout = 2; /* 2 second default. */
871 Globals.bNTPipeSupport = true; /* Do NT pipes by default. */
872 Globals.bNTStatusSupport = true; /* Use NT status by default. */
873 Globals.bStatCache = true; /* use stat cache by default */
874 Globals.iMaxStatCacheSize = 256; /* 256k by default */
875 Globals.restrict_anonymous = 0;
876 Globals.bClientLanManAuth = false; /* Do NOT use the LanMan hash if it is available */
877 Globals.bClientPlaintextAuth = false; /* Do NOT use a plaintext password even if is requested by the server */
878 Globals.bLanmanAuth = false; /* Do NOT use the LanMan hash, even if it is supplied */
879 Globals.bNTLMAuth = true; /* Do use NTLMv1 if it is supplied by the client (otherwise NTLMv2) */
880 Globals.bClientNTLMv2Auth = true; /* Client should always use use NTLMv2, as we can't tell that the server supports it, but most modern servers do */
881 /* Note, that we will also use NTLM2 session security (which is different), if it is available */
883 Globals.map_to_guest = 0; /* By Default, "Never" */
884 Globals.oplock_break_wait_time = 0; /* By Default, 0 msecs. */
885 Globals.enhanced_browsing = true;
886 Globals.iLockSpinTime = WINDOWS_MINIMUM_LOCK_TIMEOUT_MS; /* msec. */
887 #ifdef MMAP_BLACKLIST
888 Globals.bUseMmap = false;
889 #else
890 Globals.bUseMmap = true;
891 #endif
892 Globals.bUnicode = true;
893 Globals.bUnixExtensions = true;
894 Globals.bResetOnZeroVC = false;
895 Globals.bLogWriteableFilesOnExit = false;
896 Globals.bCreateKrb5Conf = true;
897 Globals.winbindMaxDomainConnections = 1;
899 /* hostname lookups can be very expensive and are broken on
900 a large number of sites (tridge) */
901 Globals.bHostnameLookups = false;
903 string_set(&Globals.passdb_backend, "tdbsam");
904 string_set(&Globals.szLdapSuffix, "");
905 string_set(&Globals.szLdapMachineSuffix, "");
906 string_set(&Globals.szLdapUserSuffix, "");
907 string_set(&Globals.szLdapGroupSuffix, "");
908 string_set(&Globals.szLdapIdmapSuffix, "");
910 string_set(&Globals.szLdapAdminDn, "");
911 Globals.ldap_ssl = LDAP_SSL_START_TLS;
912 Globals.ldap_ssl_ads = false;
913 Globals.ldap_deref = -1;
914 Globals.ldap_passwd_sync = LDAP_PASSWD_SYNC_OFF;
915 Globals.ldap_delete_dn = false;
916 Globals.ldap_replication_sleep = 1000; /* wait 1 sec for replication */
917 Globals.ldap_follow_referral = Auto;
918 Globals.ldap_timeout = LDAP_DEFAULT_TIMEOUT;
919 Globals.ldap_connection_timeout = LDAP_CONNECTION_DEFAULT_TIMEOUT;
920 Globals.ldap_page_size = LDAP_PAGE_SIZE;
922 Globals.ldap_debug_level = 0;
923 Globals.ldap_debug_threshold = 10;
925 /* This is what we tell the afs client. in reality we set the token
926 * to never expire, though, when this runs out the afs client will
927 * forget the token. Set to 0 to get NEVERDATE.*/
928 Globals.iAfsTokenLifetime = 604800;
929 Globals.cups_connection_timeout = CUPS_DEFAULT_CONNECTION_TIMEOUT;
931 /* these parameters are set to defaults that are more appropriate
932 for the increasing samba install base:
934 as a member of the workgroup, that will possibly become a
935 _local_ master browser (lm = true). this is opposed to a forced
936 local master browser startup (pm = true).
938 doesn't provide WINS server service by default (wsupp = false),
939 and doesn't provide domain master browser services by default, either.
943 Globals.bMsAddPrinterWizard = true;
944 Globals.os_level = 20;
945 Globals.bLocalMaster = true;
946 Globals.domain_master = Auto; /* depending on bDomainLogons */
947 Globals.bDomainLogons = false;
948 Globals.bBrowseList = true;
949 Globals.bWINSsupport = false;
950 Globals.bWINSproxy = false;
952 TALLOC_FREE(Globals.szInitLogonDelayedHosts);
953 Globals.InitLogonDelay = 100; /* 100 ms default delay */
955 Globals.bWINSdnsProxy = true;
957 Globals.bAllowTrustedDomains = true;
958 string_set(&Globals.szIdmapBackend, "tdb");
960 string_set(&Globals.szTemplateShell, "/bin/false");
961 string_set(&Globals.szTemplateHomedir, "/home/%D/%U");
962 string_set(&Globals.szWinbindSeparator, "\\");
964 string_set(&Globals.szCupsServer, "");
965 string_set(&Globals.szIPrintServer, "");
967 #ifdef CLUSTER_SUPPORT
968 string_set(&Globals.ctdbdSocket, CTDB_PATH);
969 #else
970 string_set(&Globals.ctdbdSocket, "");
971 #endif
973 Globals.szClusterAddresses = NULL;
974 Globals.clustering = false;
975 Globals.ctdb_timeout = 0;
976 Globals.ctdb_locktime_warn_threshold = 0;
978 Globals.winbind_cache_time = 300; /* 5 minutes */
979 Globals.winbind_reconnect_delay = 30; /* 30 seconds */
980 Globals.winbind_max_clients = 200;
981 Globals.bWinbindEnumUsers = false;
982 Globals.bWinbindEnumGroups = false;
983 Globals.bWinbindUseDefaultDomain = false;
984 Globals.bWinbindTrustedDomainsOnly = false;
985 Globals.bWinbindNestedGroups = true;
986 Globals.winbind_expand_groups = 1;
987 Globals.szWinbindNssInfo = (const char **)str_list_make_v3(NULL, "template", NULL);
988 Globals.bWinbindRefreshTickets = false;
989 Globals.bWinbindOfflineLogon = false;
991 Globals.iIdmapCacheTime = 86400 * 7; /* a week by default */
992 Globals.iIdmapNegativeCacheTime = 120; /* 2 minutes by default */
994 Globals.bPassdbExpandExplicit = false;
996 Globals.name_cache_timeout = 660; /* In seconds */
998 Globals.bUseSpnego = true;
999 Globals.bClientUseSpnego = true;
1001 Globals.client_signing = SMB_SIGNING_DEFAULT;
1002 Globals.server_signing = SMB_SIGNING_DEFAULT;
1004 Globals.bDeferSharingViolations = true;
1005 Globals.smb_ports = (const char **)str_list_make_v3(NULL, SMB_PORTS, NULL);
1007 Globals.bEnablePrivileges = true;
1008 Globals.bHostMSDfs = true;
1009 Globals.bASUSupport = false;
1011 /* User defined shares. */
1012 if (asprintf(&s, "%s/usershares", get_dyn_STATEDIR()) < 0) {
1013 smb_panic("init_globals: ENOMEM");
1015 string_set(&Globals.szUsersharePath, s);
1016 SAFE_FREE(s);
1017 string_set(&Globals.szUsershareTemplateShare, "");
1018 Globals.iUsershareMaxShares = 0;
1019 /* By default disallow sharing of directories not owned by the sharer. */
1020 Globals.bUsershareOwnerOnly = true;
1021 /* By default disallow guest access to usershares. */
1022 Globals.bUsershareAllowGuests = false;
1024 Globals.iKeepalive = DEFAULT_KEEPALIVE;
1026 /* By default no shares out of the registry */
1027 Globals.bRegistryShares = false;
1029 Globals.iminreceivefile = 0;
1031 Globals.bMapUntrustedToDomain = false;
1032 Globals.bMulticastDnsRegister = true;
1034 Globals.ismb2_max_read = DEFAULT_SMB2_MAX_READ;
1035 Globals.ismb2_max_write = DEFAULT_SMB2_MAX_WRITE;
1036 Globals.ismb2_max_trans = DEFAULT_SMB2_MAX_TRANSACT;
1037 Globals.ismb2_max_credits = DEFAULT_SMB2_MAX_CREDITS;
1039 string_set(&Globals.ncalrpc_dir, get_dyn_NCALRPCDIR());
1041 /* Now put back the settings that were set with lp_set_cmdline() */
1042 apply_lp_set_cmdline();
1045 /*******************************************************************
1046 Convenience routine to grab string parameters into talloced memory
1047 and run standard_sub_basic on them. The buffers can be written to by
1048 callers without affecting the source string.
1049 ********************************************************************/
1051 static char *lp_string(TALLOC_CTX *ctx, const char *s)
1053 char *ret;
1055 /* The follow debug is useful for tracking down memory problems
1056 especially if you have an inner loop that is calling a lp_*()
1057 function that returns a string. Perhaps this debug should be
1058 present all the time? */
1060 #if 0
1061 DEBUG(10, ("lp_string(%s)\n", s));
1062 #endif
1063 if (!s) {
1064 return NULL;
1067 ret = talloc_sub_basic(ctx,
1068 get_current_username(),
1069 current_user_info.domain,
1071 if (trim_char(ret, '\"', '\"')) {
1072 if (strchr(ret,'\"') != NULL) {
1073 TALLOC_FREE(ret);
1074 ret = talloc_sub_basic(ctx,
1075 get_current_username(),
1076 current_user_info.domain,
1080 return ret;
1084 In this section all the functions that are used to access the
1085 parameters from the rest of the program are defined
1088 #define FN_GLOBAL_STRING(fn_name,ptr) \
1089 char *lp_ ## fn_name(TALLOC_CTX *ctx) {return(lp_string((ctx), *(char **)(&Globals.ptr) ? *(char **)(&Globals.ptr) : ""));}
1090 #define FN_GLOBAL_CONST_STRING(fn_name,ptr) \
1091 const char *lp_ ## fn_name(void) {return(*(const char * const *)(&Globals.ptr) ? *(const char * const *)(&Globals.ptr) : "");}
1092 #define FN_GLOBAL_LIST(fn_name,ptr) \
1093 const char **lp_ ## fn_name(void) {return(*(const char ***)(&Globals.ptr));}
1094 #define FN_GLOBAL_BOOL(fn_name,ptr) \
1095 bool lp_ ## fn_name(void) {return(*(bool *)(&Globals.ptr));}
1096 #define FN_GLOBAL_CHAR(fn_name,ptr) \
1097 char lp_ ## fn_name(void) {return(*(char *)(&Globals.ptr));}
1098 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
1099 int lp_ ## fn_name(void) {return(*(int *)(&Globals.ptr));}
1101 #define FN_LOCAL_STRING(fn_name,val) \
1102 char *lp_ ## fn_name(TALLOC_CTX *ctx,int i) {return(lp_string((ctx), (LP_SNUM_OK(i) && ServicePtrs[(i)]->val) ? ServicePtrs[(i)]->val : sDefault.val));}
1103 #define FN_LOCAL_CONST_STRING(fn_name,val) \
1104 const char *lp_ ## fn_name(int i) {return (const char *)((LP_SNUM_OK(i) && ServicePtrs[(i)]->val) ? ServicePtrs[(i)]->val : sDefault.val);}
1105 #define FN_LOCAL_LIST(fn_name,val) \
1106 const char **lp_ ## fn_name(int i) {return(const char **)(LP_SNUM_OK(i)? ServicePtrs[(i)]->val : sDefault.val);}
1107 #define FN_LOCAL_BOOL(fn_name,val) \
1108 bool lp_ ## fn_name(int i) {return(bool)(LP_SNUM_OK(i)? ServicePtrs[(i)]->val : sDefault.val);}
1109 #define FN_LOCAL_INTEGER(fn_name,val) \
1110 int lp_ ## fn_name(int i) {return(LP_SNUM_OK(i)? ServicePtrs[(i)]->val : sDefault.val);}
1112 #define FN_LOCAL_PARM_BOOL(fn_name,val) \
1113 bool lp_ ## fn_name(const struct share_params *p) {return(bool)(LP_SNUM_OK(p->service)? ServicePtrs[(p->service)]->val : sDefault.val);}
1114 #define FN_LOCAL_PARM_INTEGER(fn_name,val) \
1115 int lp_ ## fn_name(const struct share_params *p) {return(LP_SNUM_OK(p->service)? ServicePtrs[(p->service)]->val : sDefault.val);}
1116 #define FN_LOCAL_CHAR(fn_name,val) \
1117 char lp_ ## fn_name(const struct share_params *p) {return(LP_SNUM_OK(p->service)? ServicePtrs[(p->service)]->val : sDefault.val);}
1120 static FN_GLOBAL_BOOL(_readraw, bReadRaw)
1121 static FN_GLOBAL_BOOL(_writeraw, bWriteRaw)
1123 /* If lp_statedir() and lp_cachedir() are explicitely set during the
1124 * build process or in smb.conf, we use that value. Otherwise they
1125 * default to the value of lp_lockdir(). */
1126 const char *lp_statedir(void) {
1127 if ((strcmp(get_dyn_STATEDIR(), get_dyn_LOCKDIR()) != 0) ||
1128 (strcmp(get_dyn_STATEDIR(), Globals.szStateDir) != 0))
1129 return(*(char **)(&Globals.szStateDir) ?
1130 *(char **)(&Globals.szStateDir) : "");
1131 else
1132 return(*(char **)(&Globals.szLockDir) ?
1133 *(char **)(&Globals.szLockDir) : "");
1135 const char *lp_cachedir(void) {
1136 if ((strcmp(get_dyn_CACHEDIR(), get_dyn_LOCKDIR()) != 0) ||
1137 (strcmp(get_dyn_CACHEDIR(), Globals.szCacheDir) != 0))
1138 return(*(char **)(&Globals.szCacheDir) ?
1139 *(char **)(&Globals.szCacheDir) : "");
1140 else
1141 return(*(char **)(&Globals.szLockDir) ?
1142 *(char **)(&Globals.szLockDir) : "");
1144 static FN_GLOBAL_INTEGER(winbind_max_domain_connections_int,
1145 winbindMaxDomainConnections)
1147 int lp_winbind_max_domain_connections(void)
1149 if (lp_winbind_offline_logon() &&
1150 lp_winbind_max_domain_connections_int() > 1) {
1151 DEBUG(1, ("offline logons active, restricting max domain "
1152 "connections to 1\n"));
1153 return 1;
1155 return MAX(1, lp_winbind_max_domain_connections_int());
1158 int lp_smb2_max_credits(void)
1160 if (Globals.ismb2_max_credits == 0) {
1161 Globals.ismb2_max_credits = DEFAULT_SMB2_MAX_CREDITS;
1163 return Globals.ismb2_max_credits;
1165 int lp_cups_encrypt(void)
1167 int result = 0;
1168 #ifdef HAVE_HTTPCONNECTENCRYPT
1169 switch (Globals.CupsEncrypt) {
1170 case Auto:
1171 result = HTTP_ENCRYPT_REQUIRED;
1172 break;
1173 case true:
1174 result = HTTP_ENCRYPT_ALWAYS;
1175 break;
1176 case false:
1177 result = HTTP_ENCRYPT_NEVER;
1178 break;
1180 #endif
1181 return result;
1184 /* These functions remain in source3/param for now */
1186 FN_GLOBAL_STRING(configfile, szConfigFile)
1188 #include "lib/param/param_functions.c"
1190 FN_LOCAL_STRING(servicename, szService)
1191 FN_LOCAL_CONST_STRING(const_servicename, szService)
1193 /* local prototypes */
1195 static int map_parameter_canonical(const char *pszParmName, bool *inverse);
1196 static const char *get_boolean(bool bool_value);
1197 static int getservicebyname(const char *pszServiceName,
1198 struct loadparm_service *pserviceDest);
1199 static void copy_service(struct loadparm_service *pserviceDest,
1200 struct loadparm_service *pserviceSource,
1201 struct bitmap *pcopymapDest);
1202 static bool do_parameter(const char *pszParmName, const char *pszParmValue,
1203 void *userdata);
1204 static bool do_section(const char *pszSectionName, void *userdata);
1205 static void init_copymap(struct loadparm_service *pservice);
1206 static bool hash_a_service(const char *name, int number);
1207 static void free_service_byindex(int iService);
1208 static void show_parameter(int parmIndex);
1209 static bool is_synonym_of(int parm1, int parm2, bool *inverse);
1212 * This is a helper function for parametrical options support. It returns a
1213 * pointer to parametrical option value if it exists or NULL otherwise. Actual
1214 * parametrical functions are quite simple
1216 static struct parmlist_entry *get_parametrics_by_service(struct loadparm_service *service, const char *type,
1217 const char *option)
1219 bool global_section = false;
1220 char* param_key;
1221 struct parmlist_entry *data;
1223 if (service == NULL) {
1224 data = Globals.param_opt;
1225 global_section = true;
1226 } else {
1227 data = service->param_opt;
1230 if (asprintf(&param_key, "%s:%s", type, option) == -1) {
1231 DEBUG(0,("asprintf failed!\n"));
1232 return NULL;
1235 while (data) {
1236 if (strwicmp(data->key, param_key) == 0) {
1237 string_free(&param_key);
1238 return data;
1240 data = data->next;
1243 if (!global_section) {
1244 /* Try to fetch the same option but from globals */
1245 /* but only if we are not already working with Globals */
1246 data = Globals.param_opt;
1247 while (data) {
1248 if (strwicmp(data->key, param_key) == 0) {
1249 string_free(&param_key);
1250 return data;
1252 data = data->next;
1256 string_free(&param_key);
1258 return NULL;
1262 * This is a helper function for parametrical options support. It returns a
1263 * pointer to parametrical option value if it exists or NULL otherwise. Actual
1264 * parametrical functions are quite simple
1266 static struct parmlist_entry *get_parametrics(int snum, const char *type,
1267 const char *option)
1269 if (snum >= iNumServices) return NULL;
1271 if (snum < 0) {
1272 return get_parametrics_by_service(NULL, type, option);
1273 } else {
1274 return get_parametrics_by_service(ServicePtrs[snum], type, option);
1279 #define MISSING_PARAMETER(name) \
1280 DEBUG(0, ("%s(): value is NULL or empty!\n", #name))
1282 /*******************************************************************
1283 convenience routine to return int parameters.
1284 ********************************************************************/
1285 static int lp_int(const char *s)
1288 if (!s || !*s) {
1289 MISSING_PARAMETER(lp_int);
1290 return (-1);
1293 return (int)strtol(s, NULL, 0);
1296 /*******************************************************************
1297 convenience routine to return unsigned long parameters.
1298 ********************************************************************/
1299 static unsigned long lp_ulong(const char *s)
1302 if (!s || !*s) {
1303 MISSING_PARAMETER(lp_ulong);
1304 return (0);
1307 return strtoul(s, NULL, 0);
1310 /*******************************************************************
1311 convenience routine to return boolean parameters.
1312 ********************************************************************/
1313 static bool lp_bool(const char *s)
1315 bool ret = false;
1317 if (!s || !*s) {
1318 MISSING_PARAMETER(lp_bool);
1319 return false;
1322 if (!set_boolean(s, &ret)) {
1323 DEBUG(0,("lp_bool(%s): value is not boolean!\n",s));
1324 return false;
1327 return ret;
1330 /*******************************************************************
1331 convenience routine to return enum parameters.
1332 ********************************************************************/
1333 static int lp_enum(const char *s,const struct enum_list *_enum)
1335 int i;
1337 if (!s || !*s || !_enum) {
1338 MISSING_PARAMETER(lp_enum);
1339 return (-1);
1342 for (i=0; _enum[i].name; i++) {
1343 if (strequal(_enum[i].name,s))
1344 return _enum[i].value;
1347 DEBUG(0,("lp_enum(%s,enum): value is not in enum_list!\n",s));
1348 return (-1);
1351 #undef MISSING_PARAMETER
1353 /* Return parametric option from a given service. Type is a part of option before ':' */
1354 /* Parametric option has following syntax: 'Type: option = value' */
1355 char *lp_parm_talloc_string(TALLOC_CTX *ctx, int snum, const char *type, const char *option, const char *def)
1357 struct parmlist_entry *data = get_parametrics(snum, type, option);
1359 if (data == NULL||data->value==NULL) {
1360 if (def) {
1361 return lp_string(ctx, def);
1362 } else {
1363 return NULL;
1367 return lp_string(ctx, data->value);
1370 /* Return parametric option from a given service. Type is a part of option before ':' */
1371 /* Parametric option has following syntax: 'Type: option = value' */
1372 const char *lp_parm_const_string(int snum, const char *type, const char *option, const char *def)
1374 struct parmlist_entry *data = get_parametrics(snum, type, option);
1376 if (data == NULL||data->value==NULL)
1377 return def;
1379 return data->value;
1382 const char *lp_parm_const_string_service(struct loadparm_service *service, const char *type, const char *option)
1384 struct parmlist_entry *data = get_parametrics_by_service(service, type, option);
1386 if (data == NULL||data->value==NULL)
1387 return NULL;
1389 return data->value;
1393 /* Return parametric option from a given service. Type is a part of option before ':' */
1394 /* Parametric option has following syntax: 'Type: option = value' */
1396 const char **lp_parm_string_list(int snum, const char *type, const char *option, const char **def)
1398 struct parmlist_entry *data = get_parametrics(snum, type, option);
1400 if (data == NULL||data->value==NULL)
1401 return (const char **)def;
1403 if (data->list==NULL) {
1404 data->list = str_list_make_v3(NULL, data->value, NULL);
1407 return (const char **)data->list;
1410 /* Return parametric option from a given service. Type is a part of option before ':' */
1411 /* Parametric option has following syntax: 'Type: option = value' */
1413 int lp_parm_int(int snum, const char *type, const char *option, int def)
1415 struct parmlist_entry *data = get_parametrics(snum, type, option);
1417 if (data && data->value && *data->value)
1418 return lp_int(data->value);
1420 return def;
1423 /* Return parametric option from a given service. Type is a part of option before ':' */
1424 /* Parametric option has following syntax: 'Type: option = value' */
1426 unsigned long lp_parm_ulong(int snum, const char *type, const char *option, unsigned long def)
1428 struct parmlist_entry *data = get_parametrics(snum, type, option);
1430 if (data && data->value && *data->value)
1431 return lp_ulong(data->value);
1433 return def;
1436 /* Return parametric option from a given service. Type is a part of option before ':' */
1437 /* Parametric option has following syntax: 'Type: option = value' */
1439 bool lp_parm_bool(int snum, const char *type, const char *option, bool def)
1441 struct parmlist_entry *data = get_parametrics(snum, type, option);
1443 if (data && data->value && *data->value)
1444 return lp_bool(data->value);
1446 return def;
1449 /* Return parametric option from a given service. Type is a part of option before ':' */
1450 /* Parametric option has following syntax: 'Type: option = value' */
1452 int lp_parm_enum(int snum, const char *type, const char *option,
1453 const struct enum_list *_enum, int def)
1455 struct parmlist_entry *data = get_parametrics(snum, type, option);
1457 if (data && data->value && *data->value && _enum)
1458 return lp_enum(data->value, _enum);
1460 return def;
1464 /***************************************************************************
1465 Initialise a service to the defaults.
1466 ***************************************************************************/
1468 static void init_service(struct loadparm_service *pservice)
1470 memset((char *)pservice, '\0', sizeof(struct loadparm_service));
1471 copy_service(pservice, &sDefault, NULL);
1476 * free a param_opts structure.
1477 * param_opts handling should be moved to talloc;
1478 * then this whole functions reduces to a TALLOC_FREE().
1481 static void free_param_opts(struct parmlist_entry **popts)
1483 struct parmlist_entry *opt, *next_opt;
1485 if (*popts != NULL) {
1486 DEBUG(5, ("Freeing parametrics:\n"));
1488 opt = *popts;
1489 while (opt != NULL) {
1490 string_free(&opt->key);
1491 string_free(&opt->value);
1492 TALLOC_FREE(opt->list);
1493 next_opt = opt->next;
1494 SAFE_FREE(opt);
1495 opt = next_opt;
1497 *popts = NULL;
1500 /***************************************************************************
1501 Free the dynamically allocated parts of a service struct.
1502 ***************************************************************************/
1504 static void free_service(struct loadparm_service *pservice)
1506 if (!pservice)
1507 return;
1509 if (pservice->szService)
1510 DEBUG(5, ("free_service: Freeing service %s\n",
1511 pservice->szService));
1513 free_parameters(pservice);
1515 string_free(&pservice->szService);
1516 TALLOC_FREE(pservice->copymap);
1518 free_param_opts(&pservice->param_opt);
1520 ZERO_STRUCTP(pservice);
1524 /***************************************************************************
1525 remove a service indexed in the ServicePtrs array from the ServiceHash
1526 and free the dynamically allocated parts
1527 ***************************************************************************/
1529 static void free_service_byindex(int idx)
1531 if ( !LP_SNUM_OK(idx) )
1532 return;
1534 ServicePtrs[idx]->valid = false;
1535 invalid_services[num_invalid_services++] = idx;
1537 /* we have to cleanup the hash record */
1539 if (ServicePtrs[idx]->szService) {
1540 char *canon_name = canonicalize_servicename(
1541 talloc_tos(),
1542 ServicePtrs[idx]->szService );
1544 dbwrap_delete_bystring(ServiceHash, canon_name );
1545 TALLOC_FREE(canon_name);
1548 free_service(ServicePtrs[idx]);
1549 talloc_free_children(ServicePtrs[idx]);
1552 /***************************************************************************
1553 Add a new service to the services array initialising it with the given
1554 service.
1555 ***************************************************************************/
1557 static int add_a_service(const struct loadparm_service *pservice, const char *name)
1559 int i;
1560 struct loadparm_service tservice;
1561 int num_to_alloc = iNumServices + 1;
1563 tservice = *pservice;
1565 /* it might already exist */
1566 if (name) {
1567 i = getservicebyname(name, NULL);
1568 if (i >= 0) {
1569 return (i);
1573 /* find an invalid one */
1574 i = iNumServices;
1575 if (num_invalid_services > 0) {
1576 i = invalid_services[--num_invalid_services];
1579 /* if not, then create one */
1580 if (i == iNumServices) {
1581 struct loadparm_service **tsp;
1582 int *tinvalid;
1584 tsp = SMB_REALLOC_ARRAY_KEEP_OLD_ON_ERROR(ServicePtrs, struct loadparm_service *, num_to_alloc);
1585 if (tsp == NULL) {
1586 DEBUG(0,("add_a_service: failed to enlarge ServicePtrs!\n"));
1587 return (-1);
1589 ServicePtrs = tsp;
1590 ServicePtrs[iNumServices] = talloc(NULL, struct loadparm_service);
1591 if (!ServicePtrs[iNumServices]) {
1592 DEBUG(0,("add_a_service: out of memory!\n"));
1593 return (-1);
1595 iNumServices++;
1597 /* enlarge invalid_services here for now... */
1598 tinvalid = SMB_REALLOC_ARRAY_KEEP_OLD_ON_ERROR(invalid_services, int,
1599 num_to_alloc);
1600 if (tinvalid == NULL) {
1601 DEBUG(0,("add_a_service: failed to enlarge "
1602 "invalid_services!\n"));
1603 return (-1);
1605 invalid_services = tinvalid;
1606 } else {
1607 free_service_byindex(i);
1610 ServicePtrs[i]->valid = true;
1612 init_service(ServicePtrs[i]);
1613 copy_service(ServicePtrs[i], &tservice, NULL);
1614 if (name)
1615 string_set(&ServicePtrs[i]->szService, name);
1617 DEBUG(8,("add_a_service: Creating snum = %d for %s\n",
1618 i, ServicePtrs[i]->szService));
1620 if (!hash_a_service(ServicePtrs[i]->szService, i)) {
1621 return (-1);
1624 return (i);
1627 /***************************************************************************
1628 Convert a string to uppercase and remove whitespaces.
1629 ***************************************************************************/
1631 char *canonicalize_servicename(TALLOC_CTX *ctx, const char *src)
1633 char *result;
1635 if ( !src ) {
1636 DEBUG(0,("canonicalize_servicename: NULL source name!\n"));
1637 return NULL;
1640 result = talloc_strdup(ctx, src);
1641 SMB_ASSERT(result != NULL);
1643 if (!strlower_m(result)) {
1644 TALLOC_FREE(result);
1645 return NULL;
1647 return result;
1650 /***************************************************************************
1651 Add a name/index pair for the services array to the hash table.
1652 ***************************************************************************/
1654 static bool hash_a_service(const char *name, int idx)
1656 char *canon_name;
1658 if ( !ServiceHash ) {
1659 DEBUG(10,("hash_a_service: creating servicehash\n"));
1660 ServiceHash = db_open_rbt(NULL);
1661 if ( !ServiceHash ) {
1662 DEBUG(0,("hash_a_service: open tdb servicehash failed!\n"));
1663 return false;
1667 DEBUG(10,("hash_a_service: hashing index %d for service name %s\n",
1668 idx, name));
1670 canon_name = canonicalize_servicename(talloc_tos(), name );
1672 dbwrap_store_bystring(ServiceHash, canon_name,
1673 make_tdb_data((uint8 *)&idx, sizeof(idx)),
1674 TDB_REPLACE);
1676 TALLOC_FREE(canon_name);
1678 return true;
1681 /***************************************************************************
1682 Add a new home service, with the specified home directory, defaults coming
1683 from service ifrom.
1684 ***************************************************************************/
1686 bool lp_add_home(const char *pszHomename, int iDefaultService,
1687 const char *user, const char *pszHomedir)
1689 int i;
1691 if (pszHomename == NULL || user == NULL || pszHomedir == NULL ||
1692 pszHomedir[0] == '\0') {
1693 return false;
1696 i = add_a_service(ServicePtrs[iDefaultService], pszHomename);
1698 if (i < 0)
1699 return false;
1701 if (!(*(ServicePtrs[iDefaultService]->szPath))
1702 || strequal(ServicePtrs[iDefaultService]->szPath,
1703 lp_pathname(talloc_tos(), GLOBAL_SECTION_SNUM))) {
1704 string_set(&ServicePtrs[i]->szPath, pszHomedir);
1707 if (!(*(ServicePtrs[i]->comment))) {
1708 char *comment = NULL;
1709 if (asprintf(&comment, "Home directory of %s", user) < 0) {
1710 return false;
1712 string_set(&ServicePtrs[i]->comment, comment);
1713 SAFE_FREE(comment);
1716 /* set the browseable flag from the global default */
1718 ServicePtrs[i]->bBrowseable = sDefault.bBrowseable;
1719 ServicePtrs[i]->bAccessBasedShareEnum = sDefault.bAccessBasedShareEnum;
1721 ServicePtrs[i]->autoloaded = true;
1723 DEBUG(3, ("adding home's share [%s] for user '%s' at '%s'\n", pszHomename,
1724 user, ServicePtrs[i]->szPath ));
1726 return true;
1729 /***************************************************************************
1730 Add a new service, based on an old one.
1731 ***************************************************************************/
1733 int lp_add_service(const char *pszService, int iDefaultService)
1735 if (iDefaultService < 0) {
1736 return add_a_service(&sDefault, pszService);
1739 return (add_a_service(ServicePtrs[iDefaultService], pszService));
1742 /***************************************************************************
1743 Add the IPC service.
1744 ***************************************************************************/
1746 static bool lp_add_ipc(const char *ipc_name, bool guest_ok)
1748 char *comment = NULL;
1749 int i = add_a_service(&sDefault, ipc_name);
1751 if (i < 0)
1752 return false;
1754 if (asprintf(&comment, "IPC Service (%s)",
1755 Globals.szServerString) < 0) {
1756 return false;
1759 string_set(&ServicePtrs[i]->szPath, tmpdir());
1760 string_set(&ServicePtrs[i]->szUsername, "");
1761 string_set(&ServicePtrs[i]->comment, comment);
1762 string_set(&ServicePtrs[i]->fstype, "IPC");
1763 ServicePtrs[i]->iMaxConnections = 0;
1764 ServicePtrs[i]->bAvailable = true;
1765 ServicePtrs[i]->bRead_only = true;
1766 ServicePtrs[i]->bGuest_only = false;
1767 ServicePtrs[i]->bAdministrative_share = true;
1768 ServicePtrs[i]->bGuest_ok = guest_ok;
1769 ServicePtrs[i]->bPrint_ok = false;
1770 ServicePtrs[i]->bBrowseable = sDefault.bBrowseable;
1772 DEBUG(3, ("adding IPC service\n"));
1774 SAFE_FREE(comment);
1775 return true;
1778 /***************************************************************************
1779 Add a new printer service, with defaults coming from service iFrom.
1780 ***************************************************************************/
1782 bool lp_add_printer(const char *pszPrintername, int iDefaultService)
1784 const char *comment = "From Printcap";
1785 int i = add_a_service(ServicePtrs[iDefaultService], pszPrintername);
1787 if (i < 0)
1788 return false;
1790 /* note that we do NOT default the availability flag to true - */
1791 /* we take it from the default service passed. This allows all */
1792 /* dynamic printers to be disabled by disabling the [printers] */
1793 /* entry (if/when the 'available' keyword is implemented!). */
1795 /* the printer name is set to the service name. */
1796 string_set(&ServicePtrs[i]->szPrintername, pszPrintername);
1797 string_set(&ServicePtrs[i]->comment, comment);
1799 /* set the browseable flag from the gloabl default */
1800 ServicePtrs[i]->bBrowseable = sDefault.bBrowseable;
1802 /* Printers cannot be read_only. */
1803 ServicePtrs[i]->bRead_only = false;
1804 /* No oplocks on printer services. */
1805 ServicePtrs[i]->bOpLocks = false;
1806 /* Printer services must be printable. */
1807 ServicePtrs[i]->bPrint_ok = true;
1809 DEBUG(3, ("adding printer service %s\n", pszPrintername));
1811 return true;
1815 /***************************************************************************
1816 Check whether the given parameter name is valid.
1817 Parametric options (names containing a colon) are considered valid.
1818 ***************************************************************************/
1820 bool lp_parameter_is_valid(const char *pszParmName)
1822 return ((map_parameter(pszParmName) != -1) ||
1823 (strchr(pszParmName, ':') != NULL));
1826 /***************************************************************************
1827 Check whether the given name is the name of a global parameter.
1828 Returns true for strings belonging to parameters of class
1829 P_GLOBAL, false for all other strings, also for parametric options
1830 and strings not belonging to any option.
1831 ***************************************************************************/
1833 bool lp_parameter_is_global(const char *pszParmName)
1835 int num = map_parameter(pszParmName);
1837 if (num >= 0) {
1838 return (parm_table[num].p_class == P_GLOBAL);
1841 return false;
1844 /**************************************************************************
1845 Check whether the given name is the canonical name of a parameter.
1846 Returns false if it is not a valid parameter Name.
1847 For parametric options, true is returned.
1848 **************************************************************************/
1850 bool lp_parameter_is_canonical(const char *parm_name)
1852 if (!lp_parameter_is_valid(parm_name)) {
1853 return false;
1856 return (map_parameter(parm_name) ==
1857 map_parameter_canonical(parm_name, NULL));
1860 /**************************************************************************
1861 Determine the canonical name for a parameter.
1862 Indicate when it is an inverse (boolean) synonym instead of a
1863 "usual" synonym.
1864 **************************************************************************/
1866 bool lp_canonicalize_parameter(const char *parm_name, const char **canon_parm,
1867 bool *inverse)
1869 int num;
1871 if (!lp_parameter_is_valid(parm_name)) {
1872 *canon_parm = NULL;
1873 return false;
1876 num = map_parameter_canonical(parm_name, inverse);
1877 if (num < 0) {
1878 /* parametric option */
1879 *canon_parm = parm_name;
1880 } else {
1881 *canon_parm = parm_table[num].label;
1884 return true;
1888 /**************************************************************************
1889 Determine the canonical name for a parameter.
1890 Turn the value given into the inverse boolean expression when
1891 the synonym is an invers boolean synonym.
1893 Return true if parm_name is a valid parameter name and
1894 in case it is an invers boolean synonym, if the val string could
1895 successfully be converted to the reverse bool.
1896 Return false in all other cases.
1897 **************************************************************************/
1899 bool lp_canonicalize_parameter_with_value(const char *parm_name,
1900 const char *val,
1901 const char **canon_parm,
1902 const char **canon_val)
1904 int num;
1905 bool inverse;
1907 if (!lp_parameter_is_valid(parm_name)) {
1908 *canon_parm = NULL;
1909 *canon_val = NULL;
1910 return false;
1913 num = map_parameter_canonical(parm_name, &inverse);
1914 if (num < 0) {
1915 /* parametric option */
1916 *canon_parm = parm_name;
1917 *canon_val = val;
1918 } else {
1919 *canon_parm = parm_table[num].label;
1920 if (inverse) {
1921 if (!lp_invert_boolean(val, canon_val)) {
1922 *canon_val = NULL;
1923 return false;
1925 } else {
1926 *canon_val = val;
1930 return true;
1933 /***************************************************************************
1934 Map a parameter's string representation to something we can use.
1935 Returns false if the parameter string is not recognised, else TRUE.
1936 ***************************************************************************/
1938 static int map_parameter(const char *pszParmName)
1940 int iIndex;
1942 if (*pszParmName == '-' && !strequal(pszParmName, "-valid"))
1943 return (-1);
1945 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
1946 if (strwicmp(parm_table[iIndex].label, pszParmName) == 0)
1947 return (iIndex);
1949 /* Warn only if it isn't parametric option */
1950 if (strchr(pszParmName, ':') == NULL)
1951 DEBUG(1, ("Unknown parameter encountered: \"%s\"\n", pszParmName));
1952 /* We do return 'fail' for parametric options as well because they are
1953 stored in different storage
1955 return (-1);
1958 /***************************************************************************
1959 Map a parameter's string representation to the index of the canonical
1960 form of the parameter (it might be a synonym).
1961 Returns -1 if the parameter string is not recognised.
1962 ***************************************************************************/
1964 static int map_parameter_canonical(const char *pszParmName, bool *inverse)
1966 int parm_num, canon_num;
1967 bool loc_inverse = false;
1969 parm_num = map_parameter(pszParmName);
1970 if ((parm_num < 0) || !(parm_table[parm_num].flags & FLAG_HIDE)) {
1971 /* invalid, parametric or no canidate for synonyms ... */
1972 goto done;
1975 for (canon_num = 0; parm_table[canon_num].label; canon_num++) {
1976 if (is_synonym_of(parm_num, canon_num, &loc_inverse)) {
1977 parm_num = canon_num;
1978 goto done;
1982 done:
1983 if (inverse != NULL) {
1984 *inverse = loc_inverse;
1986 return parm_num;
1989 /***************************************************************************
1990 return true if parameter number parm1 is a synonym of parameter
1991 number parm2 (parm2 being the principal name).
1992 set inverse to true if parm1 is P_BOOLREV and parm2 is P_BOOL,
1993 false otherwise.
1994 ***************************************************************************/
1996 static bool is_synonym_of(int parm1, int parm2, bool *inverse)
1998 if ((parm_table[parm1].offset == parm_table[parm2].offset) &&
1999 (parm_table[parm1].p_class == parm_table[parm2].p_class) &&
2000 (parm_table[parm1].flags & FLAG_HIDE) &&
2001 !(parm_table[parm2].flags & FLAG_HIDE))
2003 if (inverse != NULL) {
2004 if ((parm_table[parm1].type == P_BOOLREV) &&
2005 (parm_table[parm2].type == P_BOOL))
2007 *inverse = true;
2008 } else {
2009 *inverse = false;
2012 return true;
2014 return false;
2017 /***************************************************************************
2018 Show one parameter's name, type, [values,] and flags.
2019 (helper functions for show_parameter_list)
2020 ***************************************************************************/
2022 static void show_parameter(int parmIndex)
2024 int enumIndex, flagIndex;
2025 int parmIndex2;
2026 bool hadFlag;
2027 bool hadSyn;
2028 bool inverse;
2029 const char *type[] = { "P_BOOL", "P_BOOLREV", "P_CHAR", "P_INTEGER",
2030 "P_OCTAL", "P_LIST", "P_STRING", "P_USTRING",
2031 "P_ENUM", "P_SEP"};
2032 unsigned flags[] = { FLAG_BASIC, FLAG_SHARE, FLAG_PRINT, FLAG_GLOBAL,
2033 FLAG_WIZARD, FLAG_ADVANCED, FLAG_DEVELOPER, FLAG_DEPRECATED,
2034 FLAG_HIDE};
2035 const char *flag_names[] = { "FLAG_BASIC", "FLAG_SHARE", "FLAG_PRINT",
2036 "FLAG_GLOBAL", "FLAG_WIZARD", "FLAG_ADVANCED", "FLAG_DEVELOPER",
2037 "FLAG_DEPRECATED", "FLAG_HIDE", NULL};
2039 printf("%s=%s", parm_table[parmIndex].label,
2040 type[parm_table[parmIndex].type]);
2041 if (parm_table[parmIndex].type == P_ENUM) {
2042 printf(",");
2043 for (enumIndex=0;
2044 parm_table[parmIndex].enum_list[enumIndex].name;
2045 enumIndex++)
2047 printf("%s%s",
2048 enumIndex ? "|" : "",
2049 parm_table[parmIndex].enum_list[enumIndex].name);
2052 printf(",");
2053 hadFlag = false;
2054 for (flagIndex=0; flag_names[flagIndex]; flagIndex++) {
2055 if (parm_table[parmIndex].flags & flags[flagIndex]) {
2056 printf("%s%s",
2057 hadFlag ? "|" : "",
2058 flag_names[flagIndex]);
2059 hadFlag = true;
2063 /* output synonyms */
2064 hadSyn = false;
2065 for (parmIndex2=0; parm_table[parmIndex2].label; parmIndex2++) {
2066 if (is_synonym_of(parmIndex, parmIndex2, &inverse)) {
2067 printf(" (%ssynonym of %s)", inverse ? "inverse " : "",
2068 parm_table[parmIndex2].label);
2069 } else if (is_synonym_of(parmIndex2, parmIndex, &inverse)) {
2070 if (!hadSyn) {
2071 printf(" (synonyms: ");
2072 hadSyn = true;
2073 } else {
2074 printf(", ");
2076 printf("%s%s", parm_table[parmIndex2].label,
2077 inverse ? "[i]" : "");
2080 if (hadSyn) {
2081 printf(")");
2084 printf("\n");
2087 /***************************************************************************
2088 Show all parameter's name, type, [values,] and flags.
2089 ***************************************************************************/
2091 void show_parameter_list(void)
2093 int classIndex, parmIndex;
2094 const char *section_names[] = { "local", "global", NULL};
2096 for (classIndex=0; section_names[classIndex]; classIndex++) {
2097 printf("[%s]\n", section_names[classIndex]);
2098 for (parmIndex = 0; parm_table[parmIndex].label; parmIndex++) {
2099 if (parm_table[parmIndex].p_class == classIndex) {
2100 show_parameter(parmIndex);
2106 /***************************************************************************
2107 Check if a given string correctly represents a boolean value.
2108 ***************************************************************************/
2110 bool lp_string_is_valid_boolean(const char *parm_value)
2112 return set_boolean(parm_value, NULL);
2115 /***************************************************************************
2116 Get the standard string representation of a boolean value ("yes" or "no")
2117 ***************************************************************************/
2119 static const char *get_boolean(bool bool_value)
2121 static const char *yes_str = "yes";
2122 static const char *no_str = "no";
2124 return (bool_value ? yes_str : no_str);
2127 /***************************************************************************
2128 Provide the string of the negated boolean value associated to the boolean
2129 given as a string. Returns false if the passed string does not correctly
2130 represent a boolean.
2131 ***************************************************************************/
2133 bool lp_invert_boolean(const char *str, const char **inverse_str)
2135 bool val;
2137 if (!set_boolean(str, &val)) {
2138 return false;
2141 *inverse_str = get_boolean(!val);
2142 return true;
2145 /***************************************************************************
2146 Provide the canonical string representation of a boolean value given
2147 as a string. Return true on success, false if the string given does
2148 not correctly represent a boolean.
2149 ***************************************************************************/
2151 bool lp_canonicalize_boolean(const char *str, const char**canon_str)
2153 bool val;
2155 if (!set_boolean(str, &val)) {
2156 return false;
2159 *canon_str = get_boolean(val);
2160 return true;
2163 /***************************************************************************
2164 Find a service by name. Otherwise works like get_service.
2165 ***************************************************************************/
2167 static int getservicebyname(const char *pszServiceName, struct loadparm_service *pserviceDest)
2169 int iService = -1;
2170 char *canon_name;
2171 TDB_DATA data;
2172 NTSTATUS status;
2174 if (ServiceHash == NULL) {
2175 return -1;
2178 canon_name = canonicalize_servicename(talloc_tos(), pszServiceName);
2180 status = dbwrap_fetch_bystring(ServiceHash, canon_name, canon_name,
2181 &data);
2183 if (NT_STATUS_IS_OK(status) &&
2184 (data.dptr != NULL) &&
2185 (data.dsize == sizeof(iService)))
2187 iService = *(int *)data.dptr;
2190 TALLOC_FREE(canon_name);
2192 if ((iService != -1) && (LP_SNUM_OK(iService))
2193 && (pserviceDest != NULL)) {
2194 copy_service(pserviceDest, ServicePtrs[iService], NULL);
2197 return (iService);
2200 /* Return a pointer to a service by name. Unlike getservicebyname, it does not copy the service */
2201 struct loadparm_service *lp_service(const char *pszServiceName)
2203 int iService = getservicebyname(pszServiceName, NULL);
2204 if (iService == -1 || !LP_SNUM_OK(iService)) {
2205 return NULL;
2207 return ServicePtrs[iService];
2210 struct loadparm_service *lp_servicebynum(int snum)
2212 if ((snum == -1) || !LP_SNUM_OK(snum)) {
2213 return NULL;
2215 return ServicePtrs[snum];
2218 struct loadparm_service *lp_default_loadparm_service()
2220 return &sDefault;
2224 /***************************************************************************
2225 Copy a service structure to another.
2226 If pcopymapDest is NULL then copy all fields
2227 ***************************************************************************/
2230 * Add a parametric option to a parmlist_entry,
2231 * replacing old value, if already present.
2233 static void set_param_opt(struct parmlist_entry **opt_list,
2234 const char *opt_name,
2235 const char *opt_value,
2236 unsigned priority)
2238 struct parmlist_entry *new_opt, *opt;
2239 bool not_added;
2241 opt = *opt_list;
2242 not_added = true;
2244 /* Traverse destination */
2245 while (opt) {
2246 /* If we already have same option, override it */
2247 if (strwicmp(opt->key, opt_name) == 0) {
2248 if ((opt->priority & FLAG_CMDLINE) &&
2249 !(priority & FLAG_CMDLINE)) {
2250 /* it's been marked as not to be
2251 overridden */
2252 return;
2254 string_free(&opt->value);
2255 TALLOC_FREE(opt->list);
2256 opt->value = SMB_STRDUP(opt_value);
2257 opt->priority = priority;
2258 not_added = false;
2259 break;
2261 opt = opt->next;
2263 if (not_added) {
2264 new_opt = SMB_XMALLOC_P(struct parmlist_entry);
2265 new_opt->key = SMB_STRDUP(opt_name);
2266 new_opt->value = SMB_STRDUP(opt_value);
2267 new_opt->list = NULL;
2268 new_opt->priority = priority;
2269 DLIST_ADD(*opt_list, new_opt);
2273 static void copy_service(struct loadparm_service *pserviceDest, struct loadparm_service *pserviceSource,
2274 struct bitmap *pcopymapDest)
2276 int i;
2277 bool bcopyall = (pcopymapDest == NULL);
2278 struct parmlist_entry *data;
2280 for (i = 0; parm_table[i].label; i++)
2281 if (parm_table[i].p_class == P_LOCAL &&
2282 (bcopyall || bitmap_query(pcopymapDest,i))) {
2283 void *src_ptr = lp_parm_ptr(pserviceSource, &parm_table[i]);
2284 void *dest_ptr = lp_parm_ptr(pserviceDest, &parm_table[i]);
2286 switch (parm_table[i].type) {
2287 case P_BOOL:
2288 case P_BOOLREV:
2289 *(bool *)dest_ptr = *(bool *)src_ptr;
2290 break;
2292 case P_INTEGER:
2293 case P_ENUM:
2294 case P_OCTAL:
2295 case P_BYTES:
2296 *(int *)dest_ptr = *(int *)src_ptr;
2297 break;
2299 case P_CHAR:
2300 *(char *)dest_ptr = *(char *)src_ptr;
2301 break;
2303 case P_STRING:
2304 string_set((char **)dest_ptr,
2305 *(char **)src_ptr);
2306 break;
2308 case P_USTRING:
2310 char *upper_string = strupper_talloc(talloc_tos(),
2311 *(char **)src_ptr);
2312 string_set((char **)dest_ptr,
2313 upper_string);
2314 TALLOC_FREE(upper_string);
2315 break;
2317 case P_LIST:
2318 TALLOC_FREE(*((char ***)dest_ptr));
2319 *((char ***)dest_ptr) = str_list_copy(NULL,
2320 *(const char ***)src_ptr);
2321 break;
2322 default:
2323 break;
2327 if (bcopyall) {
2328 init_copymap(pserviceDest);
2329 if (pserviceSource->copymap)
2330 bitmap_copy(pserviceDest->copymap,
2331 pserviceSource->copymap);
2334 data = pserviceSource->param_opt;
2335 while (data) {
2336 set_param_opt(&pserviceDest->param_opt, data->key, data->value, data->priority);
2337 data = data->next;
2341 /***************************************************************************
2342 Check a service for consistency. Return false if the service is in any way
2343 incomplete or faulty, else true.
2344 ***************************************************************************/
2346 bool service_ok(int iService)
2348 bool bRetval;
2350 bRetval = true;
2351 if (ServicePtrs[iService]->szService[0] == '\0') {
2352 DEBUG(0, ("The following message indicates an internal error:\n"));
2353 DEBUG(0, ("No service name in service entry.\n"));
2354 bRetval = false;
2357 /* The [printers] entry MUST be printable. I'm all for flexibility, but */
2358 /* I can't see why you'd want a non-printable printer service... */
2359 if (strwicmp(ServicePtrs[iService]->szService, PRINTERS_NAME) == 0) {
2360 if (!ServicePtrs[iService]->bPrint_ok) {
2361 DEBUG(0, ("WARNING: [%s] service MUST be printable!\n",
2362 ServicePtrs[iService]->szService));
2363 ServicePtrs[iService]->bPrint_ok = true;
2365 /* [printers] service must also be non-browsable. */
2366 if (ServicePtrs[iService]->bBrowseable)
2367 ServicePtrs[iService]->bBrowseable = false;
2370 if (ServicePtrs[iService]->szPath[0] == '\0' &&
2371 strwicmp(ServicePtrs[iService]->szService, HOMES_NAME) != 0 &&
2372 ServicePtrs[iService]->szMSDfsProxy[0] == '\0'
2374 DEBUG(0, ("WARNING: No path in service %s - making it unavailable!\n",
2375 ServicePtrs[iService]->szService));
2376 ServicePtrs[iService]->bAvailable = false;
2379 /* If a service is flagged unavailable, log the fact at level 1. */
2380 if (!ServicePtrs[iService]->bAvailable)
2381 DEBUG(1, ("NOTE: Service %s is flagged unavailable.\n",
2382 ServicePtrs[iService]->szService));
2384 return (bRetval);
2387 static struct smbconf_ctx *lp_smbconf_ctx(void)
2389 sbcErr err;
2390 static struct smbconf_ctx *conf_ctx = NULL;
2392 if (conf_ctx == NULL) {
2393 err = smbconf_init(NULL, &conf_ctx, "registry:");
2394 if (!SBC_ERROR_IS_OK(err)) {
2395 DEBUG(1, ("error initializing registry configuration: "
2396 "%s\n", sbcErrorString(err)));
2397 conf_ctx = NULL;
2401 return conf_ctx;
2404 static bool process_smbconf_service(struct smbconf_service *service)
2406 uint32_t count;
2407 bool ret;
2409 if (service == NULL) {
2410 return false;
2413 ret = do_section(service->name, NULL);
2414 if (ret != true) {
2415 return false;
2417 for (count = 0; count < service->num_params; count++) {
2418 ret = do_parameter(service->param_names[count],
2419 service->param_values[count],
2420 NULL);
2421 if (ret != true) {
2422 return false;
2425 if (iServiceIndex >= 0) {
2426 return service_ok(iServiceIndex);
2428 return true;
2432 * load a service from registry and activate it
2434 bool process_registry_service(const char *service_name)
2436 sbcErr err;
2437 struct smbconf_service *service = NULL;
2438 TALLOC_CTX *mem_ctx = talloc_stackframe();
2439 struct smbconf_ctx *conf_ctx = lp_smbconf_ctx();
2440 bool ret = false;
2442 if (conf_ctx == NULL) {
2443 goto done;
2446 DEBUG(5, ("process_registry_service: service name %s\n", service_name));
2448 if (!smbconf_share_exists(conf_ctx, service_name)) {
2450 * Registry does not contain data for this service (yet),
2451 * but make sure lp_load doesn't return false.
2453 ret = true;
2454 goto done;
2457 err = smbconf_get_share(conf_ctx, mem_ctx, service_name, &service);
2458 if (!SBC_ERROR_IS_OK(err)) {
2459 goto done;
2462 ret = process_smbconf_service(service);
2463 if (!ret) {
2464 goto done;
2467 /* store the csn */
2468 smbconf_changed(conf_ctx, &conf_last_csn, NULL, NULL);
2470 done:
2471 TALLOC_FREE(mem_ctx);
2472 return ret;
2476 * process_registry_globals
2478 static bool process_registry_globals(void)
2480 bool ret;
2482 add_to_file_list(INCLUDE_REGISTRY_NAME, INCLUDE_REGISTRY_NAME);
2484 ret = do_parameter("registry shares", "yes", NULL);
2485 if (!ret) {
2486 return ret;
2489 return process_registry_service(GLOBAL_NAME);
2492 bool process_registry_shares(void)
2494 sbcErr err;
2495 uint32_t count;
2496 struct smbconf_service **service = NULL;
2497 uint32_t num_shares = 0;
2498 TALLOC_CTX *mem_ctx = talloc_stackframe();
2499 struct smbconf_ctx *conf_ctx = lp_smbconf_ctx();
2500 bool ret = false;
2502 if (conf_ctx == NULL) {
2503 goto done;
2506 err = smbconf_get_config(conf_ctx, mem_ctx, &num_shares, &service);
2507 if (!SBC_ERROR_IS_OK(err)) {
2508 goto done;
2511 ret = true;
2513 for (count = 0; count < num_shares; count++) {
2514 if (strequal(service[count]->name, GLOBAL_NAME)) {
2515 continue;
2517 ret = process_smbconf_service(service[count]);
2518 if (!ret) {
2519 goto done;
2523 /* store the csn */
2524 smbconf_changed(conf_ctx, &conf_last_csn, NULL, NULL);
2526 done:
2527 TALLOC_FREE(mem_ctx);
2528 return ret;
2532 * reload those shares from registry that are already
2533 * activated in the services array.
2535 static bool reload_registry_shares(void)
2537 int i;
2538 bool ret = true;
2540 for (i = 0; i < iNumServices; i++) {
2541 if (!VALID(i)) {
2542 continue;
2545 if (ServicePtrs[i]->usershare == USERSHARE_VALID) {
2546 continue;
2549 ret = process_registry_service(ServicePtrs[i]->szService);
2550 if (!ret) {
2551 goto done;
2555 done:
2556 return ret;
2560 #define MAX_INCLUDE_DEPTH 100
2562 static uint8_t include_depth;
2564 static struct file_lists {
2565 struct file_lists *next;
2566 char *name;
2567 char *subfname;
2568 time_t modtime;
2569 } *file_lists = NULL;
2571 /*******************************************************************
2572 Keep a linked list of all config files so we know when one has changed
2573 it's date and needs to be reloaded.
2574 ********************************************************************/
2576 static void add_to_file_list(const char *fname, const char *subfname)
2578 struct file_lists *f = file_lists;
2580 while (f) {
2581 if (f->name && !strcmp(f->name, fname))
2582 break;
2583 f = f->next;
2586 if (!f) {
2587 f = SMB_MALLOC_P(struct file_lists);
2588 if (!f)
2589 return;
2590 f->next = file_lists;
2591 f->name = SMB_STRDUP(fname);
2592 if (!f->name) {
2593 SAFE_FREE(f);
2594 return;
2596 f->subfname = SMB_STRDUP(subfname);
2597 if (!f->subfname) {
2598 SAFE_FREE(f->name);
2599 SAFE_FREE(f);
2600 return;
2602 file_lists = f;
2603 f->modtime = file_modtime(subfname);
2604 } else {
2605 time_t t = file_modtime(subfname);
2606 if (t)
2607 f->modtime = t;
2609 return;
2613 * Free the file lists
2615 static void free_file_list(void)
2617 struct file_lists *f;
2618 struct file_lists *next;
2620 f = file_lists;
2621 while( f ) {
2622 next = f->next;
2623 SAFE_FREE( f->name );
2624 SAFE_FREE( f->subfname );
2625 SAFE_FREE( f );
2626 f = next;
2628 file_lists = NULL;
2633 * Utility function for outsiders to check if we're running on registry.
2635 bool lp_config_backend_is_registry(void)
2637 return (lp_config_backend() == CONFIG_BACKEND_REGISTRY);
2641 * Utility function to check if the config backend is FILE.
2643 bool lp_config_backend_is_file(void)
2645 return (lp_config_backend() == CONFIG_BACKEND_FILE);
2648 /*******************************************************************
2649 Check if a config file has changed date.
2650 ********************************************************************/
2652 bool lp_file_list_changed(void)
2654 struct file_lists *f = file_lists;
2656 DEBUG(6, ("lp_file_list_changed()\n"));
2658 while (f) {
2659 time_t mod_time;
2661 if (strequal(f->name, INCLUDE_REGISTRY_NAME)) {
2662 struct smbconf_ctx *conf_ctx = lp_smbconf_ctx();
2664 if (conf_ctx == NULL) {
2665 return false;
2667 if (smbconf_changed(conf_ctx, &conf_last_csn, NULL,
2668 NULL))
2670 DEBUGADD(6, ("registry config changed\n"));
2671 return true;
2673 } else {
2674 char *n2 = NULL;
2675 n2 = talloc_sub_basic(talloc_tos(),
2676 get_current_username(),
2677 current_user_info.domain,
2678 f->name);
2679 if (!n2) {
2680 return false;
2682 DEBUGADD(6, ("file %s -> %s last mod_time: %s\n",
2683 f->name, n2, ctime(&f->modtime)));
2685 mod_time = file_modtime(n2);
2687 if (mod_time &&
2688 ((f->modtime != mod_time) ||
2689 (f->subfname == NULL) ||
2690 (strcmp(n2, f->subfname) != 0)))
2692 DEBUGADD(6,
2693 ("file %s modified: %s\n", n2,
2694 ctime(&mod_time)));
2695 f->modtime = mod_time;
2696 SAFE_FREE(f->subfname);
2697 f->subfname = SMB_STRDUP(n2);
2698 TALLOC_FREE(n2);
2699 return true;
2701 TALLOC_FREE(n2);
2703 f = f->next;
2705 return false;
2710 * Initialize iconv conversion descriptors.
2712 * This is called the first time it is needed, and also called again
2713 * every time the configuration is reloaded, because the charset or
2714 * codepage might have changed.
2716 static void init_iconv(void)
2718 global_iconv_handle = smb_iconv_handle_reinit(NULL, lp_dos_charset(),
2719 lp_unix_charset(),
2720 true, global_iconv_handle);
2723 static bool handle_charset(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr)
2725 if (strcmp(*ptr, pszParmValue) != 0) {
2726 string_set(ptr, pszParmValue);
2727 init_iconv();
2729 return true;
2732 static bool handle_dos_charset(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr)
2734 bool is_utf8 = false;
2735 size_t len = strlen(pszParmValue);
2737 if (len == 4 || len == 5) {
2738 /* Don't use StrCaseCmp here as we don't want to
2739 initialize iconv. */
2740 if ((toupper_m(pszParmValue[0]) == 'U') &&
2741 (toupper_m(pszParmValue[1]) == 'T') &&
2742 (toupper_m(pszParmValue[2]) == 'F')) {
2743 if (len == 4) {
2744 if (pszParmValue[3] == '8') {
2745 is_utf8 = true;
2747 } else {
2748 if (pszParmValue[3] == '-' &&
2749 pszParmValue[4] == '8') {
2750 is_utf8 = true;
2756 if (strcmp(*ptr, pszParmValue) != 0) {
2757 if (is_utf8) {
2758 DEBUG(0,("ERROR: invalid DOS charset: 'dos charset' must not "
2759 "be UTF8, using (default value) %s instead.\n",
2760 DEFAULT_DOS_CHARSET));
2761 pszParmValue = DEFAULT_DOS_CHARSET;
2763 string_set(ptr, pszParmValue);
2764 init_iconv();
2766 return true;
2769 static bool handle_realm(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr)
2771 bool ret = true;
2772 TALLOC_CTX *frame = talloc_stackframe();
2773 char *realm = strupper_talloc(frame, pszParmValue);
2774 char *dnsdomain = strlower_talloc(realm, pszParmValue);
2776 ret &= string_set(&Globals.szRealm, pszParmValue);
2777 ret &= string_set(&Globals.szRealm_upper, realm);
2778 ret &= string_set(&Globals.szRealm_lower, dnsdomain);
2779 TALLOC_FREE(frame);
2781 return ret;
2784 static bool handle_netbios_aliases(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr)
2786 TALLOC_FREE(Globals.szNetbiosAliases);
2787 Globals.szNetbiosAliases = (const char **)str_list_make_v3(NULL, pszParmValue, NULL);
2788 return set_netbios_aliases(Globals.szNetbiosAliases);
2791 /***************************************************************************
2792 Handle the include operation.
2793 ***************************************************************************/
2794 static bool bAllowIncludeRegistry = true;
2796 static bool handle_include(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr)
2798 char *fname;
2800 if (include_depth >= MAX_INCLUDE_DEPTH) {
2801 DEBUG(0, ("Error: Maximum include depth (%u) exceeded!\n",
2802 include_depth));
2803 return false;
2806 if (strequal(pszParmValue, INCLUDE_REGISTRY_NAME)) {
2807 if (!bAllowIncludeRegistry) {
2808 return true;
2810 if (bInGlobalSection) {
2811 bool ret;
2812 include_depth++;
2813 ret = process_registry_globals();
2814 include_depth--;
2815 return ret;
2816 } else {
2817 DEBUG(1, ("\"include = registry\" only effective "
2818 "in %s section\n", GLOBAL_NAME));
2819 return false;
2823 fname = talloc_sub_basic(talloc_tos(), get_current_username(),
2824 current_user_info.domain,
2825 pszParmValue);
2827 add_to_file_list(pszParmValue, fname);
2829 string_set(ptr, fname);
2831 if (file_exist(fname)) {
2832 bool ret;
2833 include_depth++;
2834 ret = pm_process(fname, do_section, do_parameter, NULL);
2835 include_depth--;
2836 TALLOC_FREE(fname);
2837 return ret;
2840 DEBUG(2, ("Can't find include file %s\n", fname));
2841 TALLOC_FREE(fname);
2842 return true;
2845 /***************************************************************************
2846 Handle the interpretation of the copy parameter.
2847 ***************************************************************************/
2849 static bool handle_copy(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr)
2851 bool bRetval;
2852 int iTemp;
2853 struct loadparm_service serviceTemp;
2855 string_set(ptr, pszParmValue);
2857 init_service(&serviceTemp);
2859 bRetval = false;
2861 DEBUG(3, ("Copying service from service %s\n", pszParmValue));
2863 if ((iTemp = getservicebyname(pszParmValue, &serviceTemp)) >= 0) {
2864 if (iTemp == iServiceIndex) {
2865 DEBUG(0, ("Can't copy service %s - unable to copy self!\n", pszParmValue));
2866 } else {
2867 copy_service(ServicePtrs[iServiceIndex],
2868 &serviceTemp,
2869 ServicePtrs[iServiceIndex]->copymap);
2870 bRetval = true;
2872 } else {
2873 DEBUG(0, ("Unable to copy service - source not found: %s\n", pszParmValue));
2874 bRetval = false;
2877 free_service(&serviceTemp);
2878 return (bRetval);
2881 static bool handle_ldap_debug_level(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr)
2883 Globals.ldap_debug_level = lp_int(pszParmValue);
2884 init_ldap_debugging();
2885 return true;
2889 * idmap related parameters
2892 static bool handle_idmap_backend(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr)
2894 lp_do_parameter(snum, "idmap config * : backend", pszParmValue);
2896 return true;
2899 static bool handle_idmap_uid(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr)
2901 lp_do_parameter(snum, "idmap config * : range", pszParmValue);
2903 return true;
2906 static bool handle_idmap_gid(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr)
2908 lp_do_parameter(snum, "idmap config * : range", pszParmValue);
2910 return true;
2913 bool lp_idmap_range(const char *domain_name, uint32_t *low, uint32_t *high)
2915 char *config_option = NULL;
2916 const char *range = NULL;
2917 bool ret = false;
2919 SMB_ASSERT(low != NULL);
2920 SMB_ASSERT(high != NULL);
2922 if ((domain_name == NULL) || (domain_name[0] == '\0')) {
2923 domain_name = "*";
2926 config_option = talloc_asprintf(talloc_tos(), "idmap config %s",
2927 domain_name);
2928 if (config_option == NULL) {
2929 DEBUG(0, ("out of memory\n"));
2930 return false;
2933 range = lp_parm_const_string(-1, config_option, "range", NULL);
2934 if (range == NULL) {
2935 DEBUG(1, ("idmap range not specified for domain '%s'\n", domain_name));
2936 goto done;
2939 if (sscanf(range, "%u - %u", low, high) != 2) {
2940 DEBUG(1, ("error parsing idmap range '%s' for domain '%s'\n",
2941 range, domain_name));
2942 goto done;
2945 ret = true;
2947 done:
2948 talloc_free(config_option);
2949 return ret;
2953 bool lp_idmap_default_range(uint32_t *low, uint32_t *high)
2955 return lp_idmap_range("*", low, high);
2958 /***************************************************************************
2959 Handle the DEBUG level list.
2960 ***************************************************************************/
2962 static bool handle_debug_list(struct loadparm_context *unused, int snum, const char *pszParmValueIn, char **ptr )
2964 string_set(ptr, pszParmValueIn);
2965 return debug_parse_levels(pszParmValueIn);
2968 /***************************************************************************
2969 Handle ldap suffixes - default to ldapsuffix if sub-suffixes are not defined.
2970 ***************************************************************************/
2972 static const char *append_ldap_suffix(TALLOC_CTX *ctx, const char *str )
2974 const char *suffix_string;
2976 suffix_string = talloc_asprintf(ctx, "%s,%s", str,
2977 Globals.szLdapSuffix );
2978 if ( !suffix_string ) {
2979 DEBUG(0,("append_ldap_suffix: talloc_asprintf() failed!\n"));
2980 return "";
2983 return suffix_string;
2986 const char *lp_ldap_machine_suffix(TALLOC_CTX *ctx)
2988 if (Globals.szLdapMachineSuffix[0])
2989 return append_ldap_suffix(ctx, Globals.szLdapMachineSuffix);
2991 return lp_string(ctx, Globals.szLdapSuffix);
2994 const char *lp_ldap_user_suffix(TALLOC_CTX *ctx)
2996 if (Globals.szLdapUserSuffix[0])
2997 return append_ldap_suffix(ctx, Globals.szLdapUserSuffix);
2999 return lp_string(ctx, Globals.szLdapSuffix);
3002 const char *lp_ldap_group_suffix(TALLOC_CTX *ctx)
3004 if (Globals.szLdapGroupSuffix[0])
3005 return append_ldap_suffix(ctx, Globals.szLdapGroupSuffix);
3007 return lp_string(ctx, Globals.szLdapSuffix);
3010 const char *lp_ldap_idmap_suffix(TALLOC_CTX *ctx)
3012 if (Globals.szLdapIdmapSuffix[0])
3013 return append_ldap_suffix(ctx, Globals.szLdapIdmapSuffix);
3015 return lp_string(ctx, Globals.szLdapSuffix);
3018 /****************************************************************************
3019 set the value for a P_ENUM
3020 ***************************************************************************/
3022 static void lp_set_enum_parm( struct parm_struct *parm, const char *pszParmValue,
3023 int *ptr )
3025 int i;
3027 for (i = 0; parm->enum_list[i].name; i++) {
3028 if ( strequal(pszParmValue, parm->enum_list[i].name)) {
3029 *ptr = parm->enum_list[i].value;
3030 return;
3033 DEBUG(0, ("WARNING: Ignoring invalid value '%s' for parameter '%s'\n",
3034 pszParmValue, parm->label));
3037 /***************************************************************************
3038 ***************************************************************************/
3040 static bool handle_printing(struct loadparm_context *unused, int snum, const char *pszParmValue, char **ptr)
3042 static int parm_num = -1;
3043 struct loadparm_service *s;
3045 if ( parm_num == -1 )
3046 parm_num = map_parameter( "printing" );
3048 lp_set_enum_parm( &parm_table[parm_num], pszParmValue, (int*)ptr );
3050 if ( snum < 0 )
3051 s = &sDefault;
3052 else
3053 s = ServicePtrs[snum];
3055 init_printer_values( s );
3057 return true;
3061 /***************************************************************************
3062 Initialise a copymap.
3063 ***************************************************************************/
3065 static void init_copymap(struct loadparm_service *pservice)
3067 int i;
3069 TALLOC_FREE(pservice->copymap);
3071 pservice->copymap = bitmap_talloc(NULL, NUMPARAMETERS);
3072 if (!pservice->copymap)
3073 DEBUG(0,
3074 ("Couldn't allocate copymap!! (size %d)\n",
3075 (int)NUMPARAMETERS));
3076 else
3077 for (i = 0; i < NUMPARAMETERS; i++)
3078 bitmap_set(pservice->copymap, i);
3082 return the parameter pointer for a parameter
3084 void *lp_parm_ptr(struct loadparm_service *service, struct parm_struct *parm)
3086 if (service == NULL) {
3087 if (parm->p_class == P_LOCAL)
3088 return (void *)(((char *)&sDefault)+parm->offset);
3089 else if (parm->p_class == P_GLOBAL)
3090 return (void *)(((char *)&Globals)+parm->offset);
3091 else return NULL;
3092 } else {
3093 return (void *)(((char *)service) + parm->offset);
3097 /***************************************************************************
3098 Return the local pointer to a parameter given the service number and parameter
3099 ***************************************************************************/
3101 void *lp_local_ptr_by_snum(int snum, struct parm_struct *parm)
3103 return lp_parm_ptr(ServicePtrs[snum], parm);
3106 /***************************************************************************
3107 Process a parameter for a particular service number. If snum < 0
3108 then assume we are in the globals.
3109 ***************************************************************************/
3111 bool lp_do_parameter(int snum, const char *pszParmName, const char *pszParmValue)
3113 int parmnum, i;
3114 void *parm_ptr = NULL; /* where we are going to store the result */
3115 struct parmlist_entry **opt_list;
3117 parmnum = map_parameter(pszParmName);
3119 if (parmnum < 0) {
3120 if (strchr(pszParmName, ':') == NULL) {
3121 DEBUG(0, ("Ignoring unknown parameter \"%s\"\n",
3122 pszParmName));
3123 return true;
3127 * We've got a parametric option
3130 opt_list = (snum < 0)
3131 ? &Globals.param_opt : &ServicePtrs[snum]->param_opt;
3132 set_param_opt(opt_list, pszParmName, pszParmValue, 0);
3134 return true;
3137 /* if it's already been set by the command line, then we don't
3138 override here */
3139 if (parm_table[parmnum].flags & FLAG_CMDLINE) {
3140 return true;
3143 if (parm_table[parmnum].flags & FLAG_DEPRECATED) {
3144 DEBUG(1, ("WARNING: The \"%s\" option is deprecated\n",
3145 pszParmName));
3148 /* we might point at a service, the default service or a global */
3149 if (snum < 0) {
3150 parm_ptr = lp_parm_ptr(NULL, &parm_table[parmnum]);
3151 } else {
3152 if (parm_table[parmnum].p_class == P_GLOBAL) {
3153 DEBUG(0,
3154 ("Global parameter %s found in service section!\n",
3155 pszParmName));
3156 return true;
3158 parm_ptr = lp_local_ptr_by_snum(snum, &parm_table[parmnum]);
3161 if (snum >= 0) {
3162 if (!ServicePtrs[snum]->copymap)
3163 init_copymap(ServicePtrs[snum]);
3165 /* this handles the aliases - set the copymap for other entries with
3166 the same data pointer */
3167 for (i = 0; parm_table[i].label; i++) {
3168 if ((parm_table[i].offset == parm_table[parmnum].offset)
3169 && (parm_table[i].p_class == parm_table[parmnum].p_class)) {
3170 bitmap_clear(ServicePtrs[snum]->copymap, i);
3175 /* if it is a special case then go ahead */
3176 if (parm_table[parmnum].special) {
3177 return parm_table[parmnum].special(NULL, snum, pszParmValue,
3178 (char **)parm_ptr);
3181 /* now switch on the type of variable it is */
3182 switch (parm_table[parmnum].type)
3184 case P_BOOL:
3185 *(bool *)parm_ptr = lp_bool(pszParmValue);
3186 break;
3188 case P_BOOLREV:
3189 *(bool *)parm_ptr = !lp_bool(pszParmValue);
3190 break;
3192 case P_INTEGER:
3193 *(int *)parm_ptr = lp_int(pszParmValue);
3194 break;
3196 case P_CHAR:
3197 *(char *)parm_ptr = *pszParmValue;
3198 break;
3200 case P_OCTAL:
3201 i = sscanf(pszParmValue, "%o", (int *)parm_ptr);
3202 if ( i != 1 ) {
3203 DEBUG ( 0, ("Invalid octal number %s\n", pszParmName ));
3205 break;
3207 case P_BYTES:
3209 uint64_t val;
3210 if (conv_str_size_error(pszParmValue, &val)) {
3211 if (val <= INT_MAX) {
3212 *(int *)parm_ptr = (int)val;
3213 break;
3217 DEBUG(0,("lp_do_parameter(%s): value is not "
3218 "a valid size specifier!\n", pszParmValue));
3219 return false;
3222 case P_LIST:
3223 case P_CMDLIST:
3224 TALLOC_FREE(*((char ***)parm_ptr));
3225 *(char ***)parm_ptr = str_list_make_v3(
3226 NULL, pszParmValue, NULL);
3227 break;
3229 case P_STRING:
3230 string_set((char **)parm_ptr, pszParmValue);
3231 break;
3233 case P_USTRING:
3235 char *upper_string = strupper_talloc(talloc_tos(),
3236 pszParmValue);
3237 string_set((char **)parm_ptr, upper_string);
3238 TALLOC_FREE(upper_string);
3239 break;
3241 case P_ENUM:
3242 lp_set_enum_parm( &parm_table[parmnum], pszParmValue, (int*)parm_ptr );
3243 break;
3244 case P_SEP:
3245 break;
3248 return true;
3251 /***************************************************************************
3252 set a parameter, marking it with FLAG_CMDLINE. Parameters marked as
3253 FLAG_CMDLINE won't be overridden by loads from smb.conf.
3254 ***************************************************************************/
3256 static bool lp_set_cmdline_helper(const char *pszParmName, const char *pszParmValue, bool store_values)
3258 int parmnum, i;
3259 parmnum = map_parameter(pszParmName);
3260 if (parmnum >= 0) {
3261 parm_table[parmnum].flags &= ~FLAG_CMDLINE;
3262 if (!lp_do_parameter(-1, pszParmName, pszParmValue)) {
3263 return false;
3265 parm_table[parmnum].flags |= FLAG_CMDLINE;
3267 /* we have to also set FLAG_CMDLINE on aliases. Aliases must
3268 * be grouped in the table, so we don't have to search the
3269 * whole table */
3270 for (i=parmnum-1;
3271 i>=0 && parm_table[i].offset == parm_table[parmnum].offset
3272 && parm_table[i].p_class == parm_table[parmnum].p_class;
3273 i--) {
3274 parm_table[i].flags |= FLAG_CMDLINE;
3276 for (i=parmnum+1;i<NUMPARAMETERS && parm_table[i].offset == parm_table[parmnum].offset
3277 && parm_table[i].p_class == parm_table[parmnum].p_class;i++) {
3278 parm_table[i].flags |= FLAG_CMDLINE;
3281 if (store_values) {
3282 store_lp_set_cmdline(pszParmName, pszParmValue);
3284 return true;
3287 /* it might be parametric */
3288 if (strchr(pszParmName, ':') != NULL) {
3289 set_param_opt(&Globals.param_opt, pszParmName, pszParmValue, FLAG_CMDLINE);
3290 if (store_values) {
3291 store_lp_set_cmdline(pszParmName, pszParmValue);
3293 return true;
3296 DEBUG(0, ("Ignoring unknown parameter \"%s\"\n", pszParmName));
3297 return true;
3300 bool lp_set_cmdline(const char *pszParmName, const char *pszParmValue)
3302 return lp_set_cmdline_helper(pszParmName, pszParmValue, true);
3305 /***************************************************************************
3306 Process a parameter.
3307 ***************************************************************************/
3309 static bool do_parameter(const char *pszParmName, const char *pszParmValue,
3310 void *userdata)
3312 if (!bInGlobalSection && bGlobalOnly)
3313 return true;
3315 DEBUGADD(4, ("doing parameter %s = %s\n", pszParmName, pszParmValue));
3317 return (lp_do_parameter(bInGlobalSection ? -2 : iServiceIndex,
3318 pszParmName, pszParmValue));
3322 set a option from the commandline in 'a=b' format. Use to support --option
3324 bool lp_set_option(const char *option)
3326 char *p, *s;
3327 bool ret;
3329 s = talloc_strdup(NULL, option);
3330 if (!s) {
3331 return false;
3334 p = strchr(s, '=');
3335 if (!p) {
3336 talloc_free(s);
3337 return false;
3340 *p = 0;
3342 /* skip white spaces after the = sign */
3343 do {
3344 p++;
3345 } while (*p == ' ');
3347 ret = lp_set_cmdline(s, p);
3348 talloc_free(s);
3349 return ret;
3352 /**************************************************************************
3353 Print a parameter of the specified type.
3354 ***************************************************************************/
3356 static void print_parameter(struct parm_struct *p, void *ptr, FILE * f)
3358 /* For the seperation of lists values that we print below */
3359 const char *list_sep = ", ";
3360 int i;
3361 switch (p->type)
3363 case P_ENUM:
3364 for (i = 0; p->enum_list[i].name; i++) {
3365 if (*(int *)ptr == p->enum_list[i].value) {
3366 fprintf(f, "%s",
3367 p->enum_list[i].name);
3368 break;
3371 break;
3373 case P_BOOL:
3374 fprintf(f, "%s", BOOLSTR(*(bool *)ptr));
3375 break;
3377 case P_BOOLREV:
3378 fprintf(f, "%s", BOOLSTR(!*(bool *)ptr));
3379 break;
3381 case P_INTEGER:
3382 case P_BYTES:
3383 fprintf(f, "%d", *(int *)ptr);
3384 break;
3386 case P_CHAR:
3387 fprintf(f, "%c", *(char *)ptr);
3388 break;
3390 case P_OCTAL: {
3391 int val = *(int *)ptr;
3392 if (val == -1) {
3393 fprintf(f, "-1");
3394 } else {
3395 fprintf(f, "0%o", val);
3397 break;
3400 case P_CMDLIST:
3401 list_sep = " ";
3402 /* fall through */
3403 case P_LIST:
3404 if ((char ***)ptr && *(char ***)ptr) {
3405 char **list = *(char ***)ptr;
3406 for (; *list; list++) {
3407 /* surround strings with whitespace in double quotes */
3408 if (*(list+1) == NULL) {
3409 /* last item, no extra separator */
3410 list_sep = "";
3412 if ( strchr_m( *list, ' ' ) ) {
3413 fprintf(f, "\"%s\"%s", *list, list_sep);
3414 } else {
3415 fprintf(f, "%s%s", *list, list_sep);
3419 break;
3421 case P_STRING:
3422 case P_USTRING:
3423 if (*(char **)ptr) {
3424 fprintf(f, "%s", *(char **)ptr);
3426 break;
3427 case P_SEP:
3428 break;
3432 /***************************************************************************
3433 Check if two parameters are equal.
3434 ***************************************************************************/
3436 static bool equal_parameter(parm_type type, void *ptr1, void *ptr2)
3438 switch (type) {
3439 case P_BOOL:
3440 case P_BOOLREV:
3441 return (*((bool *)ptr1) == *((bool *)ptr2));
3443 case P_INTEGER:
3444 case P_ENUM:
3445 case P_OCTAL:
3446 case P_BYTES:
3447 return (*((int *)ptr1) == *((int *)ptr2));
3449 case P_CHAR:
3450 return (*((char *)ptr1) == *((char *)ptr2));
3452 case P_LIST:
3453 case P_CMDLIST:
3454 return str_list_equal(*(const char ***)ptr1, *(const char ***)ptr2);
3456 case P_STRING:
3457 case P_USTRING:
3459 char *p1 = *(char **)ptr1, *p2 = *(char **)ptr2;
3460 if (p1 && !*p1)
3461 p1 = NULL;
3462 if (p2 && !*p2)
3463 p2 = NULL;
3464 return (p1 == p2 || strequal(p1, p2));
3466 case P_SEP:
3467 break;
3469 return false;
3472 /***************************************************************************
3473 Initialize any local variables in the sDefault table, after parsing a
3474 [globals] section.
3475 ***************************************************************************/
3477 static void init_locals(void)
3480 * We run this check once the [globals] is parsed, to force
3481 * the VFS objects and other per-share settings we need for
3482 * the standard way a AD DC is operated. We may change these
3483 * as our code evolves, which is why we force these settings.
3485 * We can't do this at the end of lp_load_ex(), as by that
3486 * point the services have been loaded and they will already
3487 * have "" as their vfs objects.
3489 if (lp_server_role() == ROLE_ACTIVE_DIRECTORY_DC) {
3490 const char **vfs_objects = lp_vfs_objects(-1);
3491 if (!vfs_objects || !vfs_objects[0]) {
3492 if (lp_parm_const_string(-1, "xattr_tdb", "file", NULL)) {
3493 lp_do_parameter(-1, "vfs objects", "dfs_samba4 acl_xattr xattr_tdb");
3494 } else if (lp_parm_const_string(-1, "posix", "eadb", NULL)) {
3495 lp_do_parameter(-1, "vfs objects", "dfs_samba4 acl_xattr posix_eadb");
3496 } else {
3497 lp_do_parameter(-1, "vfs objects", "dfs_samba4 acl_xattr");
3501 lp_do_parameter(-1, "map hidden", "no");
3502 lp_do_parameter(-1, "map system", "no");
3503 lp_do_parameter(-1, "map readonly", "no");
3504 lp_do_parameter(-1, "map archive", "no");
3505 lp_do_parameter(-1, "store dos attributes", "yes");
3506 lp_do_parameter(-1, "create mask", "0777");
3507 lp_do_parameter(-1, "directory mask", "0777");
3511 /***************************************************************************
3512 Process a new section (service). At this stage all sections are services.
3513 Later we'll have special sections that permit server parameters to be set.
3514 Returns true on success, false on failure.
3515 ***************************************************************************/
3517 static bool do_section(const char *pszSectionName, void *userdata)
3519 bool bRetval;
3520 bool isglobal = ((strwicmp(pszSectionName, GLOBAL_NAME) == 0) ||
3521 (strwicmp(pszSectionName, GLOBAL_NAME2) == 0));
3522 bRetval = false;
3524 /* if we were in a global section then do the local inits */
3525 if (bInGlobalSection && !isglobal)
3526 init_locals();
3528 /* if we've just struck a global section, note the fact. */
3529 bInGlobalSection = isglobal;
3531 /* check for multiple global sections */
3532 if (bInGlobalSection) {
3533 DEBUG(3, ("Processing section \"[%s]\"\n", pszSectionName));
3534 return true;
3537 if (!bInGlobalSection && bGlobalOnly)
3538 return true;
3540 /* if we have a current service, tidy it up before moving on */
3541 bRetval = true;
3543 if (iServiceIndex >= 0)
3544 bRetval = service_ok(iServiceIndex);
3546 /* if all is still well, move to the next record in the services array */
3547 if (bRetval) {
3548 /* We put this here to avoid an odd message order if messages are */
3549 /* issued by the post-processing of a previous section. */
3550 DEBUG(2, ("Processing section \"[%s]\"\n", pszSectionName));
3552 iServiceIndex = add_a_service(&sDefault, pszSectionName);
3553 if (iServiceIndex < 0) {
3554 DEBUG(0, ("Failed to add a new service\n"));
3555 return false;
3557 /* Clean all parametric options for service */
3558 /* They will be added during parsing again */
3559 free_param_opts(&ServicePtrs[iServiceIndex]->param_opt);
3562 return bRetval;
3566 /***************************************************************************
3567 Determine if a partcular base parameter is currentl set to the default value.
3568 ***************************************************************************/
3570 static bool is_default(int i)
3572 if (!defaults_saved)
3573 return false;
3574 switch (parm_table[i].type) {
3575 case P_LIST:
3576 case P_CMDLIST:
3577 return str_list_equal((const char **)parm_table[i].def.lvalue,
3578 *(const char ***)lp_parm_ptr(NULL,
3579 &parm_table[i]));
3580 case P_STRING:
3581 case P_USTRING:
3582 return strequal(parm_table[i].def.svalue,
3583 *(char **)lp_parm_ptr(NULL,
3584 &parm_table[i]));
3585 case P_BOOL:
3586 case P_BOOLREV:
3587 return parm_table[i].def.bvalue ==
3588 *(bool *)lp_parm_ptr(NULL,
3589 &parm_table[i]);
3590 case P_CHAR:
3591 return parm_table[i].def.cvalue ==
3592 *(char *)lp_parm_ptr(NULL,
3593 &parm_table[i]);
3594 case P_INTEGER:
3595 case P_OCTAL:
3596 case P_ENUM:
3597 case P_BYTES:
3598 return parm_table[i].def.ivalue ==
3599 *(int *)lp_parm_ptr(NULL,
3600 &parm_table[i]);
3601 case P_SEP:
3602 break;
3604 return false;
3607 /***************************************************************************
3608 Display the contents of the global structure.
3609 ***************************************************************************/
3611 static void dump_globals(FILE *f)
3613 int i;
3614 struct parmlist_entry *data;
3616 fprintf(f, "[global]\n");
3618 for (i = 0; parm_table[i].label; i++)
3619 if (parm_table[i].p_class == P_GLOBAL &&
3620 !(parm_table[