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.ntgmtime(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)
162 /* delete the specials */
163 ldb.del("@INDEXLIST");
164 ldb.del("@ATTRIBUTES");
165 ldb.del("@SUBCLASSES");
167 ldb.del("@PARTITION");
168 ldb.del("@KLUDGEACL");
171 attrs = new Array("dn");
173 var res = ldb.search("(&(|(objectclass=*)(dn=*))(!(dn=@BASEINFO)))", basedn, ldb.SCOPE_SUBTREE, attrs);
175 if (typeof(res) == "undefined") {
179 for (i=0;i<res.length;i++) {
184 var res = ldb.search("(&(|(objectclass=*)(dn=*))(!(dn=@BASEINFO)))", basedn, ldb.SCOPE_SUBTREE, attrs);
185 if (res.length != 0) {
189 assert(res.length == 0);
193 erase an ldb, removing all records
195 function ldb_erase_partitions(info, ldb)
197 var rootDSE_attrs = new Array("namingContexts");
198 var lp = loadparm_init();
201 var res = ldb.search("(objectClass=*)", "", ldb.SCOPE_BASE, rootDSE_attrs);
202 assert(typeof(res) != "undefined");
203 assert(res.length == 1);
204 if (typeof(res[0].namingContexts) == "undefined") {
207 for (j=0; j<res[0].namingContexts.length; j++) {
208 var attrs = new Array("dn");
209 var basedn = res[0].namingContexts[j];
211 var previous_remaining = 1;
212 var current_remaining = 0;
214 for (k=0; k < 10 && (previous_remaining != current_remaining); k++) {
216 var res2 = ldb.search("(|(objectclass=*)(dn=*))", basedn, ldb.SCOPE_SUBTREE, attrs);
218 if (typeof(res2) == "undefined") {
219 info.message("ldb search failed: " + ldb.errstring() + "\n");
222 previous_remaining = current_remaining;
223 current_remaining = res2.length;
224 for (i=0;i<res2.length;i++) {
228 var res3 = ldb.search("(|(objectclass=*)(dn=*))", basedn, ldb.SCOPE_SUBTREE, attrs);
229 if (typeof(res3) == "undefined") {
230 info.message("ldb search failed: " + ldb.errstring() + "\n");
233 if (res3.length != 0) {
234 info.message("Failed to delete all records under " + basedn + ", " + res3.length + " records remaining\n");
240 function open_ldb(info, dbname, erase)
242 var ldb = ldb_init();
243 ldb.session_info = info.session_info;
244 ldb.credentials = info.credentials;
245 ldb.filename = dbname;
247 var connect_ok = ldb.connect(dbname);
249 var lp = loadparm_init();
250 sys.unlink(sprintf("%s/%s", lp.get("private dir"), dbname));
251 connect_ok = ldb.connect(dbname);
255 ldb.transaction_start();
265 setup a ldb in the private dir
267 function setup_add_ldif(ldif, info, ldb, failok)
269 var lp = loadparm_init();
270 var src = lp.get("setup directory") + "/" + ldif;
272 var data = sys.file_load(src);
273 data = substitute_var(data, info.subobj);
275 var add_ok = ldb.add(data);
277 info.message("ldb load failed: " + ldb.errstring() + "\n");
285 function setup_modify_ldif(ldif, info, ldb, failok)
287 var lp = loadparm_init();
288 var src = lp.get("setup directory") + "/" + ldif;
290 var data = sys.file_load(src);
291 data = substitute_var(data, info.subobj);
293 var mod_ok = ldb.modify(data);
295 info.message("ldb load failed: " + ldb.errstring() + "\n");
304 function setup_ldb(ldif, info, dbname)
309 if (arguments.length >= 4) {
310 erase = arguments[3];
312 if (arguments.length == 5) {
313 failok = arguments[4];
315 var ldb = open_ldb(info, dbname, erase);
316 if (setup_add_ldif(ldif, info, ldb, failok)) {
317 var commit_ok = ldb.transaction_commit();
319 info.message("ldb commit failed: " + ldb.errstring() + "\n");
326 setup a ldb in the private dir
328 function setup_ldb_modify(ldif, info, ldb)
330 var lp = loadparm_init();
332 var src = lp.get("setup directory") + "/" + ldif;
334 var data = sys.file_load(src);
335 data = substitute_var(data, info.subobj);
337 var mod_ok = ldb.modify(data);
339 info.message("ldb load failed: " + ldb.errstring() + "\n");
346 setup a file in the private dir
348 function setup_file(template, message, fname, subobj)
350 var lp = loadparm_init();
352 var src = lp.get("setup directory") + "/" + template;
356 var data = sys.file_load(src);
357 data = substitute_var(data, subobj);
359 ok = sys.file_save(f, data);
361 message("failed to create file: " + f + "\n");
366 function provision_default_paths(subobj)
368 var lp = loadparm_init();
369 var paths = new Object();
370 paths.smbconf = lp.get("config file");
371 paths.shareconf = lp.get("private dir") + "/" + "share.ldb";
372 paths.hklm = "hklm.ldb";
373 paths.hkcu = "hkcu.ldb";
374 paths.hkcr = "hkcr.ldb";
375 paths.hku = "hku.ldb";
376 paths.hkpd = "hkpd.ldb";
377 paths.hkpt = "hkpt.ldb";
378 paths.samdb = lp.get("sam database");
379 paths.secrets = "secrets.ldb";
380 paths.dns = lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".zone";
381 paths.winsdb = "wins.ldb";
382 paths.ldap_basedn_ldif = lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".ldif";
388 setup reasonable name mappings for sam names to unix names
390 function setup_name_mappings(info, ldb)
392 var lp = loadparm_init();
393 var attrs = new Array("objectSid");
394 var subobj = info.subobj;
396 res = ldb.search("objectSid=*", subobj.BASEDN, ldb.SCOPE_BASE, attrs);
397 assert(res.length == 1 && res[0].objectSid != undefined);
398 var sid = res[0].objectSid;
400 /* add some foreign sids if they are not present already */
401 add_foreign(ldb, subobj, "S-1-5-7", "Anonymous");
402 add_foreign(ldb, subobj, "S-1-1-0", "World");
403 add_foreign(ldb, subobj, "S-1-5-2", "Network");
404 add_foreign(ldb, subobj, "S-1-5-18", "System");
405 add_foreign(ldb, subobj, "S-1-5-11", "Authenticated Users");
407 /* some well known sids */
408 setup_name_mapping(info, ldb, "S-1-5-7", subobj.NOBODY);
409 setup_name_mapping(info, ldb, "S-1-1-0", subobj.NOGROUP);
410 setup_name_mapping(info, ldb, "S-1-5-2", subobj.NOGROUP);
411 setup_name_mapping(info, ldb, "S-1-5-18", subobj.ROOT);
412 setup_name_mapping(info, ldb, "S-1-5-11", subobj.USERS);
413 setup_name_mapping(info, ldb, "S-1-5-32-544", subobj.WHEEL);
414 setup_name_mapping(info, ldb, "S-1-5-32-545", subobj.USERS);
415 setup_name_mapping(info, ldb, "S-1-5-32-546", subobj.NOGROUP);
416 setup_name_mapping(info, ldb, "S-1-5-32-551", subobj.BACKUP);
418 /* and some well known domain rids */
419 setup_name_mapping(info, ldb, sid + "-500", subobj.ROOT);
420 setup_name_mapping(info, ldb, sid + "-518", subobj.WHEEL);
421 setup_name_mapping(info, ldb, sid + "-519", subobj.WHEEL);
422 setup_name_mapping(info, ldb, sid + "-512", subobj.WHEEL);
423 setup_name_mapping(info, ldb, sid + "-513", subobj.USERS);
424 setup_name_mapping(info, ldb, sid + "-520", subobj.WHEEL);
431 provision samba4 - caution, this wipes all existing data!
433 function provision(subobj, message, blank, paths, session_info, credentials)
435 var lp = loadparm_init();
436 var sys = sys_init();
437 var info = new Object();
440 some options need to be upper/lower case
442 subobj.REALM = strupper(subobj.REALM);
443 subobj.HOSTNAME = strlower(subobj.HOSTNAME);
444 subobj.DOMAIN = strupper(subobj.DOMAIN);
445 assert(valid_netbios_name(subobj.DOMAIN));
446 subobj.NETBIOSNAME = strupper(subobj.HOSTNAME);
447 assert(valid_netbios_name(subobj.NETBIOSNAME));
448 var rdns = split(",", subobj.BASEDN);
449 subobj.RDN_DC = substr(rdns[0], strlen("DC="));
451 if (subobj.DOMAINGUID != undefined) {
452 subobj.DOMAINGUID_MOD = sprintf("replace: objectGUID\nobjectGUID: %s\n-", subobj.DOMAINGUID);
454 subobj.DOMAINGUID_MOD = "";
457 if (subobj.HOSTGUID != undefined) {
458 subobj.HOSTGUID_ADD = sprintf("objectGUID: %s", subobj.HOSTGUID);
460 subobj.HOSTGUID_ADD = "";
463 info.subobj = subobj;
464 info.message = message;
465 info.credentials = credentials;
466 info.session_info = session_info;
468 /* only install a new smb.conf if there isn't one there already */
469 var st = sys.stat(paths.smbconf);
470 if (st == undefined) {
471 message("Setting up smb.conf\n");
472 setup_file("provision.smb.conf", info.message, paths.smbconf, subobj);
475 /* only install a new shares config db if there is none */
476 st = sys.stat(paths.shareconf);
477 if (st == undefined) {
478 message("Setting up share.ldb\n");
479 setup_ldb("share.ldif", info, paths.shareconf);
481 message("Setting up secrets.ldb\n");
482 setup_ldb("secrets.ldif", info, paths.secrets);
483 message("Setting up keytabs\n");
484 var keytab_ok = credentials_update_all_keytabs();
486 message("Setting up hklm.ldb\n");
487 setup_ldb("hklm.ldif", info, paths.hklm);
489 message("Setting up sam.ldb partitions\n");
490 /* Also wipes the database */
491 setup_ldb("provision_partitions.ldif", info, paths.samdb);
493 var samdb = open_ldb(info, paths.samdb, false);
495 message("Setting up sam.ldb attributes\n");
496 setup_add_ldif("provision_init.ldif", info, samdb, false);
497 message("Erasing data from partitions\n");
498 ldb_erase_partitions(info, samdb);
500 message("Adding baseDN: " + subobj.BASEDN + " (permitted to fail)\n");
501 var add_ok = setup_add_ldif("provision_basedn.ldif", info, samdb, true);
502 message("Modifying baseDN: " + subobj.BASEDN + "\n");
503 var modify_ok = setup_ldb_modify("provision_basedn_modify.ldif", info, samdb);
506 message("Failed to both add and modify " + subobj.BASEDN + " in target " + subobj.LDAPBACKEND + "\n");
507 message("Perhaps you need to run the provision script with the --ldap-base-dn option, and add this record to the backend manually\n");
512 message("Setting up sam.ldb Samba4 schema\n");
513 setup_add_ldif("schema_samba4.ldif", info, samdb, false);
514 message("Setting up sam.ldb AD schema\n");
515 setup_add_ldif("schema.ldif", info, samdb, false);
517 // (hack) Reload, now we have the schema loaded.
518 var commit_ok = samdb.transaction_commit();
520 info.message("samdb commit failed: " + samdb.errstring() + "\n");
525 samdb = open_ldb(info, paths.samdb, false);
527 message("Setting up display specifiers\n");
528 setup_add_ldif("display_specifiers.ldif", info, samdb, false);
529 message("Setting up sam.ldb templates\n");
530 setup_add_ldif("provision_templates.ldif", info, samdb, false);
531 message("Setting up sam.ldb data\n");
532 setup_add_ldif("provision.ldif", info, samdb, false);
534 if (blank != false) {
535 message("Setting up sam.ldb index\n");
536 setup_add_ldif("provision_index.ldif", info, samdb, false);
538 var commit_ok = samdb.transaction_commit();
540 info.message("ldb commit failed: " + samdb.errstring() + "\n");
546 // message("Activate schema module");
547 // setup_modify_ldif("schema_activation.ldif", info, samdb, false);
549 // // (hack) Reload, now we have the schema loaded.
550 // var commit_ok = samdb.transaction_commit();
552 // info.message("samdb commit failed: " + samdb.errstring() + "\n");
553 // assert(commit_ok);
557 // samdb = open_ldb(info, paths.samdb, false);
559 message("Setting up sam.ldb users and groups\n");
560 setup_add_ldif("provision_users.ldif", info, samdb, false);
562 if (setup_name_mappings(info, samdb) == false) {
566 message("Setting up sam.ldb index\n");
567 setup_add_ldif("provision_index.ldif", info, samdb, false);
569 var commit_ok = samdb.transaction_commit();
571 info.message("samdb commit failed: " + samdb.errstring() + "\n");
578 /* Write out a DNS zone file, from the info in the current database */
579 function provision_dns(subobj, message, paths, session_info, credentials)
581 message("Setting up DNS zone: " + subobj.DNSDOMAIN + " \n");
582 var ldb = ldb_init();
583 ldb.session_info = session_info;
584 ldb.credentials = credentials;
586 /* connect to the sam */
587 var ok = ldb.connect(paths.samdb);
590 /* These values may have changed, due to an incoming SamSync,
591 or may not have been specified, so fetch them from the database */
593 var attrs = new Array("objectGUID");
594 res = ldb.search("objectGUID=*", subobj.BASEDN, ldb.SCOPE_BASE, attrs);
595 assert(res.length == 1);
596 assert(res[0].objectGUID != undefined);
597 subobj.DOMAINGUID = res[0].objectGUID;
599 subobj.HOSTGUID = searchone(ldb, subobj.BASEDN, "(&(objectClass=computer)(cn=" + subobj.NETBIOSNAME + "))", "objectGUID");
600 assert(subobj.HOSTGUID != undefined);
602 setup_file("provision.zone",
606 message("Please install the zone located in " + paths.dns + " into your DNS server\n");
609 /* Write out a DNS zone file, from the info in the current database */
610 function provision_ldapbase(subobj, message, paths)
612 message("Setting up LDAP base entry: " + subobj.BASEDN + " \n");
613 var rdns = split(",", subobj.BASEDN);
614 subobj.EXTENSIBLEOBJECT = "objectClass: extensibleObject";
616 subobj.RDN_DC = substr(rdns[0], strlen("DC="));
618 setup_file("provision_basedn.ldif",
619 message, paths.ldap_basedn_ldif,
622 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");
627 guess reasonably default options for provisioning
629 function provision_guess()
631 var subobj = new Object();
632 var nss = nss_init();
633 var lp = loadparm_init();
637 subobj.REALM = strupper(lp.get("realm"));
638 subobj.DOMAIN = lp.get("workgroup");
639 subobj.HOSTNAME = hostname();
641 assert(subobj.REALM);
642 assert(subobj.DOMAIN);
643 assert(subobj.HOSTNAME);
645 subobj.VERSION = version();
646 subobj.HOSTIP = hostip();
647 subobj.DOMAINSID = randsid();
648 subobj.INVOCATIONID = randguid();
649 subobj.KRBTGTPASS = randpass(12);
650 subobj.MACHINEPASS = randpass(12);
651 subobj.ADMINPASS = randpass(12);
652 subobj.DEFAULTSITE = "Default-First-Site-Name";
653 subobj.NEWGUID = randguid;
654 subobj.NTTIME = nttime;
655 subobj.LDAPTIME = ldaptime;
656 subobj.DATESTRING = datestring;
657 subobj.ROOT = findnss(nss.getpwnam, "root");
658 subobj.NOBODY = findnss(nss.getpwnam, "nobody");
659 subobj.NOGROUP = findnss(nss.getgrnam, "nogroup", "nobody");
660 subobj.WHEEL = findnss(nss.getgrnam, "wheel", "root", "staff", "adm");
661 subobj.BACKUP = findnss(nss.getgrnam, "backup", "wheel", "root", "staff");
662 subobj.USERS = findnss(nss.getgrnam, "users", "guest", "other", "unknown", "usr");
663 subobj.DNSDOMAIN = strlower(subobj.REALM);
664 subobj.DNSNAME = sprintf("%s.%s",
665 strlower(subobj.HOSTNAME),
667 rdn_list = split(".", subobj.DNSDOMAIN);
668 subobj.BASEDN = "DC=" + join(",DC=", rdn_list);
669 subobj.LDAPBACKEND = "users.ldb";
670 subobj.LDAPMODULES = "objectguid";
671 subobj.EXTENSIBLEOBJECT = "# no objectClass: extensibleObject for local ldb";
676 search for one attribute as a string
678 function searchone(ldb, basedn, expression, attribute)
680 var attrs = new Array(attribute);
681 res = ldb.search(expression, basedn, ldb.SCOPE_SUBTREE, attrs);
682 if (res.length != 1 ||
683 res[0][attribute] == undefined) {
686 return res[0][attribute];
690 modify an account to remove the
692 function enable_account(ldb, user_dn)
694 var attrs = new Array("userAccountControl");
695 var res = ldb.search(NULL, user_dn, ldb.SCOPE_ONELEVEL, attrs);
696 assert(res.length == 1);
697 var userAccountControl = res[0].userAccountControl;
698 userAccountControl = userAccountControl - 2; /* remove disabled bit */
702 replace: userAccountControl
703 userAccountControl: %u
705 user_dn, userAccountControl);
706 var ok = ldb.modify(mod);
712 add a new user record
714 function newuser(username, unixname, password, message, session_info, credentials)
716 var lp = loadparm_init();
717 var samdb = lp.get("sam database");
718 var ldb = ldb_init();
720 ldb.session_info = session_info;
721 ldb.credentials = credentials;
723 /* connect to the sam */
724 var ok = ldb.connect(samdb);
727 ldb.transaction_start();
729 /* find the DNs for the domain and the domain users group */
730 var attrs = new Array("defaultNamingContext");
731 res = ldb.search("defaultNamingContext=*", "", ldb.SCOPE_BASE, attrs);
732 assert(res.length == 1 && res[0].defaultNamingContext != undefined);
733 var domain_dn = res[0].defaultNamingContext;
734 assert(domain_dn != undefined);
735 var dom_users = searchone(ldb, domain_dn, "name=Domain Users", "dn");
736 assert(dom_users != undefined);
738 var user_dn = sprintf("CN=%s,CN=Users,%s", username, domain_dn);
742 the new user record. note the reliance on the samdb module to fill
753 user_dn, username, dom_users,
756 add the user to the users group as well
758 var modgroup = sprintf("
770 message("Adding user %s\n", user_dn);
773 message("Failed to add %s - %s\n", user_dn, ldb.errstring());
777 message("Modifying group %s\n", dom_users);
778 ok = ldb.modify(modgroup);
780 message("Failed to modify %s - %s\n", dom_users, ldb.errstring());
785 modify the userAccountControl to remove the disabled bit
787 ok = enable_account(ldb, user_dn);
789 ldb.transaction_commit();
794 // Check whether a name is valid as a NetBIOS name.
795 // FIXME: There are probably more constraints here.
796 // crh has a paragraph on this in his book (1.4.1.1)
797 function valid_netbios_name(name)
799 if (strlen(name) > 13) return false;
803 function provision_validate(subobj, message)
805 var lp = loadparm_init();
807 if (!valid_netbios_name(subobj.DOMAIN)) {
808 message("Invalid NetBIOS name for domain\n");
812 if (!valid_netbios_name(subobj.NETBIOSNAME)) {
813 message("Invalid NetBIOS name for host\n");
818 if (strupper(lp.get("workgroup")) != strupper(subobj.DOMAIN)) {
819 message("workgroup '%s' in smb.conf must match chosen domain '%s'\n",
820 lp.get("workgroup"), subobj.DOMAIN);
824 if (strupper(lp.get("realm")) != strupper(subobj.REALM)) {
825 message("realm '%s' in smb.conf must match chosen realm '%s'\n",
826 lp.get("realm"), subobj.REALM);
833 function join_domain(domain, netbios_name, join_type, creds, message)
835 var ctx = NetContext(creds);
836 var joindom = new Object();
837 joindom.domain = domain;
838 joindom.join_type = join_type;
839 joindom.netbios_name = netbios_name;
840 if (!ctx.JoinDomain(joindom)) {
841 message("Domain Join failed: " + joindom.error_string);
847 /* Vampire a remote domain. Session info and credentials are required for for
848 * access to our local database (might be remote ldap)
851 function vampire(domain, session_info, credentials, message) {
852 var ctx = NetContext(credentials);
853 var vampire_ctx = new Object();
854 var machine_creds = credentials_init();
855 machine_creds.set_domain(form.DOMAIN);
856 if (!machine_creds.set_machine_account()) {
857 message("Failed to access domain join information!");
860 vampire_ctx.machine_creds = machine_creds;
861 vampire_ctx.session_info = session_info;
862 if (!ctx.SamSyncLdb(vampire_ctx)) {
863 message("Migration of remote domain to Samba failed: " + vampire_ctx.error_string);