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());
126 erase an ldb, removing all records
128 function ldb_erase(ldb)
130 var attrs = new Array("dn");
132 /* delete the specials */
133 ldb.del("@INDEXLIST");
134 ldb.del("@ATTRIBUTES");
135 ldb.del("@SUBCLASSES");
139 var res = ldb.search("(|(objectclass=*)(dn=*))", attrs);
141 for (i=0;i<res.length;i++) {
144 res = ldb.search("(objectclass=*)", attrs);
145 assert(res.length == 0);
150 setup a ldb in the private dir
152 function setup_ldb(ldif, dbname, subobj)
156 var ldb = ldb_init();
157 var lp = loadparm_init();
159 if (arguments.length >= 4) {
160 extra = arguments[3];
163 if (arguments.length == 5) {
164 erase = arguments[4];
167 var src = lp.get("setup directory") + "/" + ldif;
169 var data = sys.file_load(src);
171 data = substitute_var(data, subobj);
173 var ok = ldb.connect(dbname);
185 setup a file in the private dir
187 function setup_file(template, fname, subobj)
189 var lp = loadparm_init();
191 var src = lp.get("setup directory") + "/" + template;
195 var data = sys.file_load(src);
196 data = substitute_var(data, subobj);
198 ok = sys.file_save(f, data);
202 function provision_default_paths(subobj)
204 var lp = loadparm_init();
205 var paths = new Object();
206 paths.smbconf = lp.get("config file");
207 paths.hklm = "hklm.ldb";
208 paths.hkcu = "hkcu.ldb";
209 paths.hkcr = "hkcr.ldb";
210 paths.hku = "hku.ldb";
211 paths.hkpd = "hkpd.ldb";
212 paths.hkpt = "hkpt.ldb";
213 paths.samdb = "sam.ldb";
214 paths.rootdse = "rootdse.ldb";
215 paths.secrets = "secrets.ldb";
216 paths.dns = lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".zone";
217 paths.winsdb = "wins.ldb";
222 provision samba4 - caution, this wipes all existing data!
224 function provision(subobj, message, blank, paths)
227 var lp = loadparm_init();
228 var sys = sys_init();
231 some options need to be upper/lower case
233 subobj.REALM = strlower(subobj.REALM);
234 subobj.HOSTNAME = strlower(subobj.HOSTNAME);
235 subobj.DOMAIN = strupper(subobj.DOMAIN);
236 assert(valid_netbios_name(subobj.DOMAIN));
237 subobj.NETBIOSNAME = strupper(subobj.HOSTNAME);
238 assert(valid_netbios_name(subobj.NETBIOSNAME));
239 var rdns = split(",", subobj.BASEDN);
240 subobj.RDN_DC = substr(rdns[0], strlen("DC="));
242 data = add_foreign(data, "S-1-5-7", "Anonymous", "${NOBODY}");
243 data = add_foreign(data, "S-1-1-0", "World", "${NOGROUP}");
244 data = add_foreign(data, "S-1-5-2", "Network", "${NOGROUP}");
245 data = add_foreign(data, "S-1-5-18", "System", "${ROOT}");
246 data = add_foreign(data, "S-1-5-11", "Authenticated Users", "${USERS}");
248 provision_next_usn = 1;
250 /* only install a new smb.conf if there isn't one there already */
251 var st = sys.stat(paths.smbconf);
252 if (st == undefined) {
253 message("Setting up smb.conf\n");
254 setup_file("provision.smb.conf", paths.smbconf, subobj);
257 message("Setting up hklm.ldb\n");
258 setup_ldb("hklm.ldif", paths.hklm, subobj);
259 message("Setting up sam.ldb attributes\n");
260 setup_ldb("provision_init.ldif", paths.samdb, subobj);
261 message("Setting up sam.ldb templates\n");
262 setup_ldb("provision_templates.ldif", paths.samdb, subobj, NULL, false);
263 message("Setting up sam.ldb data\n");
264 setup_ldb("provision.ldif", paths.samdb, subobj, NULL, false);
265 if (blank == false) {
266 message("Setting up sam.ldb users and groups\n");
267 setup_ldb("provision_users.ldif", paths.samdb, subobj, data, false);
269 message("Setting up rootdse.ldb\n");
270 setup_ldb("rootdse.ldif", paths.rootdse, subobj);
271 message("Setting up secrets.ldb\n");
272 setup_ldb("secrets.ldif", paths.secrets, subobj);
273 message("Setting up DNS zone file\n");
274 setup_file("provision.zone",
280 guess reasonably default options for provisioning
282 function provision_guess()
284 var subobj = new Object();
285 var nss = nss_init();
286 var lp = loadparm_init();
290 subobj.REALM = lp.get("realm");
291 subobj.DOMAIN = lp.get("workgroup");
292 subobj.HOSTNAME = hostname();
294 assert(subobj.REALM);
295 assert(subobj.DOMAIN);
296 assert(subobj.HOSTNAME);
298 subobj.HOSTIP = hostip();
299 subobj.DOMAINGUID = randguid();
300 subobj.DOMAINSID = randsid();
301 subobj.HOSTGUID = randguid();
302 subobj.INVOCATIONID = randguid();
303 subobj.KRBTGTPASS = randpass(12);
304 subobj.MACHINEPASS = randpass(12);
305 subobj.ADMINPASS = randpass(12);
306 subobj.DEFAULTSITE = "Default-First-Site-Name";
307 subobj.NEWGUID = randguid;
308 subobj.NTTIME = nttime;
309 subobj.LDAPTIME = ldaptime;
310 subobj.DATESTRING = datestring;
311 subobj.USN = nextusn;
312 subobj.ROOT = findnss(nss.getpwnam, "root");
313 subobj.NOBODY = findnss(nss.getpwnam, "nobody");
314 subobj.NOGROUP = findnss(nss.getgrnam, "nogroup", "nobody");
315 subobj.WHEEL = findnss(nss.getgrnam, "wheel", "root", "staff");
316 subobj.USERS = findnss(nss.getgrnam, "users", "guest", "other");
317 subobj.DNSDOMAIN = strlower(subobj.REALM);
318 subobj.DNSNAME = sprintf("%s.%s",
319 strlower(subobj.HOSTNAME),
321 rdn_list = split(".", subobj.REALM);
322 subobj.BASEDN = "DC=" + join(",DC=", rdn_list);
327 search for one attribute as a string
329 function searchone(ldb, expression, attribute)
331 var attrs = new Array(attribute);
332 res = ldb.search(expression, attrs);
333 if (res.length != 1 ||
334 res[0][attribute] == undefined) {
337 return res[0][attribute];
341 modify an account to remove the
343 function enable_account(ldb, user_dn)
345 var attrs = new Array("userAccountControl");
346 var res = ldb.search(NULL, user_dn, ldb.SCOPE_ONELEVEL, attrs);
347 assert(res.length == 1);
348 var userAccountControl = res[0].userAccountControl;
349 userAccountControl = userAccountControl - 2; /* remove disabled bit */
353 replace: userAccountControl
354 userAccountControl: %u
356 user_dn, userAccountControl);
357 var ok = ldb.modify(mod);
363 add a new user record
365 function newuser(username, unixname, password, message)
367 var lp = loadparm_init();
368 var samdb = lp.get("sam database");
369 var ldb = ldb_init();
372 /* connect to the sam */
373 var ok = ldb.connect(samdb);
376 /* find the DNs for the domain and the domain users group */
377 var domain_dn = searchone(ldb, "objectClass=domainDNS", "dn");
378 assert(domain_dn != undefined);
379 var dom_users = searchone(ldb, "name=Domain Users", "dn");
380 assert(dom_users != undefined);
382 var user_dn = sprintf("CN=%s,CN=Users,%s", username, domain_dn);
386 the new user record. note the reliance on the samdb module to fill
399 user_dn, username, username, dom_users,
400 unixname, randguid(), password);
402 add the user to the users group as well
404 var modgroup = sprintf("
416 message("Adding user %s\n", user_dn);
419 message("Failed to add %s - %s\n", user_dn, ldb.errstring());
423 message("Modifying group %s\n", dom_users);
424 ok = ldb.modify(modgroup);
426 message("Failed to modify %s - %s\n", dom_users, ldb.errstring());
431 modify the userAccountControl to remove the disabled bit
433 return enable_account(ldb, user_dn);
436 // Check whether a name is valid as a NetBIOS name.
437 // FIXME: There are probably more constraints here
438 function valid_netbios_name(name)
440 if (strlen(name) > 13) return false;
441 if (strstr(name, ".")) return false;
445 function provision_validate(subobj, message)
447 if (!valid_netbios_name(subobj.DOMAIN)) {
448 message("Invalid NetBIOS name for domain\n");
452 if (!valid_netbios_name(subobj.NETBIOSNAME)) {
453 message("Invalid NetBIOS name for host\n");