2 backend code for provisioning a Samba4 server
3 Copyright Andrew Tridgell 2005
4 Released under the GNU GPL v2 or later
10 return true if the current install seems to be OK
12 function install_ok(session_info, credentials)
14 var lp = loadparm_init();
16 ldb.session_info = session_info;
17 ldb.credentials = credentials;
18 if (lp.get("realm") == "") {
21 var ok = ldb.connect(lp.get("sam database"));
25 var res = ldb.search("(cn=Administrator)");
26 if (res.length != 1) {
33 find a user or group from a list of possibilities
38 assert(arguments.length >= 2);
39 var nssfn = arguments[0];
40 for (i=1;i<arguments.length;i++) {
41 if (nssfn(arguments[i]) != undefined) {
45 printf("Unable to find user/group for %s\n", arguments[1]);
46 assert(i<arguments.length);
50 add a foreign security principle
52 function add_foreign(ldb, subobj, sid, desc)
55 dn: CN=%s,CN=ForeignSecurityPrincipals,%s
57 objectClass: foreignSecurityPrincipal
60 sid, subobj.BASEDN, desc);
61 /* deliberately ignore errors from this, as the records may
68 setup a mapping between a sam name and a unix name
70 function setup_name_mapping(info, ldb, sid, unixname)
72 var attrs = new Array("dn");
73 var res = ldb.search(sprintf("objectSid=%s", sid),
74 info.subobj.BASEDN, ldb.SCOPE_SUBTREE, attrs);
75 if (res.length != 1) {
76 info.message("Failed to find record for objectSid %s\n", sid);
86 var ok = ldb.modify(mod);
88 info.message("name mapping for %s failed - %s\n",
89 sid, ldb.errstring());
96 return current time as a nt time string
100 return "" + sys.nttime();
104 return current time as a ldap time string
108 return sys.ldaptime(sys.nttime());
112 return a date string suitable for a dns zone serial number
114 function datestring()
116 var t = sys.gmtime(sys.nttime());
117 return sprintf("%04u%02u%02u%02u",
118 t.tm_year+1900, t.tm_mon+1, t.tm_mday, t.tm_hour);
126 var list = sys.interfaces();
132 return first part of hostname
136 var s = split(".", sys.hostname());
140 /* the ldb is in bad shape, possibly due to being built from an
141 incompatible previous version of the code, so delete it
143 function ldb_delete(ldb)
145 println("Deleting " + ldb.filename);
146 var lp = loadparm_init();
147 sys.unlink(sprintf("%s/%s", lp.get("private dir"), ldb.filename));
148 ldb.transaction_cancel();
150 var ok = ldb.connect(ldb.filename);
151 ldb.transaction_start();
156 erase an ldb, removing all records
158 function ldb_erase(ldb)
160 var attrs = new Array("dn");
162 /* delete the specials */
163 ldb.del("@INDEXLIST");
164 ldb.del("@ATTRIBUTES");
165 ldb.del("@SUBCLASSES");
169 var res = ldb.search("(&(|(objectclass=*)(dn=*))(!(dn=@BASEINFO)))", attrs);
171 if (typeof(res) == "undefined") {
175 for (i=0;i<res.length;i++) {
178 /* extra hack to ensure it's gone on remote ldap */
179 ldb.del("cn=ROOTDSE");
181 var res = ldb.search("(&(|(objectclass=*)(dn=*))(!(dn=@BASEINFO)))", attrs);
182 if (res.length != 0) {
186 assert(res.length == 0);
190 erase an ldb, removing all records
192 function ldb_erase_partitions(info, ldb)
194 var rootDSE_attrs = new Array("namingContexts");
195 var lp = loadparm_init();
198 var res = ldb.search("(objectClass=*)", "", ldb.SCOPE_BASE, rootDSE_attrs);
199 assert(typeof(res) != "undefined");
200 assert(res.length == 1);
201 for (j=0; j<res[0].namingContexts.length; j++) {
202 var attrs = new Array("dn");
203 var basedn = res[0].namingContexts[j];
205 var previous_remaining = 1;
206 var current_remaining = 0;
208 for (k=0; k < 10 && (previous_remaining != current_remaining); k++) {
210 var res2 = ldb.search("(|(objectclass=*)(dn=*))", basedn, ldb.SCOPE_SUBTREE, attrs);
212 if (typeof(res2) == "undefined") {
213 info.message("ldb search failed: " + ldb.errstring() + "\n");
216 previous_remaining = current_remaining;
217 current_remaining = res2.length;
218 for (i=0;i<res2.length;i++) {
222 var res3 = ldb.search("(|(objectclass=*)(dn=*))", basedn, ldb.SCOPE_SUBTREE, attrs);
223 if (res3.length != 0) {
224 info.message("Failed to delete all records under " + basedn + ", " + res3.length + " records remaining\n");
230 function open_ldb(info, dbname, erase)
232 var ldb = ldb_init();
233 ldb.session_info = info.session_info;
234 ldb.credentials = info.credentials;
235 ldb.filename = dbname;
237 var connect_ok = ldb.connect(dbname);
239 sys.unlink(sprintf("%s/%s", lp.get("private dir"), dbname));
240 connect_ok = ldb.connect(dbname);
244 ldb.transaction_start();
254 setup a ldb in the private dir
256 function setup_add_ldif(ldif, info, ldb, failok)
258 var lp = loadparm_init();
259 var src = lp.get("setup directory") + "/" + ldif;
261 var data = sys.file_load(src);
262 data = substitute_var(data, info.subobj);
264 var add_ok = ldb.add(data);
266 info.message("ldb load failed: " + ldb.errstring() + "\n");
274 function setup_ldb(ldif, info, dbname)
279 if (arguments.length >= 4) {
280 erase = arguments[3];
282 if (arguments.length == 5) {
283 failok = arguments[4];
285 var ldb = open_ldb(info, dbname, erase);
286 if (setup_add_ldif(ldif, info, ldb, erase, failok)) {
287 var commit_ok = ldb.transaction_commit();
289 info.message("ldb commit failed: " + ldb.errstring() + "\n");
296 setup a ldb in the private dir
298 function setup_ldb_modify(ldif, info, ldb)
300 var lp = loadparm_init();
302 var src = lp.get("setup directory") + "/" + ldif;
304 var data = sys.file_load(src);
305 data = substitute_var(data, info.subobj);
307 var mod_ok = ldb.modify(data);
309 info.message("ldb load failed: " + ldb.errstring() + "\n");
315 setup a file in the private dir
317 function setup_file(template, message, fname, subobj)
319 var lp = loadparm_init();
321 var src = lp.get("setup directory") + "/" + template;
325 var data = sys.file_load(src);
326 data = substitute_var(data, subobj);
328 ok = sys.file_save(f, data);
330 message("failed to create file: " + f + "\n");
335 function provision_default_paths(subobj)
337 var lp = loadparm_init();
338 var paths = new Object();
339 paths.smbconf = lp.get("config file");
340 paths.shareconf = lp.get("private dir") + "/" + "share.ldb";
341 paths.hklm = "hklm.ldb";
342 paths.hkcu = "hkcu.ldb";
343 paths.hkcr = "hkcr.ldb";
344 paths.hku = "hku.ldb";
345 paths.hkpd = "hkpd.ldb";
346 paths.hkpt = "hkpt.ldb";
347 paths.samdb = lp.get("sam database");
348 paths.secrets = "secrets.ldb";
349 paths.dns = lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".zone";
350 paths.winsdb = "wins.ldb";
351 paths.ldap_basedn_ldif = lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".ldif";
357 setup reasonable name mappings for sam names to unix names
359 function setup_name_mappings(info, subobj, ldb)
361 var lp = loadparm_init();
362 var attrs = new Array("objectSid");
363 res = ldb.search("objectSid=*", subobj.BASEDN, ldb.SCOPE_BASE, attrs);
364 assert(res.length == 1 && res[0].objectSid != undefined);
365 var sid = res[0].objectSid;
367 /* add some foreign sids if they are not present already */
368 add_foreign(ldb, subobj, "S-1-5-7", "Anonymous");
369 add_foreign(ldb, subobj, "S-1-1-0", "World");
370 add_foreign(ldb, subobj, "S-1-5-2", "Network");
371 add_foreign(ldb, subobj, "S-1-5-18", "System");
372 add_foreign(ldb, subobj, "S-1-5-11", "Authenticated Users");
374 /* some well known sids */
375 setup_name_mapping(info, ldb, "S-1-5-7", subobj.NOBODY);
376 setup_name_mapping(info, ldb, "S-1-1-0", subobj.NOGROUP);
377 setup_name_mapping(info, ldb, "S-1-5-2", subobj.NOGROUP);
378 setup_name_mapping(info, ldb, "S-1-5-18", subobj.ROOT);
379 setup_name_mapping(info, ldb, "S-1-5-11", subobj.USERS);
380 setup_name_mapping(info, ldb, "S-1-5-32-544", subobj.WHEEL);
381 setup_name_mapping(info, ldb, "S-1-5-32-545", subobj.USERS);
382 setup_name_mapping(info, ldb, "S-1-5-32-546", subobj.NOGROUP);
383 setup_name_mapping(info, ldb, "S-1-5-32-551", subobj.BACKUP);
385 /* and some well known domain rids */
386 setup_name_mapping(info, ldb, sid + "-500", subobj.ROOT);
387 setup_name_mapping(info, ldb, sid + "-518", subobj.WHEEL);
388 setup_name_mapping(info, ldb, sid + "-519", subobj.WHEEL);
389 setup_name_mapping(info, ldb, sid + "-512", subobj.WHEEL);
390 setup_name_mapping(info, ldb, sid + "-513", subobj.USERS);
391 setup_name_mapping(info, ldb, sid + "-520", subobj.WHEEL);
398 provision samba4 - caution, this wipes all existing data!
400 function provision(subobj, message, blank, paths, session_info, credentials)
402 var lp = loadparm_init();
403 var sys = sys_init();
404 var info = new Object();
407 some options need to be upper/lower case
409 subobj.REALM = strupper(subobj.REALM);
410 subobj.HOSTNAME = strlower(subobj.HOSTNAME);
411 subobj.DOMAIN = strupper(subobj.DOMAIN);
412 assert(valid_netbios_name(subobj.DOMAIN));
413 subobj.NETBIOSNAME = strupper(subobj.HOSTNAME);
414 assert(valid_netbios_name(subobj.NETBIOSNAME));
415 var rdns = split(",", subobj.BASEDN);
416 subobj.RDN_DC = substr(rdns[0], strlen("DC="));
418 info.subobj = subobj;
419 info.message = message;
420 info.credentials = credentials;
421 info.session_info = session_info;
423 /* only install a new smb.conf if there isn't one there already */
424 var st = sys.stat(paths.smbconf);
425 if (st == undefined) {
426 message("Setting up smb.conf\n");
427 setup_file("provision.smb.conf", info.message, paths.smbconf, subobj);
430 /* only install a new shares config db if there is none */
431 st = sys.stat(paths.shareconf);
432 if (st == undefined) {
433 message("Setting up sconf.ldb\n");
434 setup_ldb("share.ldif", info, paths.shareconf);
436 message("Setting up secrets.ldb\n");
437 setup_ldb("secrets.ldif", info, paths.secrets);
438 message("Setting up keytabs\n");
439 var keytab_ok = credentials_update_all_keytabs();
441 message("Setting up hklm.ldb\n");
442 setup_ldb("hklm.ldif", info, paths.hklm);
444 message("Setting up sam.ldb partitions\n");
445 /* Also wipes the database */
446 setup_ldb("provision_partitions.ldif", info, paths.samdb);
448 var samdb = open_ldb(info, paths.samdb, false);
450 message("Setting up sam.ldb attributes\n");
451 setup_add_ldif("provision_init.ldif", info, samdb, false);
452 message("Erasing data from partitions\n");
453 ldb_erase_partitions(info, samdb);
455 message("Adding baseDN: " + subobj.BASEDN + " (permitted to fail)\n");
456 setup_add_ldif("provision_basedn.ldif", info, samdb, true);
457 message("Modifying baseDN: " + subobj.BASEDN + "\n");
458 setup_ldb_modify("provision_basedn_modify.ldif", info, samdb);
460 message("Setting up sam.ldb Samba4 schema\n");
461 setup_add_ldif("schema_samba4.ldif", info, samdb, false);
462 message("Setting up sam.ldb AD schema\n");
463 setup_add_ldif("schema.ldif", info, samdb, false);
464 message("Setting up display specifiers\n");
465 setup_add_ldif("display_specifiers.ldif", info, samdb, false);
466 message("Setting up sam.ldb templates\n");
467 setup_add_ldif("provision_templates.ldif", info, samdb, false);
468 message("Setting up sam.ldb data\n");
469 setup_add_ldif("provision.ldif", info, samdb, false);
471 if (blank != false) {
472 var commit_ok = samdb.transaction_commit();
474 info.message("ldb commit failed: " + samdb.errstring() + "\n");
480 message("Setting up sam.ldb users and groups\n");
481 setup_add_ldif("provision_users.ldif", info, samdb, false);
483 if (setup_name_mappings(info, subobj, samdb) == false) {
487 var commit_ok = samdb.transaction_commit();
489 info.message("samdb commit failed: " + samdb.errstring() + "\n");
496 /* Write out a DNS zone file, from the info in the current database */
497 function provision_dns(subobj, message, paths, session_info, credentials)
499 message("Setting up DNS zone: " + subobj.DNSDOMAIN + " \n");
500 var ldb = ldb_init();
501 ldb.session_info = session_info;
502 ldb.credentials = credentials;
504 /* connect to the sam */
505 var ok = ldb.connect(paths.samdb);
508 /* These values may have changed, due to an incoming SamSync, so fetch them from the database */
509 var attrs = new Array("objectGUID");
510 res = ldb.search("objectGUID=*", subobj.BASEDN, ldb.SCOPE_BASE, attrs);
511 assert(res.length == 1 && res[0].objectGUID != undefined)
512 subobj.DOMAINGUID = res[0].objectGUID;
514 subobj.HOSTGUID = searchone(ldb, subobj.BASEDN, "(&(objectClass=computer)(cn=" + subobj.NETBIOSNAME + "))", "objectGUID");
515 assert(subobj.HOSTGUID != undefined);
517 setup_file("provision.zone",
521 message("Please install the zone located in " + paths.dns + " into your DNS server\n");
524 /* Write out a DNS zone file, from the info in the current database */
525 function provision_ldapbase(subobj, message, paths)
527 message("Setting up LDAP base entry: " + subobj.BASEDN + " \n");
528 var rdns = split(",", subobj.BASEDN);
529 subobj.RDN_DC = substr(rdns[0], strlen("DC="));
531 setup_file("provision_basedn.ldif",
532 message, paths.ldap_basedn_ldif,
535 message("Please install the LDIF located in " + paths.ldap_basedn_ldif + " into your LDAP server, and re-run with --ldap-backend=ldap://my.ldap.server\n");
540 guess reasonably default options for provisioning
542 function provision_guess()
544 var subobj = new Object();
545 var nss = nss_init();
546 var lp = loadparm_init();
550 subobj.REALM = strupper(lp.get("realm"));
551 subobj.DOMAIN = lp.get("workgroup");
552 subobj.HOSTNAME = hostname();
554 assert(subobj.REALM);
555 assert(subobj.DOMAIN);
556 assert(subobj.HOSTNAME);
558 subobj.VERSION = version();
559 subobj.HOSTIP = hostip();
560 subobj.DOMAINGUID = randguid();
561 subobj.DOMAINSID = randsid();
562 subobj.HOSTGUID = randguid();
563 subobj.INVOCATIONID = randguid();
564 subobj.KRBTGTPASS = randpass(12);
565 subobj.MACHINEPASS = randpass(12);
566 subobj.ADMINPASS = randpass(12);
567 subobj.DEFAULTSITE = "Default-First-Site-Name";
568 subobj.NEWGUID = randguid;
569 subobj.NTTIME = nttime;
570 subobj.LDAPTIME = ldaptime;
571 subobj.DATESTRING = datestring;
572 subobj.ROOT = findnss(nss.getpwnam, "root");
573 subobj.NOBODY = findnss(nss.getpwnam, "nobody");
574 subobj.NOGROUP = findnss(nss.getgrnam, "nogroup", "nobody");
575 subobj.WHEEL = findnss(nss.getgrnam, "wheel", "root", "staff");
576 subobj.BACKUP = findnss(nss.getgrnam, "backup", "wheel", "root", "staff");
577 subobj.USERS = findnss(nss.getgrnam, "users", "guest", "other", "unknown");
578 subobj.DNSDOMAIN = strlower(subobj.REALM);
579 subobj.DNSNAME = sprintf("%s.%s",
580 strlower(subobj.HOSTNAME),
582 rdn_list = split(".", subobj.DNSDOMAIN);
583 subobj.BASEDN = "DC=" + join(",DC=", rdn_list);
584 subobj.LDAPBACKEND = "users.ldb";
589 search for one attribute as a string
591 function searchone(ldb, basedn, expression, attribute)
593 var attrs = new Array(attribute);
594 res = ldb.search(expression, basedn, ldb.SCOPE_SUBTREE, attrs);
595 if (res.length != 1 ||
596 res[0][attribute] == undefined) {
599 return res[0][attribute];
603 modify an account to remove the
605 function enable_account(ldb, user_dn)
607 var attrs = new Array("userAccountControl");
608 var res = ldb.search(NULL, user_dn, ldb.SCOPE_ONELEVEL, attrs);
609 assert(res.length == 1);
610 var userAccountControl = res[0].userAccountControl;
611 userAccountControl = userAccountControl - 2; /* remove disabled bit */
615 replace: userAccountControl
616 userAccountControl: %u
618 user_dn, userAccountControl);
619 var ok = ldb.modify(mod);
625 add a new user record
627 function newuser(username, unixname, password, message, session_info, credentials)
629 var lp = loadparm_init();
630 var samdb = lp.get("sam database");
631 var ldb = ldb_init();
633 ldb.session_info = session_info;
634 ldb.credentials = credentials;
636 /* connect to the sam */
637 var ok = ldb.connect(samdb);
640 ldb.transaction_start();
642 /* find the DNs for the domain and the domain users group */
643 var attrs = new Array("defaultNamingContext");
644 res = ldb.search("defaultNamingContext=*", "", ldb.SCOPE_BASE, attrs);
645 assert(res.length == 1 && res[0].defaultNamingContext != undefined);
646 var domain_dn = res[0].defaultNamingContext;
647 assert(domain_dn != undefined);
648 var dom_users = searchone(ldb, domain_dn, "name=Domain Users", "dn");
649 assert(dom_users != undefined);
651 var user_dn = sprintf("CN=%s,CN=Users,%s", username, domain_dn);
655 the new user record. note the reliance on the samdb module to fill
666 user_dn, username, dom_users,
669 add the user to the users group as well
671 var modgroup = sprintf("
683 message("Adding user %s\n", user_dn);
686 message("Failed to add %s - %s\n", user_dn, ldb.errstring());
690 message("Modifying group %s\n", dom_users);
691 ok = ldb.modify(modgroup);
693 message("Failed to modify %s - %s\n", dom_users, ldb.errstring());
698 modify the userAccountControl to remove the disabled bit
700 ok = enable_account(ldb, user_dn);
702 ldb.transaction_commit();
707 // Check whether a name is valid as a NetBIOS name.
708 // FIXME: There are probably more constraints here.
709 // crh has a paragraph on this in his book (1.4.1.1)
710 function valid_netbios_name(name)
712 if (strlen(name) > 13) return false;
716 function provision_validate(subobj, message)
718 var lp = loadparm_init();
720 if (!valid_netbios_name(subobj.DOMAIN)) {
721 message("Invalid NetBIOS name for domain\n");
725 if (!valid_netbios_name(subobj.NETBIOSNAME)) {
726 message("Invalid NetBIOS name for host\n");
731 if (strupper(lp.get("workgroup")) != strupper(subobj.DOMAIN)) {
732 message("workgroup '%s' in smb.conf must match chosen domain '%s'\n",
733 lp.get("workgroup"), subobj.DOMAIN);
737 if (strupper(lp.get("realm")) != strupper(subobj.REALM)) {
738 message("realm '%s' in smb.conf must match chosen realm '%s'\n",
739 lp.get("realm"), subobj.REALM);
746 function join_domain(domain, netbios_name, join_type, creds, message)
748 var ctx = NetContext(creds);
749 var joindom = new Object();
750 joindom.domain = domain;
751 joindom.join_type = join_type;
752 joindom.netbios_name = netbios_name;
753 if (!ctx.JoinDomain(joindom)) {
754 message("Domain Join failed: " + joindom.error_string);
760 /* Vampire a remote domain. Session info and credentials are required for for
761 * access to our local database (might be remote ldap)
764 function vampire(domain, session_info, credentials, message) {
765 var ctx = NetContext(credentials);
766 var vampire_ctx = new Object();
767 var machine_creds = credentials_init();
768 machine_creds.set_domain(form.DOMAIN);
769 if (!machine_creds.set_machine_account()) {
770 message("Failed to access domain join information!");
773 vampire_ctx.machine_creds = machine_creds;
774 vampire_ctx.session_info = session_info;
775 if (!ctx.SamSyncLdb(vampire_ctx)) {
776 message("Migration of remote domain to Samba failed: " + vampire_ctx.error_string);