2 Unix SMB/CIFS implementation.
3 Parameter loading functions
4 Copyright (C) Karl Auer 1993-1998
6 Largely re-written by Andrew Tridgell, September 1994
8 Copyright (C) Simo Sorce 2001
9 Copyright (C) Alexander Bokovoy 2002
10 Copyright (C) Stefan (metze) Metzmacher 2002
11 Copyright (C) Jim McDonough (jmcd@us.ibm.com) 2003.
12 Copyright (C) James Myers 2003 <myersjj@samba.org>
13 Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007
14 Copyright (C) Andrew Bartlett 2011-2012
16 This program is free software; you can redistribute it and/or modify
17 it under the terms of the GNU General Public License as published by
18 the Free Software Foundation; either version 3 of the License, or
19 (at your option) any later version.
21 This program is distributed in the hope that it will be useful,
22 but WITHOUT ANY WARRANTY; without even the implied warranty of
23 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 GNU General Public License for more details.
26 You should have received a copy of the GNU General Public License
27 along with this program. If not, see <http://www.gnu.org/licenses/>.
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.
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
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
58 #include "dynconfig/dynconfig.h"
59 #include "system/time.h"
60 #include "system/locale.h"
61 #include "system/network.h" /* needed for TCP_NODELAY */
62 #include "../lib/util/dlinklist.h"
63 #include "lib/param/param.h"
64 #include "lib/param/loadparm.h"
65 #include "auth/gensec/gensec.h"
66 #include "lib/param/s3_param.h"
67 #include "lib/util/bitmap.h"
68 #include "libcli/smb/smb_constants.h"
69 #include "source4/dns_server/dns_update.h"
71 #define standard_sub_basic talloc_strdup
73 static bool do_parameter(const char *, const char *, void *);
74 static bool defaults_saved = false;
76 #define LOADPARM_EXTRA_GLOBALS \
77 struct parmlist_entry *param_opt; \
91 #include "lib/param/param_global.h"
93 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
96 /* prototypes for the special type handlers */
97 static bool handle_include(struct loadparm_context *lp_ctx, int unused,
98 const char *pszParmValue, char **ptr);
99 static bool handle_realm(struct loadparm_context *lp_ctx, int unused,
100 const char *pszParmValue, char **ptr);
101 static bool handle_copy(struct loadparm_context *lp_ctx, int unused,
102 const char *pszParmValue, char **ptr);
103 static bool handle_debuglevel(struct loadparm_context *lp_ctx, int unused,
104 const char *pszParmValue, char **ptr);
105 static bool handle_logfile(struct loadparm_context *lp_ctx, int unused,
106 const char *pszParmValue, char **ptr);
108 #include "lib/param/param_enums.c"
110 #define GLOBAL_VAR(name) offsetof(struct loadparm_global, name)
111 #define LOCAL_VAR(name) offsetof(struct loadparm_service, name)
113 static struct parm_struct parm_table[] = {
115 .label = "server role",
118 .offset = GLOBAL_VAR(server_role),
120 .enum_list = enum_server_role
123 .label = "domain logons",
126 .offset = GLOBAL_VAR(domain_logons),
128 .enum_list = enum_bool_auto
131 .label = "domain master",
134 .offset = GLOBAL_VAR(domain_master),
136 .enum_list = enum_bool_auto
139 .label = "dos charset",
142 .offset = GLOBAL_VAR(dos_charset),
147 .label = "unix charset",
150 .offset = GLOBAL_VAR(unix_charset),
155 .label = "ncalrpc dir",
158 .offset = GLOBAL_VAR(ncalrpc_dir),
166 .offset = LOCAL_VAR(comment),
169 .flags = FLAG_BASIC | FLAG_ADVANCED | FLAG_SHARE | FLAG_PRINT
175 .offset = LOCAL_VAR(szPath),
178 .flags = FLAG_BASIC | FLAG_ADVANCED | FLAG_SHARE | FLAG_PRINT,
181 .label = "directory",
184 .offset = LOCAL_VAR(szPath),
190 .label = "workgroup",
193 .offset = GLOBAL_VAR(szWorkgroup),
196 .flags = FLAG_BASIC | FLAG_ADVANCED | FLAG_WIZARD,
202 .offset = GLOBAL_VAR(szRealm),
203 .special = handle_realm,
205 .flags = FLAG_BASIC | FLAG_ADVANCED | FLAG_WIZARD,
208 .label = "netbios name",
211 .offset = GLOBAL_VAR(szNetbiosName),
214 .flags = FLAG_BASIC | FLAG_ADVANCED | FLAG_WIZARD,
217 .label = "netbios aliases",
220 .offset = GLOBAL_VAR(szNetbiosAliases),
225 .label = "netbios scope",
228 .offset = GLOBAL_VAR(szNetbiosScope),
231 .flags = FLAG_ADVANCED,
234 .label = "server string",
237 .offset = GLOBAL_VAR(szServerString),
240 .flags = FLAG_BASIC | FLAG_ADVANCED,
243 .label = "interfaces",
246 .offset = GLOBAL_VAR(szInterfaces),
249 .flags = FLAG_BASIC | FLAG_ADVANCED | FLAG_WIZARD,
252 .label = "bind interfaces only",
255 .offset = GLOBAL_VAR(bBindInterfacesOnly),
258 .flags = FLAG_ADVANCED | FLAG_WIZARD,
261 .label = "ntvfs handler",
264 .offset = LOCAL_VAR(ntvfs_handler),
269 .label = "ntptr providor",
272 .offset = GLOBAL_VAR(ntptr_providor),
277 .label = "passdb backend",
280 .offset = GLOBAL_VAR(passdb_backend),
285 .label = "dcerpc endpoint servers",
288 .offset = GLOBAL_VAR(dcerpc_ep_servers),
293 .label = "server services",
296 .offset = GLOBAL_VAR(server_services),
305 .offset = GLOBAL_VAR(security),
307 .enum_list = enum_security
310 .label = "encrypt passwords",
313 .offset = GLOBAL_VAR(bEncryptPasswords),
318 .label = "null passwords",
321 .offset = GLOBAL_VAR(bNullPasswords),
324 .flags = FLAG_ADVANCED | FLAG_DEPRECATED,
327 .label = "obey pam restrictions",
330 .offset = GLOBAL_VAR(bObeyPamRestrictions),
333 .flags = FLAG_ADVANCED,
336 .label = "password server",
339 .offset = GLOBAL_VAR(szPasswordServer),
344 .label = "private dir",
347 .offset = GLOBAL_VAR(szPrivateDir),
352 .label = "passwd chat",
355 .offset = GLOBAL_VAR(szPasswdChat),
360 .label = "password level",
363 .offset = GLOBAL_VAR(pwordlevel),
368 .label = "lanman auth",
371 .offset = GLOBAL_VAR(bLanmanAuth),
374 .flags = FLAG_ADVANCED,
377 .label = "ntlm auth",
380 .offset = GLOBAL_VAR(bNTLMAuth),
383 .flags = FLAG_ADVANCED,
386 .label = "client NTLMv2 auth",
389 .offset = GLOBAL_VAR(bClientNTLMv2Auth),
392 .flags = FLAG_ADVANCED,
395 .label = "client lanman auth",
398 .offset = GLOBAL_VAR(bClientLanManAuth),
401 .flags = FLAG_ADVANCED,
404 .label = "client plaintext auth",
407 .offset = GLOBAL_VAR(bClientPlaintextAuth),
410 .flags = FLAG_ADVANCED,
413 .label = "client use spnego principal",
416 .offset = GLOBAL_VAR(client_use_spnego_principal),
422 .label = "read only",
425 .offset = LOCAL_VAR(bRead_only),
431 .label = "create mask",
434 .offset = LOCAL_VAR(iCreate_mask),
439 .label = "force create mode",
442 .offset = LOCAL_VAR(iCreate_force_mode),
447 .label = "directory mask",
450 .offset = LOCAL_VAR(iDir_mask),
455 .label = "force directory mode",
458 .offset = LOCAL_VAR(iDir_force_mode),
464 .label = "hosts allow",
467 .offset = LOCAL_VAR(szHostsallow),
472 .label = "hosts deny",
475 .offset = LOCAL_VAR(szHostsdeny),
481 .label = "log level",
484 .offset = GLOBAL_VAR(loglevel),
485 .special = handle_debuglevel,
489 .label = "debuglevel",
492 .offset = GLOBAL_VAR(loglevel),
493 .special = handle_debuglevel,
500 .offset = GLOBAL_VAR(logfile),
501 .special = handle_logfile,
503 .flags = FLAG_ADVANCED,
507 .label = "smb ports",
510 .offset = GLOBAL_VAR(smb_ports),
518 .offset = GLOBAL_VAR(nbt_port),
523 .label = "dgram port",
526 .offset = GLOBAL_VAR(dgram_port),
531 .label = "cldap port",
534 .offset = GLOBAL_VAR(cldap_port),
539 .label = "krb5 port",
542 .offset = GLOBAL_VAR(krb5_port),
547 .label = "kpasswd port",
550 .offset = GLOBAL_VAR(kpasswd_port),
558 .offset = GLOBAL_VAR(web_port),
563 .label = "tls enabled",
566 .offset = GLOBAL_VAR(tls_enabled),
571 .label = "tls keyfile",
574 .offset = GLOBAL_VAR(tls_keyfile),
579 .label = "tls certfile",
582 .offset = GLOBAL_VAR(tls_certfile),
587 .label = "tls cafile",
590 .offset = GLOBAL_VAR(tls_cafile),
595 .label = "tls crlfile",
598 .offset = GLOBAL_VAR(tls_crlfile),
603 .label = "tls dh params file",
606 .offset = GLOBAL_VAR(tls_dhpfile),
611 .label = "large readwrite",
614 .offset = GLOBAL_VAR(bLargeReadwrite),
617 .flags = FLAG_ADVANCED,
620 .label = "server max protocol",
623 .offset = GLOBAL_VAR(srv_maxprotocol),
625 .enum_list = enum_protocol,
626 .flags = FLAG_ADVANCED,
629 .label = "max protocol",
632 .offset = GLOBAL_VAR(srv_maxprotocol),
634 .enum_list = enum_protocol,
635 .flags = FLAG_ADVANCED,
641 .offset = GLOBAL_VAR(srv_maxprotocol),
643 .enum_list = enum_protocol,
644 .flags = FLAG_ADVANCED,
647 .label = "server min protocol",
650 .offset = GLOBAL_VAR(srv_minprotocol),
652 .enum_list = enum_protocol,
653 .flags = FLAG_ADVANCED,
656 .label = "min protocol",
659 .offset = GLOBAL_VAR(srv_minprotocol),
661 .enum_list = enum_protocol,
662 .flags = FLAG_ADVANCED,
665 .label = "client max protocol",
668 .offset = GLOBAL_VAR(cli_maxprotocol),
670 .enum_list = enum_protocol
673 .label = "client min protocol",
676 .offset = GLOBAL_VAR(cli_minprotocol),
678 .enum_list = enum_protocol
684 .offset = GLOBAL_VAR(bUnicode),
692 .offset = GLOBAL_VAR(bReadRaw),
697 .label = "write raw",
700 .offset = GLOBAL_VAR(bWriteRaw),
705 .label = "disable netbios",
708 .offset = GLOBAL_VAR(bDisableNetbios),
714 .label = "nt status support",
717 .offset = GLOBAL_VAR(bNTStatusSupport),
726 .offset = GLOBAL_VAR(max_mux),
729 .flags = FLAG_ADVANCED,
735 .offset = GLOBAL_VAR(max_xmit),
738 .flags = FLAG_ADVANCED,
742 .label = "name resolve order",
745 .offset = GLOBAL_VAR(szNameResolveOrder),
750 .label = "max wins ttl",
753 .offset = GLOBAL_VAR(max_wins_ttl),
756 .flags = FLAG_ADVANCED,
759 .label = "min wins ttl",
762 .offset = GLOBAL_VAR(min_wins_ttl),
765 .flags = FLAG_ADVANCED,
768 .label = "time server",
771 .offset = GLOBAL_VAR(bTimeServer),
774 .flags = FLAG_ADVANCED,
777 .label = "unix extensions",
780 .offset = GLOBAL_VAR(bUnixExtensions),
783 .flags = FLAG_ADVANCED,
786 .label = "use spnego",
789 .offset = GLOBAL_VAR(bUseSpnego),
794 .label = "server signing",
797 .offset = GLOBAL_VAR(server_signing),
799 .enum_list = enum_smb_signing_vals,
800 .flags = FLAG_ADVANCED,
803 .label = "client signing",
806 .offset = GLOBAL_VAR(client_signing),
808 .enum_list = enum_smb_signing_vals
811 .label = "rpc big endian",
814 .offset = GLOBAL_VAR(bRpcBigEndian),
820 .label = "max connections",
823 .offset = LOCAL_VAR(iMaxConnections),
826 .flags = FLAG_ADVANCED | FLAG_SHARE,
829 .label = "paranoid server security",
832 .offset = GLOBAL_VAR(paranoid_server_security),
837 .label = "socket options",
840 .offset = GLOBAL_VAR(socket_options),
846 .label = "strict sync",
849 .offset = LOCAL_VAR(bStrictSync),
857 .offset = GLOBAL_VAR(bUseMmap),
860 .flags = FLAG_ADVANCED,
863 .label = "case insensitive filesystem",
866 .offset = LOCAL_VAR(bCIFileSystem),
872 .label = "max print jobs",
875 .offset = LOCAL_VAR(iMaxPrintJobs),
880 .label = "printable",
883 .offset = LOCAL_VAR(bPrint_ok),
891 .offset = LOCAL_VAR(bPrint_ok),
897 .label = "printer name",
900 .offset = LOCAL_VAR(szPrintername),
903 .flags = FLAG_ADVANCED | FLAG_PRINT,
909 .offset = LOCAL_VAR(szPrintername),
916 .label = "map system",
919 .offset = LOCAL_VAR(bMap_system),
924 .label = "map hidden",
927 .offset = LOCAL_VAR(bMap_hidden),
932 .label = "map archive",
935 .offset = LOCAL_VAR(bMap_archive),
941 .label = "preferred master",
944 .offset = GLOBAL_VAR(bPreferredMaster),
946 .enum_list = enum_bool_auto,
947 .flags = FLAG_BASIC | FLAG_ADVANCED,
950 .label = "prefered master",
953 .offset = GLOBAL_VAR(bPreferredMaster),
955 .enum_list = enum_bool_auto,
959 .label = "local master",
962 .offset = GLOBAL_VAR(bLocalMaster),
967 .label = "browseable",
970 .offset = LOCAL_VAR(bBrowseable),
973 .flags = FLAG_BASIC | FLAG_ADVANCED | FLAG_SHARE | FLAG_PRINT,
976 .label = "browsable",
979 .offset = LOCAL_VAR(bBrowseable),
985 .label = "dns proxy",
988 .offset = GLOBAL_VAR(bWINSdnsProxy),
993 .label = "wins server",
996 .offset = GLOBAL_VAR(szWINSservers),
999 .flags = FLAG_BASIC | FLAG_ADVANCED | FLAG_WIZARD,
1002 .label = "wins support",
1004 .p_class = P_GLOBAL,
1005 .offset = GLOBAL_VAR(bWINSsupport),
1008 .flags = FLAG_BASIC | FLAG_ADVANCED | FLAG_WIZARD,
1011 .label = "wins hook",
1013 .p_class = P_GLOBAL,
1014 .offset = GLOBAL_VAR(szWINSHook),
1017 .flags = FLAG_ADVANCED,
1021 .label = "csc policy",
1024 .offset = LOCAL_VAR(iCSCPolicy),
1026 .enum_list = enum_csc_policy,
1027 .flags = FLAG_ADVANCED | FLAG_SHARE | FLAG_GLOBAL,
1031 .label = "strict locking",
1034 .offset = LOCAL_VAR(iStrictLocking),
1042 .offset = LOCAL_VAR(bOpLocks),
1048 .label = "share backend",
1050 .p_class = P_GLOBAL,
1051 .offset = GLOBAL_VAR(szShareBackend),
1058 .p_class = P_GLOBAL,
1059 .offset = GLOBAL_VAR(szAutoServices),
1062 .flags = FLAG_ADVANCED,
1065 .label = "auto services",
1067 .p_class = P_GLOBAL,
1068 .offset = GLOBAL_VAR(szAutoServices),
1071 .flags = FLAG_ADVANCED,
1074 .label = "lock directory",
1076 .p_class = P_GLOBAL,
1077 .offset = GLOBAL_VAR(szLockDir),
1080 .flags = FLAG_ADVANCED,
1083 .label = "lock dir",
1085 .p_class = P_GLOBAL,
1086 .offset = GLOBAL_VAR(szLockDir),
1092 .label = "state directory",
1094 .p_class = P_GLOBAL,
1095 .offset = GLOBAL_VAR(szStateDir),
1098 .flags = FLAG_ADVANCED,
1101 .label = "cache directory",
1103 .p_class = P_GLOBAL,
1104 .offset = GLOBAL_VAR(szCacheDir),
1107 .flags = FLAG_ADVANCED,
1110 .label = "pid directory",
1112 .p_class = P_GLOBAL,
1113 .offset = GLOBAL_VAR(szPidDir),
1119 .label = "socket address",
1121 .p_class = P_GLOBAL,
1122 .offset = GLOBAL_VAR(szSocketAddress),
1130 .offset = LOCAL_VAR(szCopy),
1131 .special = handle_copy,
1139 .offset = LOCAL_VAR(szInclude),
1140 .special = handle_include,
1145 .label = "available",
1148 .offset = LOCAL_VAR(bAvailable),
1156 .offset = LOCAL_VAR(volume),
1159 .flags = FLAG_ADVANCED | FLAG_SHARE,
1165 .offset = LOCAL_VAR(fstype),
1171 .label = "panic action",
1173 .p_class = P_GLOBAL,
1174 .offset = GLOBAL_VAR(panic_action),
1180 .label = "msdfs root",
1183 .offset = LOCAL_VAR(bMSDfsRoot),
1188 .label = "host msdfs",
1190 .p_class = P_GLOBAL,
1191 .offset = GLOBAL_VAR(bHostMSDfs),
1194 .flags = FLAG_ADVANCED,
1197 .label = "winbind separator",
1199 .p_class = P_GLOBAL,
1200 .offset = GLOBAL_VAR(szWinbindSeparator),
1205 .label = "winbindd socket directory",
1207 .p_class = P_GLOBAL,
1208 .offset = GLOBAL_VAR(szWinbinddSocketDirectory),
1211 .flags = FLAG_ADVANCED,
1214 .label = "winbindd privileged socket directory",
1216 .p_class = P_GLOBAL,
1217 .offset = GLOBAL_VAR(szWinbinddPrivilegedSocketDirectory),
1220 .flags = FLAG_ADVANCED,
1223 .label = "winbind sealed pipes",
1225 .p_class = P_GLOBAL,
1226 .offset = GLOBAL_VAR(bWinbindSealedPipes),
1229 .flags = FLAG_ADVANCED,
1232 .label = "template shell",
1234 .p_class = P_GLOBAL,
1235 .offset = GLOBAL_VAR(szTemplateShell),
1238 .flags = FLAG_ADVANCED,
1241 .label = "template homedir",
1243 .p_class = P_GLOBAL,
1244 .offset = GLOBAL_VAR(szTemplateHomedir),
1247 .flags = FLAG_ADVANCED,
1250 .label = "ntp signd socket directory",
1252 .p_class = P_GLOBAL,
1253 .offset = GLOBAL_VAR(szNTPSignDSocketDirectory),
1256 .flags = FLAG_ADVANCED,
1259 .label = "rndc command",
1261 .p_class = P_GLOBAL,
1262 .offset = GLOBAL_VAR(szRNDCCommand),
1265 .flags = FLAG_ADVANCED,
1268 .label = "dns update command",
1270 .p_class = P_GLOBAL,
1271 .offset = GLOBAL_VAR(szDNSUpdateCommand),
1274 .flags = FLAG_ADVANCED,
1277 .label = "spn update command",
1279 .p_class = P_GLOBAL,
1280 .offset = GLOBAL_VAR(szSPNUpdateCommand),
1283 .flags = FLAG_ADVANCED,
1286 .label = "samba kcc command",
1288 .p_class = P_GLOBAL,
1289 .offset = GLOBAL_VAR(szSambaKCCCommand),
1292 .flags = FLAG_ADVANCED,
1295 .label = "nsupdate command",
1297 .p_class = P_GLOBAL,
1298 .offset = GLOBAL_VAR(szNSUpdateCommand),
1301 .flags = FLAG_ADVANCED,
1304 .label = "allow dns updates",
1306 .p_class = P_GLOBAL,
1307 .offset = GLOBAL_VAR(allow_dns_updates),
1309 .enum_list = enum_dns_update_settings,
1310 .flags = FLAG_ADVANCED,
1313 .label = "dns forwarder",
1315 .p_class = P_GLOBAL,
1316 .offset = GLOBAL_VAR(dns_forwarder),
1319 .flags = FLAG_ADVANCED,
1322 .label = "dns recursive queries",
1324 .p_class = P_GLOBAL,
1325 .offset = GLOBAL_VAR(dns_recursive_queries),
1330 {NULL, P_BOOL, P_NONE, 0, NULL, NULL, 0}
1334 /* local variables */
1335 struct loadparm_context {
1336 const char *szConfigFile;
1337 struct loadparm_global *globals;
1338 struct loadparm_service **services;
1339 struct loadparm_service *sDefault;
1340 struct smb_iconv_handle *iconv_handle;
1342 struct loadparm_service *currentService;
1343 bool bInGlobalSection;
1345 struct file_lists *next;
1350 unsigned int flags[NUMPARAMETERS];
1353 bool global; /* Is this the global context, which may set
1354 * global variables such as debug level etc? */
1355 const struct loadparm_s3_helpers *s3_fns;
1359 struct loadparm_service *lpcfg_default_service(struct loadparm_context *lp_ctx)
1361 if (lp_ctx->s3_fns) {
1362 return lp_ctx->s3_fns->get_default_loadparm_service();
1364 return lp_ctx->sDefault;
1368 * Convenience routine to grab string parameters into temporary memory
1369 * and run standard_sub_basic on them.
1371 * The buffers can be written to by
1372 * callers without affecting the source string.
1375 static const char *lp_string(const char *s)
1377 #if 0 /* until REWRITE done to make thread-safe */
1378 size_t len = s ? strlen(s) : 0;
1382 /* The follow debug is useful for tracking down memory problems
1383 especially if you have an inner loop that is calling a lp_*()
1384 function that returns a string. Perhaps this debug should be
1385 present all the time? */
1388 DEBUG(10, ("lp_string(%s)\n", s));
1391 #if 0 /* until REWRITE done to make thread-safe */
1393 lp_talloc = talloc_init("lp_talloc");
1395 ret = talloc_array(lp_talloc, char, len + 100); /* leave room for substitution */
1403 strlcpy(ret, s, len);
1405 if (trim_string(ret, "\"", "\"")) {
1406 if (strchr(ret,'"') != NULL)
1407 strlcpy(ret, s, len);
1410 standard_sub_basic(ret,len+100);
1417 In this section all the functions that are used to access the
1418 parameters from the rest of the program are defined
1422 * the creation of separate lpcfg_*() and lp_*() functions is to allow
1423 * for code compatibility between existing Samba4 and Samba3 code.
1426 /* this global context supports the lp_*() function varients */
1427 static struct loadparm_context *global_loadparm_context;
1429 #define lpcfg_default_service global_loadparm_context->sDefault
1430 #define lpcfg_global_service(i) global_loadparm_context->services[i]
1432 #define FN_GLOBAL_STRING(fn_name,var_name) \
1433 _PUBLIC_ const char *lpcfg_ ## fn_name(struct loadparm_context *lp_ctx) { \
1434 if (lp_ctx == NULL) return NULL; \
1435 if (lp_ctx->s3_fns) { \
1436 SMB_ASSERT(lp_ctx->s3_fns->fn_name); \
1437 return lp_ctx->s3_fns->fn_name(); \
1439 return lp_ctx->globals->var_name ? lp_string(lp_ctx->globals->var_name) : ""; \
1442 #define FN_GLOBAL_CONST_STRING(fn_name,var_name) \
1443 _PUBLIC_ const char *lpcfg_ ## fn_name(struct loadparm_context *lp_ctx) {\
1444 if (lp_ctx == NULL) return NULL; \
1445 if (lp_ctx->s3_fns) { \
1446 SMB_ASSERT(lp_ctx->s3_fns->fn_name); \
1447 return lp_ctx->s3_fns->fn_name(); \
1449 return lp_ctx->globals->var_name ? lp_string(lp_ctx->globals->var_name) : ""; \
1452 #define FN_GLOBAL_LIST(fn_name,var_name) \
1453 _PUBLIC_ const char **lpcfg_ ## fn_name(struct loadparm_context *lp_ctx) { \
1454 if (lp_ctx == NULL) return NULL; \
1455 if (lp_ctx->s3_fns) { \
1456 SMB_ASSERT(lp_ctx->s3_fns->fn_name); \
1457 return lp_ctx->s3_fns->fn_name(); \
1459 return lp_ctx->globals->var_name; \
1462 #define FN_GLOBAL_BOOL(fn_name,var_name) \
1463 _PUBLIC_ bool lpcfg_ ## fn_name(struct loadparm_context *lp_ctx) {\
1464 if (lp_ctx == NULL) return false; \
1465 if (lp_ctx->s3_fns) { \
1466 SMB_ASSERT(lp_ctx->s3_fns->fn_name); \
1467 return lp_ctx->s3_fns->fn_name(); \
1469 return lp_ctx->globals->var_name; \
1472 #define FN_GLOBAL_INTEGER(fn_name,var_name) \
1473 _PUBLIC_ int lpcfg_ ## fn_name(struct loadparm_context *lp_ctx) { \
1474 if (lp_ctx->s3_fns) { \
1475 SMB_ASSERT(lp_ctx->s3_fns->fn_name); \
1476 return lp_ctx->s3_fns->fn_name(); \
1478 return lp_ctx->globals->var_name; \
1481 /* Local parameters don't need the ->s3_fns because the struct
1482 * loadparm_service is shared and lpcfg_service() checks the ->s3_fns
1484 #define FN_LOCAL_STRING(fn_name,val) \
1485 _PUBLIC_ const char *lpcfg_ ## fn_name(struct loadparm_service *service, \
1486 struct loadparm_service *sDefault) { \
1487 return(lp_string((const char *)((service != NULL && service->val != NULL) ? service->val : sDefault->val))); \
1490 #define FN_LOCAL_CONST_STRING(fn_name,val) FN_LOCAL_STRING(fn_name, val)
1492 #define FN_LOCAL_LIST(fn_name,val) \
1493 _PUBLIC_ const char **lpcfg_ ## fn_name(struct loadparm_service *service, \
1494 struct loadparm_service *sDefault) {\
1495 return(const char **)(service != NULL && service->val != NULL? service->val : sDefault->val); \
1498 #define FN_LOCAL_PARM_BOOL(fn_name, val) FN_LOCAL_BOOL(fn_name, val)
1500 #define FN_LOCAL_BOOL(fn_name,val) \
1501 _PUBLIC_ bool lpcfg_ ## fn_name(struct loadparm_service *service, \
1502 struct loadparm_service *sDefault) { \
1503 return((service != NULL)? service->val : sDefault->val); \
1506 #define FN_LOCAL_INTEGER(fn_name,val) \
1507 _PUBLIC_ int lpcfg_ ## fn_name(struct loadparm_service *service, \
1508 struct loadparm_service *sDefault) { \
1509 return((service != NULL)? service->val : sDefault->val); \
1512 #define FN_LOCAL_PARM_INTEGER(fn_name, val) FN_LOCAL_INTEGER(fn_name, val)
1514 #define FN_LOCAL_PARM_CHAR(fn_name, val) FN_LOCAL_CHAR(fn_name, val)
1516 #define FN_LOCAL_CHAR(fn_name,val) \
1517 _PUBLIC_ char lpcfg_ ## fn_name(struct loadparm_service *service, \
1518 struct loadparm_service *sDefault) { \
1519 return((service != NULL)? service->val : sDefault->val); \
1522 #include "lib/param/param_functions.c"
1524 /* These functions remain only in lib/param for now */
1525 FN_GLOBAL_BOOL(readraw, bReadRaw)
1526 FN_GLOBAL_BOOL(writeraw, bWriteRaw)
1527 FN_GLOBAL_STRING(cachedir, szCacheDir)
1528 FN_GLOBAL_STRING(socket_address, szSocketAddress)
1529 FN_GLOBAL_STRING(statedir, szStateDir)
1531 /* local prototypes */
1532 static int map_parameter(const char *pszParmName);
1533 static struct loadparm_service *getservicebyname(struct loadparm_context *lp_ctx,
1534 const char *pszServiceName);
1535 static void copy_service(struct loadparm_service *pserviceDest,
1536 struct loadparm_service *pserviceSource,
1537 struct bitmap *pcopymapDest);
1538 static bool lpcfg_service_ok(struct loadparm_service *service);
1539 static bool do_section(const char *pszSectionName, void *);
1540 static void init_copymap(struct loadparm_service *pservice);
1542 /* This is a helper function for parametrical options support. */
1543 /* It returns a pointer to parametrical option value if it exists or NULL otherwise */
1544 /* Actual parametrical functions are quite simple */
1545 const char *lpcfg_get_parametric(struct loadparm_context *lp_ctx,
1546 struct loadparm_service *service,
1547 const char *type, const char *option)
1549 char *vfskey_tmp = NULL;
1550 char *vfskey = NULL;
1551 struct parmlist_entry *data;
1556 if (lp_ctx->s3_fns) {
1557 return lp_ctx->s3_fns->get_parametric(service, type, option);
1560 data = (service == NULL ? lp_ctx->globals->param_opt : service->param_opt);
1562 vfskey_tmp = talloc_asprintf(NULL, "%s:%s", type, option);
1563 if (vfskey_tmp == NULL) return NULL;
1564 vfskey = strlower_talloc(NULL, vfskey_tmp);
1565 talloc_free(vfskey_tmp);
1568 if (strcmp(data->key, vfskey) == 0) {
1569 talloc_free(vfskey);
1575 if (service != NULL) {
1576 /* Try to fetch the same option but from globals */
1577 /* but only if we are not already working with globals */
1578 for (data = lp_ctx->globals->param_opt; data;
1579 data = data->next) {
1580 if (strcmp(data->key, vfskey) == 0) {
1581 talloc_free(vfskey);
1587 talloc_free(vfskey);
1594 * convenience routine to return int parameters.
1596 static int lp_int(const char *s)
1600 DEBUG(0,("lp_int(%s): is called with NULL!\n",s));
1604 return strtol(s, NULL, 0);
1608 * convenience routine to return unsigned long parameters.
1610 static unsigned long lp_ulong(const char *s)
1614 DEBUG(0,("lp_ulong(%s): is called with NULL!\n",s));
1618 return strtoul(s, NULL, 0);
1622 * convenience routine to return unsigned long parameters.
1624 static long lp_long(const char *s)
1628 DEBUG(0,("lp_long(%s): is called with NULL!\n",s));
1632 return strtol(s, NULL, 0);
1636 * convenience routine to return unsigned long parameters.
1638 static double lp_double(const char *s)
1642 DEBUG(0,("lp_double(%s): is called with NULL!\n",s));
1646 return strtod(s, NULL);
1650 * convenience routine to return boolean parameters.
1652 static bool lp_bool(const char *s)
1657 DEBUG(0,("lp_bool(%s): is called with NULL!\n",s));
1661 if (!set_boolean(s, &ret)) {
1662 DEBUG(0,("lp_bool(%s): value is not boolean!\n",s));
1671 * Return parametric option from a given service. Type is a part of option before ':'
1672 * Parametric option has following syntax: 'Type: option = value'
1673 * Returned value is allocated in 'lp_talloc' context
1676 const char *lpcfg_parm_string(struct loadparm_context *lp_ctx,
1677 struct loadparm_service *service, const char *type,
1680 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
1683 return lp_string(value);
1689 * Return parametric option from a given service. Type is a part of option before ':'
1690 * Parametric option has following syntax: 'Type: option = value'
1691 * Returned value is allocated in 'lp_talloc' context
1694 const char **lpcfg_parm_string_list(TALLOC_CTX *mem_ctx,
1695 struct loadparm_context *lp_ctx,
1696 struct loadparm_service *service,
1698 const char *option, const char *separator)
1700 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
1703 return (const char **)str_list_make(mem_ctx, value, separator);
1709 * Return parametric option from a given service. Type is a part of option before ':'
1710 * Parametric option has following syntax: 'Type: option = value'
1713 int lpcfg_parm_int(struct loadparm_context *lp_ctx,
1714 struct loadparm_service *service, const char *type,
1715 const char *option, int default_v)
1717 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
1720 return lp_int(value);
1726 * Return parametric option from a given service. Type is a part of
1727 * option before ':'.
1728 * Parametric option has following syntax: 'Type: option = value'.
1731 int lpcfg_parm_bytes(struct loadparm_context *lp_ctx,
1732 struct loadparm_service *service, const char *type,
1733 const char *option, int default_v)
1737 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
1739 if (value && conv_str_size_error(value, &bval)) {
1740 if (bval <= INT_MAX) {
1749 * Return parametric option from a given service.
1750 * Type is a part of option before ':'
1751 * Parametric option has following syntax: 'Type: option = value'
1753 unsigned long lpcfg_parm_ulong(struct loadparm_context *lp_ctx,
1754 struct loadparm_service *service, const char *type,
1755 const char *option, unsigned long default_v)
1757 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
1760 return lp_ulong(value);
1765 long lpcfg_parm_long(struct loadparm_context *lp_ctx,
1766 struct loadparm_service *service, const char *type,
1767 const char *option, long default_v)
1769 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
1772 return lp_long(value);
1777 double lpcfg_parm_double(struct loadparm_context *lp_ctx,
1778 struct loadparm_service *service, const char *type,
1779 const char *option, double default_v)
1781 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
1784 return lp_double(value);
1790 * Return parametric option from a given service. Type is a part of option before ':'
1791 * Parametric option has following syntax: 'Type: option = value'
1794 bool lpcfg_parm_bool(struct loadparm_context *lp_ctx,
1795 struct loadparm_service *service, const char *type,
1796 const char *option, bool default_v)
1798 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
1801 return lp_bool(value);
1808 * Initialise a service to the defaults.
1811 static struct loadparm_service *init_service(TALLOC_CTX *mem_ctx, struct loadparm_service *sDefault)
1813 struct loadparm_service *pservice =
1814 talloc_zero(mem_ctx, struct loadparm_service);
1815 copy_service(pservice, sDefault, NULL);
1820 * Set a string value, deallocating any existing space, and allocing the space
1823 static bool lpcfg_string_set(TALLOC_CTX *mem_ctx, char **dest, const char *src)
1830 *dest = talloc_strdup(mem_ctx, src);
1831 if ((*dest) == NULL) {
1832 DEBUG(0,("Out of memory in string_set\n"));
1840 * Set a string value, deallocating any existing space, and allocing the space
1843 static bool lpcfg_string_set_upper(TALLOC_CTX *mem_ctx, char **dest, const char *src)
1850 *dest = strupper_talloc(mem_ctx, src);
1851 if ((*dest) == NULL) {
1852 DEBUG(0,("Out of memory in string_set_upper\n"));
1862 * Add a new service to the services array initialising it with the given
1866 struct loadparm_service *lpcfg_add_service(struct loadparm_context *lp_ctx,
1867 const struct loadparm_service *pservice,
1871 struct loadparm_service tservice;
1872 int num_to_alloc = lp_ctx->iNumServices + 1;
1873 struct parmlist_entry *data, *pdata;
1875 if (pservice == NULL) {
1876 pservice = lp_ctx->sDefault;
1879 tservice = *pservice;
1881 /* it might already exist */
1883 struct loadparm_service *service = getservicebyname(lp_ctx,
1885 if (service != NULL) {
1886 /* Clean all parametric options for service */
1887 /* They will be added during parsing again */
1888 data = service->param_opt;
1894 service->param_opt = NULL;
1899 /* find an invalid one */
1900 for (i = 0; i < lp_ctx->iNumServices; i++)
1901 if (lp_ctx->services[i] == NULL)
1904 /* if not, then create one */
1905 if (i == lp_ctx->iNumServices) {
1906 struct loadparm_service **tsp;
1908 tsp = talloc_realloc(lp_ctx, lp_ctx->services, struct loadparm_service *, num_to_alloc);
1911 DEBUG(0,("lpcfg_add_service: failed to enlarge services!\n"));
1914 lp_ctx->services = tsp;
1915 lp_ctx->services[lp_ctx->iNumServices] = NULL;
1918 lp_ctx->iNumServices++;
1921 lp_ctx->services[i] = init_service(lp_ctx->services, lp_ctx->sDefault);
1922 if (lp_ctx->services[i] == NULL) {
1923 DEBUG(0,("lpcfg_add_service: out of memory!\n"));
1926 copy_service(lp_ctx->services[i], &tservice, NULL);
1928 lpcfg_string_set(lp_ctx->services[i], &lp_ctx->services[i]->szService, name);
1929 return lp_ctx->services[i];
1933 * Add a new home service, with the specified home directory, defaults coming
1934 * from service ifrom.
1937 bool lpcfg_add_home(struct loadparm_context *lp_ctx,
1938 const char *pszHomename,
1939 struct loadparm_service *default_service,
1940 const char *user, const char *pszHomedir)
1942 struct loadparm_service *service;
1944 service = lpcfg_add_service(lp_ctx, default_service, pszHomename);
1946 if (service == NULL)
1949 if (!(*(default_service->szPath))
1950 || strequal(default_service->szPath, lp_ctx->sDefault->szPath)) {
1951 service->szPath = talloc_strdup(service, pszHomedir);
1953 service->szPath = string_sub_talloc(service, lpcfg_pathname(default_service, lp_ctx->sDefault), "%H", pszHomedir);
1956 if (!(*(service->comment))) {
1957 service->comment = talloc_asprintf(service, "Home directory of %s", user);
1959 service->bAvailable = default_service->bAvailable;
1960 service->bBrowseable = default_service->bBrowseable;
1962 DEBUG(3, ("adding home's share [%s] for user '%s' at '%s'\n",
1963 pszHomename, user, service->szPath));
1969 * Add a new printer service, with defaults coming from service iFrom.
1972 bool lpcfg_add_printer(struct loadparm_context *lp_ctx,
1973 const char *pszPrintername,
1974 struct loadparm_service *default_service)
1976 const char *comment = "From Printcap";
1977 struct loadparm_service *service;
1978 service = lpcfg_add_service(lp_ctx, default_service, pszPrintername);
1980 if (service == NULL)
1983 /* note that we do NOT default the availability flag to True - */
1984 /* we take it from the default service passed. This allows all */
1985 /* dynamic printers to be disabled by disabling the [printers] */
1986 /* entry (if/when the 'available' keyword is implemented!). */
1988 /* the printer name is set to the service name. */
1989 lpcfg_string_set(service, &service->szPrintername, pszPrintername);
1990 lpcfg_string_set(service, &service->comment, comment);
1991 service->bBrowseable = default_service->bBrowseable;
1992 /* Printers cannot be read_only. */
1993 service->bRead_only = false;
1994 /* Printer services must be printable. */
1995 service->bPrint_ok = true;
1997 DEBUG(3, ("adding printer service %s\n", pszPrintername));
2003 * Map a parameter's string representation to something we can use.
2004 * Returns False if the parameter string is not recognised, else TRUE.
2007 static int map_parameter(const char *pszParmName)
2011 if (*pszParmName == '-')
2014 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
2015 if (strwicmp(parm_table[iIndex].label, pszParmName) == 0)
2018 /* Warn only if it isn't parametric option */
2019 if (strchr(pszParmName, ':') == NULL)
2020 DEBUG(0, ("Unknown parameter encountered: \"%s\"\n", pszParmName));
2021 /* We do return 'fail' for parametric options as well because they are
2022 stored in different storage
2029 return the parameter structure for a parameter
2031 struct parm_struct *lpcfg_parm_struct(struct loadparm_context *lp_ctx, const char *name)
2035 if (lp_ctx->s3_fns) {
2036 return lp_ctx->s3_fns->get_parm_struct(name);
2039 parmnum = map_parameter(name);
2040 if (parmnum == -1) return NULL;
2041 return &parm_table[parmnum];
2045 return the parameter pointer for a parameter
2047 void *lpcfg_parm_ptr(struct loadparm_context *lp_ctx,
2048 struct loadparm_service *service, struct parm_struct *parm)
2050 if (lp_ctx->s3_fns) {
2051 return lp_ctx->s3_fns->get_parm_ptr(service, parm);
2054 if (service == NULL) {
2055 if (parm->p_class == P_LOCAL)
2056 return ((char *)lp_ctx->sDefault)+parm->offset;
2057 else if (parm->p_class == P_GLOBAL)
2058 return ((char *)lp_ctx->globals)+parm->offset;
2061 return ((char *)service) + parm->offset;
2066 return the parameter pointer for a parameter
2068 bool lpcfg_parm_is_cmdline(struct loadparm_context *lp_ctx, const char *name)
2072 if (lp_ctx->s3_fns) {
2073 struct parm_struct *parm = lp_ctx->s3_fns->get_parm_struct(name);
2075 return parm->flags & FLAG_CMDLINE;
2080 parmnum = map_parameter(name);
2081 if (parmnum == -1) return false;
2083 return lp_ctx->flags[parmnum] & FLAG_CMDLINE;
2087 * Find a service by name. Otherwise works like get_service.
2090 static struct loadparm_service *getservicebyname(struct loadparm_context *lp_ctx,
2091 const char *pszServiceName)
2095 if (lp_ctx->s3_fns) {
2096 return lp_ctx->s3_fns->get_service(pszServiceName);
2099 for (iService = lp_ctx->iNumServices - 1; iService >= 0; iService--)
2100 if (lp_ctx->services[iService] != NULL &&
2101 strwicmp(lp_ctx->services[iService]->szService, pszServiceName) == 0) {
2102 return lp_ctx->services[iService];
2109 * Copy a service structure to another.
2110 * If pcopymapDest is NULL then copy all fields
2113 static void copy_service(struct loadparm_service *pserviceDest,
2114 struct loadparm_service *pserviceSource,
2115 struct bitmap *pcopymapDest)
2118 bool bcopyall = (pcopymapDest == NULL);
2119 struct parmlist_entry *data, *pdata, *paramo;
2122 for (i = 0; parm_table[i].label; i++)
2123 if (parm_table[i].p_class == P_LOCAL &&
2124 (bcopyall || bitmap_query(pcopymapDest, i))) {
2126 ((char *)pserviceSource) + parm_table[i].offset;
2128 ((char *)pserviceDest) + parm_table[i].offset;
2130 switch (parm_table[i].type) {
2132 *(bool *)dest_ptr = *(bool *)src_ptr;
2139 *(int *)dest_ptr = *(int *)src_ptr;
2143 lpcfg_string_set(pserviceDest,
2149 lpcfg_string_set_upper(pserviceDest,
2154 *(const char ***)dest_ptr = (const char **)str_list_copy(pserviceDest,
2155 *(const char ***)src_ptr);
2163 init_copymap(pserviceDest);
2164 if (pserviceSource->copymap)
2165 bitmap_copy(pserviceDest->copymap,
2166 pserviceSource->copymap);
2169 data = pserviceSource->param_opt;
2172 pdata = pserviceDest->param_opt;
2173 /* Traverse destination */
2175 /* If we already have same option, override it */
2176 if (strcmp(pdata->key, data->key) == 0) {
2177 talloc_free(pdata->value);
2178 pdata->value = talloc_strdup(pdata,
2183 pdata = pdata->next;
2186 paramo = talloc_zero(pserviceDest, struct parmlist_entry);
2189 paramo->key = talloc_strdup(paramo, data->key);
2190 paramo->value = talloc_strdup(paramo, data->value);
2191 DLIST_ADD(pserviceDest->param_opt, paramo);
2198 * Check a service for consistency. Return False if the service is in any way
2199 * incomplete or faulty, else True.
2201 static bool lpcfg_service_ok(struct loadparm_service *service)
2206 if (service->szService[0] == '\0') {
2207 DEBUG(0, ("The following message indicates an internal error:\n"));
2208 DEBUG(0, ("No service name in service entry.\n"));
2212 /* The [printers] entry MUST be printable. I'm all for flexibility, but */
2213 /* I can't see why you'd want a non-printable printer service... */
2214 if (strwicmp(service->szService, PRINTERS_NAME) == 0) {
2215 if (!service->bPrint_ok) {
2216 DEBUG(0, ("WARNING: [%s] service MUST be printable!\n",
2217 service->szService));
2218 service->bPrint_ok = true;
2220 /* [printers] service must also be non-browsable. */
2221 if (service->bBrowseable)
2222 service->bBrowseable = false;
2225 /* If a service is flagged unavailable, log the fact at level 0. */
2226 if (!service->bAvailable)
2227 DEBUG(1, ("NOTE: Service %s is flagged unavailable.\n",
2228 service->szService));
2234 /*******************************************************************
2235 Keep a linked list of all config files so we know when one has changed
2236 it's date and needs to be reloaded.
2237 ********************************************************************/
2239 static void add_to_file_list(struct loadparm_context *lp_ctx,
2240 const char *fname, const char *subfname)
2242 struct file_lists *f = lp_ctx->file_lists;
2245 if (f->name && !strcmp(f->name, fname))
2251 f = talloc(lp_ctx, struct file_lists);
2254 f->next = lp_ctx->file_lists;
2255 f->name = talloc_strdup(f, fname);
2260 f->subfname = talloc_strdup(f, subfname);
2265 lp_ctx->file_lists = f;
2266 f->modtime = file_modtime(subfname);
2268 time_t t = file_modtime(subfname);
2274 /*******************************************************************
2275 Check if a config file has changed date.
2276 ********************************************************************/
2277 bool lpcfg_file_list_changed(struct loadparm_context *lp_ctx)
2279 struct file_lists *f;
2280 DEBUG(6, ("lp_file_list_changed()\n"));
2282 for (f = lp_ctx->file_lists; f != NULL; f = f->next) {
2286 n2 = standard_sub_basic(lp_ctx, f->name);
2288 DEBUGADD(6, ("file %s -> %s last mod_time: %s\n",
2289 f->name, n2, ctime(&f->modtime)));
2291 mod_time = file_modtime(n2);
2293 if (mod_time && ((f->modtime != mod_time) || (f->subfname == NULL) || (strcmp(n2, f->subfname) != 0))) {
2294 DEBUGADD(6, ("file %s modified: %s\n", n2,
2296 f->modtime = mod_time;
2297 talloc_free(f->subfname);
2298 f->subfname = talloc_strdup(f, n2);
2305 /***************************************************************************
2306 Handle the "realm" parameter
2307 ***************************************************************************/
2309 static bool handle_realm(struct loadparm_context *lp_ctx, int unused,
2310 const char *pszParmValue, char **ptr)
2312 lpcfg_string_set(lp_ctx, ptr, pszParmValue);
2314 talloc_free(lp_ctx->globals->szRealm_upper);
2315 talloc_free(lp_ctx->globals->szRealm_lower);
2317 lp_ctx->globals->szRealm_upper = strupper_talloc(lp_ctx, pszParmValue);
2318 lp_ctx->globals->szRealm_lower = strlower_talloc(lp_ctx, pszParmValue);
2323 /***************************************************************************
2324 Handle the include operation.
2325 ***************************************************************************/
2327 static bool handle_include(struct loadparm_context *lp_ctx, int unused,
2328 const char *pszParmValue, char **ptr)
2330 char *fname = standard_sub_basic(lp_ctx, pszParmValue);
2332 add_to_file_list(lp_ctx, pszParmValue, fname);
2334 lpcfg_string_set(lp_ctx, ptr, fname);
2336 if (file_exist(fname))
2337 return pm_process(fname, do_section, do_parameter, lp_ctx);
2339 DEBUG(2, ("Can't find include file %s\n", fname));
2344 /***************************************************************************
2345 Handle the interpretation of the copy parameter.
2346 ***************************************************************************/
2348 static bool handle_copy(struct loadparm_context *lp_ctx, int unused,
2349 const char *pszParmValue, char **ptr)
2352 struct loadparm_service *serviceTemp;
2354 lpcfg_string_set(lp_ctx, ptr, pszParmValue);
2358 DEBUG(3, ("Copying service from service %s\n", pszParmValue));
2360 if ((serviceTemp = getservicebyname(lp_ctx, pszParmValue)) != NULL) {
2361 if (serviceTemp == lp_ctx->currentService) {
2362 DEBUG(0, ("Can't copy service %s - unable to copy self!\n", pszParmValue));
2364 copy_service(lp_ctx->currentService,
2366 lp_ctx->currentService->copymap);
2370 DEBUG(0, ("Unable to copy service - source not found: %s\n",
2378 static bool handle_debuglevel(struct loadparm_context *lp_ctx, int unused,
2379 const char *pszParmValue, char **ptr)
2382 lpcfg_string_set(lp_ctx, ptr, pszParmValue);
2383 if (lp_ctx->global) {
2384 return debug_parse_levels(pszParmValue);
2389 static bool handle_logfile(struct loadparm_context *lp_ctx, int unused,
2390 const char *pszParmValue, char **ptr)
2392 debug_set_logfile(pszParmValue);
2393 if (lp_ctx->global) {
2394 lpcfg_string_set(lp_ctx, ptr, pszParmValue);
2399 /***************************************************************************
2400 Initialise a copymap.
2401 ***************************************************************************/
2403 static void init_copymap(struct loadparm_service *pservice)
2407 TALLOC_FREE(pservice->copymap);
2409 pservice->copymap = bitmap_talloc(NULL, NUMPARAMETERS);
2410 if (!pservice->copymap)
2412 ("Couldn't allocate copymap!! (size %d)\n",
2413 (int)NUMPARAMETERS));
2415 for (i = 0; i < NUMPARAMETERS; i++)
2416 bitmap_set(pservice->copymap, i);
2420 * Process a parametric option
2422 static bool lp_do_parameter_parametric(struct loadparm_context *lp_ctx,
2423 struct loadparm_service *service,
2424 const char *pszParmName,
2425 const char *pszParmValue, int flags)
2427 struct parmlist_entry *paramo, *data;
2429 TALLOC_CTX *mem_ctx;
2431 while (isspace((unsigned char)*pszParmName)) {
2435 name = strlower_talloc(lp_ctx, pszParmName);
2436 if (!name) return false;
2438 if (service == NULL) {
2439 data = lp_ctx->globals->param_opt;
2440 mem_ctx = lp_ctx->globals;
2442 data = service->param_opt;
2446 /* Traverse destination */
2447 for (paramo=data; paramo; paramo=paramo->next) {
2448 /* If we already have the option set, override it unless
2449 it was a command line option and the new one isn't */
2450 if (strcmp(paramo->key, name) == 0) {
2451 if ((paramo->priority & FLAG_CMDLINE) &&
2452 !(flags & FLAG_CMDLINE)) {
2457 talloc_free(paramo->value);
2458 paramo->value = talloc_strdup(paramo, pszParmValue);
2459 paramo->priority = flags;
2465 paramo = talloc_zero(mem_ctx, struct parmlist_entry);
2468 paramo->key = talloc_strdup(paramo, name);
2469 paramo->value = talloc_strdup(paramo, pszParmValue);
2470 paramo->priority = flags;
2471 if (service == NULL) {
2472 DLIST_ADD(lp_ctx->globals->param_opt, paramo);
2474 DLIST_ADD(service->param_opt, paramo);
2482 static bool set_variable(TALLOC_CTX *mem_ctx, int parmnum, void *parm_ptr,
2483 const char *pszParmName, const char *pszParmValue,
2484 struct loadparm_context *lp_ctx, bool on_globals)
2487 /* if it is a special case then go ahead */
2488 if (parm_table[parmnum].special) {
2490 ret = parm_table[parmnum].special(lp_ctx, -1, pszParmValue,
2495 goto mark_non_default;
2498 /* now switch on the type of variable it is */
2499 switch (parm_table[parmnum].type)
2503 if (!set_boolean(pszParmValue, &b)) {
2504 DEBUG(0,("lp_do_parameter(%s): value is not boolean!\n", pszParmValue));
2507 *(bool *)parm_ptr = b;
2513 if (!set_boolean(pszParmValue, &b)) {
2514 DEBUG(0,("lp_do_parameter(%s): value is not boolean!\n", pszParmValue));
2517 *(bool *)parm_ptr = !b;
2522 *(int *)parm_ptr = atoi(pszParmValue);
2526 *(char *)parm_ptr = *pszParmValue;
2530 *(int *)parm_ptr = strtol(pszParmValue, NULL, 8);
2536 if (conv_str_size_error(pszParmValue, &val)) {
2537 if (val <= INT_MAX) {
2538 *(int *)parm_ptr = (int)val;
2543 DEBUG(0,("lp_do_parameter(%s): value is not "
2544 "a valid size specifier!\n", pszParmValue));
2549 *(const char ***)parm_ptr = (const char **)str_list_make(mem_ctx,
2550 pszParmValue, NULL);
2554 char **new_list = str_list_make(mem_ctx,
2555 pszParmValue, NULL);
2556 for (i=0; new_list[i]; i++) {
2557 if (new_list[i][0] == '+' && new_list[i][1]) {
2558 if (!str_list_check(*(const char ***)parm_ptr,
2560 *(const char ***)parm_ptr = str_list_add(*(const char ***)parm_ptr,
2563 } else if (new_list[i][0] == '-' && new_list[i][1]) {
2564 str_list_remove(*(const char ***)parm_ptr,
2568 DEBUG(0, ("Unsupported list syntax for: %s = %s\n",
2569 pszParmName, pszParmValue));
2572 *(const char ***)parm_ptr = (const char **) new_list;
2579 lpcfg_string_set(mem_ctx, (char **)parm_ptr, pszParmValue);
2583 lpcfg_string_set_upper(mem_ctx, (char **)parm_ptr, pszParmValue);
2587 for (i = 0; parm_table[parmnum].enum_list[i].name; i++) {
2590 parm_table[parmnum].enum_list[i].name)) {
2592 parm_table[parmnum].
2597 if (!parm_table[parmnum].enum_list[i].name) {
2598 DEBUG(0,("Unknown enumerated value '%s' for '%s'\n",
2599 pszParmValue, pszParmName));
2609 if (on_globals && (lp_ctx->flags[parmnum] & FLAG_DEFAULT)) {
2610 lp_ctx->flags[parmnum] &= ~FLAG_DEFAULT;
2611 /* we have to also unset FLAG_DEFAULT on aliases */
2612 for (i=parmnum-1;i>=0 && parm_table[i].offset == parm_table[parmnum].offset;i--) {
2613 lp_ctx->flags[i] &= ~FLAG_DEFAULT;
2615 for (i=parmnum+1;i<NUMPARAMETERS && parm_table[i].offset == parm_table[parmnum].offset;i++) {
2616 lp_ctx->flags[i] &= ~FLAG_DEFAULT;
2623 bool lpcfg_do_global_parameter(struct loadparm_context *lp_ctx,
2624 const char *pszParmName, const char *pszParmValue)
2626 int parmnum = map_parameter(pszParmName);
2630 if (strchr(pszParmName, ':')) {
2631 return lp_do_parameter_parametric(lp_ctx, NULL, pszParmName, pszParmValue, 0);
2633 DEBUG(0, ("Ignoring unknown parameter \"%s\"\n", pszParmName));
2637 /* if the flag has been set on the command line, then don't allow override,
2638 but don't report an error */
2639 if (lp_ctx->flags[parmnum] & FLAG_CMDLINE) {
2643 parm_ptr = lpcfg_parm_ptr(lp_ctx, NULL, &parm_table[parmnum]);
2645 return set_variable(lp_ctx->globals, parmnum, parm_ptr,
2646 pszParmName, pszParmValue, lp_ctx, true);
2649 bool lpcfg_do_service_parameter(struct loadparm_context *lp_ctx,
2650 struct loadparm_service *service,
2651 const char *pszParmName, const char *pszParmValue)
2655 int parmnum = map_parameter(pszParmName);
2658 if (strchr(pszParmName, ':')) {
2659 return lp_do_parameter_parametric(lp_ctx, service, pszParmName, pszParmValue, 0);
2661 DEBUG(0, ("Ignoring unknown parameter \"%s\"\n", pszParmName));
2665 /* if the flag has been set on the command line, then don't allow override,
2666 but don't report an error */
2667 if (lp_ctx->flags[parmnum] & FLAG_CMDLINE) {
2671 if (parm_table[parmnum].p_class == P_GLOBAL) {
2673 ("Global parameter %s found in service section!\n",
2677 parm_ptr = ((char *)service) + parm_table[parmnum].offset;
2679 if (!service->copymap)
2680 init_copymap(service);
2682 /* this handles the aliases - set the copymap for other
2683 * entries with the same data pointer */
2684 for (i = 0; parm_table[i].label; i++)
2685 if (parm_table[i].offset == parm_table[parmnum].offset &&
2686 parm_table[i].p_class == parm_table[parmnum].p_class)
2687 bitmap_clear(service->copymap, i);
2689 return set_variable(service, parmnum, parm_ptr, pszParmName,
2690 pszParmValue, lp_ctx, false);
2694 * Process a parameter.
2697 static bool do_parameter(const char *pszParmName, const char *pszParmValue,
2700 struct loadparm_context *lp_ctx = (struct loadparm_context *)userdata;
2702 if (lp_ctx->bInGlobalSection)
2703 return lpcfg_do_global_parameter(lp_ctx, pszParmName,
2706 return lpcfg_do_service_parameter(lp_ctx, lp_ctx->currentService,
2707 pszParmName, pszParmValue);
2711 variable argument do parameter
2713 bool lpcfg_do_global_parameter_var(struct loadparm_context *lp_ctx, const char *pszParmName, const char *fmt, ...) PRINTF_ATTRIBUTE(3, 4);
2714 bool lpcfg_do_global_parameter_var(struct loadparm_context *lp_ctx,
2715 const char *pszParmName, const char *fmt, ...)
2722 s = talloc_vasprintf(NULL, fmt, ap);
2724 ret = lpcfg_do_global_parameter(lp_ctx, pszParmName, s);
2731 set a parameter from the commandline - this is called from command line parameter
2732 parsing code. It sets the parameter then marks the parameter as unable to be modified
2733 by smb.conf processing
2735 bool lpcfg_set_cmdline(struct loadparm_context *lp_ctx, const char *pszParmName,
2736 const char *pszParmValue)
2741 if (lp_ctx->s3_fns) {
2742 return lp_ctx->s3_fns->set_cmdline(pszParmName, pszParmValue);
2745 parmnum = map_parameter(pszParmName);
2747 while (isspace((unsigned char)*pszParmValue)) pszParmValue++;
2750 if (parmnum < 0 && strchr(pszParmName, ':')) {
2751 /* set a parametric option */
2752 return lp_do_parameter_parametric(lp_ctx, NULL, pszParmName,
2753 pszParmValue, FLAG_CMDLINE);
2757 DEBUG(0,("Unknown option '%s'\n", pszParmName));
2761 /* reset the CMDLINE flag in case this has been called before */
2762 lp_ctx->flags[parmnum] &= ~FLAG_CMDLINE;
2764 if (!lpcfg_do_global_parameter(lp_ctx, pszParmName, pszParmValue)) {
2768 lp_ctx->flags[parmnum] |= FLAG_CMDLINE;
2770 /* we have to also set FLAG_CMDLINE on aliases */
2771 for (i=parmnum-1;i>=0 && parm_table[i].offset == parm_table[parmnum].offset;i--) {
2772 lp_ctx->flags[i] |= FLAG_CMDLINE;
2774 for (i=parmnum+1;i<NUMPARAMETERS && parm_table[i].offset == parm_table[parmnum].offset;i++) {
2775 lp_ctx->flags[i] |= FLAG_CMDLINE;
2782 set a option from the commandline in 'a=b' format. Use to support --option
2784 bool lpcfg_set_option(struct loadparm_context *lp_ctx, const char *option)
2789 s = talloc_strdup(NULL, option);
2802 ret = lpcfg_set_cmdline(lp_ctx, s, p+1);
2808 #define BOOLSTR(b) ((b) ? "Yes" : "No")
2811 * Print a parameter of the specified type.
2814 static void print_parameter(struct parm_struct *p, void *ptr, FILE * f)
2816 /* For the seperation of lists values that we print below */
2817 const char *list_sep = ", ";
2822 for (i = 0; p->enum_list[i].name; i++) {
2823 if (*(int *)ptr == p->enum_list[i].value) {
2825 p->enum_list[i].name);
2832 fprintf(f, "%s", BOOLSTR(*(bool *)ptr));
2836 fprintf(f, "%s", BOOLSTR(!*(bool *)ptr));
2841 fprintf(f, "%d", *(int *)ptr);
2845 fprintf(f, "%c", *(char *)ptr);
2849 int val = *(int *)ptr;
2853 fprintf(f, "0%o", val);
2862 if ((char ***)ptr && *(char ***)ptr) {
2863 char **list = *(char ***)ptr;
2864 for (; *list; list++) {
2865 /* surround strings with whitespace in double quotes */
2866 if (*(list+1) == NULL) {
2867 /* last item, no extra separator */
2870 if ( strchr_m( *list, ' ' ) ) {
2871 fprintf(f, "\"%s\"%s", *list, list_sep);
2873 fprintf(f, "%s%s", *list, list_sep);
2881 if (*(char **)ptr) {
2882 fprintf(f, "%s", *(char **)ptr);
2891 * Check if two parameters are equal.
2894 static bool equal_parameter(parm_type type, void *ptr1, void *ptr2)
2899 return (*((bool *)ptr1) == *((bool *)ptr2));
2905 return (*((int *)ptr1) == *((int *)ptr2));
2908 return (*((char *)ptr1) == *((char *)ptr2));
2912 return str_list_equal(*(const char ***)ptr1, *(const char ***)ptr2);
2917 char *p1 = *(char **)ptr1, *p2 = *(char **)ptr2;
2922 return (p1 == p2 || strequal(p1, p2));
2931 * Process a new section (service).
2933 * At this stage all sections are services.
2934 * Later we'll have special sections that permit server parameters to be set.
2935 * Returns True on success, False on failure.
2938 static bool do_section(const char *pszSectionName, void *userdata)
2940 struct loadparm_context *lp_ctx = (struct loadparm_context *)userdata;
2942 bool isglobal = ((strwicmp(pszSectionName, GLOBAL_NAME) == 0) ||
2943 (strwicmp(pszSectionName, GLOBAL_NAME2) == 0));
2946 /* if we've just struck a global section, note the fact. */
2947 lp_ctx->bInGlobalSection = isglobal;
2949 /* check for multiple global sections */
2950 if (lp_ctx->bInGlobalSection) {
2951 DEBUG(4, ("Processing section \"[%s]\"\n", pszSectionName));
2955 /* if we have a current service, tidy it up before moving on */
2958 if (lp_ctx->currentService != NULL)
2959 bRetval = lpcfg_service_ok(lp_ctx->currentService);
2961 /* if all is still well, move to the next record in the services array */
2963 /* We put this here to avoid an odd message order if messages are */
2964 /* issued by the post-processing of a previous section. */
2965 DEBUG(4, ("Processing section \"[%s]\"\n", pszSectionName));
2967 if ((lp_ctx->currentService = lpcfg_add_service(lp_ctx, lp_ctx->sDefault,
2970 DEBUG(0, ("Failed to add a new service\n"));
2980 * Determine if a particular base parameter is currently set to the default value.
2983 static bool is_default(struct loadparm_service *sDefault, int i)
2985 void *def_ptr = ((char *)sDefault) + parm_table[i].offset;
2986 if (!defaults_saved)
2988 switch (parm_table[i].type) {
2991 return str_list_equal((const char **)parm_table[i].def.lvalue,
2992 (const char **)def_ptr);
2995 return strequal(parm_table[i].def.svalue,
2999 return parm_table[i].def.bvalue ==
3006 return parm_table[i].def.ivalue ==
3015 *Display the contents of the global structure.
3018 static void dump_globals(struct loadparm_context *lp_ctx, FILE *f,
3022 struct parmlist_entry *data;
3024 fprintf(f, "# Global parameters\n[global]\n");
3026 for (i = 0; parm_table[i].label; i++)
3027 if (parm_table[i].p_class == P_GLOBAL &&
3028 (i == 0 || (parm_table[i].offset != parm_table[i - 1].offset))) {
3029 if (!show_defaults && (lp_ctx->flags[i] & FLAG_DEFAULT))
3031 fprintf(f, "\t%s = ", parm_table[i].label);
3032 print_parameter(&parm_table[i], lpcfg_parm_ptr(lp_ctx, NULL, &parm_table[i]), f);
3035 if (lp_ctx->globals->param_opt != NULL) {
3036 for (data = lp_ctx->globals->param_opt; data;
3037 data = data->next) {
3038 if (!show_defaults && (data->priority & FLAG_DEFAULT)) {
3041 fprintf(f, "\t%s = %s\n", data->key, data->value);
3048 * Display the contents of a single services record.
3051 static void dump_a_service(struct loadparm_service * pService, struct loadparm_service *sDefault, FILE * f,
3052 unsigned int *flags)
3055 struct parmlist_entry *data;
3057 if (pService != sDefault)
3058 fprintf(f, "\n[%s]\n", pService->szService);
3060 for (i = 0; parm_table[i].label; i++) {
3061 if (parm_table[i].p_class == P_LOCAL &&
3062 (*parm_table[i].label != '-') &&
3063 (i == 0 || (parm_table[i].offset != parm_table[i - 1].offset)))
3065 if (pService == sDefault) {
3066 if (flags && (flags[i] & FLAG_DEFAULT)) {
3069 if (defaults_saved) {
3070 if (is_default(sDefault, i)) {
3075 if (equal_parameter(parm_table[i].type,
3076 ((char *)pService) +
3077 parm_table[i].offset,
3078 ((char *)sDefault) +
3079 parm_table[i].offset))
3083 fprintf(f, "\t%s = ", parm_table[i].label);
3084 print_parameter(&parm_table[i],
3085 ((char *)pService) + parm_table[i].offset, f);
3089 if (pService->param_opt != NULL) {
3090 for (data = pService->param_opt; data; data = data->next) {
3091 fprintf(f, "\t%s = %s\n", data->key, data->value);
3096 bool lpcfg_dump_a_parameter(struct loadparm_context *lp_ctx,
3097 struct loadparm_service *service,
3098 const char *parm_name, FILE * f)
3100 struct parm_struct *parm;
3103 parm = lpcfg_parm_struct(lp_ctx, parm_name);
3108 ptr = lpcfg_parm_ptr(lp_ctx, service,parm);
3110 print_parameter(parm, ptr, f);
3116 * Return info about the next parameter in a service.
3117 * snum==-1 gives the globals.
3118 * Return NULL when out of parameters.
3122 struct parm_struct *lpcfg_next_parameter(struct loadparm_context *lp_ctx, int snum, int *i,
3126 /* do the globals */
3127 for (; parm_table[*i].label; (*i)++) {
3128 if ((*parm_table[*i].label == '-'))
3132 && (parm_table[*i].offset ==
3133 parm_table[(*i) - 1].offset)
3134 && (parm_table[*i].p_class ==
3135 parm_table[(*i) - 1].p_class))
3138 return &parm_table[(*i)++];
3141 struct loadparm_service *pService = lp_ctx->services[snum];
3143 for (; parm_table[*i].label; (*i)++) {
3144 if (parm_table[*i].p_class == P_LOCAL &&
3145 (*parm_table[*i].label != '-') &&
3147 (parm_table[*i].offset !=
3148 parm_table[(*i) - 1].offset)))
3150 if (allparameters ||
3151 !equal_parameter(parm_table[*i].type,
3152 ((char *)pService) +
3153 parm_table[*i].offset,
3154 ((char *)lp_ctx->sDefault) +
3155 parm_table[*i].offset))
3157 return &parm_table[(*i)++];
3168 * Auto-load some home services.
3170 static void lpcfg_add_auto_services(struct loadparm_context *lp_ctx,
3178 * Unload unused services.
3181 void lpcfg_killunused(struct loadparm_context *lp_ctx,
3182 struct smbsrv_connection *smb,
3183 bool (*snumused) (struct smbsrv_connection *, int))
3186 for (i = 0; i < lp_ctx->iNumServices; i++) {
3187 if (lp_ctx->services[i] == NULL)
3190 if (!snumused || !snumused(smb, i)) {
3191 talloc_free(lp_ctx->services[i]);
3192 lp_ctx->services[i] = NULL;
3198 static int lpcfg_destructor(struct loadparm_context *lp_ctx)
3200 struct parmlist_entry *data;
3202 if (lp_ctx->refuse_free) {
3203 /* someone is trying to free the
3204 global_loadparm_context.
3205 We can't allow that. */
3209 if (lp_ctx->globals->param_opt != NULL) {
3210 struct parmlist_entry *next;
3211 for (data = lp_ctx->globals->param_opt; data; data=next) {
3213 if (data->priority & FLAG_CMDLINE) continue;
3214 DLIST_REMOVE(lp_ctx->globals->param_opt, data);
3223 * Initialise the global parameter structure.
3225 * Note that most callers should use loadparm_init_global() instead
3227 struct loadparm_context *loadparm_init(TALLOC_CTX *mem_ctx)
3231 struct loadparm_context *lp_ctx;
3232 struct parmlist_entry *parm;
3235 lp_ctx = talloc_zero(mem_ctx, struct loadparm_context);
3239 talloc_set_destructor(lp_ctx, lpcfg_destructor);
3240 lp_ctx->bInGlobalSection = true;
3241 lp_ctx->globals = talloc_zero(lp_ctx, struct loadparm_global);
3242 lp_ctx->sDefault = talloc_zero(lp_ctx, struct loadparm_service);
3244 lp_ctx->sDefault->iMaxPrintJobs = 1000;
3245 lp_ctx->sDefault->bAvailable = true;
3246 lp_ctx->sDefault->bBrowseable = true;
3247 lp_ctx->sDefault->bRead_only = true;
3248 lp_ctx->sDefault->bMap_archive = true;
3249 lp_ctx->sDefault->iStrictLocking = true;
3250 lp_ctx->sDefault->bOpLocks = true;
3251 lp_ctx->sDefault->iCreate_mask = 0744;
3252 lp_ctx->sDefault->iCreate_force_mode = 0000;
3253 lp_ctx->sDefault->iDir_mask = 0755;
3254 lp_ctx->sDefault->iDir_force_mode = 0000;
3256 DEBUG(3, ("Initialising global parameters\n"));
3258 for (i = 0; parm_table[i].label; i++) {
3259 if ((parm_table[i].type == P_STRING ||
3260 parm_table[i].type == P_USTRING) &&
3261 !(lp_ctx->flags[i] & FLAG_CMDLINE)) {
3263 if (parm_table[i].p_class == P_LOCAL) {
3264 r = (char **)(((char *)lp_ctx->sDefault) + parm_table[i].offset);
3266 r = (char **)(((char *)lp_ctx->globals) + parm_table[i].offset);
3268 *r = talloc_strdup(lp_ctx, "");
3272 logfile = talloc_asprintf(lp_ctx, "%s/log.samba", dyn_LOGFILEBASE);
3273 lpcfg_do_global_parameter(lp_ctx, "log file", logfile);
3274 talloc_free(logfile);
3276 lpcfg_do_global_parameter(lp_ctx, "log level", "0");
3278 lpcfg_do_global_parameter(lp_ctx, "share backend", "classic");
3280 lpcfg_do_global_parameter(lp_ctx, "server role", "auto");
3281 lpcfg_do_global_parameter(lp_ctx, "domain logons", "No");
3282 lpcfg_do_global_parameter(lp_ctx, "domain master", "Auto");
3284 /* options that can be set on the command line must be initialised via
3285 the slower lpcfg_do_global_parameter() to ensure that FLAG_CMDLINE is obeyed */
3287 lpcfg_do_global_parameter(lp_ctx, "socket options", "TCP_NODELAY");
3289 lpcfg_do_global_parameter(lp_ctx, "workgroup", DEFAULT_WORKGROUP);
3290 myname = get_myname(lp_ctx);
3291 lpcfg_do_global_parameter(lp_ctx, "netbios name", myname);
3292 talloc_free(myname);
3293 lpcfg_do_global_parameter(lp_ctx, "name resolve order", "wins host bcast");
3295 lpcfg_do_global_parameter(lp_ctx, "fstype", "NTFS");
3297 lpcfg_do_global_parameter(lp_ctx, "ntvfs handler", "unixuid default");
3298 lpcfg_do_global_parameter(lp_ctx, "max connections", "-1");
3300 lpcfg_do_global_parameter(lp_ctx, "dcerpc endpoint servers", "epmapper wkssvc rpcecho samr netlogon lsarpc spoolss drsuapi dssetup unixinfo browser eventlog6 backupkey dnsserver");
3301 lpcfg_do_global_parameter(lp_ctx, "server services", "s3fs rpc nbt wrepl ldap cldap kdc drepl winbind ntp_signd kcc dnsupdate");
3302 lpcfg_do_global_parameter(lp_ctx, "ntptr providor", "simple_ldb");
3303 /* the winbind method for domain controllers is for both RODC
3304 auth forwarding and for trusted domains */
3305 lpcfg_do_global_parameter(lp_ctx, "private dir", dyn_PRIVATE_DIR);
3306 lpcfg_do_global_parameter(lp_ctx, "registry:HKEY_LOCAL_MACHINE", "hklm.ldb");
3308 /* This hive should be dynamically generated by Samba using
3309 data from the sam, but for the moment leave it in a tdb to
3310 keep regedt32 from popping up an annoying dialog. */
3311 lpcfg_do_global_parameter(lp_ctx, "registry:HKEY_USERS", "hku.ldb");
3313 /* using UTF8 by default allows us to support all chars */
3314 lpcfg_do_global_parameter(lp_ctx, "unix charset", "UTF8");
3316 /* Use codepage 850 as a default for the dos character set */
3317 lpcfg_do_global_parameter(lp_ctx, "dos charset", "CP850");
3320 * Allow the default PASSWD_CHAT to be overridden in local.h.
3322 lpcfg_do_global_parameter(lp_ctx, "passwd chat", DEFAULT_PASSWD_CHAT);
3324 lpcfg_do_global_parameter(lp_ctx, "pid directory", dyn_PIDDIR);
3325 lpcfg_do_global_parameter(lp_ctx, "lock dir", dyn_LOCKDIR);
3326 lpcfg_do_global_parameter(lp_ctx, "state directory", dyn_STATEDIR);
3327 lpcfg_do_global_parameter(lp_ctx, "cache directory", dyn_CACHEDIR);
3328 lpcfg_do_global_parameter(lp_ctx, "ncalrpc dir", dyn_NCALRPCDIR);
3330 lpcfg_do_global_parameter(lp_ctx, "socket address", "");
3331 lpcfg_do_global_parameter_var(lp_ctx, "server string",
3332 "Samba %s", SAMBA_VERSION_STRING);
3334 lpcfg_do_global_parameter(lp_ctx, "password server", "*");
3336 lpcfg_do_global_parameter(lp_ctx, "max mux", "50");
3337 lpcfg_do_global_parameter(lp_ctx, "max xmit", "12288");
3338 lpcfg_do_global_parameter(lp_ctx, "host msdfs", "true");
3340 lpcfg_do_global_parameter(lp_ctx, "password level", "0");
3341 lpcfg_do_global_parameter(lp_ctx, "LargeReadwrite", "True");
3342 lpcfg_do_global_parameter(lp_ctx, "server min protocol", "CORE");
3343 lpcfg_do_global_parameter(lp_ctx, "server max protocol", "NT1");
3344 lpcfg_do_global_parameter(lp_ctx, "client min protocol", "CORE");
3345 lpcfg_do_global_parameter(lp_ctx, "client max protocol", "NT1");
3346 lpcfg_do_global_parameter(lp_ctx, "security", "AUTO");
3347 lpcfg_do_global_parameter(lp_ctx, "paranoid server security", "True");
3348 lpcfg_do_global_parameter(lp_ctx, "EncryptPasswords", "True");
3349 lpcfg_do_global_parameter(lp_ctx, "ReadRaw", "True");
3350 lpcfg_do_global_parameter(lp_ctx, "WriteRaw", "True");
3351 lpcfg_do_global_parameter(lp_ctx, "NullPasswords", "False");
3352 lpcfg_do_global_parameter(lp_ctx, "ObeyPamRestrictions", "False");
3354 lpcfg_do_global_parameter(lp_ctx, "TimeServer", "False");
3355 lpcfg_do_global_parameter(lp_ctx, "BindInterfacesOnly", "False");
3356 lpcfg_do_global_parameter(lp_ctx, "Unicode", "True");
3357 lpcfg_do_global_parameter(lp_ctx, "ClientLanManAuth", "False");
3358 lpcfg_do_global_parameter(lp_ctx, "ClientNTLMv2Auth", "True");
3359 lpcfg_do_global_parameter(lp_ctx, "LanmanAuth", "False");
3360 lpcfg_do_global_parameter(lp_ctx, "NTLMAuth", "True");
3361 lpcfg_do_global_parameter(lp_ctx, "client use spnego principal", "False");
3363 lpcfg_do_global_parameter(lp_ctx, "UnixExtensions", "False");
3365 lpcfg_do_global_parameter(lp_ctx, "PreferredMaster", "Auto");
3366 lpcfg_do_global_parameter(lp_ctx, "LocalMaster", "True");
3368 lpcfg_do_global_parameter(lp_ctx, "wins support", "False");
3369 lpcfg_do_global_parameter(lp_ctx, "dns proxy", "True");
3371 lpcfg_do_global_parameter(lp_ctx, "winbind separator", "\\");
3372 lpcfg_do_global_parameter(lp_ctx, "winbind sealed pipes", "True");
3373 lpcfg_do_global_parameter(lp_ctx, "winbindd socket directory", dyn_WINBINDD_SOCKET_DIR);
3374 #if _SAMBA_BUILD_ >= 4
3375 lpcfg_do_global_parameter(lp_ctx, "winbindd privileged socket directory", dyn_WINBINDD_PRIVILEGED_SOCKET_DIR);
3376 lpcfg_do_global_parameter(lp_ctx, "ntp signd socket directory", dyn_NTP_SIGND_SOCKET_DIR);
3377 lpcfg_do_global_parameter_var(lp_ctx, "dns update command", "%s/samba_dnsupdate", dyn_SCRIPTSBINDIR);
3378 lpcfg_do_global_parameter_var(lp_ctx, "spn update command", "%s/samba_spnupdate", dyn_SCRIPTSBINDIR);
3379 lpcfg_do_global_parameter_var(lp_ctx, "samba kcc command",
3380 "%s/samba_kcc", dyn_SCRIPTSBINDIR);
3382 lpcfg_do_global_parameter(lp_ctx, "template shell", "/bin/false");
3383 lpcfg_do_global_parameter(lp_ctx, "template homedir", "/home/%WORKGROUP%/%ACCOUNTNAME%");
3385 lpcfg_do_global_parameter(lp_ctx, "client signing", "default");
3386 lpcfg_do_global_parameter(lp_ctx, "server signing", "default");
3388 lpcfg_do_global_parameter(lp_ctx, "use spnego", "True");
3390 lpcfg_do_global_parameter(lp_ctx, "use mmap", "True");
3392 lpcfg_do_global_parameter(lp_ctx, "smb ports", "445 139");
3393 lpcfg_do_global_parameter(lp_ctx, "nbt port", "137");
3394 lpcfg_do_global_parameter(lp_ctx, "dgram port", "138");
3395 lpcfg_do_global_parameter(lp_ctx, "cldap port", "389");
3396 lpcfg_do_global_parameter(lp_ctx, "krb5 port", "88");
3397 lpcfg_do_global_parameter(lp_ctx, "kpasswd port", "464");
3398 lpcfg_do_global_parameter(lp_ctx, "web port", "901");
3400 lpcfg_do_global_parameter(lp_ctx, "nt status support", "True");
3402 lpcfg_do_global_parameter(lp_ctx, "max wins ttl", "518400"); /* 6 days */
3403 lpcfg_do_global_parameter(lp_ctx, "min wins ttl", "10");
3405 lpcfg_do_global_parameter(lp_ctx, "tls enabled", "True");
3406 lpcfg_do_global_parameter(lp_ctx, "tls keyfile", "tls/key.pem");
3407 lpcfg_do_global_parameter(lp_ctx, "tls certfile", "tls/cert.pem");
3408 lpcfg_do_global_parameter(lp_ctx, "tls cafile", "tls/ca.pem");
3409 lpcfg_do_global_parameter(lp_ctx, "prefork children:smb", "4");
3411 lpcfg_do_global_parameter(lp_ctx, "rndc command", "/usr/sbin/rndc");
3412 lpcfg_do_global_parameter(lp_ctx, "nsupdate command", "/usr/bin/nsupdate -g");
3414 lpcfg_do_global_parameter(lp_ctx, "allow dns updates", "False");
3415 lpcfg_do_global_parameter(lp_ctx, "dns recursive queries", "False");
3416 lpcfg_do_global_parameter(lp_ctx, "dns forwarder", "");
3418 for (i = 0; parm_table[i].label; i++) {
3419 if (!(lp_ctx->flags[i] & FLAG_CMDLINE)) {
3420 lp_ctx->flags[i] |= FLAG_DEFAULT;
3424 for (parm=lp_ctx->globals->param_opt; parm; parm=parm->next) {
3425 if (!(parm->priority & FLAG_CMDLINE)) {
3426 parm->priority |= FLAG_DEFAULT;
3434 * Initialise the global parameter structure.
3436 struct loadparm_context *loadparm_init_global(bool load_default)
3438 if (global_loadparm_context == NULL) {
3439 global_loadparm_context = loadparm_init(NULL);
3441 if (global_loadparm_context == NULL) {
3444 global_loadparm_context->global = true;
3445 if (load_default && !global_loadparm_context->loaded) {
3446 lpcfg_load_default(global_loadparm_context);
3448 global_loadparm_context->refuse_free = true;
3449 return global_loadparm_context;
3453 * Initialise the global parameter structure.
3455 struct loadparm_context *loadparm_init_s3(TALLOC_CTX *mem_ctx,
3456 const struct loadparm_s3_helpers *s3_fns)
3458 struct loadparm_context *loadparm_context = talloc_zero(mem_ctx, struct loadparm_context);
3459 if (!loadparm_context) {
3462 loadparm_context->s3_fns = s3_fns;
3463 return loadparm_context;
3466 const char *lpcfg_configfile(struct loadparm_context *lp_ctx)
3468 return lp_ctx->szConfigFile;
3471 const char *lp_default_path(void)
3473 if (getenv("SMB_CONF_PATH"))
3474 return getenv("SMB_CONF_PATH");
3476 return dyn_CONFIGFILE;
3480 * Update the internal state of a loadparm context after settings
3483 static bool lpcfg_update(struct loadparm_context *lp_ctx)
3485 struct debug_settings settings;
3486 lpcfg_add_auto_services(lp_ctx, lpcfg_auto_services(lp_ctx));
3488 if (!lp_ctx->globals->szWINSservers && lp_ctx->globals->bWINSsupport) {
3489 lpcfg_do_global_parameter(lp_ctx, "wins server", "127.0.0.1");
3492 if (!lp_ctx->global) {
3496 panic_action = lp_ctx->globals->panic_action;
3498 reload_charcnv(lp_ctx);
3500 ZERO_STRUCT(settings);
3501 /* Add any more debug-related smb.conf parameters created in
3503 settings.timestamp_logs = true;
3504 debug_set_settings(&settings);
3506 /* FIXME: This is a bit of a hack, but we can't use a global, since
3507 * not everything that uses lp also uses the socket library */
3508 if (lpcfg_parm_bool(lp_ctx, NULL, "socket", "testnonblock", false)) {
3509 setenv("SOCKET_TESTNONBLOCK", "1", 1);
3511 unsetenv("SOCKET_TESTNONBLOCK");
3517 bool lpcfg_load_default(struct loadparm_context *lp_ctx)
3521 path = lp_default_path();
3523 if (!file_exist(path)) {
3524 /* We allow the default smb.conf file to not exist,
3525 * basically the equivalent of an empty file. */
3526 return lpcfg_update(lp_ctx);
3529 return lpcfg_load(lp_ctx, path);
3533 * Load the services array from the services file.
3535 * Return True on success, False on failure.
3537 bool lpcfg_load(struct loadparm_context *lp_ctx, const char *filename)
3542 filename = talloc_strdup(lp_ctx, filename);
3544 lp_ctx->szConfigFile = filename;
3546 if (lp_ctx->s3_fns) {
3547 return lp_ctx->s3_fns->load(filename);
3550 lp_ctx->bInGlobalSection = true;
3551 n2 = standard_sub_basic(lp_ctx, lp_ctx->szConfigFile);
3552 DEBUG(2, ("lpcfg_load: refreshing parameters from %s\n", n2));
3554 add_to_file_list(lp_ctx, lp_ctx->szConfigFile, n2);
3556 /* We get sections first, so have to start 'behind' to make up */
3557 lp_ctx->currentService = NULL;
3558 bRetval = pm_process(n2, do_section, do_parameter, lp_ctx);
3560 /* finish up the last section */
3561 DEBUG(4, ("pm_process() returned %s\n", BOOLSTR(bRetval)));
3563 if (lp_ctx->currentService != NULL)
3564 bRetval = lpcfg_service_ok(lp_ctx->currentService);
3566 bRetval = bRetval && lpcfg_update(lp_ctx);
3568 /* we do this unconditionally, so that it happens even
3569 for a missing smb.conf */
3570 reload_charcnv(lp_ctx);
3572 if (bRetval == true) {
3573 /* set this up so that any child python tasks will
3574 find the right smb.conf */
3575 setenv("SMB_CONF_PATH", filename, 1);
3577 /* set the context used by the lp_*() function
3579 global_loadparm_context = lp_ctx;
3580 lp_ctx->loaded = true;
3587 * Return the max number of services.
3590 int lpcfg_numservices(struct loadparm_context *lp_ctx)
3592 if (lp_ctx->s3_fns) {
3593 return lp_ctx->s3_fns->get_numservices();
3596 return lp_ctx->iNumServices;
3600 * Display the contents of the services array in human-readable form.
3603 void lpcfg_dump(struct loadparm_context *lp_ctx, FILE *f, bool show_defaults,
3608 if (lp_ctx->s3_fns) {
3609 lp_ctx->s3_fns->dump(f, show_defaults, maxtoprint);
3613 defaults_saved = !show_defaults;
3615 dump_globals(lp_ctx, f, show_defaults);
3617 dump_a_service(lp_ctx->sDefault, lp_ctx->sDefault, f, lp_ctx->flags);
3619 for (iService = 0; iService < maxtoprint; iService++)
3620 lpcfg_dump_one(f, show_defaults, lp_ctx->services[iService], lp_ctx->sDefault);
3624 * Display the contents of one service in human-readable form.
3626 void lpcfg_dump_one(FILE *f, bool show_defaults, struct loadparm_service *service, struct loadparm_service *sDefault)
3628 if (service != NULL) {
3629 if (service->szService[0] == '\0')
3631 dump_a_service(service, sDefault, f, NULL);
3635 struct loadparm_service *lpcfg_servicebynum(struct loadparm_context *lp_ctx,
3638 if (lp_ctx->s3_fns) {
3639 return lp_ctx->s3_fns->get_servicebynum(snum);
3642 return lp_ctx->services[snum];
3645 struct loadparm_service *lpcfg_service(struct loadparm_context *lp_ctx,
3646 const char *service_name)
3651 if (lp_ctx->s3_fns) {
3652 return lp_ctx->s3_fns->get_service(service_name);
3655 for (iService = lp_ctx->iNumServices - 1; iService >= 0; iService--) {
3656 if (lp_ctx->services[iService] &&
3657 lp_ctx->services[iService]->szService) {
3659 * The substitution here is used to support %U is
3662 serviceName = standard_sub_basic(
3663 lp_ctx->services[iService],
3664 lp_ctx->services[iService]->szService);
3665 if (strequal(serviceName, service_name)) {
3666 talloc_free(serviceName);
3667 return lp_ctx->services[iService];
3669 talloc_free(serviceName);
3673 DEBUG(7,("lpcfg_servicenumber: couldn't find %s\n", service_name));
3677 const char *lpcfg_servicename(const struct loadparm_service *service)
3679 return lp_string((const char *)service->szService);
3683 * A useful volume label function.
3685 const char *lpcfg_volume_label(struct loadparm_service *service, struct loadparm_service *sDefault)
3688 ret = lp_string((const char *)((service != NULL && service->volume != NULL) ?
3689 service->volume : sDefault->volume));
3691 return lpcfg_servicename(service);
3696 * If we are PDC then prefer us as DMB
3698 const char *lpcfg_printername(struct loadparm_service *service, struct loadparm_service *sDefault)
3701 ret = lp_string((const char *)((service != NULL && service->szPrintername != NULL) ?
3702 service->szPrintername : sDefault->szPrintername));
3703 if (ret == NULL || (ret != NULL && *ret == '\0'))
3704 ret = lpcfg_servicename(service);
3711 * Return the max print jobs per queue.
3713 int lpcfg_maxprintjobs(struct loadparm_service *service, struct loadparm_service *sDefault)
3715 int maxjobs = (service != NULL) ? service->iMaxPrintJobs : sDefault->iMaxPrintJobs;
3716 if (maxjobs <= 0 || maxjobs >= PRINT_MAX_JOBID)
3717 maxjobs = PRINT_MAX_JOBID - 1;
3722 struct smb_iconv_handle *lpcfg_iconv_handle(struct loadparm_context *lp_ctx)
3724 if (lp_ctx == NULL) {
3725 return get_iconv_handle();
3727 return lp_ctx->iconv_handle;
3730 _PUBLIC_ void reload_charcnv(struct loadparm_context *lp_ctx)
3732 struct smb_iconv_handle *old_ic = lp_ctx->iconv_handle;
3733 if (!lp_ctx->global) {
3737 if (old_ic == NULL) {
3738 old_ic = global_iconv_handle;
3740 lp_ctx->iconv_handle = smb_iconv_handle_reinit_lp(lp_ctx, lp_ctx, old_ic);
3741 global_iconv_handle = lp_ctx->iconv_handle;
3744 _PUBLIC_ char *lpcfg_tls_keyfile(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx)
3746 return lpcfg_private_path(mem_ctx, lp_ctx, lp_ctx->globals->tls_keyfile);
3749 _PUBLIC_ char *lpcfg_tls_certfile(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx)
3751 return lpcfg_private_path(mem_ctx, lp_ctx, lp_ctx->globals->tls_certfile);
3754 _PUBLIC_ char *lpcfg_tls_cafile(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx)
3756 return lpcfg_private_path(mem_ctx, lp_ctx, lp_ctx->globals->tls_cafile);
3759 _PUBLIC_ char *lpcfg_tls_crlfile(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx)
3761 return lpcfg_private_path(mem_ctx, lp_ctx, lp_ctx->globals->tls_crlfile);
3764 _PUBLIC_ char *lpcfg_tls_dhpfile(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx)
3766 return lpcfg_private_path(mem_ctx, lp_ctx, lp_ctx->globals->tls_dhpfile);
3769 struct gensec_settings *lpcfg_gensec_settings(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx)
3771 struct gensec_settings *settings = talloc_zero(mem_ctx, struct gensec_settings);
3772 if (settings == NULL)
3774 SMB_ASSERT(lp_ctx != NULL);
3775 settings->lp_ctx = talloc_reference(settings, lp_ctx);
3776 settings->target_hostname = lpcfg_parm_string(lp_ctx, NULL, "gensec", "target_hostname");
3780 int lpcfg_server_role(struct loadparm_context *lp_ctx)
3782 if (lp_ctx->s3_fns) {
3783 return lp_ctx->s3_fns->server_role();
3786 return lp_find_server_role(lp_ctx->globals->server_role,
3787 lp_ctx->globals->security,
3788 lp_ctx->globals->domain_logons,
3789 (lp_ctx->globals->domain_master == true) ||
3790 (lp_ctx->globals->domain_master == Auto));
3793 int lpcfg_security(struct loadparm_context *lp_ctx)
3795 if (lp_ctx->s3_fns) {
3796 return lp_ctx->s3_fns->security();
3799 return lp_find_security(lp_ctx->globals->server_role,
3800 lp_ctx->globals->security);