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=*)(dn=*))(!(dn=@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=*)(dn=*))(!(dn=@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=*)(dn=*))";
211 var attrs = new Array("dn");
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 info.message("ldb search failed: " + res.errstr + "\n");
230 previous_remaining = current_remaining;
231 current_remaining = res2.msgs.length;
232 for (i=0;i<res2.msgs.length;i++) {
233 ldb.del(res2.msgs[i].dn);
236 var res3 = ldb.search(anything, basedn, ldb.SCOPE_SUBTREE, attrs);
237 if (res3.error != 0) {
238 info.message("ldb search failed: " + res.errstr + "\n");
241 if (res3.msgs.length != 0) {
242 info.message("Failed to delete all records under " + basedn + ", " + res3.msgs.length + " records remaining\n");
248 function open_ldb(info, dbname, erase)
250 var ldb = ldb_init();
251 ldb.session_info = info.session_info;
252 ldb.credentials = info.credentials;
253 ldb.filename = dbname;
255 var connect_ok = ldb.connect(dbname);
257 var lp = loadparm_init();
258 sys.unlink(sprintf("%s/%s", lp.get("private dir"), dbname));
259 connect_ok = ldb.connect(dbname);
263 ldb.transaction_start();
266 ldb_erase(info, ldb);
273 setup a ldb in the private dir
275 function setup_add_ldif(ldif, info, ldb, failok)
277 var lp = loadparm_init();
278 var src = lp.get("setup directory") + "/" + ldif;
280 var data = sys.file_load(src);
281 data = substitute_var(data, info.subobj);
283 var add_res = ldb.add(data);
284 if (add_res.error != 0) {
285 info.message("ldb load failed: " + add_res.errstr + "\n");
287 assert(add_res.error == 0);
290 return (add_res.error == 0);
293 function setup_modify_ldif(ldif, info, ldb, failok)
295 var lp = loadparm_init();
296 var src = lp.get("setup directory") + "/" + ldif;
298 var data = sys.file_load(src);
299 data = substitute_var(data, info.subobj);
301 var mod_res = ldb.modify(data);
302 if (mod_res.error != 0) {
303 info.message("ldb load failed: " + mod_res.errstr + "\n");
305 assert(mod_res.error == 0);
308 return (mod_res.error == 0);
312 function setup_ldb(ldif, info, dbname)
317 if (arguments.length >= 4) {
318 erase = arguments[3];
320 if (arguments.length == 5) {
321 failok = arguments[4];
323 var ldb = open_ldb(info, dbname, erase);
324 if (setup_add_ldif(ldif, info, ldb, failok)) {
325 var commit_ok = ldb.transaction_commit();
327 info.message("ldb commit failed: " + ldb.errstring() + "\n");
334 setup a ldb in the private dir
336 function setup_ldb_modify(ldif, info, ldb)
338 var lp = loadparm_init();
340 var src = lp.get("setup directory") + "/" + ldif;
342 var data = sys.file_load(src);
343 data = substitute_var(data, info.subobj);
345 var mod_res = ldb.modify(data);
346 if (mod_res.error != 0) {
347 info.message("ldb load failed: " + mod_res.errstr + "\n");
348 return (mod_res.error == 0);
350 return (mod_res.error == 0);
354 setup a file in the private dir
356 function setup_file(template, message, fname, subobj)
358 var lp = loadparm_init();
360 var src = lp.get("setup directory") + "/" + template;
362 if (! sys.stat(src)) {
363 message("Template file not found: %s\n",src);
369 var data = sys.file_load(src);
370 data = substitute_var(data, subobj);
372 ok = sys.file_save(f, data);
374 message("failed to create file: " + f + "\n");
379 function provision_default_paths(subobj)
381 /* subobj.DNSDOMAIN isn't available at this point */
382 var dnsdomain = strlower(subobj.REALM);
383 var lp = loadparm_init();
384 var paths = new Object();
385 paths.smbconf = lp.get("config file");
386 paths.shareconf = lp.get("private dir") + "/" + "share.ldb";
387 paths.samdb = lp.get("sam database");
388 paths.secrets = lp.get("secrets database");
389 paths.templates = lp.get("private dir") + "/" + "templates.ldb";
390 paths.keytab = "secrets.keytab";
391 paths.dns_keytab = "dns.keytab";
392 paths.dns_keytab_abs = lp.get("private dir") + "/" + paths.dns_keytab;
393 paths.dns = lp.get("private dir") + "/" + dnsdomain + ".zone";
394 paths.named_conf = lp.get("private dir") + "/named.conf";
395 paths.winsdb = "wins.ldb";
396 paths.ldapdir = lp.get("private dir") + "/ldap";
397 paths.ldap_basedn_ldif = paths.ldapdir + "/" + dnsdomain + ".ldif";
398 paths.ldap_config_basedn_ldif = paths.ldapdir + "/" + dnsdomain + "-config.ldif";
399 paths.ldap_schema_basedn_ldif = paths.ldapdir + "/" + dnsdomain + "-schema.ldif";
401 paths.s4_ldapi_socket = lp.get("private dir") + "/ldapi";
402 paths.phpldapadminconfig = lp.get("private dir") + "/phpldapadmin-config.php";
404 paths.sysvol = lp.get("sysvol", "path");
406 if (paths.sysvol == undefined) {
407 paths.sysvol = lp.get("lock dir") + "/sysvol";
410 paths.netlogon = lp.get("netlogon", "path");
412 if (paths.netlogon == undefined) {
413 paths.netlogon = paths.sysvol + "/" + dnsdomain + "/scripts";
421 setup reasonable name mappings for sam names to unix names
423 function setup_name_mappings(info, ldb)
425 var lp = loadparm_init();
426 var attrs = new Array("objectSid");
427 var subobj = info.subobj;
429 res = ldb.search("objectSid=*", subobj.DOMAINDN, ldb.SCOPE_BASE, attrs);
430 assert(res.error == 0);
431 assert(res.msgs.length == 1 && res.msgs[0].objectSid != undefined);
432 var sid = res.msgs[0].objectSid;
434 /* add some foreign sids if they are not present already */
435 add_foreign(ldb, subobj, "S-1-5-7", "Anonymous");
436 add_foreign(ldb, subobj, "S-1-1-0", "World");
437 add_foreign(ldb, subobj, "S-1-5-2", "Network");
438 add_foreign(ldb, subobj, "S-1-5-18", "System");
439 add_foreign(ldb, subobj, "S-1-5-11", "Authenticated Users");
441 /* some well known sids */
442 setup_name_mapping(info, ldb, "S-1-5-7", subobj.NOBODY);
443 setup_name_mapping(info, ldb, "S-1-1-0", subobj.NOGROUP);
444 setup_name_mapping(info, ldb, "S-1-5-2", subobj.NOGROUP);
445 setup_name_mapping(info, ldb, "S-1-5-18", subobj.ROOT);
446 setup_name_mapping(info, ldb, "S-1-5-11", subobj.USERS);
447 setup_name_mapping(info, ldb, "S-1-5-32-544", subobj.WHEEL);
448 setup_name_mapping(info, ldb, "S-1-5-32-545", subobj.USERS);
449 setup_name_mapping(info, ldb, "S-1-5-32-546", subobj.NOGROUP);
450 setup_name_mapping(info, ldb, "S-1-5-32-551", subobj.BACKUP);
452 /* and some well known domain rids */
453 setup_name_mapping(info, ldb, sid + "-500", subobj.ROOT);
454 setup_name_mapping(info, ldb, sid + "-518", subobj.WHEEL);
455 setup_name_mapping(info, ldb, sid + "-519", subobj.WHEEL);
456 setup_name_mapping(info, ldb, sid + "-512", subobj.WHEEL);
457 setup_name_mapping(info, ldb, sid + "-513", subobj.USERS);
458 setup_name_mapping(info, ldb, sid + "-520", subobj.WHEEL);
463 function provision_fix_subobj(subobj, paths)
465 var ldb = ldb_init();
467 subobj.REALM = strupper(subobj.REALM);
468 subobj.HOSTNAME = strlower(subobj.HOSTNAME);
469 subobj.DOMAIN = strupper(subobj.DOMAIN);
470 subobj.NETBIOSNAME = strupper(subobj.HOSTNAME);
471 subobj.DNSDOMAIN = strlower(subobj.REALM);
472 subobj.DNSNAME = sprintf("%s.%s",
473 strlower(subobj.HOSTNAME),
475 var rdn_list = split(".", subobj.DNSDOMAIN);
476 subobj.DOMAINDN = "DC=" + join(",DC=", rdn_list);
477 subobj.ROOTDN = subobj.DOMAINDN;
478 subobj.CONFIGDN = "CN=Configuration," + subobj.ROOTDN;
479 subobj.SCHEMADN = "CN=Schema," + subobj.CONFIGDN;
481 subobj.MACHINEPASS_B64 = ldb.encode(subobj.MACHINEPASS);
482 subobj.KRBTGTPASS_B64 = ldb.encode(subobj.KRBTGTPASS);
483 subobj.ADMINPASS_B64 = ldb.encode(subobj.ADMINPASS);
484 subobj.DNSPASS_B64 = ldb.encode(subobj.DNSPASS);
486 var rdns = split(",", subobj.DOMAINDN);
487 subobj.RDN_DC = substr(rdns[0], strlen("DC="));
489 subobj.SAM_LDB = "tdb://" + paths.samdb;
490 subobj.SECRETS_KEYTAB = paths.keytab;
491 subobj.DNS_KEYTAB = paths.dns_keytab;
492 subobj.DNS_KEYTAB_ABS = paths.dns_keytab_abs;
494 subobj.LDAPDIR = paths.ldapdir;
495 var ldap_path_list = split("/", paths.ldapdir);
496 subobj.LDAPI_URI = "ldapi://" + join("%2F", ldap_path_list) + "%2Fldapi";
498 var s4ldap_path_list = split("/", paths.s4_ldapi_socket);
499 subobj.S4_LDAPI_URI = "ldapi://" + join("%2F", s4ldap_path_list);
501 subobj.LDAPMANAGERDN = "cn=Manager," + subobj.DOMAINDN;
503 subobj.NETLOGONPATH = paths.netlogon;
504 subobj.SYSVOLPATH = paths.sysvol;
506 if (subobj.DOMAIN_CONF == undefined) {
507 subobj.DOMAIN_CONF = subobj.DOMAIN;
509 if (subobj.REALM_CONF == undefined) {
510 subobj.REALM_CONF = subobj.REALM;
512 if (strlower(subobj.SERVERROLE) != strlower("domain controller")) {
513 subobj.REALM = subobj.HOSTNAME;
514 subobj.DOMAIN = subobj.HOSTNAME;
520 function provision_become_dc(subobj, message, erase, paths, session_info)
522 var lp = loadparm_init();
523 var sys = sys_init();
524 var info = new Object();
526 var ok = provision_fix_subobj(subobj, paths);
529 info.subobj = subobj;
530 info.message = message;
531 info.session_info = session_info;
533 message("Setting up teplates into " + paths.templates + "\n");
534 setup_ldb("provision_templates.ldif", info, paths.templates);
536 /* Also wipes the database */
537 message("Setting up " + paths.samdb + " partitions\n");
538 setup_ldb("provision_partitions.ldif", info, paths.samdb);
540 var samdb = open_ldb(info, paths.samdb, false);
542 message("Setting up " + paths.samdb + " attributes\n");
543 setup_add_ldif("provision_init.ldif", info, samdb, false);
545 message("Setting up " + paths.samdb + " rootDSE\n");
546 setup_add_ldif("provision_rootdse_add.ldif", info, samdb, false);
549 message("Erasing data from partitions\n");
550 ldb_erase_partitions(info, samdb, undefined);
553 message("Setting up " + paths.samdb + " indexes\n");
554 setup_add_ldif("provision_index.ldif", info, samdb, false);
556 ok = samdb.transaction_commit();
559 message("Setting up " + paths.secrets + "\n");
560 setup_ldb("secrets_init.ldif", info, paths.secrets);
562 setup_ldb("secrets.ldif", info, paths.secrets, false);
564 setup_ldb("secrets_dc.ldif", info, paths.secrets, false);
569 function load_schema(subobj, message, samdb)
571 var lp = loadparm_init();
572 var src = lp.get("setup directory") + "/" + "schema.ldif";
574 if (! sys.stat(src)) {
575 message("Template file not found: %s\n",src);
579 var schema_data = sys.file_load(src);
581 src = lp.get("setup directory") + "/" + "schema_samba4.ldif";
583 if (! sys.stat(src)) {
584 message("Template file not found: %s\n",src);
588 schema_data = schema_data + sys.file_load(src);
590 schema_data = substitute_var(schema_data, subobj);
592 src = lp.get("setup directory") + "/" + "provision_schema_basedn_modify.ldif";
594 if (! sys.stat(src)) {
595 message("Template file not found: %s\n",src);
599 var head_data = sys.file_load(src);
600 head_data = substitute_var(head_data, subobj);
602 var ok = samdb.attach_dsdb_schema_from_ldif(head_data, schema_data);
608 provision samba4 - caution, this wipes all existing data!
610 function provision(subobj, message, blank, paths, session_info, credentials, ldapbackend)
612 var lp = loadparm_init();
613 var sys = sys_init();
614 var info = new Object();
616 var ok = provision_fix_subobj(subobj, paths);
619 if (subobj.DOMAINGUID != undefined) {
620 subobj.DOMAINGUID_MOD = sprintf("replace: objectGUID\nobjectGUID: %s\n-", subobj.DOMAINGUID);
622 subobj.DOMAINGUID_MOD = "";
625 if (subobj.HOSTGUID != undefined) {
626 subobj.HOSTGUID_ADD = sprintf("objectGUID: %s", subobj.HOSTGUID);
628 subobj.HOSTGUID_ADD = "";
631 info.subobj = subobj;
632 info.message = message;
633 info.credentials = credentials;
634 info.session_info = session_info;
636 /* only install a new smb.conf if there isn't one there already */
637 var st = sys.stat(paths.smbconf);
638 if (st == undefined) {
640 if (strlower(subobj.SERVERROLE) == strlower("domain controller")) {
641 smbconfsuffix = "dc";
642 } else if (strlower(subobj.SERVERROLE) == strlower("member server")) {
643 smbconfsuffix = "member";
645 smbconfsuffix = subobj.SERVERROLE;
647 message("Setting up " + paths.smbconf +"\n");
648 setup_file("provision.smb.conf." + smbconfsuffix, info.message, paths.smbconf, subobj);
651 /* only install a new shares config db if there is none */
652 st = sys.stat(paths.shareconf);
653 if (st == undefined) {
654 message("Setting up share.ldb\n");
655 setup_ldb("share.ldif", info, paths.shareconf);
658 message("Setting up " + paths.secrets + "\n");
659 setup_ldb("secrets_init.ldif", info, paths.secrets);
660 setup_ldb("secrets.ldif", info, paths.secrets, false);
662 message("Setting up the registry\n");
663 var reg = reg_open();
664 reg.apply_patchfile(lp.get("setup directory") + "/provision.reg")
666 message("Setting up teplates into " + paths.templates + "\n");
667 setup_ldb("provision_templates.ldif", info, paths.templates);
669 message("Setting up sam.ldb partitions\n");
670 /* Also wipes the database */
671 setup_ldb("provision_partitions.ldif", info, paths.samdb);
673 var samdb = open_ldb(info, paths.samdb, false);
675 message("Setting up sam.ldb attributes\n");
676 setup_add_ldif("provision_init.ldif", info, samdb, false);
678 message("Setting up sam.ldb rootDSE\n");
679 setup_add_ldif("provision_rootdse_add.ldif", info, samdb, false);
681 message("Erasing data from partitions\n");
682 ldb_erase_partitions(info, samdb, ldapbackend);
684 // (hack) Reload, now we have the partitions and rootdse loaded.
685 var commit_ok = samdb.transaction_commit();
687 info.message("samdb commit failed: " + samdb.errstring() + "\n");
692 message("Pre-loading the Samba4 and AD schema\n");
694 samdb = open_ldb(info, paths.samdb, false);
696 samdb.set_domain_sid(subobj.DOMAINSID);
698 var load_schema_ok = load_schema(subobj, message, samdb);
699 assert(load_schema_ok.is_ok);
701 message("Adding DomainDN: " + subobj.DOMAINDN + " (permitted to fail)\n");
702 var add_ok = setup_add_ldif("provision_basedn.ldif", info, samdb, true);
703 message("Modifying DomainDN: " + subobj.DOMAINDN + "\n");
704 var modify_basedn_ok = setup_ldb_modify("provision_basedn_modify.ldif", info, samdb);
705 if (!modify_basedn_ok) {
707 message("%s", "Failed to both add and modify " + subobj.DOMAINDN + " in target " + subobj.DOMAINDN_LDB + ": " + samdb.errstring() + "\n");
708 message("Perhaps you need to run the provision script with the --ldap-base-dn option, and add this record to the backend manually\n");
710 assert(modify_basedn_ok);
713 message("Adding configuration container (permitted to fail)\n");
714 var add_config_ok = setup_add_ldif("provision_configuration_basedn.ldif", info, samdb, true);
715 message("Modifying configuration container\n");
716 var modify_config_ok = setup_ldb_modify("provision_configuration_basedn_modify.ldif", info, samdb);
717 if (!modify_config_ok) {
718 if (!add_config_ok) {
719 message("%s", "Failed to both add and modify " + subobj.CONFIGDN + " in target " + subobj.CONFIGDN_LDB + ": " + samdb.errstring() + "\n");
720 message("Perhaps you need to run the provision script with the --ldap-base-dn option, and add this record to the backend manually\n");
722 assert(modify_config_ok);
725 message("Adding schema container (permitted to fail)\n");
726 var add_schema_ok = setup_add_ldif("provision_schema_basedn.ldif", info, samdb, true);
727 message("Modifying schema container\n");
728 var modify_schema_ok = setup_ldb_modify("provision_schema_basedn_modify.ldif", info, samdb);
729 if (!modify_schema_ok) {
730 if (!add_schema_ok) {
731 message("%s", "Failed to both add and modify " + subobj.SCHEMADN + " in target " + subobj.SCHEMADN_LDB + ": " + samdb.errstring() + "\n");
732 message("Perhaps you need to run the provision script with the --ldap-base-dn option, and add this record to the backend manually\n");
734 message("Failed to modify the schema container: " + samdb.errstring() + "\n");
735 assert(modify_schema_ok);
738 message("Setting up sam.ldb Samba4 schema\n");
739 setup_add_ldif("schema_samba4.ldif", info, samdb, false);
740 message("Setting up sam.ldb AD schema\n");
741 setup_add_ldif("schema.ldif", info, samdb, false);
743 message("Setting up sam.ldb configuration data\n");
744 setup_add_ldif("provision_configuration.ldif", info, samdb, false);
746 message("Setting up display specifiers\n");
747 setup_add_ldif("display_specifiers.ldif", info, samdb, false);
749 message("Adding users container (permitted to fail)\n");
750 var add_users_ok = setup_add_ldif("provision_users_add.ldif", info, samdb, true);
751 message("Modifying users container\n");
752 var modify_users_ok = setup_ldb_modify("provision_users_modify.ldif", info, samdb);
753 if (!modify_users_ok) {
755 message("Failed to both add and modify the users container\n");
757 assert(modify_users_ok);
759 message("Adding computers container (permitted to fail)\n");
760 var add_computers_ok = setup_add_ldif("provision_computers_add.ldif", info, samdb, true);
761 message("Modifying computers container\n");
762 var modify_computers_ok = setup_ldb_modify("provision_computers_modify.ldif", info, samdb);
763 if (!modify_computers_ok) {
764 if (!add_computers_ok) {
765 message("Failed to both add and modify the computers container\n");
767 assert(modify_computers_ok);
770 message("Setting up sam.ldb data\n");
771 setup_add_ldif("provision.ldif", info, samdb, false);
773 if (blank != false) {
774 message("Setting up sam.ldb index\n");
775 setup_add_ldif("provision_index.ldif", info, samdb, false);
777 message("Setting up sam.ldb rootDSE marking as syncronized\n");
778 setup_modify_ldif("provision_rootdse_modify.ldif", info, samdb, false);
780 var commit_ok = samdb.transaction_commit();
782 info.message("ldb commit failed: " + samdb.errstring() + "\n");
788 // message("Activate schema module");
789 // setup_modify_ldif("schema_activation.ldif", info, samdb, false);
791 // // (hack) Reload, now we have the schema loaded.
792 // var commit_ok = samdb.transaction_commit();
794 // info.message("samdb commit failed: " + samdb.errstring() + "\n");
795 // assert(commit_ok);
799 // samdb = open_ldb(info, paths.samdb, false);
801 message("Setting up sam.ldb users and groups\n");
802 setup_add_ldif("provision_users.ldif", info, samdb, false);
804 if (strlower(subobj.SERVERROLE) == strlower("domain controller")) {
805 message("Setting up self join\n");
806 setup_add_ldif("provision_self_join.ldif", info, samdb, false);
807 setup_add_ldif("provision_group_policy.ldif", info, samdb, false);
809 sys.mkdir(paths.sysvol, 0755);
810 sys.mkdir(paths.sysvol + "/"+ subobj.DNSDOMAIN, 0755);
811 sys.mkdir(paths.sysvol + "/"+ subobj.DNSDOMAIN + "/Policies", 0755);
812 sys.mkdir(paths.sysvol + "/"+ subobj.DNSDOMAIN + "/Policies/{" + subobj.POLICYGUID + "}", 0755);
813 sys.mkdir(paths.sysvol + "/"+ subobj.DNSDOMAIN + "/Policies/{" + subobj.POLICYGUID + "}/Machine", 0755);
814 sys.mkdir(paths.sysvol + "/"+ subobj.DNSDOMAIN + "/Policies/{" + subobj.POLICYGUID + "}/User", 0755);
816 sys.mkdir(paths.netlogon, 0755);
818 setup_ldb("secrets_dc.ldif", info, paths.secrets, false);
822 if (setup_name_mappings(info, samdb) == false) {
826 message("Setting up sam.ldb index\n");
827 setup_add_ldif("provision_index.ldif", info, samdb, false);
829 message("Setting up sam.ldb rootDSE marking as syncronized\n");
830 setup_modify_ldif("provision_rootdse_modify.ldif", info, samdb, false);
832 var commit_ok = samdb.transaction_commit();
834 info.message("samdb commit failed: " + samdb.errstring() + "\n");
838 message("Setting up phpLDAPadmin configuration\n");
839 setup_file("phpldapadmin-config.php", info.message, paths.phpldapadminconfig, subobj);
840 message("Please install the phpLDAPadmin configuration located at " + paths.phpldapadminconfig + " into /etc/phpldapadmin/config.php\n");
846 provision just the schema into a temporary ldb, so we can run ad2oLschema on it
848 function provision_schema(subobj, message, tmp_schema_path, paths)
850 var lp = loadparm_init();
851 var sys = sys_init();
852 var info = new Object();
854 var ok = provision_fix_subobj(subobj, paths);
857 info.subobj = subobj;
858 info.message = message;
860 message("Setting up sam.ldb partitions\n");
862 /* This will erase anything in the tmp db */
863 var samdb = open_ldb(info, tmp_schema_path, true);
865 message("Adding schema container (permitted to fail)\n");
866 var add_ok = setup_add_ldif("provision_schema_basedn.ldif", info, samdb, true);
867 message("Modifying schema container\n");
868 var modify_ok = setup_ldb_modify("provision_schema_basedn_modify.ldif", info, samdb);
871 message("Failed to both add and modify schema dn: " + samdb.errstring() + "\n");
872 message("Perhaps you need to run the provision script with the --ldap-base-dn option, and add this record to the backend manually\n");
875 message("Failed to modify the schema container: " + samdb.errstring() + "\n");
879 message("Setting up sam.ldb Samba4 schema\n");
880 setup_add_ldif("schema_samba4.ldif", info, samdb, false);
881 message("Setting up sam.ldb AD schema\n");
882 setup_add_ldif("schema.ldif", info, samdb, false);
884 var commit_ok = samdb.transaction_commit();
886 info.message("samdb commit failed: " + samdb.errstring() + "\n");
892 /* Write out a DNS zone file, from the info in the current database */
893 function provision_dns(subobj, message, paths, session_info, credentials)
895 var lp = loadparm_init();
896 if (strlower(subobj.SERVERROLE) != strlower("domain controller")) {
897 message("No DNS zone required for role %s\n", subobj.SERVERROLE);
900 message("Setting up DNS zone: " + subobj.DNSDOMAIN + " \n");
901 var ldb = ldb_init();
902 ldb.session_info = session_info;
903 ldb.credentials = credentials;
905 /* connect to the sam */
906 var ok = ldb.connect(paths.samdb);
909 /* These values may have changed, due to an incoming SamSync,
910 or may not have been specified, so fetch them from the database */
912 var attrs = new Array("objectGUID");
913 res = ldb.search("objectGUID=*", subobj.DOMAINDN, ldb.SCOPE_BASE, attrs);
914 assert(res.error == 0);
915 assert(res.msgs.length == 1);
916 assert(res.msgs[0].objectGUID != undefined);
917 subobj.DOMAINGUID = res.msgs[0].objectGUID;
919 subobj.HOSTGUID = searchone(ldb, subobj.DOMAINDN, "(&(objectClass=computer)(cn=" + subobj.NETBIOSNAME + "))", "objectGUID");
920 assert(subobj.HOSTGUID != undefined);
922 setup_file("provision.zone",
926 setup_file("named.conf",
927 message, paths.named_conf,
930 message("Please install the zone located in " + paths.dns + " into your DNS server. A sample BIND configuration snippit is at " + paths.named_conf + "\n");
933 /* Write out a DNS zone file, from the info in the current database */
934 function provision_ldapbase(subobj, message, paths)
936 var ok = provision_fix_subobj(subobj, paths);
939 message("Setting up LDAP base entry: " + subobj.DOMAINDN + " \n");
940 var rdns = split(",", subobj.DOMAINDN);
941 subobj.EXTENSIBLEOBJECT = "objectClass: extensibleObject";
943 subobj.RDN_DC = substr(rdns[0], strlen("DC="));
945 sys.mkdir(paths.ldapdir, 0700);
947 setup_file("provision_basedn.ldif",
948 message, paths.ldap_basedn_ldif,
951 setup_file("provision_configuration_basedn.ldif",
952 message, paths.ldap_config_basedn_ldif,
955 setup_file("provision_schema_basedn.ldif",
956 message, paths.ldap_schema_basedn_ldif,
963 guess reasonably default options for provisioning
965 function provision_guess()
967 var subobj = new Object();
968 var nss = nss_init();
969 var lp = loadparm_init();
973 subobj.SERVERROLE = strlower(lp.get("server role"));
974 subobj.REALM = strupper(lp.get("realm"));
975 subobj.DOMAIN = lp.get("workgroup");
976 subobj.HOSTNAME = hostname();
978 assert(subobj.REALM);
979 assert(subobj.DOMAIN);
980 assert(subobj.HOSTNAME);
982 subobj.VERSION = version();
983 subobj.HOSTIP = hostip();
984 subobj.DOMAINSID = randsid();
985 subobj.INVOCATIONID = randguid();
986 subobj.POLICYGUID = randguid();
987 subobj.KRBTGTPASS = randpass(12);
988 subobj.MACHINEPASS = randpass(12);
989 subobj.DNSPASS = randpass(12);
990 subobj.ADMINPASS = randpass(12);
991 subobj.LDAPMANAGERPASS = randpass(12);
992 subobj.DEFAULTSITE = "Default-First-Site-Name";
993 subobj.NEWGUID = randguid;
994 subobj.NTTIME = nttime;
995 subobj.LDAPTIME = ldaptime;
996 subobj.DATESTRING = datestring;
997 subobj.ROOT = findnss(nss.getpwnam, "root");
998 subobj.NOBODY = findnss(nss.getpwnam, "nobody");
999 subobj.NOGROUP = findnss(nss.getgrnam, "nogroup", "nobody");
1000 subobj.WHEEL = findnss(nss.getgrnam, "wheel", "root", "staff", "adm");
1001 subobj.BACKUP = findnss(nss.getgrnam, "backup", "wheel", "root", "staff");
1002 subobj.USERS = findnss(nss.getgrnam, "users", "guest", "other", "unknown", "usr");
1004 //Add modules to the list to activate them by default
1005 //beware often order is important
1007 // Some Known ordering constraints:
1008 // - rootdse must be first, as it makes redirects from "" -> cn=rootdse
1009 // - objectclass must be before password_hash, because password_hash checks
1010 // that the objectclass is of type person (filled in by the objectclass
1011 // module when expanding the objectclass list)
1012 // - partition must be last
1013 // - each partition has its own module list then
1014 var modules_list = new Array("rootdse",
1025 var tdb_modules_list = new Array("subtree_rename",
1027 "linked_attributes");
1028 var modules_list2 = new Array("show_deleted",
1030 subobj.MODULES_LIST = join(",", modules_list);
1031 subobj.TDB_MODULES_LIST = "," + join(",", tdb_modules_list);
1032 subobj.MODULES_LIST2 = join(",", modules_list2);
1033 subobj.DOMAINDN_LDB = "users.ldb";
1034 subobj.CONFIGDN_LDB = "configuration.ldb";
1035 subobj.SCHEMADN_LDB = "schema.ldb";
1036 subobj.DOMAINDN_MOD = "pdc_fsmo,password_hash";
1037 subobj.CONFIGDN_MOD = "naming_fsmo";
1038 subobj.SCHEMADN_MOD = "schema_fsmo";
1039 subobj.DOMAINDN_MOD2 = ",objectguid";
1040 subobj.CONFIGDN_MOD2 = ",objectguid";
1041 subobj.SCHEMADN_MOD2 = ",objectguid";
1043 subobj.EXTENSIBLEOBJECT = "# no objectClass: extensibleObject for local ldb";
1044 subobj.ACI = "# no aci for local ldb";
1050 search for one attribute as a string
1052 function searchone(ldb, basedn, expression, attribute)
1054 var attrs = new Array(attribute);
1055 res = ldb.search(expression, basedn, ldb.SCOPE_SUBTREE, attrs);
1056 if (res.error != 0 ||
1057 res.msgs.length != 1 ||
1058 res.msgs[0][attribute] == undefined) {
1061 return res.msgs[0][attribute];
1065 modify an account to remove the
1067 function enable_account(ldb, user_dn)
1069 var attrs = new Array("userAccountControl");
1070 var res = ldb.search(NULL, user_dn, ldb.SCOPE_ONELEVEL, attrs);
1071 assert(res.error == 0);
1072 assert(res.msgs.length == 1);
1073 var userAccountControl = res.msgs[0].userAccountControl;
1074 userAccountControl = userAccountControl - 2; /* remove disabled bit */
1078 replace: userAccountControl
1079 userAccountControl: %u
1081 user_dn, userAccountControl);
1082 var ok = ldb.modify(mod);
1083 return (ok.error == 0);
1088 add a new user record
1090 function newuser(username, unixname, password, message, session_info, credentials)
1092 var lp = loadparm_init();
1093 var samdb = lp.get("sam database");
1094 var ldb = ldb_init();
1096 ldb.session_info = session_info;
1097 ldb.credentials = credentials;
1099 /* connect to the sam */
1100 var ok = ldb.connect(samdb);
1103 ldb.transaction_start();
1105 /* find the DNs for the domain and the domain users group */
1106 var attrs = new Array("defaultNamingContext");
1107 res = ldb.search("defaultNamingContext=*", "", ldb.SCOPE_BASE, attrs);
1108 assert(res.error == 0);
1109 assert(res.msgs.length == 1 && res.msgs[0].defaultNamingContext != undefined);
1110 var domain_dn = res.msgs[0].defaultNamingContext;
1111 assert(domain_dn != undefined);
1112 var dom_users = searchone(ldb, domain_dn, "name=Domain Users", "dn");
1113 assert(dom_users != undefined);
1115 var user_dn = sprintf("CN=%s,CN=Users,%s", username, domain_dn);
1119 the new user record. note the reliance on the samdb module to fill
1122 var ldif = sprintf("
1129 user_dn, username, dom_users,
1130 unixname, password);
1132 add the user to the users group as well
1134 var modgroup = sprintf("
1140 dom_users, user_dn);
1146 message("Adding user %s\n", user_dn);
1148 if (ok.error != 0) {
1149 message("Failed to add %s - %s\n", user_dn, ok.errstr);
1153 message("Modifying group %s\n", dom_users);
1154 ok = ldb.modify(modgroup);
1155 if (ok.error != 0) {
1156 message("Failed to modify %s - %s\n", dom_users, ok.errstr);
1161 modify the userAccountControl to remove the disabled bit
1163 ok = enable_account(ldb, user_dn);
1165 ldb.transaction_commit();
1170 // Check whether a name is valid as a NetBIOS name.
1171 // FIXME: There are probably more constraints here.
1172 // crh has a paragraph on this in his book (1.4.1.1)
1173 function valid_netbios_name(name)
1175 if (strlen(name) > 13) return false;
1179 function provision_validate(subobj, message)
1181 var lp = loadparm_init();
1183 if (!valid_netbios_name(subobj.DOMAIN)) {
1184 message("Invalid NetBIOS name for domain\n");
1188 if (!valid_netbios_name(subobj.NETBIOSNAME)) {
1189 message("Invalid NetBIOS name for host\n");
1194 if (strupper(lp.get("workgroup")) != strupper(subobj.DOMAIN_CONF)) {
1195 message("workgroup '%s' in smb.conf must match chosen domain '%s'\n",
1196 lp.get("workgroup"), subobj.DOMAIN_CONF);
1200 if (strupper(lp.get("realm")) != strupper(subobj.REALM_CONF)) {
1201 message("realm '%s' in smb.conf must match chosen realm '%s'\n",
1202 lp.get("realm"), subobj.REALM_CONF);
1206 if (strlower(lp.get("server role")) != strlower(subobj.SERVERROLE)) {
1207 message("server role '%s' in smb.conf must match chosen role '%s'\n",
1208 lp.get("server role"), subobj.SERVERROLE);
1215 function join_domain(domain, netbios_name, join_type, creds, message)
1217 var ctx = NetContext(creds);
1218 var joindom = new Object();
1219 joindom.domain = domain;
1220 joindom.join_type = join_type;
1221 joindom.netbios_name = netbios_name;
1222 if (!ctx.JoinDomain(joindom)) {
1223 message("Domain Join failed: " + joindom.error_string);
1229 /* Vampire a remote domain. Session info and credentials are required for for
1230 * access to our local database (might be remote ldap)
1233 function vampire(domain, session_info, credentials, message) {
1234 var ctx = NetContext(credentials);
1235 var vampire_ctx = new Object();
1236 var machine_creds = credentials_init();
1237 machine_creds.set_domain(form.DOMAIN);
1238 if (!machine_creds.set_machine_account()) {
1239 message("Failed to access domain join information!");
1242 vampire_ctx.machine_creds = machine_creds;
1243 vampire_ctx.session_info = session_info;
1244 if (!ctx.SamSyncLdb(vampire_ctx)) {
1245 message("Migration of remote domain to Samba failed: " + vampire_ctx.error_string);