2 backend code for provisioning a Samba4 server
3 Copyright Andrew Tridgell 2005
4 Released under the GNU GPL v2 or later
7 /* used to generate sequence numbers for records */
8 provision_next_usn = 1;
13 return true if the current install seems to be OK
17 var lp = loadparm_init();
19 if (lp.get("realm") == "") {
22 var ok = ldb.connect(lp.get("sam database"));
26 var res = ldb.search("(name=Administrator)");
27 if (res.length != 1) {
34 find a user or group from a list of possibilities
39 assert(arguments.length >= 2);
40 var nssfn = arguments[0];
41 for (i=1;i<arguments.length;i++) {
42 if (nssfn(arguments[i]) != undefined) {
46 printf("Unable to find user/group for %s\n", arguments[1]);
47 assert(i<arguments.length);
51 add a foreign security principle
53 function add_foreign(str, sid, desc, unixname)
56 dn: CN=${SID},CN=ForeignSecurityPrincipals,${BASEDN}
58 objectClass: foreignSecurityPrincipal
64 var sub = new Object();
67 sub.UNIXNAME = unixname;
68 return str + substitute_var(add, sub);
72 return current time as a nt time string
76 return "" + sys.nttime();
80 return current time as a ldap time string
84 return sys.ldaptime(sys.nttime());
88 return a date string suitable for a dns zone serial number
92 var t = sys.gmtime(sys.nttime());
93 return sprintf("%04u%02u%02u%02u",
94 t.tm_year+1900, t.tm_mon+1, t.tm_mday, t.tm_hour);
102 var list = sys.interfaces();
107 return next USN in the sequence
111 provision_next_usn = provision_next_usn+1;
112 return provision_next_usn;
116 return first part of hostname
120 var s = split(".", sys.hostname());
125 /* the ldb is in bad shape, possibly due to being built from an
126 incompatible previous version of the code, so delete it
128 function ldb_delete(ldb)
130 println("Deleting " + ldb.filename);
131 sys.unlink(ldb.filename);
133 var ok = ldb.connect(ldb.filename);
138 erase an ldb, removing all records
140 function ldb_erase(ldb)
142 var attrs = new Array("dn");
144 /* delete the specials */
145 ldb.del("@INDEXLIST");
146 ldb.del("@ATTRIBUTES");
147 ldb.del("@SUBCLASSES");
151 var res = ldb.search("(|(objectclass=*)(dn=*))", attrs);
153 if (typeof(res) == "undefined") {
157 for (i=0;i<res.length;i++) {
160 res = ldb.search("(objectclass=*)", attrs);
161 if (res.length != 0) {
165 assert(res.length == 0);
170 setup a ldb in the private dir
172 function setup_ldb(ldif, dbname, subobj)
176 var ldb = ldb_init();
177 var lp = loadparm_init();
179 if (arguments.length >= 4) {
180 extra = arguments[3];
183 if (arguments.length == 5) {
184 erase = arguments[4];
187 var src = lp.get("setup directory") + "/" + ldif;
189 var data = sys.file_load(src);
191 data = substitute_var(data, subobj);
193 ldb.filename = dbname;
195 var connect_ok = ldb.connect(dbname);
202 var add_ok = ldb.add(data);
207 setup a file in the private dir
209 function setup_file(template, fname, subobj)
211 var lp = loadparm_init();
213 var src = lp.get("setup directory") + "/" + template;
217 var data = sys.file_load(src);
218 data = substitute_var(data, subobj);
220 ok = sys.file_save(f, data);
224 function provision_default_paths(subobj)
226 var lp = loadparm_init();
227 var paths = new Object();
228 paths.smbconf = lp.get("config file");
229 paths.hklm = "hklm.ldb";
230 paths.hkcu = "hkcu.ldb";
231 paths.hkcr = "hkcr.ldb";
232 paths.hku = "hku.ldb";
233 paths.hkpd = "hkpd.ldb";
234 paths.hkpt = "hkpt.ldb";
235 paths.samdb = "sam.ldb";
236 paths.rootdse = "rootdse.ldb";
237 paths.secrets = "secrets.ldb";
238 paths.dns = lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".zone";
239 paths.winsdb = "wins.ldb";
244 provision samba4 - caution, this wipes all existing data!
246 function provision(subobj, message, blank, paths)
249 var lp = loadparm_init();
250 var sys = sys_init();
253 some options need to be upper/lower case
255 subobj.REALM = strlower(subobj.REALM);
256 subobj.HOSTNAME = strlower(subobj.HOSTNAME);
257 subobj.DOMAIN = strupper(subobj.DOMAIN);
258 assert(valid_netbios_name(subobj.DOMAIN));
259 subobj.NETBIOSNAME = strupper(subobj.HOSTNAME);
260 assert(valid_netbios_name(subobj.NETBIOSNAME));
261 var rdns = split(",", subobj.BASEDN);
262 subobj.RDN_DC = substr(rdns[0], strlen("DC="));
264 data = add_foreign(data, "S-1-5-7", "Anonymous", "${NOBODY}");
265 data = add_foreign(data, "S-1-1-0", "World", "${NOGROUP}");
266 data = add_foreign(data, "S-1-5-2", "Network", "${NOGROUP}");
267 data = add_foreign(data, "S-1-5-18", "System", "${ROOT}");
268 data = add_foreign(data, "S-1-5-11", "Authenticated Users", "${USERS}");
270 provision_next_usn = 1;
272 /* only install a new smb.conf if there isn't one there already */
273 var st = sys.stat(paths.smbconf);
274 if (st == undefined) {
275 message("Setting up smb.conf\n");
276 setup_file("provision.smb.conf", paths.smbconf, subobj);
279 message("Setting up hklm.ldb\n");
280 setup_ldb("hklm.ldif", paths.hklm, subobj);
281 message("Setting up sam.ldb attributes\n");
282 setup_ldb("provision_init.ldif", paths.samdb, subobj);
283 message("Setting up sam.ldb templates\n");
284 setup_ldb("provision_templates.ldif", paths.samdb, subobj, NULL, false);
285 message("Setting up sam.ldb data\n");
286 setup_ldb("provision.ldif", paths.samdb, subobj, NULL, false);
287 if (blank == false) {
288 message("Setting up sam.ldb users and groups\n");
289 setup_ldb("provision_users.ldif", paths.samdb, subobj, data, false);
291 message("Setting up rootdse.ldb\n");
292 setup_ldb("rootdse.ldif", paths.rootdse, subobj);
293 message("Setting up secrets.ldb\n");
294 setup_ldb("secrets.ldif", paths.secrets, subobj);
295 message("Setting up DNS zone file\n");
296 setup_file("provision.zone",
302 guess reasonably default options for provisioning
304 function provision_guess()
306 var subobj = new Object();
307 var nss = nss_init();
308 var lp = loadparm_init();
312 subobj.REALM = lp.get("realm");
313 subobj.DOMAIN = lp.get("workgroup");
314 subobj.HOSTNAME = hostname();
316 assert(subobj.REALM);
317 assert(subobj.DOMAIN);
318 assert(subobj.HOSTNAME);
320 subobj.HOSTIP = hostip();
321 subobj.DOMAINGUID = randguid();
322 subobj.DOMAINSID = randsid();
323 subobj.HOSTGUID = randguid();
324 subobj.INVOCATIONID = randguid();
325 subobj.KRBTGTPASS = randpass(12);
326 subobj.MACHINEPASS = randpass(12);
327 subobj.ADMINPASS = randpass(12);
328 subobj.DEFAULTSITE = "Default-First-Site-Name";
329 subobj.NEWGUID = randguid;
330 subobj.NTTIME = nttime;
331 subobj.LDAPTIME = ldaptime;
332 subobj.DATESTRING = datestring;
333 subobj.USN = nextusn;
334 subobj.ROOT = findnss(nss.getpwnam, "root");
335 subobj.NOBODY = findnss(nss.getpwnam, "nobody");
336 subobj.NOGROUP = findnss(nss.getgrnam, "nogroup", "nobody");
337 subobj.WHEEL = findnss(nss.getgrnam, "wheel", "root", "staff");
338 subobj.USERS = findnss(nss.getgrnam, "users", "guest", "other");
339 subobj.DNSDOMAIN = strlower(subobj.REALM);
340 subobj.DNSNAME = sprintf("%s.%s",
341 strlower(subobj.HOSTNAME),
343 rdn_list = split(".", subobj.REALM);
344 subobj.BASEDN = "DC=" + join(",DC=", rdn_list);
349 search for one attribute as a string
351 function searchone(ldb, expression, attribute)
353 var attrs = new Array(attribute);
354 res = ldb.search(expression, attrs);
355 if (res.length != 1 ||
356 res[0][attribute] == undefined) {
359 return res[0][attribute];
363 modify an account to remove the
365 function enable_account(ldb, user_dn)
367 var attrs = new Array("userAccountControl");
368 var res = ldb.search(NULL, user_dn, ldb.SCOPE_ONELEVEL, attrs);
369 assert(res.length == 1);
370 var userAccountControl = res[0].userAccountControl;
371 userAccountControl = userAccountControl - 2; /* remove disabled bit */
375 replace: userAccountControl
376 userAccountControl: %u
378 user_dn, userAccountControl);
379 var ok = ldb.modify(mod);
385 add a new user record
387 function newuser(username, unixname, password, message)
389 var lp = loadparm_init();
390 var samdb = lp.get("sam database");
391 var ldb = ldb_init();
394 /* connect to the sam */
395 var ok = ldb.connect(samdb);
398 /* find the DNs for the domain and the domain users group */
399 var domain_dn = searchone(ldb, "objectClass=domainDNS", "dn");
400 assert(domain_dn != undefined);
401 var dom_users = searchone(ldb, "name=Domain Users", "dn");
402 assert(dom_users != undefined);
404 var user_dn = sprintf("CN=%s,CN=Users,%s", username, domain_dn);
408 the new user record. note the reliance on the samdb module to fill
421 user_dn, username, username, dom_users,
422 unixname, randguid(), password);
424 add the user to the users group as well
426 var modgroup = sprintf("
438 message("Adding user %s\n", user_dn);
441 message("Failed to add %s - %s\n", user_dn, ldb.errstring());
445 message("Modifying group %s\n", dom_users);
446 ok = ldb.modify(modgroup);
448 message("Failed to modify %s - %s\n", dom_users, ldb.errstring());
453 modify the userAccountControl to remove the disabled bit
455 return enable_account(ldb, user_dn);
458 // Check whether a name is valid as a NetBIOS name.
459 // FIXME: There are probably more constraints here
460 function valid_netbios_name(name)
462 if (strlen(name) > 13) return false;
463 if (strstr(name, ".")) return false;
467 function provision_validate(subobj, message)
469 if (!valid_netbios_name(subobj.DOMAIN)) {
470 message("Invalid NetBIOS name for domain\n");
474 if (!valid_netbios_name(subobj.NETBIOSNAME)) {
475 message("Invalid NetBIOS name for host\n");