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("namingContexts");
163 /* delete within each naming context - this copes with existing partitions */
164 res = ldb.search("objectClass=*", "", ldb.SCOPE_BASE, attrs);
165 if (typeof(res) != "undefined") {
166 if (res.length > 0) {
167 var names = res[0].namingContexts;
168 for (i=0;i<names.length;i++) {
169 attrs = new Array("dn");
170 res = ldb.search("(objectclass=*)", names[i], ldb.SCOPE_SUBTREE, attrs);
172 for (j=0;j<res.length;j++) {
179 /* delete the specials */
180 ldb.del("@INDEXLIST");
181 ldb.del("@ATTRIBUTES");
182 ldb.del("@SUBCLASSES");
184 ldb.del("@PARTITION");
185 ldb.del("@KLUDGEACL");
188 attrs = new Array("dn");
190 var res = ldb.search("(&(|(objectclass=*)(dn=*))(!(dn=@BASEINFO)))", basedn, ldb.SCOPE_SUBTREE, attrs);
192 if (typeof(res) == "undefined") {
196 for (i=0;i<res.length;i++) {
201 var res = ldb.search("(&(|(objectclass=*)(dn=*))(!(dn=@BASEINFO)))", basedn, ldb.SCOPE_SUBTREE, attrs);
202 if (res.length != 0) {
206 assert(res.length == 0);
210 erase an ldb, removing all records
212 function ldb_erase_partitions(info, ldb)
214 var rootDSE_attrs = new Array("namingContexts");
215 var lp = loadparm_init();
218 var res = ldb.search("(objectClass=*)", "", ldb.SCOPE_BASE, rootDSE_attrs);
219 assert(typeof(res) != "undefined");
220 assert(res.length == 1);
221 if (typeof(res[0].namingContexts) == "undefined") {
224 for (j=0; j<res[0].namingContexts.length; j++) {
225 var attrs = new Array("dn");
226 var basedn = res[0].namingContexts[j];
228 var previous_remaining = 1;
229 var current_remaining = 0;
231 for (k=0; k < 10 && (previous_remaining != current_remaining); k++) {
233 var res2 = ldb.search("(|(objectclass=*)(dn=*))", basedn, ldb.SCOPE_SUBTREE, attrs);
235 if (typeof(res2) == "undefined") {
236 info.message("ldb search failed: " + ldb.errstring() + "\n");
239 previous_remaining = current_remaining;
240 current_remaining = res2.length;
241 for (i=0;i<res2.length;i++) {
245 var res3 = ldb.search("(|(objectclass=*)(dn=*))", basedn, ldb.SCOPE_SUBTREE, attrs);
246 if (typeof(res3) == "undefined") {
247 info.message("ldb search failed: " + ldb.errstring() + "\n");
250 if (res3.length != 0) {
251 info.message("Failed to delete all records under " + basedn + ", " + res3.length + " records remaining\n");
257 function open_ldb(info, dbname, erase)
259 var ldb = ldb_init();
260 ldb.session_info = info.session_info;
261 ldb.credentials = info.credentials;
262 ldb.filename = dbname;
264 var connect_ok = ldb.connect(dbname);
266 var lp = loadparm_init();
267 sys.unlink(sprintf("%s/%s", lp.get("private dir"), dbname));
268 connect_ok = ldb.connect(dbname);
272 ldb.transaction_start();
282 setup a ldb in the private dir
284 function setup_add_ldif(ldif, info, ldb, failok)
286 var lp = loadparm_init();
287 var src = lp.get("setup directory") + "/" + ldif;
289 var data = sys.file_load(src);
290 data = substitute_var(data, info.subobj);
292 var add_ok = ldb.add(data);
294 info.message("ldb load failed: " + ldb.errstring() + "\n");
302 function setup_ldb(ldif, info, dbname)
307 if (arguments.length >= 4) {
308 erase = arguments[3];
310 if (arguments.length == 5) {
311 failok = arguments[4];
313 var ldb = open_ldb(info, dbname, erase);
314 if (setup_add_ldif(ldif, info, ldb, failok)) {
315 var commit_ok = ldb.transaction_commit();
317 info.message("ldb commit failed: " + ldb.errstring() + "\n");
324 setup a ldb in the private dir
326 function setup_ldb_modify(ldif, info, ldb)
328 var lp = loadparm_init();
330 var src = lp.get("setup directory") + "/" + ldif;
332 var data = sys.file_load(src);
333 data = substitute_var(data, info.subobj);
335 var mod_ok = ldb.modify(data);
337 info.message("ldb load failed: " + ldb.errstring() + "\n");
344 setup a file in the private dir
346 function setup_file(template, message, fname, subobj)
348 var lp = loadparm_init();
350 var src = lp.get("setup directory") + "/" + template;
354 var data = sys.file_load(src);
355 data = substitute_var(data, subobj);
357 ok = sys.file_save(f, data);
359 message("failed to create file: " + f + "\n");
364 function provision_default_paths(subobj)
366 var lp = loadparm_init();
367 var paths = new Object();
368 paths.smbconf = lp.get("config file");
369 paths.shareconf = lp.get("private dir") + "/" + "share.ldb";
370 paths.hklm = "hklm.ldb";
371 paths.hkcu = "hkcu.ldb";
372 paths.hkcr = "hkcr.ldb";
373 paths.hku = "hku.ldb";
374 paths.hkpd = "hkpd.ldb";
375 paths.hkpt = "hkpt.ldb";
376 paths.samdb = lp.get("sam database");
377 paths.secrets = "secrets.ldb";
378 paths.dns = lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".zone";
379 paths.winsdb = "wins.ldb";
380 paths.ldap_basedn_ldif = lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".ldif";
386 setup reasonable name mappings for sam names to unix names
388 function setup_name_mappings(info, subobj, ldb)
390 var lp = loadparm_init();
391 var attrs = new Array("objectSid");
392 res = ldb.search("objectSid=*", subobj.BASEDN, ldb.SCOPE_BASE, attrs);
393 assert(res.length == 1 && res[0].objectSid != undefined);
394 var sid = res[0].objectSid;
396 /* add some foreign sids if they are not present already */
397 add_foreign(ldb, subobj, "S-1-5-7", "Anonymous");
398 add_foreign(ldb, subobj, "S-1-1-0", "World");
399 add_foreign(ldb, subobj, "S-1-5-2", "Network");
400 add_foreign(ldb, subobj, "S-1-5-18", "System");
401 add_foreign(ldb, subobj, "S-1-5-11", "Authenticated Users");
403 /* some well known sids */
404 setup_name_mapping(info, ldb, "S-1-5-7", subobj.NOBODY);
405 setup_name_mapping(info, ldb, "S-1-1-0", subobj.NOGROUP);
406 setup_name_mapping(info, ldb, "S-1-5-2", subobj.NOGROUP);
407 setup_name_mapping(info, ldb, "S-1-5-18", subobj.ROOT);
408 setup_name_mapping(info, ldb, "S-1-5-11", subobj.USERS);
409 setup_name_mapping(info, ldb, "S-1-5-32-544", subobj.WHEEL);
410 setup_name_mapping(info, ldb, "S-1-5-32-545", subobj.USERS);
411 setup_name_mapping(info, ldb, "S-1-5-32-546", subobj.NOGROUP);
412 setup_name_mapping(info, ldb, "S-1-5-32-551", subobj.BACKUP);
414 /* and some well known domain rids */
415 setup_name_mapping(info, ldb, sid + "-500", subobj.ROOT);
416 setup_name_mapping(info, ldb, sid + "-518", subobj.WHEEL);
417 setup_name_mapping(info, ldb, sid + "-519", subobj.WHEEL);
418 setup_name_mapping(info, ldb, sid + "-512", subobj.WHEEL);
419 setup_name_mapping(info, ldb, sid + "-513", subobj.USERS);
420 setup_name_mapping(info, ldb, sid + "-520", subobj.WHEEL);
427 provision samba4 - caution, this wipes all existing data!
429 function provision(subobj, message, blank, paths, session_info, credentials)
431 var lp = loadparm_init();
432 var sys = sys_init();
433 var info = new Object();
436 some options need to be upper/lower case
438 subobj.REALM = strupper(subobj.REALM);
439 subobj.HOSTNAME = strlower(subobj.HOSTNAME);
440 subobj.DOMAIN = strupper(subobj.DOMAIN);
441 assert(valid_netbios_name(subobj.DOMAIN));
442 subobj.NETBIOSNAME = strupper(subobj.HOSTNAME);
443 assert(valid_netbios_name(subobj.NETBIOSNAME));
444 var rdns = split(",", subobj.BASEDN);
445 subobj.RDN_DC = substr(rdns[0], strlen("DC="));
447 if (subobj.DOMAINGUID != undefined) {
448 subobj.DOMAINGUID_MOD = sprintf("replace: objectGUID\nobjectGUID: %s\n-", subobj.DOMAINGUID);
450 subobj.DOMAINGUID_MOD = "";
453 if (subobj.HOSTGUID != undefined) {
454 subobj.HOSTGUID_ADD = sprintf("objectGUID: %s", subobj.HOSTGUID);
456 subobj.HOSTGUID_ADD = "";
459 info.subobj = subobj;
460 info.message = message;
461 info.credentials = credentials;
462 info.session_info = session_info;
464 /* only install a new smb.conf if there isn't one there already */
465 var st = sys.stat(paths.smbconf);
466 if (st == undefined) {
467 message("Setting up smb.conf\n");
468 setup_file("provision.smb.conf", info.message, paths.smbconf, subobj);
471 /* only install a new shares config db if there is none */
472 st = sys.stat(paths.shareconf);
473 if (st == undefined) {
474 message("Setting up sconf.ldb\n");
475 setup_ldb("share.ldif", info, paths.shareconf);
477 message("Setting up secrets.ldb\n");
478 setup_ldb("secrets.ldif", info, paths.secrets);
479 message("Setting up keytabs\n");
480 var keytab_ok = credentials_update_all_keytabs();
482 message("Setting up hklm.ldb\n");
483 setup_ldb("hklm.ldif", info, paths.hklm);
485 message("Setting up sam.ldb partitions\n");
486 /* Also wipes the database */
487 setup_ldb("provision_partitions.ldif", info, paths.samdb);
489 var samdb = open_ldb(info, paths.samdb, false);
491 message("Setting up sam.ldb attributes\n");
492 setup_add_ldif("provision_init.ldif", info, samdb, false);
493 message("Erasing data from partitions\n");
494 ldb_erase_partitions(info, samdb);
496 message("Adding baseDN: " + subobj.BASEDN + " (permitted to fail)\n");
497 var add_ok = setup_add_ldif("provision_basedn.ldif", info, samdb, true);
498 message("Modifying baseDN: " + subobj.BASEDN + "\n");
499 var modify_ok = setup_ldb_modify("provision_basedn_modify.ldif", info, samdb);
502 message("Failed to both add and modify " + subobj.BASEDN + " in target " + subobj.LDAPBACKEND + "\n");
503 message("Perhaps you need to run the provision script with the --ldap-base-dn option, and add this record to the backend manually\n");
508 message("Setting up sam.ldb Samba4 schema\n");
509 setup_add_ldif("schema_samba4.ldif", info, samdb, false);
510 message("Setting up sam.ldb AD schema\n");
511 setup_add_ldif("schema.ldif", info, samdb, false);
513 // (hack) Reload, now we have the schema loaded.
514 var commit_ok = samdb.transaction_commit();
516 info.message("samdb commit failed: " + samdb.errstring() + "\n");
521 samdb = open_ldb(info, paths.samdb, false);
523 message("Setting up display specifiers\n");
524 setup_add_ldif("display_specifiers.ldif", info, samdb, false);
525 message("Setting up sam.ldb templates\n");
526 setup_add_ldif("provision_templates.ldif", info, samdb, false);
527 message("Setting up sam.ldb data\n");
528 setup_add_ldif("provision.ldif", info, samdb, false);
530 if (blank != false) {
531 var commit_ok = samdb.transaction_commit();
533 info.message("ldb commit failed: " + samdb.errstring() + "\n");
539 message("Setting up sam.ldb users and groups\n");
540 setup_add_ldif("provision_users.ldif", info, samdb, false);
542 if (setup_name_mappings(info, subobj, samdb) == false) {
546 var commit_ok = samdb.transaction_commit();
548 info.message("samdb commit failed: " + samdb.errstring() + "\n");
555 /* Write out a DNS zone file, from the info in the current database */
556 function provision_dns(subobj, message, paths, session_info, credentials)
558 message("Setting up DNS zone: " + subobj.DNSDOMAIN + " \n");
559 var ldb = ldb_init();
560 ldb.session_info = session_info;
561 ldb.credentials = credentials;
563 /* connect to the sam */
564 var ok = ldb.connect(paths.samdb);
567 /* These values may have changed, due to an incoming SamSync,
568 or may not have been specified, so fetch them from the database */
570 var attrs = new Array("objectGUID");
571 res = ldb.search("objectGUID=*", subobj.BASEDN, ldb.SCOPE_BASE, attrs);
572 assert(res.length == 1);
573 assert(res[0].objectGUID != undefined);
574 subobj.DOMAINGUID = res[0].objectGUID;
576 subobj.HOSTGUID = searchone(ldb, subobj.BASEDN, "(&(objectClass=computer)(cn=" + subobj.NETBIOSNAME + "))", "objectGUID");
577 assert(subobj.HOSTGUID != undefined);
579 setup_file("provision.zone",
583 message("Please install the zone located in " + paths.dns + " into your DNS server\n");
586 /* Write out a DNS zone file, from the info in the current database */
587 function provision_ldapbase(subobj, message, paths)
589 message("Setting up LDAP base entry: " + subobj.BASEDN + " \n");
590 var rdns = split(",", subobj.BASEDN);
591 subobj.EXTENSIBLEOBJECT = "objectClass: extensibleObject";
593 subobj.RDN_DC = substr(rdns[0], strlen("DC="));
595 setup_file("provision_basedn.ldif",
596 message, paths.ldap_basedn_ldif,
599 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");
604 guess reasonably default options for provisioning
606 function provision_guess()
608 var subobj = new Object();
609 var nss = nss_init();
610 var lp = loadparm_init();
614 subobj.REALM = strupper(lp.get("realm"));
615 subobj.DOMAIN = lp.get("workgroup");
616 subobj.HOSTNAME = hostname();
618 assert(subobj.REALM);
619 assert(subobj.DOMAIN);
620 assert(subobj.HOSTNAME);
622 subobj.VERSION = version();
623 subobj.HOSTIP = hostip();
624 subobj.DOMAINSID = randsid();
625 subobj.INVOCATIONID = randguid();
626 subobj.KRBTGTPASS = randpass(12);
627 subobj.MACHINEPASS = randpass(12);
628 subobj.ADMINPASS = randpass(12);
629 subobj.DEFAULTSITE = "Default-First-Site-Name";
630 subobj.NEWGUID = randguid;
631 subobj.NTTIME = nttime;
632 subobj.LDAPTIME = ldaptime;
633 subobj.DATESTRING = datestring;
634 subobj.ROOT = findnss(nss.getpwnam, "root");
635 subobj.NOBODY = findnss(nss.getpwnam, "nobody");
636 subobj.NOGROUP = findnss(nss.getgrnam, "nogroup", "nobody");
637 subobj.WHEEL = findnss(nss.getgrnam, "wheel", "root", "staff", "adm");
638 subobj.BACKUP = findnss(nss.getgrnam, "backup", "wheel", "root", "staff");
639 subobj.USERS = findnss(nss.getgrnam, "users", "guest", "other", "unknown", "usr");
640 subobj.DNSDOMAIN = strlower(subobj.REALM);
641 subobj.DNSNAME = sprintf("%s.%s",
642 strlower(subobj.HOSTNAME),
644 rdn_list = split(".", subobj.DNSDOMAIN);
645 subobj.BASEDN = "DC=" + join(",DC=", rdn_list);
646 subobj.LDAPBACKEND = "users.ldb";
647 subobj.LDAPMODULES = "objectguid";
648 subobj.EXTENSIBLEOBJECT = "# no objectClass: extensibleObject for local ldb";
653 search for one attribute as a string
655 function searchone(ldb, basedn, expression, attribute)
657 var attrs = new Array(attribute);
658 res = ldb.search(expression, basedn, ldb.SCOPE_SUBTREE, attrs);
659 if (res.length != 1 ||
660 res[0][attribute] == undefined) {
663 return res[0][attribute];
667 modify an account to remove the
669 function enable_account(ldb, user_dn)
671 var attrs = new Array("userAccountControl");
672 var res = ldb.search(NULL, user_dn, ldb.SCOPE_ONELEVEL, attrs);
673 assert(res.length == 1);
674 var userAccountControl = res[0].userAccountControl;
675 userAccountControl = userAccountControl - 2; /* remove disabled bit */
679 replace: userAccountControl
680 userAccountControl: %u
682 user_dn, userAccountControl);
683 var ok = ldb.modify(mod);
689 add a new user record
691 function newuser(username, unixname, password, message, session_info, credentials)
693 var lp = loadparm_init();
694 var samdb = lp.get("sam database");
695 var ldb = ldb_init();
697 ldb.session_info = session_info;
698 ldb.credentials = credentials;
700 /* connect to the sam */
701 var ok = ldb.connect(samdb);
704 ldb.transaction_start();
706 /* find the DNs for the domain and the domain users group */
707 var attrs = new Array("defaultNamingContext");
708 res = ldb.search("defaultNamingContext=*", "", ldb.SCOPE_BASE, attrs);
709 assert(res.length == 1 && res[0].defaultNamingContext != undefined);
710 var domain_dn = res[0].defaultNamingContext;
711 assert(domain_dn != undefined);
712 var dom_users = searchone(ldb, domain_dn, "name=Domain Users", "dn");
713 assert(dom_users != undefined);
715 var user_dn = sprintf("CN=%s,CN=Users,%s", username, domain_dn);
719 the new user record. note the reliance on the samdb module to fill
730 user_dn, username, dom_users,
733 add the user to the users group as well
735 var modgroup = sprintf("
747 message("Adding user %s\n", user_dn);
750 message("Failed to add %s - %s\n", user_dn, ldb.errstring());
754 message("Modifying group %s\n", dom_users);
755 ok = ldb.modify(modgroup);
757 message("Failed to modify %s - %s\n", dom_users, ldb.errstring());
762 modify the userAccountControl to remove the disabled bit
764 ok = enable_account(ldb, user_dn);
766 ldb.transaction_commit();
771 // Check whether a name is valid as a NetBIOS name.
772 // FIXME: There are probably more constraints here.
773 // crh has a paragraph on this in his book (1.4.1.1)
774 function valid_netbios_name(name)
776 if (strlen(name) > 13) return false;
780 function provision_validate(subobj, message)
782 var lp = loadparm_init();
784 if (!valid_netbios_name(subobj.DOMAIN)) {
785 message("Invalid NetBIOS name for domain\n");
789 if (!valid_netbios_name(subobj.NETBIOSNAME)) {
790 message("Invalid NetBIOS name for host\n");
795 if (strupper(lp.get("workgroup")) != strupper(subobj.DOMAIN)) {
796 message("workgroup '%s' in smb.conf must match chosen domain '%s'\n",
797 lp.get("workgroup"), subobj.DOMAIN);
801 if (strupper(lp.get("realm")) != strupper(subobj.REALM)) {
802 message("realm '%s' in smb.conf must match chosen realm '%s'\n",
803 lp.get("realm"), subobj.REALM);
810 function join_domain(domain, netbios_name, join_type, creds, message)
812 var ctx = NetContext(creds);
813 var joindom = new Object();
814 joindom.domain = domain;
815 joindom.join_type = join_type;
816 joindom.netbios_name = netbios_name;
817 if (!ctx.JoinDomain(joindom)) {
818 message("Domain Join failed: " + joindom.error_string);
824 /* Vampire a remote domain. Session info and credentials are required for for
825 * access to our local database (might be remote ldap)
828 function vampire(domain, session_info, credentials, message) {
829 var ctx = NetContext(credentials);
830 var vampire_ctx = new Object();
831 var machine_creds = credentials_init();
832 machine_creds.set_domain(form.DOMAIN);
833 if (!machine_creds.set_machine_account()) {
834 message("Failed to access domain join information!");
837 vampire_ctx.machine_creds = machine_creds;
838 vampire_ctx.session_info = session_info;
839 if (!ctx.SamSyncLdb(vampire_ctx)) {
840 message("Migration of remote domain to Samba failed: " + vampire_ctx.error_string);