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)
160 var attrs = new Array("dn");
162 /* delete the specials */
163 ldb.del("@INDEXLIST");
164 ldb.del("@ATTRIBUTES");
165 ldb.del("@SUBCLASSES");
167 ldb.del("@PARTITION");
168 ldb.del("@KLUDGEACL");
172 var res = ldb.search("(&(|(objectclass=*)(dn=*))(!(dn=@BASEINFO)))", basedn, ldb.SCOPE_SUBTREE, attrs);
174 if (typeof(res) == "undefined") {
178 for (i=0;i<res.length;i++) {
182 var res = ldb.search("(&(|(objectclass=*)(dn=*))(!(dn=@BASEINFO)))", basedn, ldb.SCOPE_SUBTREE, attrs);
183 if (res.length != 0) {
187 assert(res.length == 0);
191 erase an ldb, removing all records
193 function ldb_erase_partitions(info, ldb)
195 var rootDSE_attrs = new Array("namingContexts");
196 var lp = loadparm_init();
199 var res = ldb.search("(objectClass=*)", "", ldb.SCOPE_BASE, rootDSE_attrs);
200 assert(typeof(res) != "undefined");
201 assert(res.length == 1);
202 if (typeof(res[0].namingContexts) == "undefined") {
205 for (j=0; j<res[0].namingContexts.length; j++) {
206 var attrs = new Array("dn");
207 var basedn = res[0].namingContexts[j];
209 var previous_remaining = 1;
210 var current_remaining = 0;
212 for (k=0; k < 10 && (previous_remaining != current_remaining); k++) {
214 var res2 = ldb.search("(|(objectclass=*)(dn=*))", basedn, ldb.SCOPE_SUBTREE, attrs);
216 if (typeof(res2) == "undefined") {
217 info.message("ldb search failed: " + ldb.errstring() + "\n");
220 previous_remaining = current_remaining;
221 current_remaining = res2.length;
222 for (i=0;i<res2.length;i++) {
226 var res3 = ldb.search("(|(objectclass=*)(dn=*))", basedn, ldb.SCOPE_SUBTREE, attrs);
227 if (typeof(res3) == "undefined") {
228 info.message("ldb search failed: " + ldb.errstring() + "\n");
231 if (res3.length != 0) {
232 info.message("Failed to delete all records under " + basedn + ", " + res3.length + " records remaining\n");
238 function open_ldb(info, dbname, erase)
240 var ldb = ldb_init();
241 ldb.session_info = info.session_info;
242 ldb.credentials = info.credentials;
243 ldb.filename = dbname;
245 var connect_ok = ldb.connect(dbname);
247 var lp = loadparm_init();
248 sys.unlink(sprintf("%s/%s", lp.get("private dir"), dbname));
249 connect_ok = ldb.connect(dbname);
253 ldb.transaction_start();
263 setup a ldb in the private dir
265 function setup_add_ldif(ldif, info, ldb, failok)
267 var lp = loadparm_init();
268 var src = lp.get("setup directory") + "/" + ldif;
270 var data = sys.file_load(src);
271 data = substitute_var(data, info.subobj);
273 var add_ok = ldb.add(data);
275 info.message("ldb load failed: " + ldb.errstring() + "\n");
283 function setup_ldb(ldif, info, dbname)
288 if (arguments.length >= 4) {
289 erase = arguments[3];
291 if (arguments.length == 5) {
292 failok = arguments[4];
294 var ldb = open_ldb(info, dbname, erase);
295 if (setup_add_ldif(ldif, info, ldb, erase, failok)) {
296 var commit_ok = ldb.transaction_commit();
298 info.message("ldb commit failed: " + ldb.errstring() + "\n");
305 setup a ldb in the private dir
307 function setup_ldb_modify(ldif, info, ldb)
309 var lp = loadparm_init();
311 var src = lp.get("setup directory") + "/" + ldif;
313 var data = sys.file_load(src);
314 data = substitute_var(data, info.subobj);
316 var mod_ok = ldb.modify(data);
318 info.message("ldb load failed: " + ldb.errstring() + "\n");
325 setup a file in the private dir
327 function setup_file(template, message, fname, subobj)
329 var lp = loadparm_init();
331 var src = lp.get("setup directory") + "/" + template;
335 var data = sys.file_load(src);
336 data = substitute_var(data, subobj);
338 ok = sys.file_save(f, data);
340 message("failed to create file: " + f + "\n");
345 function provision_default_paths(subobj)
347 var lp = loadparm_init();
348 var paths = new Object();
349 paths.smbconf = lp.get("config file");
350 paths.shareconf = lp.get("private dir") + "/" + "share.ldb";
351 paths.hklm = "hklm.ldb";
352 paths.hkcu = "hkcu.ldb";
353 paths.hkcr = "hkcr.ldb";
354 paths.hku = "hku.ldb";
355 paths.hkpd = "hkpd.ldb";
356 paths.hkpt = "hkpt.ldb";
357 paths.samdb = lp.get("sam database");
358 paths.secrets = "secrets.ldb";
359 paths.dns = lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".zone";
360 paths.winsdb = "wins.ldb";
361 paths.ldap_basedn_ldif = lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".ldif";
367 setup reasonable name mappings for sam names to unix names
369 function setup_name_mappings(info, subobj, ldb)
371 var lp = loadparm_init();
372 var attrs = new Array("objectSid");
373 res = ldb.search("objectSid=*", subobj.BASEDN, ldb.SCOPE_BASE, attrs);
374 assert(res.length == 1 && res[0].objectSid != undefined);
375 var sid = res[0].objectSid;
377 /* add some foreign sids if they are not present already */
378 add_foreign(ldb, subobj, "S-1-5-7", "Anonymous");
379 add_foreign(ldb, subobj, "S-1-1-0", "World");
380 add_foreign(ldb, subobj, "S-1-5-2", "Network");
381 add_foreign(ldb, subobj, "S-1-5-18", "System");
382 add_foreign(ldb, subobj, "S-1-5-11", "Authenticated Users");
384 /* some well known sids */
385 setup_name_mapping(info, ldb, "S-1-5-7", subobj.NOBODY);
386 setup_name_mapping(info, ldb, "S-1-1-0", subobj.NOGROUP);
387 setup_name_mapping(info, ldb, "S-1-5-2", subobj.NOGROUP);
388 setup_name_mapping(info, ldb, "S-1-5-18", subobj.ROOT);
389 setup_name_mapping(info, ldb, "S-1-5-11", subobj.USERS);
390 setup_name_mapping(info, ldb, "S-1-5-32-544", subobj.WHEEL);
391 setup_name_mapping(info, ldb, "S-1-5-32-545", subobj.USERS);
392 setup_name_mapping(info, ldb, "S-1-5-32-546", subobj.NOGROUP);
393 setup_name_mapping(info, ldb, "S-1-5-32-551", subobj.BACKUP);
395 /* and some well known domain rids */
396 setup_name_mapping(info, ldb, sid + "-500", subobj.ROOT);
397 setup_name_mapping(info, ldb, sid + "-518", subobj.WHEEL);
398 setup_name_mapping(info, ldb, sid + "-519", subobj.WHEEL);
399 setup_name_mapping(info, ldb, sid + "-512", subobj.WHEEL);
400 setup_name_mapping(info, ldb, sid + "-513", subobj.USERS);
401 setup_name_mapping(info, ldb, sid + "-520", subobj.WHEEL);
408 provision samba4 - caution, this wipes all existing data!
410 function provision(subobj, message, blank, paths, session_info, credentials)
412 var lp = loadparm_init();
413 var sys = sys_init();
414 var info = new Object();
417 some options need to be upper/lower case
419 subobj.REALM = strupper(subobj.REALM);
420 subobj.HOSTNAME = strlower(subobj.HOSTNAME);
421 subobj.DOMAIN = strupper(subobj.DOMAIN);
422 assert(valid_netbios_name(subobj.DOMAIN));
423 subobj.NETBIOSNAME = strupper(subobj.HOSTNAME);
424 assert(valid_netbios_name(subobj.NETBIOSNAME));
425 var rdns = split(",", subobj.BASEDN);
426 subobj.RDN_DC = substr(rdns[0], strlen("DC="));
428 if (subobj.DOMAINGUID != undefined) {
429 subobj.DOMAINGUID_MOD = sprintf("replace: objectGUID\nobjectGUID: %s\n-", subobj.DOMAINGUID);
431 subobj.DOMAINGUID_MOD = "";
434 if (subobj.HOSTGUID != undefined) {
435 subobj.HOSTGUID_ADD = sprintf("objectGUID: %s", subobj.HOSTGUID);
437 subobj.HOSTGUID_ADD = "";
440 info.subobj = subobj;
441 info.message = message;
442 info.credentials = credentials;
443 info.session_info = session_info;
445 /* only install a new smb.conf if there isn't one there already */
446 var st = sys.stat(paths.smbconf);
447 if (st == undefined) {
448 message("Setting up smb.conf\n");
449 setup_file("provision.smb.conf", info.message, paths.smbconf, subobj);
452 /* only install a new shares config db if there is none */
453 st = sys.stat(paths.shareconf);
454 if (st == undefined) {
455 message("Setting up sconf.ldb\n");
456 setup_ldb("share.ldif", info, paths.shareconf);
458 message("Setting up secrets.ldb\n");
459 setup_ldb("secrets.ldif", info, paths.secrets);
460 message("Setting up keytabs\n");
461 var keytab_ok = credentials_update_all_keytabs();
463 message("Setting up hklm.ldb\n");
464 setup_ldb("hklm.ldif", info, paths.hklm);
466 message("Setting up sam.ldb partitions\n");
467 /* Also wipes the database */
468 setup_ldb("provision_partitions.ldif", info, paths.samdb);
470 var samdb = open_ldb(info, paths.samdb, false);
472 message("Setting up sam.ldb attributes\n");
473 setup_add_ldif("provision_init.ldif", info, samdb, false);
474 message("Erasing data from partitions\n");
475 ldb_erase_partitions(info, samdb);
477 message("Adding baseDN: " + subobj.BASEDN + " (permitted to fail)\n");
478 var add_ok = setup_add_ldif("provision_basedn.ldif", info, samdb, true);
479 message("Modifying baseDN: " + subobj.BASEDN + "\n");
480 var modify_ok = setup_ldb_modify("provision_basedn_modify.ldif", info, samdb);
483 message("Failed to both add and modify " + subobj.BASEDN + " in target " + subobj.LDAPBACKEND + "\n");
484 message("Perhaps you need to run the provision script with the --ldap-base-dn option, and add this record to the backend manually\n");
489 message("Setting up sam.ldb Samba4 schema\n");
490 setup_add_ldif("schema_samba4.ldif", info, samdb, false);
491 message("Setting up sam.ldb AD schema\n");
492 setup_add_ldif("schema.ldif", info, samdb, false);
494 // (hack) Reload, now we have the schema loaded.
495 var commit_ok = samdb.transaction_commit();
497 info.message("samdb commit failed: " + samdb.errstring() + "\n");
502 samdb = open_ldb(info, paths.samdb, false);
504 message("Setting up display specifiers\n");
505 setup_add_ldif("display_specifiers.ldif", info, samdb, false);
506 message("Setting up sam.ldb templates\n");
507 setup_add_ldif("provision_templates.ldif", info, samdb, false);
508 message("Setting up sam.ldb data\n");
509 setup_add_ldif("provision.ldif", info, samdb, false);
511 if (blank != false) {
512 var commit_ok = samdb.transaction_commit();
514 info.message("ldb commit failed: " + samdb.errstring() + "\n");
520 message("Setting up sam.ldb users and groups\n");
521 setup_add_ldif("provision_users.ldif", info, samdb, false);
523 if (setup_name_mappings(info, subobj, samdb) == false) {
527 var commit_ok = samdb.transaction_commit();
529 info.message("samdb commit failed: " + samdb.errstring() + "\n");
536 /* Write out a DNS zone file, from the info in the current database */
537 function provision_dns(subobj, message, paths, session_info, credentials)
539 message("Setting up DNS zone: " + subobj.DNSDOMAIN + " \n");
540 var ldb = ldb_init();
541 ldb.session_info = session_info;
542 ldb.credentials = credentials;
544 /* connect to the sam */
545 var ok = ldb.connect(paths.samdb);
548 /* These values may have changed, due to an incoming SamSync,
549 or may not have been specified, so fetch them from the database */
551 var attrs = new Array("objectGUID");
552 res = ldb.search("objectGUID=*", subobj.BASEDN, ldb.SCOPE_BASE, attrs);
553 assert(res.length == 1);
554 assert(res[0].objectGUID != undefined);
555 subobj.DOMAINGUID = res[0].objectGUID;
557 subobj.HOSTGUID = searchone(ldb, subobj.BASEDN, "(&(objectClass=computer)(cn=" + subobj.NETBIOSNAME + "))", "objectGUID");
558 assert(subobj.HOSTGUID != undefined);
560 setup_file("provision.zone",
564 message("Please install the zone located in " + paths.dns + " into your DNS server\n");
567 /* Write out a DNS zone file, from the info in the current database */
568 function provision_ldapbase(subobj, message, paths)
570 message("Setting up LDAP base entry: " + subobj.BASEDN + " \n");
571 var rdns = split(",", subobj.BASEDN);
572 subobj.EXTENSIBLEOBJECT = "objectClass: extensibleObject";
574 subobj.RDN_DC = substr(rdns[0], strlen("DC="));
576 setup_file("provision_basedn.ldif",
577 message, paths.ldap_basedn_ldif,
580 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");
585 guess reasonably default options for provisioning
587 function provision_guess()
589 var subobj = new Object();
590 var nss = nss_init();
591 var lp = loadparm_init();
595 subobj.REALM = strupper(lp.get("realm"));
596 subobj.DOMAIN = lp.get("workgroup");
597 subobj.HOSTNAME = hostname();
599 assert(subobj.REALM);
600 assert(subobj.DOMAIN);
601 assert(subobj.HOSTNAME);
603 subobj.VERSION = version();
604 subobj.HOSTIP = hostip();
605 subobj.DOMAINSID = randsid();
606 subobj.INVOCATIONID = randguid();
607 subobj.KRBTGTPASS = randpass(12);
608 subobj.MACHINEPASS = randpass(12);
609 subobj.ADMINPASS = randpass(12);
610 subobj.DEFAULTSITE = "Default-First-Site-Name";
611 subobj.NEWGUID = randguid;
612 subobj.NTTIME = nttime;
613 subobj.LDAPTIME = ldaptime;
614 subobj.DATESTRING = datestring;
615 subobj.ROOT = findnss(nss.getpwnam, "root");
616 subobj.NOBODY = findnss(nss.getpwnam, "nobody");
617 subobj.NOGROUP = findnss(nss.getgrnam, "nogroup", "nobody");
618 subobj.WHEEL = findnss(nss.getgrnam, "wheel", "root", "staff", "adm");
619 subobj.BACKUP = findnss(nss.getgrnam, "backup", "wheel", "root", "staff");
620 subobj.USERS = findnss(nss.getgrnam, "users", "guest", "other", "unknown", "usr");
621 subobj.DNSDOMAIN = strlower(subobj.REALM);
622 subobj.DNSNAME = sprintf("%s.%s",
623 strlower(subobj.HOSTNAME),
625 rdn_list = split(".", subobj.DNSDOMAIN);
626 subobj.BASEDN = "DC=" + join(",DC=", rdn_list);
627 subobj.LDAPBACKEND = "users.ldb";
628 subobj.EXTENSIBLEOBJECT = "# no objectClass: extensibleObject for local ldb";
633 search for one attribute as a string
635 function searchone(ldb, basedn, expression, attribute)
637 var attrs = new Array(attribute);
638 res = ldb.search(expression, basedn, ldb.SCOPE_SUBTREE, attrs);
639 if (res.length != 1 ||
640 res[0][attribute] == undefined) {
643 return res[0][attribute];
647 modify an account to remove the
649 function enable_account(ldb, user_dn)
651 var attrs = new Array("userAccountControl");
652 var res = ldb.search(NULL, user_dn, ldb.SCOPE_ONELEVEL, attrs);
653 assert(res.length == 1);
654 var userAccountControl = res[0].userAccountControl;
655 userAccountControl = userAccountControl - 2; /* remove disabled bit */
659 replace: userAccountControl
660 userAccountControl: %u
662 user_dn, userAccountControl);
663 var ok = ldb.modify(mod);
669 add a new user record
671 function newuser(username, unixname, password, message, session_info, credentials)
673 var lp = loadparm_init();
674 var samdb = lp.get("sam database");
675 var ldb = ldb_init();
677 ldb.session_info = session_info;
678 ldb.credentials = credentials;
680 /* connect to the sam */
681 var ok = ldb.connect(samdb);
684 ldb.transaction_start();
686 /* find the DNs for the domain and the domain users group */
687 var attrs = new Array("defaultNamingContext");
688 res = ldb.search("defaultNamingContext=*", "", ldb.SCOPE_BASE, attrs);
689 assert(res.length == 1 && res[0].defaultNamingContext != undefined);
690 var domain_dn = res[0].defaultNamingContext;
691 assert(domain_dn != undefined);
692 var dom_users = searchone(ldb, domain_dn, "name=Domain Users", "dn");
693 assert(dom_users != undefined);
695 var user_dn = sprintf("CN=%s,CN=Users,%s", username, domain_dn);
699 the new user record. note the reliance on the samdb module to fill
710 user_dn, username, dom_users,
713 add the user to the users group as well
715 var modgroup = sprintf("
727 message("Adding user %s\n", user_dn);
730 message("Failed to add %s - %s\n", user_dn, ldb.errstring());
734 message("Modifying group %s\n", dom_users);
735 ok = ldb.modify(modgroup);
737 message("Failed to modify %s - %s\n", dom_users, ldb.errstring());
742 modify the userAccountControl to remove the disabled bit
744 ok = enable_account(ldb, user_dn);
746 ldb.transaction_commit();
751 // Check whether a name is valid as a NetBIOS name.
752 // FIXME: There are probably more constraints here.
753 // crh has a paragraph on this in his book (1.4.1.1)
754 function valid_netbios_name(name)
756 if (strlen(name) > 13) return false;
760 function provision_validate(subobj, message)
762 var lp = loadparm_init();
764 if (!valid_netbios_name(subobj.DOMAIN)) {
765 message("Invalid NetBIOS name for domain\n");
769 if (!valid_netbios_name(subobj.NETBIOSNAME)) {
770 message("Invalid NetBIOS name for host\n");
775 if (strupper(lp.get("workgroup")) != strupper(subobj.DOMAIN)) {
776 message("workgroup '%s' in smb.conf must match chosen domain '%s'\n",
777 lp.get("workgroup"), subobj.DOMAIN);
781 if (strupper(lp.get("realm")) != strupper(subobj.REALM)) {
782 message("realm '%s' in smb.conf must match chosen realm '%s'\n",
783 lp.get("realm"), subobj.REALM);
790 function join_domain(domain, netbios_name, join_type, creds, message)
792 var ctx = NetContext(creds);
793 var joindom = new Object();
794 joindom.domain = domain;
795 joindom.join_type = join_type;
796 joindom.netbios_name = netbios_name;
797 if (!ctx.JoinDomain(joindom)) {
798 message("Domain Join failed: " + joindom.error_string);
804 /* Vampire a remote domain. Session info and credentials are required for for
805 * access to our local database (might be remote ldap)
808 function vampire(domain, session_info, credentials, message) {
809 var ctx = NetContext(credentials);
810 var vampire_ctx = new Object();
811 var machine_creds = credentials_init();
812 machine_creds.set_domain(form.DOMAIN);
813 if (!machine_creds.set_machine_account()) {
814 message("Failed to access domain join information!");
817 vampire_ctx.machine_creds = machine_creds;
818 vampire_ctx.session_info = session_info;
819 if (!ctx.SamSyncLdb(vampire_ctx)) {
820 message("Migration of remote domain to Samba failed: " + vampire_ctx.error_string);