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.error != 0 || res.msgs.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.DOMAINDN, 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.DOMAINDN, ldb.SCOPE_SUBTREE, attrs);
75 if (res.error != 0 || res.msgs.length != 1) {
76 info.message("Failed to find record for objectSid %s\n", sid);
85 res.msgs[0].dn, unixname);
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(info, ldb)
145 info.message("Deleting " + ldb.filename + "\n");
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(info, ldb)
162 /* delete the specials */
163 ldb.del("@INDEXLIST");
164 ldb.del("@ATTRIBUTES");
167 ldb.del("@PARTITION");
168 ldb.del("@KLUDGEACL");
171 attrs = new Array("dn");
173 var res = ldb.search("(&(|(objectclass=*)(distinguishedName=*))(!(distinguishedName=@BASEINFO)))", basedn, ldb.SCOPE_SUBTREE, attrs);
175 if (res.error != 0) {
176 ldb_delete(info, ldb);
179 for (i=0;i<res.msgs.length;i++) {
180 ldb.del(res.msgs[i].dn);
183 var res = ldb.search("(&(|(objectclass=*)(distinguishedName=*))(!(distinguishedName=@BASEINFO)))", basedn, ldb.SCOPE_SUBTREE, attrs);
184 if (res.error != 0 || res.msgs.length != 0) {
185 ldb_delete(info, ldb);
188 assert(res.msgs.length == 0);
192 erase an ldb, removing all records
194 function ldb_erase_partitions(info, ldb, ldapbackend)
196 var rootDSE_attrs = new Array("namingContexts");
197 var lp = loadparm_init();
200 var res = ldb.search("(objectClass=*)", "", ldb.SCOPE_BASE, rootDSE_attrs);
201 if (res.error != 0) {
202 info.message("rootdse search failed: " + res.errstr + "\n");
203 assert(res.error == 0);
205 assert(res.msgs.length == 1);
206 if (typeof(res.msgs[0].namingContexts) == "undefined") {
209 for (j=0; j<res.msgs[0].namingContexts.length; j++) {
210 var anything = "(|(objectclass=*)(distinguishedName=*))";
211 var attrs = new Array("distinguishedName");
212 var basedn = res.msgs[0].namingContexts[j];
214 var previous_remaining = 1;
215 var current_remaining = 0;
217 if (ldapbackend && (basedn == info.subobj.DOMAINDN)) {
218 /* Only delete objects that were created by provision */
219 anything = "(objectcategory=*)";
222 for (k=0; k < 10 && (previous_remaining != current_remaining); k++) {
224 var res2 = ldb.search(anything, basedn, ldb.SCOPE_SUBTREE, attrs);
226 if (res2.error != 0) {
227 if (res2.error == 32) {
230 info.message("ldb search(2) failed: " + res2.errstr + "\n");
234 previous_remaining = current_remaining;
235 current_remaining = res2.msgs.length;
236 for (i=0;i<res2.msgs.length;i++) {
237 ldb.del(res2.msgs[i].dn);
240 var res3 = ldb.search(anything, basedn, ldb.SCOPE_SUBTREE, attrs);
241 if (res3.error != 0) {
242 info.message("ldb search(3) failed: " + res3.errstr + "\n");
245 if (res3.msgs.length != 0) {
246 info.message("Failed to delete all records under " + basedn + ", " + res3.msgs.length + " records remaining\n");
252 function open_ldb(info, dbname, erase)
254 var ldb = ldb_init();
255 ldb.session_info = info.session_info;
256 ldb.credentials = info.credentials;
257 ldb.filename = dbname;
259 var connect_ok = ldb.connect(dbname);
261 var lp = loadparm_init();
262 sys.unlink(sprintf("%s/%s", lp.get("private dir"), dbname));
263 connect_ok = ldb.connect(dbname);
267 ldb.transaction_start();
270 ldb_erase(info, ldb);
277 setup a ldb in the private dir
279 function setup_add_ldif(ldif, info, ldb, failok)
281 var lp = loadparm_init();
282 var src = lp.get("setup directory") + "/" + ldif;
284 var data = sys.file_load(src);
285 data = substitute_var(data, info.subobj);
287 var add_res = ldb.add(data);
288 if (add_res.error != 0) {
289 info.message("ldb load failed: " + add_res.errstr + "\n");
291 assert(add_res.error == 0);
294 return (add_res.error == 0);
297 function setup_modify_ldif(ldif, info, ldb, failok)
299 var lp = loadparm_init();
300 var src = lp.get("setup directory") + "/" + ldif;
302 var data = sys.file_load(src);
303 data = substitute_var(data, info.subobj);
305 var mod_res = ldb.modify(data);
306 if (mod_res.error != 0) {
307 info.message("ldb load failed: " + mod_res.errstr + "\n");
309 assert(mod_res.error == 0);
312 return (mod_res.error == 0);
316 function setup_ldb(ldif, info, dbname)
321 if (arguments.length >= 4) {
322 erase = arguments[3];
324 if (arguments.length == 5) {
325 failok = arguments[4];
327 var ldb = open_ldb(info, dbname, erase);
328 if (setup_add_ldif(ldif, info, ldb, failok)) {
329 var commit_ok = ldb.transaction_commit();
331 info.message("ldb commit failed: " + ldb.errstring() + "\n");
338 setup a ldb in the private dir
340 function setup_ldb_modify(ldif, info, ldb)
342 var lp = loadparm_init();
344 var src = lp.get("setup directory") + "/" + ldif;
346 var data = sys.file_load(src);
347 data = substitute_var(data, info.subobj);
349 var mod_res = ldb.modify(data);
350 if (mod_res.error != 0) {
351 info.message("ldb load failed: " + mod_res.errstr + "\n");
352 return (mod_res.error == 0);
354 return (mod_res.error == 0);
358 setup a file in the private dir
360 function setup_file(template, message, fname, subobj)
362 var lp = loadparm_init();
364 var src = lp.get("setup directory") + "/" + template;
366 if (! sys.stat(src)) {
367 message("Template file not found: %s\n",src);
373 var data = sys.file_load(src);
374 data = substitute_var(data, subobj);
376 ok = sys.file_save(f, data);
378 message("failed to create file: " + f + "\n");
383 function provision_default_paths(subobj)
385 /* subobj.DNSDOMAIN isn't available at this point */
386 var dnsdomain = strlower(subobj.REALM);
387 var lp = loadparm_init();
388 var paths = new Object();
389 paths.smbconf = lp.filename()
390 paths.shareconf = lp.get("private dir") + "/" + "share.ldb";
391 paths.samdb = lp.get("sam database");
392 paths.secrets = lp.get("secrets database");
393 paths.templates = lp.get("private dir") + "/" + "templates.ldb";
394 paths.keytab = "secrets.keytab";
395 paths.dns_keytab = "dns.keytab";
396 paths.dns_keytab_abs = lp.get("private dir") + "/" + paths.dns_keytab;
397 paths.dns = lp.get("private dir") + "/" + dnsdomain + ".zone";
398 paths.named_conf = lp.get("private dir") + "/named.conf";
399 paths.winsdb = "wins.ldb";
400 paths.ldapdir = lp.get("private dir") + "/ldap";
402 paths.s4_ldapi_socket = lp.get("private dir") + "/ldapi";
403 paths.phpldapadminconfig = lp.get("private dir") + "/phpldapadmin-config.php";
405 paths.sysvol = lp.get("sysvol", "path");
407 if (paths.sysvol == undefined) {
408 paths.sysvol = lp.get("lock dir") + "/sysvol";
411 paths.netlogon = lp.get("netlogon", "path");
413 if (paths.netlogon == undefined) {
414 paths.netlogon = paths.sysvol + "/" + dnsdomain + "/scripts";
422 setup reasonable name mappings for sam names to unix names
424 function setup_name_mappings(info, ldb)
426 var lp = loadparm_init();
427 var attrs = new Array("objectSid");
428 var subobj = info.subobj;
430 res = ldb.search("objectSid=*", subobj.DOMAINDN, ldb.SCOPE_BASE, attrs);
431 assert(res.error == 0);
432 assert(res.msgs.length == 1 && res.msgs[0].objectSid != undefined);
433 var sid = res.msgs[0].objectSid;
435 /* add some foreign sids if they are not present already */
436 add_foreign(ldb, subobj, "S-1-5-7", "Anonymous");
437 add_foreign(ldb, subobj, "S-1-1-0", "World");
438 add_foreign(ldb, subobj, "S-1-5-2", "Network");
439 add_foreign(ldb, subobj, "S-1-5-18", "System");
440 add_foreign(ldb, subobj, "S-1-5-11", "Authenticated Users");
442 /* some well known sids */
443 setup_name_mapping(info, ldb, "S-1-5-7", subobj.NOBODY);
444 setup_name_mapping(info, ldb, "S-1-1-0", subobj.NOGROUP);
445 setup_name_mapping(info, ldb, "S-1-5-2", subobj.NOGROUP);
446 setup_name_mapping(info, ldb, "S-1-5-18", subobj.ROOT);
447 setup_name_mapping(info, ldb, "S-1-5-11", subobj.USERS);
448 setup_name_mapping(info, ldb, "S-1-5-32-544", subobj.WHEEL);
449 setup_name_mapping(info, ldb, "S-1-5-32-545", subobj.USERS);
450 setup_name_mapping(info, ldb, "S-1-5-32-546", subobj.NOGROUP);
451 setup_name_mapping(info, ldb, "S-1-5-32-551", subobj.BACKUP);
453 /* and some well known domain rids */
454 setup_name_mapping(info, ldb, sid + "-500", subobj.ROOT);
455 setup_name_mapping(info, ldb, sid + "-518", subobj.WHEEL);
456 setup_name_mapping(info, ldb, sid + "-519", subobj.WHEEL);
457 setup_name_mapping(info, ldb, sid + "-512", subobj.WHEEL);
458 setup_name_mapping(info, ldb, sid + "-513", subobj.USERS);
459 setup_name_mapping(info, ldb, sid + "-520", subobj.WHEEL);
464 function provision_fix_subobj(subobj, paths)
466 var ldb = ldb_init();
468 subobj.REALM = strupper(subobj.REALM);
469 subobj.HOSTNAME = strlower(subobj.HOSTNAME);
470 subobj.DOMAIN = strupper(subobj.DOMAIN);
471 subobj.NETBIOSNAME = strupper(subobj.HOSTNAME);
472 subobj.DNSDOMAIN = strlower(subobj.REALM);
473 subobj.DNSNAME = sprintf("%s.%s",
474 strlower(subobj.HOSTNAME),
476 var rdn_list = split(".", subobj.DNSDOMAIN);
477 subobj.DOMAINDN = "DC=" + join(",DC=", rdn_list);
478 subobj.ROOTDN = subobj.DOMAINDN;
479 subobj.CONFIGDN = "CN=Configuration," + subobj.ROOTDN;
480 subobj.SCHEMADN = "CN=Schema," + subobj.CONFIGDN;
482 subobj.MACHINEPASS_B64 = ldb.encode(subobj.MACHINEPASS);
483 subobj.KRBTGTPASS_B64 = ldb.encode(subobj.KRBTGTPASS);
484 subobj.ADMINPASS_B64 = ldb.encode(subobj.ADMINPASS);
485 subobj.DNSPASS_B64 = ldb.encode(subobj.DNSPASS);
487 subobj.SAM_LDB = "tdb://" + paths.samdb;
488 subobj.SECRETS_KEYTAB = paths.keytab;
489 subobj.DNS_KEYTAB = paths.dns_keytab;
490 subobj.DNS_KEYTAB_ABS = paths.dns_keytab_abs;
492 subobj.LDAPDIR = paths.ldapdir;
493 var ldap_path_list = split("/", paths.ldapdir);
494 subobj.LDAPI_URI = "ldapi://" + join("%2F", ldap_path_list) + "%2Fldapi";
496 var s4ldap_path_list = split("/", paths.s4_ldapi_socket);
497 subobj.S4_LDAPI_URI = "ldapi://" + join("%2F", s4ldap_path_list);
499 subobj.LDAPMANAGERDN = "cn=Manager," + subobj.DOMAINDN;
501 subobj.NETLOGONPATH = paths.netlogon;
502 subobj.SYSVOLPATH = paths.sysvol;
504 if (subobj.DOMAIN_CONF == undefined) {
505 subobj.DOMAIN_CONF = subobj.DOMAIN;
507 if (subobj.REALM_CONF == undefined) {
508 subobj.REALM_CONF = subobj.REALM;
510 if (strlower(subobj.SERVERROLE) != strlower("domain controller")) {
511 subobj.REALM = subobj.HOSTNAME;
512 subobj.DOMAIN = subobj.HOSTNAME;
518 function provision_become_dc(subobj, message, erase, paths, session_info)
520 var lp = loadparm_init();
521 var sys = sys_init();
522 var info = new Object();
524 var ok = provision_fix_subobj(subobj, paths);
527 if (subobj.BACKEND_MOD == undefined) {
528 subobj.BACKEND_MOD = "repl_meta_data";
531 info.subobj = subobj;
532 info.message = message;
533 info.session_info = session_info;
535 message("Setting up templates into " + paths.templates + "\n");
536 setup_ldb("provision_templates.ldif", info, paths.templates);
538 /* Also wipes the database */
539 message("Setting up " + paths.samdb + " partitions\n");
540 setup_ldb("provision_partitions.ldif", info, paths.samdb);
542 var samdb = open_ldb(info, paths.samdb, false);
544 message("Setting up " + paths.samdb + " attributes\n");
545 setup_add_ldif("provision_init.ldif", info, samdb, false);
547 message("Setting up " + paths.samdb + " rootDSE\n");
548 setup_add_ldif("provision_rootdse_add.ldif", info, samdb, false);
551 message("Erasing data from partitions\n");
552 ldb_erase_partitions(info, samdb, undefined);
555 message("Setting up " + paths.samdb + " indexes\n");
556 setup_add_ldif("provision_index.ldif", info, samdb, false);
558 ok = samdb.transaction_commit();
561 message("Setting up " + paths.secrets + "\n");
562 setup_ldb("secrets_init.ldif", info, paths.secrets);
564 setup_ldb("secrets.ldif", info, paths.secrets, false);
566 setup_ldb("secrets_dc.ldif", info, paths.secrets, false);
571 function load_schema(subobj, message, samdb)
573 var lp = loadparm_init();
574 var src = lp.get("setup directory") + "/" + "schema.ldif";
576 if (! sys.stat(src)) {
577 message("Template file not found: %s\n",src);
581 var schema_data = sys.file_load(src);
583 src = lp.get("setup directory") + "/" + "schema_samba4.ldif";
585 if (! sys.stat(src)) {
586 message("Template file not found: %s\n",src);
590 schema_data = schema_data + sys.file_load(src);
592 schema_data = substitute_var(schema_data, subobj);
594 src = lp.get("setup directory") + "/" + "provision_schema_basedn_modify.ldif";
596 if (! sys.stat(src)) {
597 message("Template file not found: %s\n",src);
601 var head_data = sys.file_load(src);
602 head_data = substitute_var(head_data, subobj);
604 var ok = samdb.attach_dsdb_schema_from_ldif(head_data, schema_data);
610 provision samba4 - caution, this wipes all existing data!
612 function provision(subobj, message, blank, paths, session_info, credentials, ldapbackend)
614 var lp = loadparm_init();
615 var sys = sys_init();
616 var info = new Object();
619 var ok = provision_fix_subobj(subobj, paths);
622 if (strlower(subobj.SERVERROLE) == strlower("domain controller")) {
623 if (subobj.BACKEND_MOD == undefined) {
624 subobj.BACKEND_MOD = "repl_meta_data";
627 if (subobj.BACKEND_MOD == undefined) {
628 subobj.BACKEND_MOD = "objectguid";
632 if (subobj.DOMAINGUID != undefined) {
633 subobj.DOMAINGUID_MOD = sprintf("replace: objectGUID\nobjectGUID: %s\n-", subobj.DOMAINGUID);
635 subobj.DOMAINGUID_MOD = "";
638 if (subobj.HOSTGUID != undefined) {
639 subobj.HOSTGUID_ADD = sprintf("objectGUID: %s", subobj.HOSTGUID);
641 subobj.HOSTGUID_ADD = "";
644 info.subobj = subobj;
645 info.message = message;
646 info.credentials = credentials;
647 info.session_info = session_info;
649 /* only install a new smb.conf if there isn't one there already */
650 var st = sys.stat(paths.smbconf);
651 if (st == undefined) {
653 if (strlower(subobj.SERVERROLE) == strlower("domain controller")) {
654 smbconfsuffix = "dc";
655 } else if (strlower(subobj.SERVERROLE) == strlower("member server")) {
656 smbconfsuffix = "member";
658 smbconfsuffix = subobj.SERVERROLE;
660 message("Setting up " + paths.smbconf +"\n");
661 setup_file("provision.smb.conf." + smbconfsuffix, info.message, paths.smbconf, subobj);
664 /* only install a new shares config db if there is none */
665 st = sys.stat(paths.shareconf);
666 if (st == undefined) {
667 message("Setting up share.ldb\n");
668 setup_ldb("share.ldif", info, paths.shareconf);
671 message("Setting up " + paths.secrets + "\n");
672 setup_ldb("secrets_init.ldif", info, paths.secrets);
673 setup_ldb("secrets.ldif", info, paths.secrets, false);
675 message("Setting up the registry\n");
676 var reg = reg_open();
677 reg.apply_patchfile(lp.get("setup directory") + "/provision.reg")
679 message("Setting up templates into " + paths.templates + "\n");
680 setup_ldb("provision_templates.ldif", info, paths.templates);
682 message("Setting up sam.ldb partitions\n");
683 /* Also wipes the database */
684 setup_ldb("provision_partitions.ldif", info, paths.samdb);
686 var samdb = open_ldb(info, paths.samdb, false);
688 message("Setting up sam.ldb attributes\n");
689 setup_add_ldif("provision_init.ldif", info, samdb, false);
691 message("Setting up sam.ldb rootDSE\n");
692 setup_add_ldif("provision_rootdse_add.ldif", info, samdb, false);
694 message("Erasing data from partitions\n");
695 ldb_erase_partitions(info, samdb, ldapbackend);
697 // (hack) Reload, now we have the partitions and rootdse loaded.
698 var commit_ok = samdb.transaction_commit();
700 info.message("samdb commit failed: " + samdb.errstring() + "\n");
705 message("Pre-loading the Samba4 and AD schema\n");
707 samdb = open_ldb(info, paths.samdb, false);
709 samdb.set_domain_sid(subobj.DOMAINSID);
711 if (strlower(subobj.SERVERROLE) == strlower("domain controller")) {
712 if (subobj.INVOCATIONID == undefined) {
713 subobj.INVOCATIONID = randguid();
715 samdb.set_ntds_invocationId(subobj.INVOCATIONID);
716 if (subobj.BACKEND_MOD == undefined) {
717 subobj.BACKEND_MOD = "repl_meta_data";
720 if (subobj.BACKEND_MOD == undefined) {
721 subobj.BACKEND_MOD = "objectguid";
725 var load_schema_ok = load_schema(subobj, message, samdb);
726 assert(load_schema_ok.is_ok);
728 message("Adding DomainDN: " + subobj.DOMAINDN + " (permitted to fail)\n");
729 var add_ok = setup_add_ldif("provision_basedn.ldif", info, samdb, true);
730 message("Modifying DomainDN: " + subobj.DOMAINDN + "\n");
731 var modify_basedn_ok = setup_ldb_modify("provision_basedn_modify.ldif", info, samdb);
732 if (!modify_basedn_ok) {
734 message("%s", "Failed to both add and modify " + subobj.DOMAINDN + " in target " + subobj.DOMAINDN_LDB + ": " + samdb.errstring() + "\n");
735 message("Perhaps you need to run the provision script with the --ldap-base-dn option, and add this record to the backend manually\n");
737 assert(modify_basedn_ok);
740 message("Adding configuration container (permitted to fail)\n");
741 var add_config_ok = setup_add_ldif("provision_configuration_basedn.ldif", info, samdb, true);
742 message("Modifying configuration container\n");
743 var modify_config_ok = setup_ldb_modify("provision_configuration_basedn_modify.ldif", info, samdb);
744 if (!modify_config_ok) {
745 if (!add_config_ok) {
746 message("%s", "Failed to both add and modify " + subobj.CONFIGDN + " in target " + subobj.CONFIGDN_LDB + ": " + samdb.errstring() + "\n");
747 message("Perhaps you need to run the provision script with the --ldap-base-dn option, and add this record to the backend manually\n");
749 assert(modify_config_ok);
752 message("Adding schema container (permitted to fail)\n");
753 var add_schema_ok = setup_add_ldif("provision_schema_basedn.ldif", info, samdb, true);
754 message("Modifying schema container\n");
755 var modify_schema_ok = setup_ldb_modify("provision_schema_basedn_modify.ldif", info, samdb);
756 if (!modify_schema_ok) {
757 if (!add_schema_ok) {
758 message("%s", "Failed to both add and modify " + subobj.SCHEMADN + " in target " + subobj.SCHEMADN_LDB + ": " + samdb.errstring() + "\n");
759 message("Perhaps you need to run the provision script with the --ldap-base-dn option, and add this record to the backend manually\n");
761 message("Failed to modify the schema container: " + samdb.errstring() + "\n");
762 assert(modify_schema_ok);
765 message("Setting up sam.ldb Samba4 schema\n");
766 setup_add_ldif("schema_samba4.ldif", info, samdb, false);
767 message("Setting up sam.ldb AD schema\n");
768 setup_add_ldif("schema.ldif", info, samdb, false);
770 message("Setting up sam.ldb configuration data\n");
771 setup_add_ldif("provision_configuration.ldif", info, samdb, false);
773 message("Setting up display specifiers\n");
774 setup_add_ldif("display_specifiers.ldif", info, samdb, false);
776 message("Adding users container (permitted to fail)\n");
777 var add_users_ok = setup_add_ldif("provision_users_add.ldif", info, samdb, true);
778 message("Modifying users container\n");
779 var modify_users_ok = setup_ldb_modify("provision_users_modify.ldif", info, samdb);
780 if (!modify_users_ok) {
782 message("Failed to both add and modify the users container\n");
784 assert(modify_users_ok);
786 message("Adding computers container (permitted to fail)\n");
787 var add_computers_ok = setup_add_ldif("provision_computers_add.ldif", info, samdb, true);
788 message("Modifying computers container\n");
789 var modify_computers_ok = setup_ldb_modify("provision_computers_modify.ldif", info, samdb);
790 if (!modify_computers_ok) {
791 if (!add_computers_ok) {
792 message("Failed to both add and modify the computers container\n");
794 assert(modify_computers_ok);
797 message("Setting up sam.ldb data\n");
798 setup_add_ldif("provision.ldif", info, samdb, false);
800 if (blank != false) {
801 message("Setting up sam.ldb index\n");
802 setup_add_ldif("provision_index.ldif", info, samdb, false);
804 message("Setting up sam.ldb rootDSE marking as syncronized\n");
805 setup_modify_ldif("provision_rootdse_modify.ldif", info, samdb, false);
807 var commit_ok = samdb.transaction_commit();
809 info.message("ldb commit failed: " + samdb.errstring() + "\n");
815 // message("Activate schema module");
816 // setup_modify_ldif("schema_activation.ldif", info, samdb, false);
818 // // (hack) Reload, now we have the schema loaded.
819 // var commit_ok = samdb.transaction_commit();
821 // info.message("samdb commit failed: " + samdb.errstring() + "\n");
822 // assert(commit_ok);
826 // samdb = open_ldb(info, paths.samdb, false);
828 message("Setting up sam.ldb users and groups\n");
829 setup_add_ldif("provision_users.ldif", info, samdb, false);
831 if (strlower(subobj.SERVERROLE) == strlower("domain controller")) {
832 message("Setting up self join\n");
833 setup_add_ldif("provision_self_join.ldif", info, samdb, false);
834 setup_add_ldif("provision_group_policy.ldif", info, samdb, false);
836 sys.mkdir(paths.sysvol, 0755);
837 sys.mkdir(paths.sysvol + "/"+ subobj.DNSDOMAIN, 0755);
838 sys.mkdir(paths.sysvol + "/"+ subobj.DNSDOMAIN + "/Policies", 0755);
839 sys.mkdir(paths.sysvol + "/"+ subobj.DNSDOMAIN + "/Policies/{" + subobj.POLICYGUID + "}", 0755);
840 sys.mkdir(paths.sysvol + "/"+ subobj.DNSDOMAIN + "/Policies/{" + subobj.POLICYGUID + "}/Machine", 0755);
841 sys.mkdir(paths.sysvol + "/"+ subobj.DNSDOMAIN + "/Policies/{" + subobj.POLICYGUID + "}/User", 0755);
843 sys.mkdir(paths.netlogon, 0755);
845 setup_ldb("secrets_dc.ldif", info, paths.secrets, false);
849 if (setup_name_mappings(info, samdb) == false) {
853 message("Setting up sam.ldb index\n");
854 setup_add_ldif("provision_index.ldif", info, samdb, false);
856 message("Setting up sam.ldb rootDSE marking as syncronized\n");
857 setup_modify_ldif("provision_rootdse_modify.ldif", info, samdb, false);
859 var commit_ok = samdb.transaction_commit();
861 info.message("samdb commit failed: " + samdb.errstring() + "\n");
865 message("Setting up phpLDAPadmin configuration\n");
866 setup_file("phpldapadmin-config.php", info.message, paths.phpldapadminconfig, subobj);
867 message("Please install the phpLDAPadmin configuration located at " + paths.phpldapadminconfig + " into /etc/phpldapadmin/config.php\n");
873 provision just the schema into a temporary ldb, so we can run ad2oLschema on it
875 function provision_schema(subobj, message, tmp_schema_path, paths)
877 var lp = loadparm_init();
878 var sys = sys_init();
879 var info = new Object();
881 var ok = provision_fix_subobj(subobj, paths);
884 info.subobj = subobj;
885 info.message = message;
887 message("Setting up sam.ldb partitions\n");
889 /* This will erase anything in the tmp db */
890 var samdb = open_ldb(info, tmp_schema_path, true);
892 message("Setting up sam.ldb attributes\n");
893 setup_add_ldif("provision_init.ldif", info, samdb, false);
895 message("Setting up sam.ldb rootDSE\n");
896 setup_add_ldif("provision_rootdse_add.ldif", info, samdb, false);
898 message("Adding schema container (permitted to fail)\n");
899 var add_ok = setup_add_ldif("provision_schema_basedn.ldif", info, samdb, true);
900 message("Modifying schema container\n");
901 var modify_ok = setup_ldb_modify("provision_schema_basedn_modify.ldif", info, samdb);
904 message("Failed to both add and modify schema dn: " + samdb.errstring() + "\n");
905 message("Perhaps you need to run the provision script with the --ldap-base-dn option, and add this record to the backend manually\n");
908 message("Failed to modify the schema container: " + samdb.errstring() + "\n");
912 message("Setting up sam.ldb Samba4 schema\n");
913 setup_add_ldif("schema_samba4.ldif", info, samdb, false);
914 message("Setting up sam.ldb AD schema\n");
915 setup_add_ldif("schema.ldif", info, samdb, false);
917 var commit_ok = samdb.transaction_commit();
919 info.message("samdb commit failed: " + samdb.errstring() + "\n");
925 /* Write out a DNS zone file, from the info in the current database */
926 function provision_dns(subobj, message, paths, session_info, credentials)
928 var lp = loadparm_init();
929 if (strlower(subobj.SERVERROLE) != strlower("domain controller")) {
930 message("No DNS zone required for role %s\n", subobj.SERVERROLE);
933 message("Setting up DNS zone: " + subobj.DNSDOMAIN + " \n");
934 var ldb = ldb_init();
935 ldb.session_info = session_info;
936 ldb.credentials = credentials;
938 /* connect to the sam */
939 var ok = ldb.connect(paths.samdb);
942 /* These values may have changed, due to an incoming SamSync,
943 or may not have been specified, so fetch them from the database */
945 var attrs = new Array("objectGUID");
946 res = ldb.search("objectGUID=*", subobj.DOMAINDN, ldb.SCOPE_BASE, attrs);
947 assert(res.error == 0);
948 assert(res.msgs.length == 1);
949 assert(res.msgs[0].objectGUID != undefined);
950 subobj.DOMAINGUID = res.msgs[0].objectGUID;
952 subobj.HOSTGUID = searchone(ldb, subobj.DOMAINDN, "(&(objectClass=computer)(cn=" + subobj.NETBIOSNAME + "))", "objectGUID");
953 assert(subobj.HOSTGUID != undefined);
955 setup_file("provision.zone",
959 setup_file("named.conf",
960 message, paths.named_conf,
963 message("Please install the zone located in " + paths.dns + " into your DNS server. A sample BIND configuration snippit is at " + paths.named_conf + "\n");
968 guess reasonably default options for provisioning
970 function provision_guess()
972 var subobj = new Object();
973 var nss = nss_init();
974 var lp = loadparm_init();
978 subobj.SERVERROLE = strlower(lp.get("server role"));
979 subobj.REALM = strupper(lp.get("realm"));
980 subobj.DOMAIN = lp.get("workgroup");
981 subobj.HOSTNAME = hostname();
983 assert(subobj.REALM);
984 assert(subobj.DOMAIN);
985 assert(subobj.HOSTNAME);
987 subobj.VERSION = version();
988 subobj.HOSTIP = hostip();
989 subobj.DOMAINSID = randsid();
990 subobj.POLICYGUID = randguid();
991 subobj.KRBTGTPASS = randpass(12);
992 subobj.MACHINEPASS = randpass(12);
993 subobj.DNSPASS = randpass(12);
994 subobj.ADMINPASS = randpass(12);
995 subobj.LDAPMANAGERPASS = randpass(12);
996 subobj.DEFAULTSITE = "Default-First-Site-Name";
997 subobj.DATESTRING = datestring;
998 subobj.ROOT = findnss(nss.getpwnam, "root");
999 subobj.NOBODY = findnss(nss.getpwnam, "nobody");
1000 subobj.NOGROUP = findnss(nss.getgrnam, "nogroup", "nobody");
1001 subobj.WHEEL = findnss(nss.getgrnam, "wheel", "root", "staff", "adm");
1002 subobj.BACKUP = findnss(nss.getgrnam, "backup", "wheel", "root", "staff");
1003 subobj.USERS = findnss(nss.getgrnam, "users", "guest", "other", "unknown", "usr");
1005 //Add modules to the list to activate them by default
1006 //beware often order is important
1008 // Some Known ordering constraints:
1009 // - rootdse must be first, as it makes redirects from "" -> cn=rootdse
1010 // - objectclass must be before password_hash, because password_hash checks
1011 // that the objectclass is of type person (filled in by the objectclass
1012 // module when expanding the objectclass list)
1013 // - partition must be last
1014 // - each partition has its own module list then
1015 var modules_list = new Array("rootdse",
1027 var tdb_modules_list = new Array("subtree_rename",
1029 "linked_attributes");
1030 var modules_list2 = new Array("show_deleted",
1032 subobj.MODULES_LIST = join(",", modules_list);
1033 subobj.TDB_MODULES_LIST = "," + join(",", tdb_modules_list);
1034 subobj.MODULES_LIST2 = join(",", modules_list2);
1035 subobj.DOMAINDN_LDB = "users.ldb";
1036 subobj.CONFIGDN_LDB = "configuration.ldb";
1037 subobj.SCHEMADN_LDB = "schema.ldb";
1038 subobj.DOMAINDN_MOD = "pdc_fsmo,password_hash,instancetype";
1039 subobj.CONFIGDN_MOD = "naming_fsmo,instancetype";
1040 subobj.SCHEMADN_MOD = "schema_fsmo,instancetype";
1042 subobj.ACI = "# no aci for local ldb";
1048 search for one attribute as a string
1050 function searchone(ldb, basedn, expression, attribute)
1052 var attrs = new Array(attribute);
1053 res = ldb.search(expression, basedn, ldb.SCOPE_SUBTREE, attrs);
1054 if (res.error != 0 ||
1055 res.msgs.length != 1 ||
1056 res.msgs[0][attribute] == undefined) {
1059 return res.msgs[0][attribute];
1063 modify an account to remove the
1065 function enable_account(ldb, user_dn)
1067 var attrs = new Array("userAccountControl");
1068 var res = ldb.search(NULL, user_dn, ldb.SCOPE_ONELEVEL, attrs);
1069 assert(res.error == 0);
1070 assert(res.msgs.length == 1);
1071 var userAccountControl = res.msgs[0].userAccountControl;
1072 userAccountControl = userAccountControl - 2; /* remove disabled bit */
1076 replace: userAccountControl
1077 userAccountControl: %u
1079 user_dn, userAccountControl);
1080 var ok = ldb.modify(mod);
1081 return (ok.error == 0);
1086 add a new user record
1088 function newuser(username, unixname, password, message, session_info, credentials)
1090 var lp = loadparm_init();
1091 var samdb = lp.get("sam database");
1092 var ldb = ldb_init();
1094 ldb.session_info = session_info;
1095 ldb.credentials = credentials;
1097 /* connect to the sam */
1098 var ok = ldb.connect(samdb);
1101 ldb.transaction_start();
1103 /* find the DNs for the domain and the domain users group */
1104 var attrs = new Array("defaultNamingContext");
1105 res = ldb.search("defaultNamingContext=*", "", ldb.SCOPE_BASE, attrs);
1106 assert(res.error == 0);
1107 assert(res.msgs.length == 1 && res.msgs[0].defaultNamingContext != undefined);
1108 var domain_dn = res.msgs[0].defaultNamingContext;
1109 assert(domain_dn != undefined);
1110 var dom_users = searchone(ldb, domain_dn, "name=Domain Users", "dn");
1111 assert(dom_users != undefined);
1113 var user_dn = sprintf("CN=%s,CN=Users,%s", username, domain_dn);
1117 the new user record. note the reliance on the samdb module to fill
1120 var ldif = sprintf("
1128 unixname, password);
1130 add the user to the users group as well
1132 var modgroup = sprintf("
1138 dom_users, user_dn);
1144 message("Adding user %s\n", user_dn);
1146 if (ok.error != 0) {
1147 message("Failed to add %s - %s\n", user_dn, ok.errstr);
1151 message("Modifying group %s\n", dom_users);
1152 ok = ldb.modify(modgroup);
1153 if (ok.error != 0) {
1154 message("Failed to modify %s - %s\n", dom_users, ok.errstr);
1159 modify the userAccountControl to remove the disabled bit
1161 ok = enable_account(ldb, user_dn);
1163 ldb.transaction_commit();
1168 // Check whether a name is valid as a NetBIOS name.
1169 // FIXME: There are probably more constraints here.
1170 // crh has a paragraph on this in his book (1.4.1.1)
1171 function valid_netbios_name(name)
1173 if (strlen(name) > 13) return false;
1177 function provision_validate(subobj, message)
1179 var lp = loadparm_init();
1181 if (!valid_netbios_name(subobj.DOMAIN)) {
1182 message("Invalid NetBIOS name for domain\n");
1186 if (!valid_netbios_name(subobj.NETBIOSNAME)) {
1187 message("Invalid NetBIOS name for host\n");
1192 if (strupper(lp.get("workgroup")) != strupper(subobj.DOMAIN_CONF)) {
1193 message("workgroup '%s' in smb.conf must match chosen domain '%s'\n",
1194 lp.get("workgroup"), subobj.DOMAIN_CONF);
1198 if (strupper(lp.get("realm")) != strupper(subobj.REALM_CONF)) {
1199 message("realm '%s' in smb.conf must match chosen realm '%s'\n",
1200 lp.get("realm"), subobj.REALM_CONF);
1204 if (strlower(lp.get("server role")) != strlower(subobj.SERVERROLE)) {
1205 message("server role '%s' in smb.conf must match chosen role '%s'\n",
1206 lp.get("server role"), subobj.SERVERROLE);
1213 function join_domain(domain, netbios_name, join_type, creds, message)
1215 var ctx = NetContext(creds);
1216 var joindom = new Object();
1217 joindom.domain = domain;
1218 joindom.join_type = join_type;
1219 joindom.netbios_name = netbios_name;
1220 if (!ctx.JoinDomain(joindom)) {
1221 message("Domain Join failed: " + joindom.error_string);
1227 /* Vampire a remote domain. Session info and credentials are required for for
1228 * access to our local database (might be remote ldap)
1231 function vampire(domain, session_info, credentials, message) {
1232 var ctx = NetContext(credentials);
1233 var vampire_ctx = new Object();
1234 var machine_creds = credentials_init();
1235 machine_creds.set_domain(form.DOMAIN);
1236 if (!machine_creds.set_machine_account()) {
1237 message("Failed to access domain join information!");
1240 vampire_ctx.machine_creds = machine_creds;
1241 vampire_ctx.session_info = session_info;
1242 if (!ctx.SamSyncLdb(vampire_ctx)) {
1243 message("Migration of remote domain to Samba failed: " + vampire_ctx.error_string);