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
15 This program is free software; you can redistribute it and/or modify
16 it under the terms of the GNU General Public License as published by
17 the Free Software Foundation; either version 3 of the License, or
18 (at your option) any later version.
20 This program is distributed in the hope that it will be useful,
21 but WITHOUT ANY WARRANTY; without even the implied warranty of
22 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 GNU General Public License for more details.
25 You should have received a copy of the GNU General Public License
26 along with this program. If not, see <http://www.gnu.org/licenses/>.
32 * This module provides suitable callback functions for the params
33 * module. It builds the internal table of service details which is
34 * then used by the rest of the server.
38 * 1) add it to the global or service structure definition
39 * 2) add it to the parm_table
40 * 3) add it to the list of available functions (eg: using FN_GLOBAL_STRING())
41 * 4) If it's a global then initialise it in init_globals. If a local
42 * (ie. service) parameter then initialise it in the sDefault structure
46 * The configuration file is processed sequentially for speed. It is NOT
47 * accessed randomly as happens in 'real' Windows. For this reason, there
48 * is a fair bit of sequence-dependent code here - ie., code which assumes
49 * that certain things happen before others. In particular, the code which
50 * happens at the boundary between sections is delicately poised, so be
57 #include "dynconfig/dynconfig.h"
58 #include "system/time.h"
59 #include "system/locale.h"
60 #include "system/network.h" /* needed for TCP_NODELAY */
61 #include "../lib/util/dlinklist.h"
62 #include "lib/param/param.h"
63 #include "lib/param/loadparm.h"
64 #include "auth/gensec/gensec.h"
66 #include "lib/util/bitmap.h"
67 #include "libcli/smb/smb_constants.h"
69 #define standard_sub_basic talloc_strdup
71 static bool do_parameter(const char *, const char *, void *);
72 static bool defaults_saved = false;
74 #define LOADPARM_EXTRA_GLOBALS \
75 struct parmlist_entry *param_opt; \
86 #include "param_global.h"
88 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
91 /* prototypes for the special type handlers */
92 static bool handle_include(struct loadparm_context *lp_ctx, int unused,
93 const char *pszParmValue, char **ptr);
94 static bool handle_realm(struct loadparm_context *lp_ctx, int unused,
95 const char *pszParmValue, char **ptr);
96 static bool handle_copy(struct loadparm_context *lp_ctx, int unused,
97 const char *pszParmValue, char **ptr);
98 static bool handle_debuglevel(struct loadparm_context *lp_ctx, int unused,
99 const char *pszParmValue, char **ptr);
100 static bool handle_logfile(struct loadparm_context *lp_ctx, int unused,
101 const char *pszParmValue, char **ptr);
103 static const struct enum_list enum_protocol[] = {
104 {PROTOCOL_SMB2_02, "SMB2"},
105 {PROTOCOL_SMB2_02, "SMB2_02"},
106 {PROTOCOL_NT1, "NT1"},
107 {PROTOCOL_LANMAN2, "LANMAN2"},
108 {PROTOCOL_LANMAN1, "LANMAN1"},
109 {PROTOCOL_CORE, "CORE"},
110 {PROTOCOL_COREPLUS, "COREPLUS"},
111 {PROTOCOL_COREPLUS, "CORE+"},
115 static const struct enum_list enum_security[] = {
116 {SEC_SHARE, "SHARE"},
122 static const struct enum_list enum_bool_auto[] = {
133 /* Client-side offline caching policy types */
135 static const struct enum_list enum_csc_policy[] = {
136 {CSC_POLICY_MANUAL, "manual"},
137 {CSC_POLICY_DOCUMENTS, "documents"},
138 {CSC_POLICY_PROGRAMS, "programs"},
139 {CSC_POLICY_DISABLE, "disable"},
143 /* SMB signing types. */
144 static const struct enum_list enum_smb_signing_vals[] = {
145 {SMB_SIGNING_DEFAULT, "default"},
146 {SMB_SIGNING_OFF, "No"},
147 {SMB_SIGNING_OFF, "False"},
148 {SMB_SIGNING_OFF, "0"},
149 {SMB_SIGNING_OFF, "Off"},
150 {SMB_SIGNING_OFF, "disabled"},
151 {SMB_SIGNING_IF_REQUIRED, "if_required"},
152 {SMB_SIGNING_IF_REQUIRED, "Yes"},
153 {SMB_SIGNING_IF_REQUIRED, "True"},
154 {SMB_SIGNING_IF_REQUIRED, "1"},
155 {SMB_SIGNING_IF_REQUIRED, "On"},
156 {SMB_SIGNING_IF_REQUIRED, "enabled"},
157 {SMB_SIGNING_IF_REQUIRED, "auto"},
158 {SMB_SIGNING_REQUIRED, "required"},
159 {SMB_SIGNING_REQUIRED, "mandatory"},
160 {SMB_SIGNING_REQUIRED, "force"},
161 {SMB_SIGNING_REQUIRED, "forced"},
162 {SMB_SIGNING_REQUIRED, "enforced"},
166 static const struct enum_list enum_server_role[] = {
167 {ROLE_STANDALONE, "standalone"},
168 {ROLE_DOMAIN_MEMBER, "member server"},
169 {ROLE_DOMAIN_MEMBER, "member"},
170 {ROLE_DOMAIN_CONTROLLER, "domain controller"},
171 {ROLE_DOMAIN_CONTROLLER, "dc"},
175 #define GLOBAL_VAR(name) offsetof(struct loadparm_global, name)
176 #define LOCAL_VAR(name) offsetof(struct loadparm_service, name)
178 static struct parm_struct parm_table[] = {
180 .label = "server role",
183 .offset = GLOBAL_VAR(server_role),
185 .enum_list = enum_server_role
188 .label = "dos charset",
191 .offset = GLOBAL_VAR(dos_charset),
196 .label = "unix charset",
199 .offset = GLOBAL_VAR(unix_charset),
204 .label = "ncalrpc dir",
207 .offset = GLOBAL_VAR(ncalrpc_dir),
215 .offset = LOCAL_VAR(comment),
223 .offset = LOCAL_VAR(szPath),
228 .label = "directory",
231 .offset = LOCAL_VAR(szPath),
236 .label = "workgroup",
239 .offset = GLOBAL_VAR(szWorkgroup),
247 .offset = GLOBAL_VAR(szRealm),
248 .special = handle_realm,
252 .label = "netbios name",
255 .offset = GLOBAL_VAR(szNetbiosName),
260 .label = "netbios aliases",
263 .offset = GLOBAL_VAR(szNetbiosAliases),
268 .label = "netbios scope",
271 .offset = GLOBAL_VAR(szNetbiosScope),
276 .label = "server string",
279 .offset = GLOBAL_VAR(szServerString),
284 .label = "interfaces",
287 .offset = GLOBAL_VAR(szInterfaces),
292 .label = "bind interfaces only",
295 .offset = GLOBAL_VAR(bBindInterfacesOnly),
300 .label = "ntvfs handler",
303 .offset = LOCAL_VAR(ntvfs_handler),
308 .label = "ntptr providor",
311 .offset = GLOBAL_VAR(ntptr_providor),
316 .label = "passdb backend",
319 .offset = GLOBAL_VAR(passdb_backend),
324 .label = "dcerpc endpoint servers",
327 .offset = GLOBAL_VAR(dcerpc_ep_servers),
332 .label = "server services",
335 .offset = GLOBAL_VAR(server_services),
344 .offset = GLOBAL_VAR(security),
346 .enum_list = enum_security
349 .label = "encrypt passwords",
352 .offset = GLOBAL_VAR(bEncryptPasswords),
357 .label = "null passwords",
360 .offset = GLOBAL_VAR(bNullPasswords),
365 .label = "obey pam restrictions",
368 .offset = GLOBAL_VAR(bObeyPamRestrictions),
373 .label = "password server",
376 .offset = GLOBAL_VAR(szPasswordServers),
381 .label = "private dir",
384 .offset = GLOBAL_VAR(szPrivateDir),
389 .label = "passwd chat",
392 .offset = GLOBAL_VAR(szPasswdChat),
397 .label = "password level",
400 .offset = GLOBAL_VAR(pwordlevel),
405 .label = "lanman auth",
408 .offset = GLOBAL_VAR(bLanmanAuth),
413 .label = "ntlm auth",
416 .offset = GLOBAL_VAR(bNTLMAuth),
421 .label = "client NTLMv2 auth",
424 .offset = GLOBAL_VAR(bClientNTLMv2Auth),
429 .label = "client lanman auth",
432 .offset = GLOBAL_VAR(bClientLanManAuth),
437 .label = "client plaintext auth",
440 .offset = GLOBAL_VAR(bClientPlaintextAuth),
445 .label = "client use spnego principal",
448 .offset = GLOBAL_VAR(client_use_spnego_principal),
454 .label = "read only",
457 .offset = LOCAL_VAR(bRead_only),
463 .label = "create mask",
466 .offset = LOCAL_VAR(iCreate_mask),
471 .label = "force create mode",
474 .offset = LOCAL_VAR(iCreate_force_mode),
479 .label = "directory mask",
482 .offset = LOCAL_VAR(iDir_mask),
487 .label = "force directory mode",
490 .offset = LOCAL_VAR(iDir_force_mode),
496 .label = "hosts allow",
499 .offset = LOCAL_VAR(szHostsallow),
504 .label = "hosts deny",
507 .offset = LOCAL_VAR(szHostsdeny),
513 .label = "log level",
516 .offset = GLOBAL_VAR(loglevel),
517 .special = handle_debuglevel,
521 .label = "debuglevel",
524 .offset = GLOBAL_VAR(loglevel),
525 .special = handle_debuglevel,
532 .offset = GLOBAL_VAR(logfile),
533 .special = handle_logfile,
538 .label = "smb ports",
541 .offset = GLOBAL_VAR(smb_ports),
549 .offset = GLOBAL_VAR(nbt_port),
554 .label = "dgram port",
557 .offset = GLOBAL_VAR(dgram_port),
562 .label = "cldap port",
565 .offset = GLOBAL_VAR(cldap_port),
570 .label = "krb5 port",
573 .offset = GLOBAL_VAR(krb5_port),
578 .label = "kpasswd port",
581 .offset = GLOBAL_VAR(kpasswd_port),
589 .offset = GLOBAL_VAR(web_port),
594 .label = "tls enabled",
597 .offset = GLOBAL_VAR(tls_enabled),
602 .label = "tls keyfile",
605 .offset = GLOBAL_VAR(tls_keyfile),
610 .label = "tls certfile",
613 .offset = GLOBAL_VAR(tls_certfile),
618 .label = "tls cafile",
621 .offset = GLOBAL_VAR(tls_cafile),
626 .label = "tls crlfile",
629 .offset = GLOBAL_VAR(tls_crlfile),
634 .label = "tls dh params file",
637 .offset = GLOBAL_VAR(tls_dhpfile),
642 .label = "large readwrite",
645 .offset = GLOBAL_VAR(bLargeReadwrite),
650 .label = "server max protocol",
653 .offset = GLOBAL_VAR(srv_maxprotocol),
655 .enum_list = enum_protocol
658 .label = "server min protocol",
661 .offset = GLOBAL_VAR(srv_minprotocol),
663 .enum_list = enum_protocol
666 .label = "client max protocol",
669 .offset = GLOBAL_VAR(cli_maxprotocol),
671 .enum_list = enum_protocol
674 .label = "client min protocol",
677 .offset = GLOBAL_VAR(cli_minprotocol),
679 .enum_list = enum_protocol
685 .offset = GLOBAL_VAR(bUnicode),
693 .offset = GLOBAL_VAR(bReadRaw),
698 .label = "write raw",
701 .offset = GLOBAL_VAR(bWriteRaw),
706 .label = "disable netbios",
709 .offset = GLOBAL_VAR(bDisableNetbios),
715 .label = "nt status support",
718 .offset = GLOBAL_VAR(bNTStatusSupport),
727 .offset = GLOBAL_VAR(max_mux),
735 .offset = GLOBAL_VAR(max_xmit),
741 .label = "name resolve order",
744 .offset = GLOBAL_VAR(szNameResolveOrder),
749 .label = "max wins ttl",
752 .offset = GLOBAL_VAR(max_wins_ttl),
757 .label = "min wins ttl",
760 .offset = GLOBAL_VAR(min_wins_ttl),
765 .label = "time server",
768 .offset = GLOBAL_VAR(bTimeServer),
773 .label = "unix extensions",
776 .offset = GLOBAL_VAR(bUnixExtensions),
781 .label = "use spnego",
784 .offset = GLOBAL_VAR(bUseSpnego),
789 .label = "server signing",
792 .offset = GLOBAL_VAR(server_signing),
794 .enum_list = enum_smb_signing_vals
797 .label = "client signing",
800 .offset = GLOBAL_VAR(client_signing),
802 .enum_list = enum_smb_signing_vals
805 .label = "rpc big endian",
808 .offset = GLOBAL_VAR(bRpcBigEndian),
814 .label = "max connections",
817 .offset = LOCAL_VAR(iMaxConnections),
822 .label = "paranoid server security",
825 .offset = GLOBAL_VAR(paranoid_server_security),
830 .label = "socket options",
833 .offset = GLOBAL_VAR(socket_options),
839 .label = "strict sync",
842 .offset = LOCAL_VAR(bStrictSync),
850 .offset = GLOBAL_VAR(bUseMmap),
853 .flags = FLAG_ADVANCED,
856 .label = "case insensitive filesystem",
859 .offset = LOCAL_VAR(bCIFileSystem),
865 .label = "max print jobs",
868 .offset = LOCAL_VAR(iMaxPrintJobs),
873 .label = "printable",
876 .offset = LOCAL_VAR(bPrint_ok),
884 .offset = LOCAL_VAR(bPrint_ok),
890 .label = "printer name",
893 .offset = LOCAL_VAR(szPrintername),
901 .offset = LOCAL_VAR(szPrintername),
907 .label = "map system",
910 .offset = LOCAL_VAR(bMap_system),
915 .label = "map hidden",
918 .offset = LOCAL_VAR(bMap_hidden),
923 .label = "map archive",
926 .offset = LOCAL_VAR(bMap_archive),
932 .label = "preferred master",
935 .offset = GLOBAL_VAR(bPreferredMaster),
937 .enum_list = enum_bool_auto
940 .label = "prefered master",
943 .offset = GLOBAL_VAR(bPreferredMaster),
945 .enum_list = enum_bool_auto
948 .label = "local master",
951 .offset = GLOBAL_VAR(bLocalMaster),
956 .label = "browseable",
959 .offset = LOCAL_VAR(bBrowseable),
964 .label = "browsable",
967 .offset = LOCAL_VAR(bBrowseable),
973 .label = "wins server",
976 .offset = GLOBAL_VAR(szWINSservers),
981 .label = "wins support",
984 .offset = GLOBAL_VAR(bWINSsupport),
989 .label = "dns proxy",
992 .offset = GLOBAL_VAR(bWINSdnsProxy),
997 .label = "wins hook",
1000 .offset = GLOBAL_VAR(szWINSHook),
1006 .label = "csc policy",
1009 .offset = LOCAL_VAR(iCSCPolicy),
1011 .enum_list = enum_csc_policy
1015 .label = "strict locking",
1018 .offset = LOCAL_VAR(iStrictLocking),
1026 .offset = LOCAL_VAR(bOpLocks),
1032 .label = "share backend",
1034 .p_class = P_GLOBAL,
1035 .offset = GLOBAL_VAR(szShareBackend),
1042 .p_class = P_GLOBAL,
1043 .offset = GLOBAL_VAR(szAutoServices),
1048 .label = "auto services",
1050 .p_class = P_GLOBAL,
1051 .offset = GLOBAL_VAR(szAutoServices),
1056 .label = "lock dir",
1058 .p_class = P_GLOBAL,
1059 .offset = GLOBAL_VAR(szLockDir),
1064 .label = "lock directory",
1066 .p_class = P_GLOBAL,
1067 .offset = GLOBAL_VAR(szLockDir),
1072 .label = "state directory",
1074 .p_class = P_GLOBAL,
1075 .offset = GLOBAL_VAR(szStateDir),
1080 .label = "cache directory",
1082 .p_class = P_GLOBAL,
1083 .offset = GLOBAL_VAR(szCacheDir),
1088 .label = "pid directory",
1090 .p_class = P_GLOBAL,
1091 .offset = GLOBAL_VAR(szPidDir),
1097 .label = "socket address",
1099 .p_class = P_GLOBAL,
1100 .offset = GLOBAL_VAR(szSocketAddress),
1108 .offset = LOCAL_VAR(szCopy),
1109 .special = handle_copy,
1116 .offset = LOCAL_VAR(szInclude),
1117 .special = handle_include,
1122 .label = "available",
1125 .offset = LOCAL_VAR(bAvailable),
1133 .offset = LOCAL_VAR(volume),
1141 .offset = LOCAL_VAR(fstype),
1147 .label = "panic action",
1149 .p_class = P_GLOBAL,
1150 .offset = GLOBAL_VAR(panic_action),
1156 .label = "msdfs root",
1159 .offset = LOCAL_VAR(bMSDfsRoot),
1164 .label = "host msdfs",
1166 .p_class = P_GLOBAL,
1167 .offset = GLOBAL_VAR(bHostMSDfs),
1172 .label = "winbind separator",
1174 .p_class = P_GLOBAL,
1175 .offset = GLOBAL_VAR(szWinbindSeparator),
1180 .label = "winbindd socket directory",
1182 .p_class = P_GLOBAL,
1183 .offset = GLOBAL_VAR(szWinbinddSocketDirectory),
1188 .label = "winbindd privileged socket directory",
1190 .p_class = P_GLOBAL,
1191 .offset = GLOBAL_VAR(szWinbinddPrivilegedSocketDirectory),
1196 .label = "winbind sealed pipes",
1198 .p_class = P_GLOBAL,
1199 .offset = GLOBAL_VAR(bWinbindSealedPipes),
1204 .label = "template shell",
1206 .p_class = P_GLOBAL,
1207 .offset = GLOBAL_VAR(szTemplateShell),
1212 .label = "template homedir",
1214 .p_class = P_GLOBAL,
1215 .offset = GLOBAL_VAR(szTemplateHomedir),
1220 .label = "idmap trusted only",
1222 .p_class = P_GLOBAL,
1223 .offset = GLOBAL_VAR(bIdmapTrustedOnly),
1229 .label = "ntp signd socket directory",
1231 .p_class = P_GLOBAL,
1232 .offset = GLOBAL_VAR(szNTPSignDSocketDirectory),
1237 .label = "rndc command",
1239 .p_class = P_GLOBAL,
1240 .offset = GLOBAL_VAR(szRNDCCommand),
1245 .label = "dns update command",
1247 .p_class = P_GLOBAL,
1248 .offset = GLOBAL_VAR(szDNSUpdateCommand),
1253 .label = "spn update command",
1255 .p_class = P_GLOBAL,
1256 .offset = GLOBAL_VAR(szSPNUpdateCommand),
1261 .label = "nsupdate command",
1263 .p_class = P_GLOBAL,
1264 .offset = GLOBAL_VAR(szNSUpdateCommand),
1269 {NULL, P_BOOL, P_NONE, 0, NULL, NULL, 0}
1273 /* local variables */
1274 struct loadparm_context {
1275 const char *szConfigFile;
1276 struct loadparm_global *globals;
1277 struct loadparm_service **services;
1278 struct loadparm_service *sDefault;
1279 struct smb_iconv_handle *iconv_handle;
1281 struct loadparm_service *currentService;
1282 bool bInGlobalSection;
1284 struct file_lists *next;
1289 unsigned int flags[NUMPARAMETERS];
1292 bool global; /* Is this the global context, which may set
1293 * global variables such as debug level etc? */
1294 const struct loadparm_s3_context *s3_fns;
1298 struct loadparm_service *lpcfg_default_service(struct loadparm_context *lp_ctx)
1300 if (lp_ctx->s3_fns) {
1301 return lp_ctx->s3_fns->get_default_loadparm_service();
1303 return lp_ctx->sDefault;
1307 * Convenience routine to grab string parameters into temporary memory
1308 * and run standard_sub_basic on them.
1310 * The buffers can be written to by
1311 * callers without affecting the source string.
1314 static const char *lp_string(const char *s)
1316 #if 0 /* until REWRITE done to make thread-safe */
1317 size_t len = s ? strlen(s) : 0;
1321 /* The follow debug is useful for tracking down memory problems
1322 especially if you have an inner loop that is calling a lp_*()
1323 function that returns a string. Perhaps this debug should be
1324 present all the time? */
1327 DEBUG(10, ("lp_string(%s)\n", s));
1330 #if 0 /* until REWRITE done to make thread-safe */
1332 lp_talloc = talloc_init("lp_talloc");
1334 ret = talloc_array(lp_talloc, char, len + 100); /* leave room for substitution */
1342 strlcpy(ret, s, len);
1344 if (trim_string(ret, "\"", "\"")) {
1345 if (strchr(ret,'"') != NULL)
1346 strlcpy(ret, s, len);
1349 standard_sub_basic(ret,len+100);
1356 In this section all the functions that are used to access the
1357 parameters from the rest of the program are defined
1361 * the creation of separate lpcfg_*() and lp_*() functions is to allow
1362 * for code compatibility between existing Samba4 and Samba3 code.
1365 /* this global context supports the lp_*() function varients */
1366 static struct loadparm_context *global_loadparm_context;
1368 #define lpcfg_default_service global_loadparm_context->sDefault
1369 #define lpcfg_global_service(i) global_loadparm_context->services[i]
1371 #define FN_GLOBAL_STRING(fn_name,var_name) \
1372 _PUBLIC_ const char *lpcfg_ ## fn_name(struct loadparm_context *lp_ctx) { \
1373 if (lp_ctx == NULL) return NULL; \
1374 if (lp_ctx->s3_fns) { \
1375 SMB_ASSERT(lp_ctx->s3_fns->fn_name); \
1376 return lp_ctx->s3_fns->fn_name(); \
1378 return lp_ctx->globals->var_name ? lp_string(lp_ctx->globals->var_name) : ""; \
1381 #define FN_GLOBAL_CONST_STRING(fn_name,var_name) \
1382 _PUBLIC_ const char *lpcfg_ ## fn_name(struct loadparm_context *lp_ctx) {\
1383 if (lp_ctx == NULL) return NULL; \
1384 if (lp_ctx->s3_fns) { \
1385 SMB_ASSERT(lp_ctx->s3_fns->fn_name); \
1386 return lp_ctx->s3_fns->fn_name(); \
1388 return lp_ctx->globals->var_name ? lp_string(lp_ctx->globals->var_name) : ""; \
1391 #define FN_GLOBAL_LIST(fn_name,var_name) \
1392 _PUBLIC_ const char **lpcfg_ ## fn_name(struct loadparm_context *lp_ctx) { \
1393 if (lp_ctx == NULL) return NULL; \
1394 if (lp_ctx->s3_fns) { \
1395 SMB_ASSERT(lp_ctx->s3_fns->fn_name); \
1396 return lp_ctx->s3_fns->fn_name(); \
1398 return lp_ctx->globals->var_name; \
1401 #define FN_GLOBAL_BOOL(fn_name,var_name) \
1402 _PUBLIC_ bool lpcfg_ ## fn_name(struct loadparm_context *lp_ctx) {\
1403 if (lp_ctx == NULL) return false; \
1404 if (lp_ctx->s3_fns) { \
1405 SMB_ASSERT(lp_ctx->s3_fns->fn_name); \
1406 return lp_ctx->s3_fns->fn_name(); \
1408 return lp_ctx->globals->var_name; \
1411 #define FN_GLOBAL_INTEGER(fn_name,var_name) \
1412 _PUBLIC_ int lpcfg_ ## fn_name(struct loadparm_context *lp_ctx) { \
1413 if (lp_ctx->s3_fns) { \
1414 SMB_ASSERT(lp_ctx->s3_fns->fn_name); \
1415 return lp_ctx->s3_fns->fn_name(); \
1417 return lp_ctx->globals->var_name; \
1420 /* Local parameters don't need the ->s3_fns because the struct
1421 * loadparm_service is shared and lpcfg_service() checks the ->s3_fns
1423 #define FN_LOCAL_STRING(fn_name,val) \
1424 _PUBLIC_ const char *lpcfg_ ## fn_name(struct loadparm_service *service, \
1425 struct loadparm_service *sDefault) { \
1426 return(lp_string((const char *)((service != NULL && service->val != NULL) ? service->val : sDefault->val))); \
1429 #define FN_LOCAL_CONST_STRING(fn_name,val) FN_LOCAL_STRING(fn_name, val)
1431 #define FN_LOCAL_LIST(fn_name,val) \
1432 _PUBLIC_ const char **lpcfg_ ## fn_name(struct loadparm_service *service, \
1433 struct loadparm_service *sDefault) {\
1434 return(const char **)(service != NULL && service->val != NULL? service->val : sDefault->val); \
1437 #define FN_LOCAL_PARM_BOOL(fn_name, val) FN_LOCAL_BOOL(fn_name, val)
1439 #define FN_LOCAL_BOOL(fn_name,val) \
1440 _PUBLIC_ bool lpcfg_ ## fn_name(struct loadparm_service *service, \
1441 struct loadparm_service *sDefault) { \
1442 return((service != NULL)? service->val : sDefault->val); \
1445 #define FN_LOCAL_INTEGER(fn_name,val) \
1446 _PUBLIC_ int lpcfg_ ## fn_name(struct loadparm_service *service, \
1447 struct loadparm_service *sDefault) { \
1448 return((service != NULL)? service->val : sDefault->val); \
1451 #define FN_LOCAL_PARM_INTEGER(fn_name, val) FN_LOCAL_INTEGER(fn_name, val)
1453 #define FN_LOCAL_PARM_CHAR(fn_name, val) FN_LOCAL_CHAR(fn_name, val)
1455 #define FN_LOCAL_CHAR(fn_name,val) \
1456 _PUBLIC_ char lpcfg_ ## fn_name(struct loadparm_service *service, \
1457 struct loadparm_service *sDefault) { \
1458 return((service != NULL)? service->val : sDefault->val); \
1461 #include "lib/param/param_functions.c"
1463 FN_GLOBAL_INTEGER(server_role, server_role)
1464 FN_GLOBAL_LIST(smb_ports, smb_ports)
1465 FN_GLOBAL_INTEGER(nbt_port, nbt_port)
1466 FN_GLOBAL_INTEGER(dgram_port, dgram_port)
1467 FN_GLOBAL_INTEGER(cldap_port, cldap_port)
1468 FN_GLOBAL_INTEGER(krb5_port, krb5_port)
1469 FN_GLOBAL_INTEGER(kpasswd_port, kpasswd_port)
1470 FN_GLOBAL_INTEGER(web_port, web_port)
1471 FN_GLOBAL_BOOL(tls_enabled, tls_enabled)
1472 FN_GLOBAL_STRING(logfile, logfile)
1473 FN_GLOBAL_STRING(share_backend, szShareBackend)
1474 FN_GLOBAL_CONST_STRING(winbind_separator, szWinbindSeparator)
1475 FN_GLOBAL_CONST_STRING(winbindd_socket_directory, szWinbinddSocketDirectory)
1476 FN_GLOBAL_CONST_STRING(winbindd_privileged_socket_directory, szWinbinddPrivilegedSocketDirectory)
1477 FN_GLOBAL_CONST_STRING(template_shell, szTemplateShell)
1478 FN_GLOBAL_CONST_STRING(template_homedir, szTemplateHomedir)
1479 FN_GLOBAL_BOOL(winbind_sealed_pipes, bWinbindSealedPipes)
1480 FN_GLOBAL_BOOL(idmap_trusted_only, bIdmapTrustedOnly)
1481 FN_GLOBAL_STRING(private_dir, szPrivateDir)
1482 FN_GLOBAL_STRING(serverstring, szServerString)
1483 FN_GLOBAL_STRING(lockdir, szLockDir)
1484 FN_GLOBAL_STRING(statedir, szStateDir)
1485 FN_GLOBAL_STRING(cachedir, szCacheDir)
1486 FN_GLOBAL_STRING(ncalrpc_dir, ncalrpc_dir)
1487 FN_GLOBAL_STRING(dos_charset, dos_charset)
1488 FN_GLOBAL_STRING(unix_charset, unix_charset)
1489 FN_GLOBAL_STRING(piddir, szPidDir)
1490 FN_GLOBAL_LIST(rndc_command, szRNDCCommand)
1491 FN_GLOBAL_LIST(dns_update_command, szDNSUpdateCommand)
1492 FN_GLOBAL_LIST(spn_update_command, szSPNUpdateCommand)
1493 FN_GLOBAL_LIST(nsupdate_command, szNSUpdateCommand)
1494 FN_GLOBAL_LIST(dcerpc_endpoint_servers, dcerpc_ep_servers)
1495 FN_GLOBAL_LIST(server_services, server_services)
1496 FN_GLOBAL_STRING(ntptr_providor, ntptr_providor)
1497 FN_GLOBAL_STRING(passdb_backend, passdb_backend)
1498 FN_GLOBAL_STRING(auto_services, szAutoServices)
1499 FN_GLOBAL_STRING(passwd_chat, szPasswdChat)
1500 FN_GLOBAL_LIST(passwordserver, szPasswordServers)
1501 FN_GLOBAL_LIST(name_resolve_order, szNameResolveOrder)
1502 FN_GLOBAL_STRING(realm, szRealm_upper)
1503 FN_GLOBAL_STRING(dnsdomain, szRealm_lower)
1504 FN_GLOBAL_STRING(socket_options, socket_options)
1505 FN_GLOBAL_STRING(workgroup, szWorkgroup)
1506 FN_GLOBAL_STRING(netbios_name, szNetbiosName)
1507 FN_GLOBAL_STRING(netbios_scope, szNetbiosScope)
1508 FN_GLOBAL_LIST(wins_server_list, szWINSservers)
1509 FN_GLOBAL_LIST(interfaces, szInterfaces)
1510 FN_GLOBAL_STRING(socket_address, szSocketAddress)
1511 FN_GLOBAL_LIST(netbios_aliases, szNetbiosAliases)
1512 FN_GLOBAL_BOOL(disable_netbios, bDisableNetbios)
1513 FN_GLOBAL_BOOL(we_are_a_wins_server, bWINSsupport)
1514 FN_GLOBAL_BOOL(wins_dns_proxy, bWINSdnsProxy)
1515 FN_GLOBAL_STRING(wins_hook, szWINSHook)
1516 FN_GLOBAL_BOOL(local_master, bLocalMaster)
1517 FN_GLOBAL_BOOL(readraw, bReadRaw)
1518 FN_GLOBAL_BOOL(large_readwrite, bLargeReadwrite)
1519 FN_GLOBAL_BOOL(writeraw, bWriteRaw)
1520 FN_GLOBAL_BOOL(null_passwords, bNullPasswords)
1521 FN_GLOBAL_BOOL(obey_pam_restrictions, bObeyPamRestrictions)
1522 FN_GLOBAL_BOOL(encrypted_passwords, bEncryptPasswords)
1523 FN_GLOBAL_BOOL(time_server, bTimeServer)
1524 FN_GLOBAL_BOOL(bind_interfaces_only, bBindInterfacesOnly)
1525 FN_GLOBAL_BOOL(unicode, bUnicode)
1526 FN_GLOBAL_BOOL(nt_status_support, bNTStatusSupport)
1527 FN_GLOBAL_BOOL(lanman_auth, bLanmanAuth)
1528 FN_GLOBAL_BOOL(ntlm_auth, bNTLMAuth)
1529 FN_GLOBAL_BOOL(client_plaintext_auth, bClientPlaintextAuth)
1530 FN_GLOBAL_BOOL(client_lanman_auth, bClientLanManAuth)
1531 FN_GLOBAL_BOOL(client_ntlmv2_auth, bClientNTLMv2Auth)
1532 FN_GLOBAL_BOOL(client_use_spnego_principal, client_use_spnego_principal)
1533 FN_GLOBAL_BOOL(host_msdfs, bHostMSDfs)
1534 FN_GLOBAL_BOOL(unix_extensions, bUnixExtensions)
1535 FN_GLOBAL_BOOL(use_spnego, bUseSpnego)
1536 FN_GLOBAL_BOOL(use_mmap, bUseMmap)
1537 FN_GLOBAL_BOOL(rpc_big_endian, bRpcBigEndian)
1538 FN_GLOBAL_INTEGER(max_wins_ttl, max_wins_ttl)
1539 FN_GLOBAL_INTEGER(min_wins_ttl, min_wins_ttl)
1540 FN_GLOBAL_INTEGER(maxmux, max_mux)
1541 FN_GLOBAL_INTEGER(max_xmit, max_xmit)
1542 FN_GLOBAL_INTEGER(passwordlevel, pwordlevel)
1543 FN_GLOBAL_INTEGER(srv_maxprotocol, srv_maxprotocol)
1544 FN_GLOBAL_INTEGER(srv_minprotocol, srv_minprotocol)
1545 FN_GLOBAL_INTEGER(cli_maxprotocol, cli_maxprotocol)
1546 FN_GLOBAL_INTEGER(cli_minprotocol, cli_minprotocol)
1547 FN_GLOBAL_INTEGER(security, security)
1548 FN_GLOBAL_BOOL(paranoid_server_security, paranoid_server_security)
1550 FN_GLOBAL_INTEGER(server_signing, server_signing)
1551 FN_GLOBAL_INTEGER(client_signing, client_signing)
1553 FN_GLOBAL_CONST_STRING(ntp_signd_socket_directory, szNTPSignDSocketDirectory)
1555 /* local prototypes */
1556 static int map_parameter(const char *pszParmName);
1557 static struct loadparm_service *getservicebyname(struct loadparm_context *lp_ctx,
1558 const char *pszServiceName);
1559 static void copy_service(struct loadparm_service *pserviceDest,
1560 struct loadparm_service *pserviceSource,
1561 struct bitmap *pcopymapDest);
1562 static bool lpcfg_service_ok(struct loadparm_service *service);
1563 static bool do_section(const char *pszSectionName, void *);
1564 static void init_copymap(struct loadparm_service *pservice);
1566 /* This is a helper function for parametrical options support. */
1567 /* It returns a pointer to parametrical option value if it exists or NULL otherwise */
1568 /* Actual parametrical functions are quite simple */
1569 const char *lpcfg_get_parametric(struct loadparm_context *lp_ctx,
1570 struct loadparm_service *service,
1571 const char *type, const char *option)
1573 char *vfskey_tmp = NULL;
1574 char *vfskey = NULL;
1575 struct parmlist_entry *data;
1580 if (lp_ctx->s3_fns) {
1581 return lp_ctx->s3_fns->get_parametric(service, type, option);
1584 data = (service == NULL ? lp_ctx->globals->param_opt : service->param_opt);
1586 vfskey_tmp = talloc_asprintf(NULL, "%s:%s", type, option);
1587 if (vfskey_tmp == NULL) return NULL;
1588 vfskey = strlower_talloc(NULL, vfskey_tmp);
1589 talloc_free(vfskey_tmp);
1592 if (strcmp(data->key, vfskey) == 0) {
1593 talloc_free(vfskey);
1599 if (service != NULL) {
1600 /* Try to fetch the same option but from globals */
1601 /* but only if we are not already working with globals */
1602 for (data = lp_ctx->globals->param_opt; data;
1603 data = data->next) {
1604 if (strcmp(data->key, vfskey) == 0) {
1605 talloc_free(vfskey);
1611 talloc_free(vfskey);
1618 * convenience routine to return int parameters.
1620 static int lp_int(const char *s)
1624 DEBUG(0,("lp_int(%s): is called with NULL!\n",s));
1628 return strtol(s, NULL, 0);
1632 * convenience routine to return unsigned long parameters.
1634 static int lp_ulong(const char *s)
1638 DEBUG(0,("lp_int(%s): is called with NULL!\n",s));
1642 return strtoul(s, NULL, 0);
1646 * convenience routine to return unsigned long parameters.
1648 static double lp_double(const char *s)
1652 DEBUG(0,("lp_double(%s): is called with NULL!\n",s));
1656 return strtod(s, NULL);
1660 * convenience routine to return boolean parameters.
1662 static bool lp_bool(const char *s)
1667 DEBUG(0,("lp_bool(%s): is called with NULL!\n",s));
1671 if (!set_boolean(s, &ret)) {
1672 DEBUG(0,("lp_bool(%s): value is not boolean!\n",s));
1681 * Return parametric option from a given service. Type is a part of option before ':'
1682 * Parametric option has following syntax: 'Type: option = value'
1683 * Returned value is allocated in 'lp_talloc' context
1686 const char *lpcfg_parm_string(struct loadparm_context *lp_ctx,
1687 struct loadparm_service *service, const char *type,
1690 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
1693 return lp_string(value);
1699 * Return parametric option from a given service. Type is a part of option before ':'
1700 * Parametric option has following syntax: 'Type: option = value'
1701 * Returned value is allocated in 'lp_talloc' context
1704 const char **lpcfg_parm_string_list(TALLOC_CTX *mem_ctx,
1705 struct loadparm_context *lp_ctx,
1706 struct loadparm_service *service,
1708 const char *option, const char *separator)
1710 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
1713 return (const char **)str_list_make(mem_ctx, value, separator);
1719 * Return parametric option from a given service. Type is a part of option before ':'
1720 * Parametric option has following syntax: 'Type: option = value'
1723 int lpcfg_parm_int(struct loadparm_context *lp_ctx,
1724 struct loadparm_service *service, const char *type,
1725 const char *option, int default_v)
1727 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
1730 return lp_int(value);
1736 * Return parametric option from a given service. Type is a part of
1737 * option before ':'.
1738 * Parametric option has following syntax: 'Type: option = value'.
1741 int lpcfg_parm_bytes(struct loadparm_context *lp_ctx,
1742 struct loadparm_service *service, const char *type,
1743 const char *option, int default_v)
1747 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
1749 if (value && conv_str_size_error(value, &bval)) {
1750 if (bval <= INT_MAX) {
1759 * Return parametric option from a given service.
1760 * Type is a part of option before ':'
1761 * Parametric option has following syntax: 'Type: option = value'
1763 unsigned long lpcfg_parm_ulong(struct loadparm_context *lp_ctx,
1764 struct loadparm_service *service, const char *type,
1765 const char *option, unsigned long default_v)
1767 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
1770 return lp_ulong(value);
1776 double lpcfg_parm_double(struct loadparm_context *lp_ctx,
1777 struct loadparm_service *service, const char *type,
1778 const char *option, double default_v)
1780 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
1783 return lp_double(value);
1789 * Return parametric option from a given service. Type is a part of option before ':'
1790 * Parametric option has following syntax: 'Type: option = value'
1793 bool lpcfg_parm_bool(struct loadparm_context *lp_ctx,
1794 struct loadparm_service *service, const char *type,
1795 const char *option, bool default_v)
1797 const char *value = lpcfg_get_parametric(lp_ctx, service, type, option);
1800 return lp_bool(value);
1807 * Initialise a service to the defaults.
1810 static struct loadparm_service *init_service(TALLOC_CTX *mem_ctx, struct loadparm_service *sDefault)
1812 struct loadparm_service *pservice =
1813 talloc_zero(mem_ctx, struct loadparm_service);
1814 copy_service(pservice, sDefault, NULL);
1819 * Set a string value, deallocating any existing space, and allocing the space
1822 static bool lpcfg_string_set(TALLOC_CTX *mem_ctx, char **dest, const char *src)
1829 *dest = talloc_strdup(mem_ctx, src);
1830 if ((*dest) == NULL) {
1831 DEBUG(0,("Out of memory in string_set\n"));
1839 * Set a string value, deallocating any existing space, and allocing the space
1842 static bool lpcfg_string_set_upper(TALLOC_CTX *mem_ctx, char **dest, const char *src)
1849 *dest = strupper_talloc(mem_ctx, src);
1850 if ((*dest) == NULL) {
1851 DEBUG(0,("Out of memory in string_set_upper\n"));
1861 * Add a new service to the services array initialising it with the given
1865 struct loadparm_service *lpcfg_add_service(struct loadparm_context *lp_ctx,
1866 const struct loadparm_service *pservice,
1870 struct loadparm_service tservice;
1871 int num_to_alloc = lp_ctx->iNumServices + 1;
1872 struct parmlist_entry *data, *pdata;
1874 if (pservice == NULL) {
1875 pservice = lp_ctx->sDefault;
1878 tservice = *pservice;
1880 /* it might already exist */
1882 struct loadparm_service *service = getservicebyname(lp_ctx,
1884 if (service != NULL) {
1885 /* Clean all parametric options for service */
1886 /* They will be added during parsing again */
1887 data = service->param_opt;
1893 service->param_opt = NULL;
1898 /* find an invalid one */
1899 for (i = 0; i < lp_ctx->iNumServices; i++)
1900 if (lp_ctx->services[i] == NULL)
1903 /* if not, then create one */
1904 if (i == lp_ctx->iNumServices) {
1905 struct loadparm_service **tsp;
1907 tsp = talloc_realloc(lp_ctx, lp_ctx->services, struct loadparm_service *, num_to_alloc);
1910 DEBUG(0,("lpcfg_add_service: failed to enlarge services!\n"));
1913 lp_ctx->services = tsp;
1914 lp_ctx->services[lp_ctx->iNumServices] = NULL;
1917 lp_ctx->iNumServices++;
1920 lp_ctx->services[i] = init_service(lp_ctx->services, lp_ctx->sDefault);
1921 if (lp_ctx->services[i] == NULL) {
1922 DEBUG(0,("lpcfg_add_service: out of memory!\n"));
1925 copy_service(lp_ctx->services[i], &tservice, NULL);
1927 lpcfg_string_set(lp_ctx->services[i], &lp_ctx->services[i]->szService, name);
1928 return lp_ctx->services[i];
1932 * Add a new home service, with the specified home directory, defaults coming
1933 * from service ifrom.
1936 bool lpcfg_add_home(struct loadparm_context *lp_ctx,
1937 const char *pszHomename,
1938 struct loadparm_service *default_service,
1939 const char *user, const char *pszHomedir)
1941 struct loadparm_service *service;
1943 service = lpcfg_add_service(lp_ctx, default_service, pszHomename);
1945 if (service == NULL)
1948 if (!(*(default_service->szPath))
1949 || strequal(default_service->szPath, lp_ctx->sDefault->szPath)) {
1950 service->szPath = talloc_strdup(service, pszHomedir);
1952 service->szPath = string_sub_talloc(service, lpcfg_pathname(default_service, lp_ctx->sDefault), "%H", pszHomedir);
1955 if (!(*(service->comment))) {
1956 service->comment = talloc_asprintf(service, "Home directory of %s", user);
1958 service->bAvailable = default_service->bAvailable;
1959 service->bBrowseable = default_service->bBrowseable;
1961 DEBUG(3, ("adding home's share [%s] for user '%s' at '%s'\n",
1962 pszHomename, user, service->szPath));
1968 * Add a new printer service, with defaults coming from service iFrom.
1971 bool lpcfg_add_printer(struct loadparm_context *lp_ctx,
1972 const char *pszPrintername,
1973 struct loadparm_service *default_service)
1975 const char *comment = "From Printcap";
1976 struct loadparm_service *service;
1977 service = lpcfg_add_service(lp_ctx, default_service, pszPrintername);
1979 if (service == NULL)
1982 /* note that we do NOT default the availability flag to True - */
1983 /* we take it from the default service passed. This allows all */
1984 /* dynamic printers to be disabled by disabling the [printers] */
1985 /* entry (if/when the 'available' keyword is implemented!). */
1987 /* the printer name is set to the service name. */
1988 lpcfg_string_set(service, &service->szPrintername, pszPrintername);
1989 lpcfg_string_set(service, &service->comment, comment);
1990 service->bBrowseable = default_service->bBrowseable;
1991 /* Printers cannot be read_only. */
1992 service->bRead_only = false;
1993 /* Printer services must be printable. */
1994 service->bPrint_ok = true;
1996 DEBUG(3, ("adding printer service %s\n", pszPrintername));
2002 * Map a parameter's string representation to something we can use.
2003 * Returns False if the parameter string is not recognised, else TRUE.
2006 static int map_parameter(const char *pszParmName)
2010 if (*pszParmName == '-')
2013 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
2014 if (strwicmp(parm_table[iIndex].label, pszParmName) == 0)
2017 /* Warn only if it isn't parametric option */
2018 if (strchr(pszParmName, ':') == NULL)
2019 DEBUG(0, ("Unknown parameter encountered: \"%s\"\n", pszParmName));
2020 /* We do return 'fail' for parametric options as well because they are
2021 stored in different storage
2028 return the parameter structure for a parameter
2030 struct parm_struct *lpcfg_parm_struct(struct loadparm_context *lp_ctx, const char *name)
2034 if (lp_ctx->s3_fns) {
2035 return lp_ctx->s3_fns->get_parm_struct(name);
2038 parmnum = map_parameter(name);
2039 if (parmnum == -1) return NULL;
2040 return &parm_table[parmnum];
2044 return the parameter pointer for a parameter
2046 void *lpcfg_parm_ptr(struct loadparm_context *lp_ctx,
2047 struct loadparm_service *service, struct parm_struct *parm)
2049 if (lp_ctx->s3_fns) {
2050 return lp_ctx->s3_fns->get_parm_ptr(service, parm);
2053 if (service == NULL) {
2054 if (parm->p_class == P_LOCAL)
2055 return ((char *)lp_ctx->sDefault)+parm->offset;
2056 else if (parm->p_class == P_GLOBAL)
2057 return ((char *)lp_ctx->globals)+parm->offset;
2060 return ((char *)service) + parm->offset;
2065 return the parameter pointer for a parameter
2067 bool lpcfg_parm_is_cmdline(struct loadparm_context *lp_ctx, const char *name)
2071 if (lp_ctx->s3_fns) {
2072 struct parm_struct *parm = lp_ctx->s3_fns->get_parm_struct(name);
2074 return parm->flags & FLAG_CMDLINE;
2079 parmnum = map_parameter(name);
2080 if (parmnum == -1) return false;
2082 return lp_ctx->flags[parmnum] & FLAG_CMDLINE;
2086 * Find a service by name. Otherwise works like get_service.
2089 static struct loadparm_service *getservicebyname(struct loadparm_context *lp_ctx,
2090 const char *pszServiceName)
2094 if (lp_ctx->s3_fns) {
2095 return lp_ctx->s3_fns->get_service(pszServiceName);
2098 for (iService = lp_ctx->iNumServices - 1; iService >= 0; iService--)
2099 if (lp_ctx->services[iService] != NULL &&
2100 strwicmp(lp_ctx->services[iService]->szService, pszServiceName) == 0) {
2101 return lp_ctx->services[iService];
2108 * Copy a service structure to another.
2109 * If pcopymapDest is NULL then copy all fields
2112 static void copy_service(struct loadparm_service *pserviceDest,
2113 struct loadparm_service *pserviceSource,
2114 struct bitmap *pcopymapDest)
2117 bool bcopyall = (pcopymapDest == NULL);
2118 struct parmlist_entry *data, *pdata, *paramo;
2121 for (i = 0; parm_table[i].label; i++)
2122 if (parm_table[i].p_class == P_LOCAL &&
2123 (bcopyall || bitmap_query(pcopymapDest, i))) {
2125 ((char *)pserviceSource) + parm_table[i].offset;
2127 ((char *)pserviceDest) + parm_table[i].offset;
2129 switch (parm_table[i].type) {
2131 *(bool *)dest_ptr = *(bool *)src_ptr;
2137 *(int *)dest_ptr = *(int *)src_ptr;
2141 lpcfg_string_set(pserviceDest,
2147 lpcfg_string_set_upper(pserviceDest,
2152 *(const char ***)dest_ptr = (const char **)str_list_copy(pserviceDest,
2153 *(const char ***)src_ptr);
2161 init_copymap(pserviceDest);
2162 if (pserviceSource->copymap)
2163 bitmap_copy(pserviceDest->copymap,
2164 pserviceSource->copymap);
2167 data = pserviceSource->param_opt;
2170 pdata = pserviceDest->param_opt;
2171 /* Traverse destination */
2173 /* If we already have same option, override it */
2174 if (strcmp(pdata->key, data->key) == 0) {
2175 talloc_free(pdata->value);
2176 pdata->value = talloc_reference(pdata,
2181 pdata = pdata->next;
2184 paramo = talloc_zero(pserviceDest, struct parmlist_entry);
2187 paramo->key = talloc_reference(paramo, data->key);
2188 paramo->value = talloc_reference(paramo, data->value);
2189 DLIST_ADD(pserviceDest->param_opt, paramo);
2196 * Check a service for consistency. Return False if the service is in any way
2197 * incomplete or faulty, else True.
2199 static bool lpcfg_service_ok(struct loadparm_service *service)
2204 if (service->szService[0] == '\0') {
2205 DEBUG(0, ("The following message indicates an internal error:\n"));
2206 DEBUG(0, ("No service name in service entry.\n"));
2210 /* The [printers] entry MUST be printable. I'm all for flexibility, but */
2211 /* I can't see why you'd want a non-printable printer service... */
2212 if (strwicmp(service->szService, PRINTERS_NAME) == 0) {
2213 if (!service->bPrint_ok) {
2214 DEBUG(0, ("WARNING: [%s] service MUST be printable!\n",
2215 service->szService));
2216 service->bPrint_ok = true;
2218 /* [printers] service must also be non-browsable. */
2219 if (service->bBrowseable)
2220 service->bBrowseable = false;
2223 /* If a service is flagged unavailable, log the fact at level 0. */
2224 if (!service->bAvailable)
2225 DEBUG(1, ("NOTE: Service %s is flagged unavailable.\n",
2226 service->szService));
2232 /*******************************************************************
2233 Keep a linked list of all config files so we know when one has changed
2234 it's date and needs to be reloaded.
2235 ********************************************************************/
2237 static void add_to_file_list(struct loadparm_context *lp_ctx,
2238 const char *fname, const char *subfname)
2240 struct file_lists *f = lp_ctx->file_lists;
2243 if (f->name && !strcmp(f->name, fname))
2249 f = talloc(lp_ctx, struct file_lists);
2252 f->next = lp_ctx->file_lists;
2253 f->name = talloc_strdup(f, fname);
2258 f->subfname = talloc_strdup(f, subfname);
2263 lp_ctx->file_lists = f;
2264 f->modtime = file_modtime(subfname);
2266 time_t t = file_modtime(subfname);
2272 /*******************************************************************
2273 Check if a config file has changed date.
2274 ********************************************************************/
2275 bool lpcfg_file_list_changed(struct loadparm_context *lp_ctx)
2277 struct file_lists *f;
2278 DEBUG(6, ("lp_file_list_changed()\n"));
2280 for (f = lp_ctx->file_lists; f != NULL; f = f->next) {
2284 n2 = standard_sub_basic(lp_ctx, f->name);
2286 DEBUGADD(6, ("file %s -> %s last mod_time: %s\n",
2287 f->name, n2, ctime(&f->modtime)));
2289 mod_time = file_modtime(n2);
2291 if (mod_time && ((f->modtime != mod_time) || (f->subfname == NULL) || (strcmp(n2, f->subfname) != 0))) {
2292 DEBUGADD(6, ("file %s modified: %s\n", n2,
2294 f->modtime = mod_time;
2295 talloc_free(f->subfname);
2296 f->subfname = talloc_strdup(f, n2);
2303 /***************************************************************************
2304 Handle the "realm" parameter
2305 ***************************************************************************/
2307 static bool handle_realm(struct loadparm_context *lp_ctx, int unused,
2308 const char *pszParmValue, char **ptr)
2310 lpcfg_string_set(lp_ctx, ptr, pszParmValue);
2312 talloc_free(lp_ctx->globals->szRealm_upper);
2313 talloc_free(lp_ctx->globals->szRealm_lower);
2315 lp_ctx->globals->szRealm_upper = strupper_talloc(lp_ctx, pszParmValue);
2316 lp_ctx->globals->szRealm_lower = strlower_talloc(lp_ctx, pszParmValue);
2321 /***************************************************************************
2322 Handle the include operation.
2323 ***************************************************************************/
2325 static bool handle_include(struct loadparm_context *lp_ctx, int unused,
2326 const char *pszParmValue, char **ptr)
2328 char *fname = standard_sub_basic(lp_ctx, pszParmValue);
2330 add_to_file_list(lp_ctx, pszParmValue, fname);
2332 lpcfg_string_set(lp_ctx, ptr, fname);
2334 if (file_exist(fname))
2335 return pm_process(fname, do_section, do_parameter, lp_ctx);
2337 DEBUG(2, ("Can't find include file %s\n", fname));
2342 /***************************************************************************
2343 Handle the interpretation of the copy parameter.
2344 ***************************************************************************/
2346 static bool handle_copy(struct loadparm_context *lp_ctx, int unused,
2347 const char *pszParmValue, char **ptr)
2350 struct loadparm_service *serviceTemp;
2352 lpcfg_string_set(lp_ctx, ptr, pszParmValue);
2356 DEBUG(3, ("Copying service from service %s\n", pszParmValue));
2358 if ((serviceTemp = getservicebyname(lp_ctx, pszParmValue)) != NULL) {
2359 if (serviceTemp == lp_ctx->currentService) {
2360 DEBUG(0, ("Can't copy service %s - unable to copy self!\n", pszParmValue));
2362 copy_service(lp_ctx->currentService,
2364 lp_ctx->currentService->copymap);
2368 DEBUG(0, ("Unable to copy service - source not found: %s\n",
2376 static bool handle_debuglevel(struct loadparm_context *lp_ctx, int unused,
2377 const char *pszParmValue, char **ptr)
2380 lpcfg_string_set(lp_ctx, ptr, pszParmValue);
2381 if (lp_ctx->global) {
2382 return debug_parse_levels(pszParmValue);
2387 static bool handle_logfile(struct loadparm_context *lp_ctx, int unused,
2388 const char *pszParmValue, char **ptr)
2390 debug_set_logfile(pszParmValue);
2391 if (lp_ctx->global) {
2392 lpcfg_string_set(lp_ctx, ptr, pszParmValue);
2397 /***************************************************************************
2398 Initialise a copymap.
2399 ***************************************************************************/
2401 static void init_copymap(struct loadparm_service *pservice)
2405 TALLOC_FREE(pservice->copymap);
2407 pservice->copymap = bitmap_talloc(NULL, NUMPARAMETERS);
2408 if (!pservice->copymap)
2410 ("Couldn't allocate copymap!! (size %d)\n",
2411 (int)NUMPARAMETERS));
2413 for (i = 0; i < NUMPARAMETERS; i++)
2414 bitmap_set(pservice->copymap, i);
2418 * Process a parametric option
2420 static bool lp_do_parameter_parametric(struct loadparm_context *lp_ctx,
2421 struct loadparm_service *service,
2422 const char *pszParmName,
2423 const char *pszParmValue, int flags)
2425 struct parmlist_entry *paramo, *data;
2427 TALLOC_CTX *mem_ctx;
2429 while (isspace((unsigned char)*pszParmName)) {
2433 name = strlower_talloc(lp_ctx, pszParmName);
2434 if (!name) return false;
2436 if (service == NULL) {
2437 data = lp_ctx->globals->param_opt;
2438 mem_ctx = lp_ctx->globals;
2440 data = service->param_opt;
2444 /* Traverse destination */
2445 for (paramo=data; paramo; paramo=paramo->next) {
2446 /* If we already have the option set, override it unless
2447 it was a command line option and the new one isn't */
2448 if (strcmp(paramo->key, name) == 0) {
2449 if ((paramo->priority & FLAG_CMDLINE) &&
2450 !(flags & FLAG_CMDLINE)) {
2455 talloc_free(paramo->value);
2456 paramo->value = talloc_strdup(paramo, pszParmValue);
2457 paramo->priority = flags;
2463 paramo = talloc_zero(mem_ctx, struct parmlist_entry);
2466 paramo->key = talloc_strdup(paramo, name);
2467 paramo->value = talloc_strdup(paramo, pszParmValue);
2468 paramo->priority = flags;
2469 if (service == NULL) {
2470 DLIST_ADD(lp_ctx->globals->param_opt, paramo);
2472 DLIST_ADD(service->param_opt, paramo);
2480 static bool set_variable(TALLOC_CTX *mem_ctx, int parmnum, void *parm_ptr,
2481 const char *pszParmName, const char *pszParmValue,
2482 struct loadparm_context *lp_ctx, bool on_globals)
2485 /* if it is a special case then go ahead */
2486 if (parm_table[parmnum].special) {
2488 ret = parm_table[parmnum].special(lp_ctx, -1, pszParmValue,
2493 goto mark_non_default;
2496 /* now switch on the type of variable it is */
2497 switch (parm_table[parmnum].type)
2501 if (!set_boolean(pszParmValue, &b)) {
2502 DEBUG(0,("lp_do_parameter(%s): value is not boolean!\n", pszParmValue));
2505 *(bool *)parm_ptr = b;
2511 if (!set_boolean(pszParmValue, &b)) {
2512 DEBUG(0,("lp_do_parameter(%s): value is not boolean!\n", pszParmValue));
2515 *(bool *)parm_ptr = !b;
2520 *(int *)parm_ptr = atoi(pszParmValue);
2524 *(char *)parm_ptr = *pszParmValue;
2528 *(int *)parm_ptr = strtol(pszParmValue, NULL, 8);
2534 if (conv_str_size_error(pszParmValue, &val)) {
2535 if (val <= INT_MAX) {
2536 *(int *)parm_ptr = (int)val;
2541 DEBUG(0,("lp_do_parameter(%s): value is not "
2542 "a valid size specifier!\n", pszParmValue));
2547 *(const char ***)parm_ptr = (const char **)str_list_make(mem_ctx,
2548 pszParmValue, NULL);
2552 char **new_list = str_list_make(mem_ctx,
2553 pszParmValue, NULL);
2554 for (i=0; new_list[i]; i++) {
2555 if (new_list[i][0] == '+' && new_list[i][1] &&
2556 (!str_list_check(*(const char ***)parm_ptr,
2557 &new_list[i][1]))) {
2558 *(const char ***)parm_ptr = str_list_add(*(const char ***)parm_ptr,
2560 } else if (new_list[i][0] == '-' && new_list[i][1]) {
2561 #if 0 /* This is commented out because we sometimes parse the list
2562 * twice, and so we can't assert on this */
2563 if (!str_list_check(*(const char ***)parm_ptr,
2565 DEBUG(0, ("Unsupported value for: %s = %s, %s is not in the original list [%s]\n",
2566 pszParmName, pszParmValue, new_list[i],
2567 str_list_join_shell(mem_ctx, *(const char ***)parm_ptr, ' ')));
2572 str_list_remove(*(const char ***)parm_ptr,
2576 DEBUG(0, ("Unsupported list syntax for: %s = %s\n",
2577 pszParmName, pszParmValue));
2580 *(const char ***)parm_ptr = (const char **) new_list;
2587 lpcfg_string_set(mem_ctx, (char **)parm_ptr, pszParmValue);
2591 lpcfg_string_set_upper(mem_ctx, (char **)parm_ptr, pszParmValue);
2595 for (i = 0; parm_table[parmnum].enum_list[i].name; i++) {
2598 parm_table[parmnum].enum_list[i].name)) {
2600 parm_table[parmnum].
2605 if (!parm_table[parmnum].enum_list[i].name) {
2606 DEBUG(0,("Unknown enumerated value '%s' for '%s'\n",
2607 pszParmValue, pszParmName));
2614 if (on_globals && (lp_ctx->flags[parmnum] & FLAG_DEFAULT)) {
2615 lp_ctx->flags[parmnum] &= ~FLAG_DEFAULT;
2616 /* we have to also unset FLAG_DEFAULT on aliases */
2617 for (i=parmnum-1;i>=0 && parm_table[i].offset == parm_table[parmnum].offset;i--) {
2618 lp_ctx->flags[i] &= ~FLAG_DEFAULT;
2620 for (i=parmnum+1;i<NUMPARAMETERS && parm_table[i].offset == parm_table[parmnum].offset;i++) {
2621 lp_ctx->flags[i] &= ~FLAG_DEFAULT;
2628 bool lpcfg_do_global_parameter(struct loadparm_context *lp_ctx,
2629 const char *pszParmName, const char *pszParmValue)
2631 int parmnum = map_parameter(pszParmName);
2635 if (strchr(pszParmName, ':')) {
2636 return lp_do_parameter_parametric(lp_ctx, NULL, pszParmName, pszParmValue, 0);
2638 DEBUG(0, ("Ignoring unknown parameter \"%s\"\n", pszParmName));
2642 /* if the flag has been set on the command line, then don't allow override,
2643 but don't report an error */
2644 if (lp_ctx->flags[parmnum] & FLAG_CMDLINE) {
2648 parm_ptr = lpcfg_parm_ptr(lp_ctx, NULL, &parm_table[parmnum]);
2650 return set_variable(lp_ctx->globals, parmnum, parm_ptr,
2651 pszParmName, pszParmValue, lp_ctx, true);
2654 bool lpcfg_do_service_parameter(struct loadparm_context *lp_ctx,
2655 struct loadparm_service *service,
2656 const char *pszParmName, const char *pszParmValue)
2660 int parmnum = map_parameter(pszParmName);
2663 if (strchr(pszParmName, ':')) {
2664 return lp_do_parameter_parametric(lp_ctx, service, pszParmName, pszParmValue, 0);
2666 DEBUG(0, ("Ignoring unknown parameter \"%s\"\n", pszParmName));
2670 /* if the flag has been set on the command line, then don't allow override,
2671 but don't report an error */
2672 if (lp_ctx->flags[parmnum] & FLAG_CMDLINE) {
2676 if (parm_table[parmnum].p_class == P_GLOBAL) {
2678 ("Global parameter %s found in service section!\n",
2682 parm_ptr = ((char *)service) + parm_table[parmnum].offset;
2684 if (!service->copymap)
2685 init_copymap(service);
2687 /* this handles the aliases - set the copymap for other
2688 * entries with the same data pointer */
2689 for (i = 0; parm_table[i].label; i++)
2690 if (parm_table[i].offset == parm_table[parmnum].offset &&
2691 parm_table[i].p_class == parm_table[parmnum].p_class)
2692 bitmap_clear(service->copymap, i);
2694 return set_variable(service, parmnum, parm_ptr, pszParmName,
2695 pszParmValue, lp_ctx, false);
2699 * Process a parameter.
2702 static bool do_parameter(const char *pszParmName, const char *pszParmValue,
2705 struct loadparm_context *lp_ctx = (struct loadparm_context *)userdata;
2707 if (lp_ctx->bInGlobalSection)
2708 return lpcfg_do_global_parameter(lp_ctx, pszParmName,
2711 return lpcfg_do_service_parameter(lp_ctx, lp_ctx->currentService,
2712 pszParmName, pszParmValue);
2716 variable argument do parameter
2718 bool lpcfg_do_global_parameter_var(struct loadparm_context *lp_ctx, const char *pszParmName, const char *fmt, ...) PRINTF_ATTRIBUTE(3, 4);
2719 bool lpcfg_do_global_parameter_var(struct loadparm_context *lp_ctx,
2720 const char *pszParmName, const char *fmt, ...)
2727 s = talloc_vasprintf(NULL, fmt, ap);
2729 ret = lpcfg_do_global_parameter(lp_ctx, pszParmName, s);
2736 set a parameter from the commandline - this is called from command line parameter
2737 parsing code. It sets the parameter then marks the parameter as unable to be modified
2738 by smb.conf processing
2740 bool lpcfg_set_cmdline(struct loadparm_context *lp_ctx, const char *pszParmName,
2741 const char *pszParmValue)
2746 if (lp_ctx->s3_fns) {
2747 return lp_ctx->s3_fns->set_cmdline(pszParmName, pszParmValue);
2750 parmnum = map_parameter(pszParmName);
2752 while (isspace((unsigned char)*pszParmValue)) pszParmValue++;
2755 if (parmnum < 0 && strchr(pszParmName, ':')) {
2756 /* set a parametric option */
2757 return lp_do_parameter_parametric(lp_ctx, NULL, pszParmName,
2758 pszParmValue, FLAG_CMDLINE);
2762 DEBUG(0,("Unknown option '%s'\n", pszParmName));
2766 /* reset the CMDLINE flag in case this has been called before */
2767 lp_ctx->flags[parmnum] &= ~FLAG_CMDLINE;
2769 if (!lpcfg_do_global_parameter(lp_ctx, pszParmName, pszParmValue)) {
2773 lp_ctx->flags[parmnum] |= FLAG_CMDLINE;
2775 /* we have to also set FLAG_CMDLINE on aliases */
2776 for (i=parmnum-1;i>=0 && parm_table[i].offset == parm_table[parmnum].offset;i--) {
2777 lp_ctx->flags[i] |= FLAG_CMDLINE;
2779 for (i=parmnum+1;i<NUMPARAMETERS && parm_table[i].offset == parm_table[parmnum].offset;i++) {
2780 lp_ctx->flags[i] |= FLAG_CMDLINE;
2787 set a option from the commandline in 'a=b' format. Use to support --option
2789 bool lpcfg_set_option(struct loadparm_context *lp_ctx, const char *option)
2794 s = talloc_strdup(NULL, option);
2807 ret = lpcfg_set_cmdline(lp_ctx, s, p+1);
2813 #define BOOLSTR(b) ((b) ? "Yes" : "No")
2816 * Print a parameter of the specified type.
2819 static void print_parameter(struct parm_struct *p, void *ptr, FILE * f)
2821 /* For the seperation of lists values that we print below */
2822 const char *list_sep = ", ";
2827 for (i = 0; p->enum_list[i].name; i++) {
2828 if (*(int *)ptr == p->enum_list[i].value) {
2830 p->enum_list[i].name);
2837 fprintf(f, "%s", BOOLSTR(*(bool *)ptr));
2841 fprintf(f, "%s", BOOLSTR(!*(bool *)ptr));
2846 fprintf(f, "%d", *(int *)ptr);
2850 fprintf(f, "%c", *(char *)ptr);
2854 int val = *(int *)ptr;
2858 fprintf(f, "0%o", val);
2867 if ((char ***)ptr && *(char ***)ptr) {
2868 char **list = *(char ***)ptr;
2869 for (; *list; list++) {
2870 /* surround strings with whitespace in double quotes */
2871 if (*(list+1) == NULL) {
2872 /* last item, no extra separator */
2875 if ( strchr_m( *list, ' ' ) ) {
2876 fprintf(f, "\"%s\"%s", *list, list_sep);
2878 fprintf(f, "%s%s", *list, list_sep);
2886 if (*(char **)ptr) {
2887 fprintf(f, "%s", *(char **)ptr);
2896 * Check if two parameters are equal.
2899 static bool equal_parameter(parm_type type, void *ptr1, void *ptr2)
2904 return (*((bool *)ptr1) == *((bool *)ptr2));
2910 return (*((int *)ptr1) == *((int *)ptr2));
2913 return (*((char *)ptr1) == *((char *)ptr2));
2917 return str_list_equal(*(const char ***)ptr1, *(const char ***)ptr2);
2922 char *p1 = *(char **)ptr1, *p2 = *(char **)ptr2;
2927 return (p1 == p2 || strequal(p1, p2));
2936 * Process a new section (service).
2938 * At this stage all sections are services.
2939 * Later we'll have special sections that permit server parameters to be set.
2940 * Returns True on success, False on failure.
2943 static bool do_section(const char *pszSectionName, void *userdata)
2945 struct loadparm_context *lp_ctx = (struct loadparm_context *)userdata;
2947 bool isglobal = ((strwicmp(pszSectionName, GLOBAL_NAME) == 0) ||
2948 (strwicmp(pszSectionName, GLOBAL_NAME2) == 0));
2951 /* if we've just struck a global section, note the fact. */
2952 lp_ctx->bInGlobalSection = isglobal;
2954 /* check for multiple global sections */
2955 if (lp_ctx->bInGlobalSection) {
2956 DEBUG(4, ("Processing section \"[%s]\"\n", pszSectionName));
2960 /* if we have a current service, tidy it up before moving on */
2963 if (lp_ctx->currentService != NULL)
2964 bRetval = lpcfg_service_ok(lp_ctx->currentService);
2966 /* if all is still well, move to the next record in the services array */
2968 /* We put this here to avoid an odd message order if messages are */
2969 /* issued by the post-processing of a previous section. */
2970 DEBUG(4, ("Processing section \"[%s]\"\n", pszSectionName));
2972 if ((lp_ctx->currentService = lpcfg_add_service(lp_ctx, lp_ctx->sDefault,
2975 DEBUG(0, ("Failed to add a new service\n"));
2985 * Determine if a particular base parameter is currently set to the default value.
2988 static bool is_default(struct loadparm_service *sDefault, int i)
2990 void *def_ptr = ((char *)sDefault) + parm_table[i].offset;
2991 if (!defaults_saved)
2993 switch (parm_table[i].type) {
2996 return str_list_equal((const char **)parm_table[i].def.lvalue,
2997 (const char **)def_ptr);
3000 return strequal(parm_table[i].def.svalue,
3004 return parm_table[i].def.bvalue ==
3011 return parm_table[i].def.ivalue ==
3018 *Display the contents of the global structure.
3021 static void dump_globals(struct loadparm_context *lp_ctx, FILE *f,
3025 struct parmlist_entry *data;
3027 fprintf(f, "# Global parameters\n[global]\n");
3029 for (i = 0; parm_table[i].label; i++)
3030 if (parm_table[i].p_class == P_GLOBAL &&
3031 (i == 0 || (parm_table[i].offset != parm_table[i - 1].offset))) {
3032 if (!show_defaults && (lp_ctx->flags[i] & FLAG_DEFAULT))
3034 fprintf(f, "\t%s = ", parm_table[i].label);
3035 print_parameter(&parm_table[i], lpcfg_parm_ptr(lp_ctx, NULL, &parm_table[i]), f);
3038 if (lp_ctx->globals->param_opt != NULL) {
3039 for (data = lp_ctx->globals->param_opt; data;
3040 data = data->next) {
3041 if (!show_defaults && (data->priority & FLAG_DEFAULT)) {
3044 fprintf(f, "\t%s = %s\n", data->key, data->value);
3051 * Display the contents of a single services record.
3054 static void dump_a_service(struct loadparm_service * pService, struct loadparm_service *sDefault, FILE * f,
3055 unsigned int *flags)
3058 struct parmlist_entry *data;
3060 if (pService != sDefault)
3061 fprintf(f, "\n[%s]\n", pService->szService);
3063 for (i = 0; parm_table[i].label; i++) {
3064 if (parm_table[i].p_class == P_LOCAL &&
3065 (*parm_table[i].label != '-') &&
3066 (i == 0 || (parm_table[i].offset != parm_table[i - 1].offset)))
3068 if (pService == sDefault) {
3069 if (flags && (flags[i] & FLAG_DEFAULT)) {
3072 if (defaults_saved) {
3073 if (is_default(sDefault, i)) {
3078 if (equal_parameter(parm_table[i].type,
3079 ((char *)pService) +
3080 parm_table[i].offset,
3081 ((char *)sDefault) +
3082 parm_table[i].offset))
3086 fprintf(f, "\t%s = ", parm_table[i].label);
3087 print_parameter(&parm_table[i],
3088 ((char *)pService) + parm_table[i].offset, f);
3092 if (pService->param_opt != NULL) {
3093 for (data = pService->param_opt; data; data = data->next) {
3094 fprintf(f, "\t%s = %s\n", data->key, data->value);
3099 bool lpcfg_dump_a_parameter(struct loadparm_context *lp_ctx,
3100 struct loadparm_service *service,
3101 const char *parm_name, FILE * f)
3103 struct parm_struct *parm;
3106 parm = lpcfg_parm_struct(lp_ctx, parm_name);
3111 ptr = lpcfg_parm_ptr(lp_ctx, service,parm);
3113 print_parameter(parm, ptr, f);
3119 * Return info about the next parameter in a service.
3120 * snum==-1 gives the globals.
3121 * Return NULL when out of parameters.
3125 struct parm_struct *lpcfg_next_parameter(struct loadparm_context *lp_ctx, int snum, int *i,
3129 /* do the globals */
3130 for (; parm_table[*i].label; (*i)++) {
3131 if ((*parm_table[*i].label == '-'))
3135 && (parm_table[*i].offset ==
3136 parm_table[(*i) - 1].offset)
3137 && (parm_table[*i].p_class ==
3138 parm_table[(*i) - 1].p_class))
3141 return &parm_table[(*i)++];
3144 struct loadparm_service *pService = lp_ctx->services[snum];
3146 for (; parm_table[*i].label; (*i)++) {
3147 if (parm_table[*i].p_class == P_LOCAL &&
3148 (*parm_table[*i].label != '-') &&
3150 (parm_table[*i].offset !=
3151 parm_table[(*i) - 1].offset)))
3153 if (allparameters ||
3154 !equal_parameter(parm_table[*i].type,
3155 ((char *)pService) +
3156 parm_table[*i].offset,
3157 ((char *)lp_ctx->sDefault) +
3158 parm_table[*i].offset))
3160 return &parm_table[(*i)++];
3171 * Auto-load some home services.
3173 static void lpcfg_add_auto_services(struct loadparm_context *lp_ctx,
3181 * Unload unused services.
3184 void lpcfg_killunused(struct loadparm_context *lp_ctx,
3185 struct smbsrv_connection *smb,
3186 bool (*snumused) (struct smbsrv_connection *, int))
3189 for (i = 0; i < lp_ctx->iNumServices; i++) {
3190 if (lp_ctx->services[i] == NULL)
3193 if (!snumused || !snumused(smb, i)) {
3194 talloc_free(lp_ctx->services[i]);
3195 lp_ctx->services[i] = NULL;
3201 static int lpcfg_destructor(struct loadparm_context *lp_ctx)
3203 struct parmlist_entry *data;
3205 if (lp_ctx->refuse_free) {
3206 /* someone is trying to free the
3207 global_loadparm_context.
3208 We can't allow that. */
3212 if (lp_ctx->globals->param_opt != NULL) {
3213 struct parmlist_entry *next;
3214 for (data = lp_ctx->globals->param_opt; data; data=next) {
3216 if (data->priority & FLAG_CMDLINE) continue;
3217 DLIST_REMOVE(lp_ctx->globals->param_opt, data);
3226 * Initialise the global parameter structure.
3228 * Note that most callers should use loadparm_init_global() instead
3230 struct loadparm_context *loadparm_init(TALLOC_CTX *mem_ctx)
3234 struct loadparm_context *lp_ctx;
3235 struct parmlist_entry *parm;
3238 lp_ctx = talloc_zero(mem_ctx, struct loadparm_context);
3242 talloc_set_destructor(lp_ctx, lpcfg_destructor);
3243 lp_ctx->bInGlobalSection = true;
3244 lp_ctx->globals = talloc_zero(lp_ctx, struct loadparm_global);
3245 lp_ctx->sDefault = talloc_zero(lp_ctx, struct loadparm_service);
3247 lp_ctx->sDefault->iMaxPrintJobs = 1000;
3248 lp_ctx->sDefault->bAvailable = true;
3249 lp_ctx->sDefault->bBrowseable = true;
3250 lp_ctx->sDefault->bRead_only = true;
3251 lp_ctx->sDefault->bMap_archive = true;
3252 lp_ctx->sDefault->iStrictLocking = true;
3253 lp_ctx->sDefault->bOpLocks = true;
3254 lp_ctx->sDefault->iCreate_mask = 0744;
3255 lp_ctx->sDefault->iCreate_force_mode = 0000;
3256 lp_ctx->sDefault->iDir_mask = 0755;
3257 lp_ctx->sDefault->iDir_force_mode = 0000;
3259 DEBUG(3, ("Initialising global parameters\n"));
3261 for (i = 0; parm_table[i].label; i++) {
3262 if ((parm_table[i].type == P_STRING ||
3263 parm_table[i].type == P_USTRING) &&
3264 !(lp_ctx->flags[i] & FLAG_CMDLINE)) {
3266 if (parm_table[i].p_class == P_LOCAL) {
3267 r = (char **)(((char *)lp_ctx->sDefault) + parm_table[i].offset);
3269 r = (char **)(((char *)lp_ctx->globals) + parm_table[i].offset);
3271 *r = talloc_strdup(lp_ctx, "");
3275 logfile = talloc_asprintf(lp_ctx, "%s/log.samba", dyn_LOGFILEBASE);
3276 lpcfg_do_global_parameter(lp_ctx, "log file", logfile);
3277 talloc_free(logfile);
3279 lpcfg_do_global_parameter(lp_ctx, "log level", "0");
3281 lpcfg_do_global_parameter(lp_ctx, "share backend", "classic");
3283 lpcfg_do_global_parameter(lp_ctx, "server role", "standalone");
3285 /* options that can be set on the command line must be initialised via
3286 the slower lpcfg_do_global_parameter() to ensure that FLAG_CMDLINE is obeyed */
3288 lpcfg_do_global_parameter(lp_ctx, "socket options", "TCP_NODELAY");
3290 lpcfg_do_global_parameter(lp_ctx, "workgroup", DEFAULT_WORKGROUP);
3291 myname = get_myname(lp_ctx);
3292 lpcfg_do_global_parameter(lp_ctx, "netbios name", myname);
3293 talloc_free(myname);
3294 lpcfg_do_global_parameter(lp_ctx, "name resolve order", "wins host bcast");
3296 lpcfg_do_global_parameter(lp_ctx, "fstype", "NTFS");
3298 lpcfg_do_global_parameter(lp_ctx, "ntvfs handler", "unixuid default");
3299 lpcfg_do_global_parameter(lp_ctx, "max connections", "-1");
3301 lpcfg_do_global_parameter(lp_ctx, "dcerpc endpoint servers", "epmapper srvsvc wkssvc rpcecho samr netlogon lsarpc spoolss drsuapi winreg dssetup unixinfo browser eventlog6 backupkey dnsserver");
3302 lpcfg_do_global_parameter(lp_ctx, "server services", "smb rpc nbt wrepl ldap cldap kdc drepl winbind ntp_signd kcc dnsupdate");
3303 lpcfg_do_global_parameter(lp_ctx, "ntptr providor", "simple_ldb");
3304 /* the winbind method for domain controllers is for both RODC
3305 auth forwarding and for trusted domains */
3306 lpcfg_do_global_parameter(lp_ctx, "private dir", dyn_PRIVATE_DIR);
3307 lpcfg_do_global_parameter(lp_ctx, "registry:HKEY_LOCAL_MACHINE", "hklm.ldb");
3309 /* This hive should be dynamically generated by Samba using
3310 data from the sam, but for the moment leave it in a tdb to
3311 keep regedt32 from popping up an annoying dialog. */
3312 lpcfg_do_global_parameter(lp_ctx, "registry:HKEY_USERS", "hku.ldb");
3314 /* using UTF8 by default allows us to support all chars */
3315 lpcfg_do_global_parameter(lp_ctx, "unix charset", "UTF8");
3317 /* Use codepage 850 as a default for the dos character set */
3318 lpcfg_do_global_parameter(lp_ctx, "dos charset", "CP850");
3321 * Allow the default PASSWD_CHAT to be overridden in local.h.
3323 lpcfg_do_global_parameter(lp_ctx, "passwd chat", DEFAULT_PASSWD_CHAT);
3325 lpcfg_do_global_parameter(lp_ctx, "pid directory", dyn_PIDDIR);
3326 lpcfg_do_global_parameter(lp_ctx, "lock dir", dyn_LOCKDIR);
3327 lpcfg_do_global_parameter(lp_ctx, "state directory", dyn_STATEDIR);
3328 lpcfg_do_global_parameter(lp_ctx, "cache directory", dyn_CACHEDIR);
3329 lpcfg_do_global_parameter(lp_ctx, "ncalrpc dir", dyn_NCALRPCDIR);
3331 lpcfg_do_global_parameter(lp_ctx, "socket address", "");
3332 lpcfg_do_global_parameter_var(lp_ctx, "server string",
3333 "Samba %s", SAMBA_VERSION_STRING);
3335 lpcfg_do_global_parameter(lp_ctx, "password server", "*");
3337 lpcfg_do_global_parameter(lp_ctx, "max mux", "50");
3338 lpcfg_do_global_parameter(lp_ctx, "max xmit", "12288");
3339 lpcfg_do_global_parameter(lp_ctx, "password level", "0");
3340 lpcfg_do_global_parameter(lp_ctx, "LargeReadwrite", "True");
3341 lpcfg_do_global_parameter(lp_ctx, "server min protocol", "CORE");
3342 lpcfg_do_global_parameter(lp_ctx, "server max protocol", "NT1");
3343 lpcfg_do_global_parameter(lp_ctx, "client min protocol", "CORE");
3344 lpcfg_do_global_parameter(lp_ctx, "client max protocol", "NT1");
3345 lpcfg_do_global_parameter(lp_ctx, "security", "USER");
3346 lpcfg_do_global_parameter(lp_ctx, "paranoid server security", "True");
3347 lpcfg_do_global_parameter(lp_ctx, "EncryptPasswords", "True");
3348 lpcfg_do_global_parameter(lp_ctx, "ReadRaw", "True");
3349 lpcfg_do_global_parameter(lp_ctx, "WriteRaw", "True");
3350 lpcfg_do_global_parameter(lp_ctx, "NullPasswords", "False");
3351 lpcfg_do_global_parameter(lp_ctx, "ObeyPamRestrictions", "False");
3353 lpcfg_do_global_parameter(lp_ctx, "TimeServer", "False");
3354 lpcfg_do_global_parameter(lp_ctx, "BindInterfacesOnly", "False");
3355 lpcfg_do_global_parameter(lp_ctx, "Unicode", "True");
3356 lpcfg_do_global_parameter(lp_ctx, "ClientLanManAuth", "False");
3357 lpcfg_do_global_parameter(lp_ctx, "ClientNTLMv2Auth", "True");
3358 lpcfg_do_global_parameter(lp_ctx, "LanmanAuth", "False");
3359 lpcfg_do_global_parameter(lp_ctx, "NTLMAuth", "True");
3360 lpcfg_do_global_parameter(lp_ctx, "client use spnego principal", "False");
3362 lpcfg_do_global_parameter(lp_ctx, "UnixExtensions", "False");
3364 lpcfg_do_global_parameter(lp_ctx, "PreferredMaster", "Auto");
3365 lpcfg_do_global_parameter(lp_ctx, "LocalMaster", "True");
3367 lpcfg_do_global_parameter(lp_ctx, "wins support", "False");
3368 lpcfg_do_global_parameter(lp_ctx, "dns proxy", "True");
3370 lpcfg_do_global_parameter(lp_ctx, "winbind separator", "\\");
3371 lpcfg_do_global_parameter(lp_ctx, "winbind sealed pipes", "True");
3372 lpcfg_do_global_parameter(lp_ctx, "winbindd socket directory", dyn_WINBINDD_SOCKET_DIR);
3373 #if _SAMBA_BUILD_ >= 4
3374 lpcfg_do_global_parameter(lp_ctx, "winbindd privileged socket directory", dyn_WINBINDD_PRIVILEGED_SOCKET_DIR);
3375 lpcfg_do_global_parameter(lp_ctx, "ntp signd socket directory", dyn_NTP_SIGND_SOCKET_DIR);
3376 lpcfg_do_global_parameter_var(lp_ctx, "dns update command", "%s/samba_dnsupdate", dyn_SCRIPTSBINDIR);
3377 lpcfg_do_global_parameter_var(lp_ctx, "spn update command", "%s/samba_spnupdate", dyn_SCRIPTSBINDIR);
3379 lpcfg_do_global_parameter(lp_ctx, "template shell", "/bin/false");
3380 lpcfg_do_global_parameter(lp_ctx, "template homedir", "/home/%WORKGROUP%/%ACCOUNTNAME%");
3381 lpcfg_do_global_parameter(lp_ctx, "idmap trusted only", "False");
3383 lpcfg_do_global_parameter(lp_ctx, "client signing", "default");
3384 lpcfg_do_global_parameter(lp_ctx, "server signing", "default");
3386 lpcfg_do_global_parameter(lp_ctx, "use spnego", "True");
3388 lpcfg_do_global_parameter(lp_ctx, "use mmap", "True");
3390 lpcfg_do_global_parameter(lp_ctx, "smb ports", "445 139");
3391 lpcfg_do_global_parameter(lp_ctx, "nbt port", "137");
3392 lpcfg_do_global_parameter(lp_ctx, "dgram port", "138");
3393 lpcfg_do_global_parameter(lp_ctx, "cldap port", "389");
3394 lpcfg_do_global_parameter(lp_ctx, "krb5 port", "88");
3395 lpcfg_do_global_parameter(lp_ctx, "kpasswd port", "464");
3396 lpcfg_do_global_parameter(lp_ctx, "web port", "901");
3398 lpcfg_do_global_parameter(lp_ctx, "nt status support", "True");
3400 lpcfg_do_global_parameter(lp_ctx, "max wins ttl", "518400"); /* 6 days */
3401 lpcfg_do_global_parameter(lp_ctx, "min wins ttl", "10");
3403 lpcfg_do_global_parameter(lp_ctx, "tls enabled", "True");
3404 lpcfg_do_global_parameter(lp_ctx, "tls keyfile", "tls/key.pem");
3405 lpcfg_do_global_parameter(lp_ctx, "tls certfile", "tls/cert.pem");
3406 lpcfg_do_global_parameter(lp_ctx, "tls cafile", "tls/ca.pem");
3407 lpcfg_do_global_parameter(lp_ctx, "prefork children:smb", "4");
3409 lpcfg_do_global_parameter(lp_ctx, "rndc command", "/usr/sbin/rndc");
3410 lpcfg_do_global_parameter(lp_ctx, "nsupdate command", "/usr/bin/nsupdate -g");
3412 for (i = 0; parm_table[i].label; i++) {
3413 if (!(lp_ctx->flags[i] & FLAG_CMDLINE)) {
3414 lp_ctx->flags[i] |= FLAG_DEFAULT;
3418 for (parm=lp_ctx->globals->param_opt; parm; parm=parm->next) {
3419 if (!(parm->priority & FLAG_CMDLINE)) {
3420 parm->priority |= FLAG_DEFAULT;
3428 * Initialise the global parameter structure.
3430 struct loadparm_context *loadparm_init_global(bool load_default)
3432 if (global_loadparm_context == NULL) {
3433 global_loadparm_context = loadparm_init(NULL);
3435 if (global_loadparm_context == NULL) {
3438 global_loadparm_context->global = true;
3439 if (load_default && !global_loadparm_context->loaded) {
3440 lpcfg_load_default(global_loadparm_context);
3442 global_loadparm_context->refuse_free = true;
3443 return global_loadparm_context;
3447 * Initialise the global parameter structure.
3449 struct loadparm_context *loadparm_init_s3(TALLOC_CTX *mem_ctx,
3450 const struct loadparm_s3_context *s3_fns)
3452 struct loadparm_context *loadparm_context = talloc_zero(mem_ctx, struct loadparm_context);
3453 if (!loadparm_context) {
3456 loadparm_context->s3_fns = s3_fns;
3457 return loadparm_context;
3460 const char *lpcfg_configfile(struct loadparm_context *lp_ctx)
3462 return lp_ctx->szConfigFile;
3465 const char *lp_default_path(void)
3467 if (getenv("SMB_CONF_PATH"))
3468 return getenv("SMB_CONF_PATH");
3470 return dyn_CONFIGFILE;
3474 * Update the internal state of a loadparm context after settings
3477 static bool lpcfg_update(struct loadparm_context *lp_ctx)
3479 struct debug_settings settings;
3480 lpcfg_add_auto_services(lp_ctx, lpcfg_auto_services(lp_ctx));
3482 if (!lp_ctx->globals->szWINSservers && lp_ctx->globals->bWINSsupport) {
3483 lpcfg_do_global_parameter(lp_ctx, "wins server", "127.0.0.1");
3486 if (!lp_ctx->global) {
3490 panic_action = lp_ctx->globals->panic_action;
3492 reload_charcnv(lp_ctx);
3494 ZERO_STRUCT(settings);
3495 /* Add any more debug-related smb.conf parameters created in
3497 settings.timestamp_logs = true;
3498 debug_set_settings(&settings);
3500 /* FIXME: This is a bit of a hack, but we can't use a global, since
3501 * not everything that uses lp also uses the socket library */
3502 if (lpcfg_parm_bool(lp_ctx, NULL, "socket", "testnonblock", false)) {
3503 setenv("SOCKET_TESTNONBLOCK", "1", 1);
3505 unsetenv("SOCKET_TESTNONBLOCK");
3511 bool lpcfg_load_default(struct loadparm_context *lp_ctx)
3515 path = lp_default_path();
3517 if (!file_exist(path)) {
3518 /* We allow the default smb.conf file to not exist,
3519 * basically the equivalent of an empty file. */
3520 return lpcfg_update(lp_ctx);
3523 return lpcfg_load(lp_ctx, path);
3527 * Load the services array from the services file.
3529 * Return True on success, False on failure.
3531 bool lpcfg_load(struct loadparm_context *lp_ctx, const char *filename)
3536 filename = talloc_strdup(lp_ctx, filename);
3538 lp_ctx->szConfigFile = filename;
3540 if (lp_ctx->s3_fns) {
3541 return lp_ctx->s3_fns->load(filename);
3544 lp_ctx->bInGlobalSection = true;
3545 n2 = standard_sub_basic(lp_ctx, lp_ctx->szConfigFile);
3546 DEBUG(2, ("lpcfg_load: refreshing parameters from %s\n", n2));
3548 add_to_file_list(lp_ctx, lp_ctx->szConfigFile, n2);
3550 /* We get sections first, so have to start 'behind' to make up */
3551 lp_ctx->currentService = NULL;
3552 bRetval = pm_process(n2, do_section, do_parameter, lp_ctx);
3554 /* finish up the last section */
3555 DEBUG(4, ("pm_process() returned %s\n", BOOLSTR(bRetval)));
3557 if (lp_ctx->currentService != NULL)
3558 bRetval = lpcfg_service_ok(lp_ctx->currentService);
3560 bRetval = bRetval && lpcfg_update(lp_ctx);
3562 /* we do this unconditionally, so that it happens even
3563 for a missing smb.conf */
3564 reload_charcnv(lp_ctx);
3566 if (bRetval == true) {
3567 /* set this up so that any child python tasks will
3568 find the right smb.conf */
3569 setenv("SMB_CONF_PATH", filename, 1);
3571 /* set the context used by the lp_*() function
3573 global_loadparm_context = lp_ctx;
3574 lp_ctx->loaded = true;
3581 * Return the max number of services.
3584 int lpcfg_numservices(struct loadparm_context *lp_ctx)
3586 if (lp_ctx->s3_fns) {
3587 return lp_ctx->s3_fns->get_numservices();
3590 return lp_ctx->iNumServices;
3594 * Display the contents of the services array in human-readable form.
3597 void lpcfg_dump(struct loadparm_context *lp_ctx, FILE *f, bool show_defaults,
3602 if (lp_ctx->s3_fns) {
3603 lp_ctx->s3_fns->dump(f, show_defaults, maxtoprint);
3607 defaults_saved = !show_defaults;
3609 dump_globals(lp_ctx, f, show_defaults);
3611 dump_a_service(lp_ctx->sDefault, lp_ctx->sDefault, f, lp_ctx->flags);
3613 for (iService = 0; iService < maxtoprint; iService++)
3614 lpcfg_dump_one(f, show_defaults, lp_ctx->services[iService], lp_ctx->sDefault);
3618 * Display the contents of one service in human-readable form.
3620 void lpcfg_dump_one(FILE *f, bool show_defaults, struct loadparm_service *service, struct loadparm_service *sDefault)
3622 if (service != NULL) {
3623 if (service->szService[0] == '\0')
3625 dump_a_service(service, sDefault, f, NULL);
3629 struct loadparm_service *lpcfg_servicebynum(struct loadparm_context *lp_ctx,
3632 if (lp_ctx->s3_fns) {
3633 return lp_ctx->s3_fns->get_servicebynum(snum);
3636 return lp_ctx->services[snum];
3639 struct loadparm_service *lpcfg_service(struct loadparm_context *lp_ctx,
3640 const char *service_name)
3645 if (lp_ctx->s3_fns) {
3646 return lp_ctx->s3_fns->get_service(service_name);
3649 for (iService = lp_ctx->iNumServices - 1; iService >= 0; iService--) {
3650 if (lp_ctx->services[iService] &&
3651 lp_ctx->services[iService]->szService) {
3653 * The substitution here is used to support %U is
3656 serviceName = standard_sub_basic(
3657 lp_ctx->services[iService],
3658 lp_ctx->services[iService]->szService);
3659 if (strequal(serviceName, service_name)) {
3660 talloc_free(serviceName);
3661 return lp_ctx->services[iService];
3663 talloc_free(serviceName);
3667 DEBUG(7,("lpcfg_servicenumber: couldn't find %s\n", service_name));
3671 const char *lpcfg_servicename(const struct loadparm_service *service)
3673 return lp_string((const char *)service->szService);
3677 * A useful volume label function.
3679 const char *lpcfg_volume_label(struct loadparm_service *service, struct loadparm_service *sDefault)
3682 ret = lp_string((const char *)((service != NULL && service->volume != NULL) ?
3683 service->volume : sDefault->volume));
3685 return lpcfg_servicename(service);
3690 * If we are PDC then prefer us as DMB
3692 const char *lpcfg_printername(struct loadparm_service *service, struct loadparm_service *sDefault)
3695 ret = lp_string((const char *)((service != NULL && service->szPrintername != NULL) ?
3696 service->szPrintername : sDefault->szPrintername));
3697 if (ret == NULL || (ret != NULL && *ret == '\0'))
3698 ret = lpcfg_servicename(service);
3705 * Return the max print jobs per queue.
3707 int lpcfg_maxprintjobs(struct loadparm_service *service, struct loadparm_service *sDefault)
3709 int maxjobs = (service != NULL) ? service->iMaxPrintJobs : sDefault->iMaxPrintJobs;
3710 if (maxjobs <= 0 || maxjobs >= PRINT_MAX_JOBID)
3711 maxjobs = PRINT_MAX_JOBID - 1;
3716 struct smb_iconv_handle *lpcfg_iconv_handle(struct loadparm_context *lp_ctx)
3718 if (lp_ctx == NULL) {
3719 return get_iconv_handle();
3721 return lp_ctx->iconv_handle;
3724 _PUBLIC_ void reload_charcnv(struct loadparm_context *lp_ctx)
3726 struct smb_iconv_handle *old_ic = lp_ctx->iconv_handle;
3727 if (!lp_ctx->global) {
3731 if (old_ic == NULL) {
3732 old_ic = global_iconv_handle;
3734 lp_ctx->iconv_handle = smb_iconv_handle_reinit_lp(lp_ctx, lp_ctx, old_ic);
3735 global_iconv_handle = lp_ctx->iconv_handle;
3738 _PUBLIC_ char *lpcfg_tls_keyfile(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx)
3740 return lpcfg_private_path(mem_ctx, lp_ctx, lp_ctx->globals->tls_keyfile);
3743 _PUBLIC_ char *lpcfg_tls_certfile(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx)
3745 return lpcfg_private_path(mem_ctx, lp_ctx, lp_ctx->globals->tls_certfile);
3748 _PUBLIC_ char *lpcfg_tls_cafile(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx)
3750 return lpcfg_private_path(mem_ctx, lp_ctx, lp_ctx->globals->tls_cafile);
3753 _PUBLIC_ char *lpcfg_tls_crlfile(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx)
3755 return lpcfg_private_path(mem_ctx, lp_ctx, lp_ctx->globals->tls_crlfile);
3758 _PUBLIC_ char *lpcfg_tls_dhpfile(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx)
3760 return lpcfg_private_path(mem_ctx, lp_ctx, lp_ctx->globals->tls_dhpfile);
3763 struct gensec_settings *lpcfg_gensec_settings(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx)
3765 struct gensec_settings *settings = talloc(mem_ctx, struct gensec_settings);
3766 if (settings == NULL)
3768 SMB_ASSERT(lp_ctx != NULL);
3769 settings->lp_ctx = talloc_reference(settings, lp_ctx);
3770 settings->target_hostname = lpcfg_parm_string(lp_ctx, NULL, "gensec", "target_hostname");