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.gmtime(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");
171 var res = ldb.search("(&(|(objectclass=*)(dn=*))(!(dn=@BASEINFO)))", attrs);
173 if (typeof(res) == "undefined") {
177 for (i=0;i<res.length;i++) {
180 /* extra hack to ensure it's gone on remote ldap */
181 ldb.del("cn=ROOTDSE");
183 var res = ldb.search("(&(|(objectclass=*)(dn=*))(!(dn=@BASEINFO)))", attrs);
184 if (res.length != 0) {
188 assert(res.length == 0);
192 erase an ldb, removing all records
194 function ldb_erase_partitions(info, ldb)
196 var rootDSE_attrs = new Array("namingContexts");
197 var lp = loadparm_init();
200 var res = ldb.search("(objectClass=*)", "", ldb.SCOPE_BASE, rootDSE_attrs);
201 assert(typeof(res) != "undefined");
202 assert(res.length == 1);
203 if (typeof(res[0].namingContexts) == "undefined") {
206 for (j=0; j<res[0].namingContexts.length; j++) {
207 var attrs = new Array("dn");
208 var basedn = res[0].namingContexts[j];
210 var previous_remaining = 1;
211 var current_remaining = 0;
213 for (k=0; k < 10 && (previous_remaining != current_remaining); k++) {
215 var res2 = ldb.search("(|(objectclass=*)(dn=*))", basedn, ldb.SCOPE_SUBTREE, attrs);
217 if (typeof(res2) == "undefined") {
218 info.message("ldb search failed: " + ldb.errstring() + "\n");
221 previous_remaining = current_remaining;
222 current_remaining = res2.length;
223 for (i=0;i<res2.length;i++) {
227 var res3 = ldb.search("(|(objectclass=*)(dn=*))", basedn, ldb.SCOPE_SUBTREE, attrs);
228 if (res3.length != 0) {
229 info.message("Failed to delete all records under " + basedn + ", " + res3.length + " records remaining\n");
235 function open_ldb(info, dbname, erase)
237 var ldb = ldb_init();
238 ldb.session_info = info.session_info;
239 ldb.credentials = info.credentials;
240 ldb.filename = dbname;
242 var connect_ok = ldb.connect(dbname);
244 var lp = loadparm_init();
245 sys.unlink(sprintf("%s/%s", lp.get("private dir"), dbname));
246 connect_ok = ldb.connect(dbname);
250 ldb.transaction_start();
260 setup a ldb in the private dir
262 function setup_add_ldif(ldif, info, ldb, failok)
264 var lp = loadparm_init();
265 var src = lp.get("setup directory") + "/" + ldif;
267 var data = sys.file_load(src);
268 data = substitute_var(data, info.subobj);
270 var add_ok = ldb.add(data);
272 info.message("ldb load failed: " + ldb.errstring() + "\n");
280 function setup_ldb(ldif, info, dbname)
285 if (arguments.length >= 4) {
286 erase = arguments[3];
288 if (arguments.length == 5) {
289 failok = arguments[4];
291 var ldb = open_ldb(info, dbname, erase);
292 if (setup_add_ldif(ldif, info, ldb, erase, failok)) {
293 var commit_ok = ldb.transaction_commit();
295 info.message("ldb commit failed: " + ldb.errstring() + "\n");
302 setup a ldb in the private dir
304 function setup_ldb_modify(ldif, info, ldb)
306 var lp = loadparm_init();
308 var src = lp.get("setup directory") + "/" + ldif;
310 var data = sys.file_load(src);
311 data = substitute_var(data, info.subobj);
313 var mod_ok = ldb.modify(data);
315 info.message("ldb load failed: " + ldb.errstring() + "\n");
322 setup a file in the private dir
324 function setup_file(template, message, fname, subobj)
326 var lp = loadparm_init();
328 var src = lp.get("setup directory") + "/" + template;
332 var data = sys.file_load(src);
333 data = substitute_var(data, subobj);
335 ok = sys.file_save(f, data);
337 message("failed to create file: " + f + "\n");
342 function provision_default_paths(subobj)
344 var lp = loadparm_init();
345 var paths = new Object();
346 paths.smbconf = lp.get("config file");
347 paths.shareconf = lp.get("private dir") + "/" + "share.ldb";
348 paths.hklm = "hklm.ldb";
349 paths.hkcu = "hkcu.ldb";
350 paths.hkcr = "hkcr.ldb";
351 paths.hku = "hku.ldb";
352 paths.hkpd = "hkpd.ldb";
353 paths.hkpt = "hkpt.ldb";
354 paths.samdb = lp.get("sam database");
355 paths.secrets = "secrets.ldb";
356 paths.dns = lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".zone";
357 paths.winsdb = "wins.ldb";
358 paths.ldap_basedn_ldif = lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".ldif";
364 setup reasonable name mappings for sam names to unix names
366 function setup_name_mappings(info, subobj, ldb)
368 var lp = loadparm_init();
369 var attrs = new Array("objectSid");
370 res = ldb.search("objectSid=*", subobj.BASEDN, ldb.SCOPE_BASE, attrs);
371 assert(res.length == 1 && res[0].objectSid != undefined);
372 var sid = res[0].objectSid;
374 /* add some foreign sids if they are not present already */
375 add_foreign(ldb, subobj, "S-1-5-7", "Anonymous");
376 add_foreign(ldb, subobj, "S-1-1-0", "World");
377 add_foreign(ldb, subobj, "S-1-5-2", "Network");
378 add_foreign(ldb, subobj, "S-1-5-18", "System");
379 add_foreign(ldb, subobj, "S-1-5-11", "Authenticated Users");
381 /* some well known sids */
382 setup_name_mapping(info, ldb, "S-1-5-7", subobj.NOBODY);
383 setup_name_mapping(info, ldb, "S-1-1-0", subobj.NOGROUP);
384 setup_name_mapping(info, ldb, "S-1-5-2", subobj.NOGROUP);
385 setup_name_mapping(info, ldb, "S-1-5-18", subobj.ROOT);
386 setup_name_mapping(info, ldb, "S-1-5-11", subobj.USERS);
387 setup_name_mapping(info, ldb, "S-1-5-32-544", subobj.WHEEL);
388 setup_name_mapping(info, ldb, "S-1-5-32-545", subobj.USERS);
389 setup_name_mapping(info, ldb, "S-1-5-32-546", subobj.NOGROUP);
390 setup_name_mapping(info, ldb, "S-1-5-32-551", subobj.BACKUP);
392 /* and some well known domain rids */
393 setup_name_mapping(info, ldb, sid + "-500", subobj.ROOT);
394 setup_name_mapping(info, ldb, sid + "-518", subobj.WHEEL);
395 setup_name_mapping(info, ldb, sid + "-519", subobj.WHEEL);
396 setup_name_mapping(info, ldb, sid + "-512", subobj.WHEEL);
397 setup_name_mapping(info, ldb, sid + "-513", subobj.USERS);
398 setup_name_mapping(info, ldb, sid + "-520", subobj.WHEEL);
405 provision samba4 - caution, this wipes all existing data!
407 function provision(subobj, message, blank, paths, session_info, credentials)
409 var lp = loadparm_init();
410 var sys = sys_init();
411 var info = new Object();
414 some options need to be upper/lower case
416 subobj.REALM = strupper(subobj.REALM);
417 subobj.HOSTNAME = strlower(subobj.HOSTNAME);
418 subobj.DOMAIN = strupper(subobj.DOMAIN);
419 assert(valid_netbios_name(subobj.DOMAIN));
420 subobj.NETBIOSNAME = strupper(subobj.HOSTNAME);
421 assert(valid_netbios_name(subobj.NETBIOSNAME));
422 var rdns = split(",", subobj.BASEDN);
423 subobj.RDN_DC = substr(rdns[0], strlen("DC="));
425 if (subobj.DOMAINGUID != undefined) {
426 subobj.DOMAINGUID_MOD = sprintf("replace: objectGUID\nobjectGUID: %s\n-", subobj.DOMAINGUID);
428 subobj.DOMAINGUID_MOD = "";
431 if (subobj.HOSTGUID != undefined) {
432 subobj.HOSTGUID_ADD = sprintf("objectGUID: %s", subobj.HOSTGUID);
434 subobj.HOSTGUID_ADD = "";
437 info.subobj = subobj;
438 info.message = message;
439 info.credentials = credentials;
440 info.session_info = session_info;
442 /* only install a new smb.conf if there isn't one there already */
443 var st = sys.stat(paths.smbconf);
444 if (st == undefined) {
445 message("Setting up smb.conf\n");
446 setup_file("provision.smb.conf", info.message, paths.smbconf, subobj);
449 /* only install a new shares config db if there is none */
450 st = sys.stat(paths.shareconf);
451 if (st == undefined) {
452 message("Setting up sconf.ldb\n");
453 setup_ldb("share.ldif", info, paths.shareconf);
455 message("Setting up secrets.ldb\n");
456 setup_ldb("secrets.ldif", info, paths.secrets);
457 message("Setting up keytabs\n");
458 var keytab_ok = credentials_update_all_keytabs();
460 message("Setting up hklm.ldb\n");
461 setup_ldb("hklm.ldif", info, paths.hklm);
463 message("Setting up sam.ldb partitions\n");
464 /* Also wipes the database */
465 setup_ldb("provision_partitions.ldif", info, paths.samdb);
467 var samdb = open_ldb(info, paths.samdb, false);
469 message("Setting up sam.ldb attributes\n");
470 setup_add_ldif("provision_init.ldif", info, samdb, false);
471 message("Erasing data from partitions\n");
472 ldb_erase_partitions(info, samdb);
474 message("Adding baseDN: " + subobj.BASEDN + " (permitted to fail)\n");
475 var add_ok = setup_add_ldif("provision_basedn.ldif", info, samdb, true);
476 message("Modifying baseDN: " + subobj.BASEDN + "\n");
477 var modify_ok = setup_ldb_modify("provision_basedn_modify.ldif", info, samdb);
480 message("Failed to both add and modify " + subobj.BASEDN + " in target " + subobj.LDAPBACKEND + "\n");
481 message("Perhaps you need to run the provision script with the --ldap-base-dn option, and add this record to the backend manually\n");
486 message("Setting up sam.ldb Samba4 schema\n");
487 setup_add_ldif("schema_samba4.ldif", info, samdb, false);
488 message("Setting up sam.ldb AD schema\n");
489 setup_add_ldif("schema.ldif", info, samdb, false);
491 // (hack) Reload, now we have the schema loaded.
492 var commit_ok = samdb.transaction_commit();
494 info.message("samdb commit failed: " + samdb.errstring() + "\n");
499 samdb = open_ldb(info, paths.samdb, false);
501 message("Setting up display specifiers\n");
502 setup_add_ldif("display_specifiers.ldif", info, samdb, false);
503 message("Setting up sam.ldb templates\n");
504 setup_add_ldif("provision_templates.ldif", info, samdb, false);
505 message("Setting up sam.ldb data\n");
506 setup_add_ldif("provision.ldif", info, samdb, false);
508 if (blank != false) {
509 var commit_ok = samdb.transaction_commit();
511 info.message("ldb commit failed: " + samdb.errstring() + "\n");
517 message("Setting up sam.ldb users and groups\n");
518 setup_add_ldif("provision_users.ldif", info, samdb, false);
520 if (setup_name_mappings(info, subobj, samdb) == false) {
524 var commit_ok = samdb.transaction_commit();
526 info.message("samdb commit failed: " + samdb.errstring() + "\n");
533 /* Write out a DNS zone file, from the info in the current database */
534 function provision_dns(subobj, message, paths, session_info, credentials)
536 message("Setting up DNS zone: " + subobj.DNSDOMAIN + " \n");
537 var ldb = ldb_init();
538 ldb.session_info = session_info;
539 ldb.credentials = credentials;
541 /* connect to the sam */
542 var ok = ldb.connect(paths.samdb);
545 /* These values may have changed, due to an incoming SamSync,
546 or may not have been specified, so fetch them from the database */
548 var attrs = new Array("objectGUID");
549 res = ldb.search("objectGUID=*", subobj.BASEDN, ldb.SCOPE_BASE, attrs);
550 assert(res.length == 1 && res[0].objectGUID != undefined)
551 subobj.DOMAINGUID = res[0].objectGUID;
553 subobj.HOSTGUID = searchone(ldb, subobj.BASEDN, "(&(objectClass=computer)(cn=" + subobj.NETBIOSNAME + "))", "objectGUID");
554 assert(subobj.HOSTGUID != undefined);
556 setup_file("provision.zone",
560 message("Please install the zone located in " + paths.dns + " into your DNS server\n");
563 /* Write out a DNS zone file, from the info in the current database */
564 function provision_ldapbase(subobj, message, paths)
566 message("Setting up LDAP base entry: " + subobj.BASEDN + " \n");
567 var rdns = split(",", subobj.BASEDN);
568 subobj.RDN_DC = substr(rdns[0], strlen("DC="));
570 setup_file("provision_basedn.ldif",
571 message, paths.ldap_basedn_ldif,
574 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");
579 guess reasonably default options for provisioning
581 function provision_guess()
583 var subobj = new Object();
584 var nss = nss_init();
585 var lp = loadparm_init();
589 subobj.REALM = strupper(lp.get("realm"));
590 subobj.DOMAIN = lp.get("workgroup");
591 subobj.HOSTNAME = hostname();
593 assert(subobj.REALM);
594 assert(subobj.DOMAIN);
595 assert(subobj.HOSTNAME);
597 subobj.VERSION = version();
598 subobj.HOSTIP = hostip();
599 subobj.DOMAINSID = randsid();
600 subobj.INVOCATIONID = randguid();
601 subobj.KRBTGTPASS = randpass(12);
602 subobj.MACHINEPASS = randpass(12);
603 subobj.ADMINPASS = randpass(12);
604 subobj.DEFAULTSITE = "Default-First-Site-Name";
605 subobj.NEWGUID = randguid;
606 subobj.NTTIME = nttime;
607 subobj.LDAPTIME = ldaptime;
608 subobj.DATESTRING = datestring;
609 subobj.ROOT = findnss(nss.getpwnam, "root");
610 subobj.NOBODY = findnss(nss.getpwnam, "nobody");
611 subobj.NOGROUP = findnss(nss.getgrnam, "nogroup", "nobody");
612 subobj.WHEEL = findnss(nss.getgrnam, "wheel", "root", "staff", "adm");
613 subobj.BACKUP = findnss(nss.getgrnam, "backup", "wheel", "root", "staff");
614 subobj.USERS = findnss(nss.getgrnam, "users", "guest", "other", "unknown");
615 subobj.DNSDOMAIN = strlower(subobj.REALM);
616 subobj.DNSNAME = sprintf("%s.%s",
617 strlower(subobj.HOSTNAME),
619 rdn_list = split(".", subobj.DNSDOMAIN);
620 subobj.BASEDN = "DC=" + join(",DC=", rdn_list);
621 subobj.LDAPBACKEND = "users.ldb";
626 search for one attribute as a string
628 function searchone(ldb, basedn, expression, attribute)
630 var attrs = new Array(attribute);
631 res = ldb.search(expression, basedn, ldb.SCOPE_SUBTREE, attrs);
632 if (res.length != 1 ||
633 res[0][attribute] == undefined) {
636 return res[0][attribute];
640 modify an account to remove the
642 function enable_account(ldb, user_dn)
644 var attrs = new Array("userAccountControl");
645 var res = ldb.search(NULL, user_dn, ldb.SCOPE_ONELEVEL, attrs);
646 assert(res.length == 1);
647 var userAccountControl = res[0].userAccountControl;
648 userAccountControl = userAccountControl - 2; /* remove disabled bit */
652 replace: userAccountControl
653 userAccountControl: %u
655 user_dn, userAccountControl);
656 var ok = ldb.modify(mod);
662 add a new user record
664 function newuser(username, unixname, password, message, session_info, credentials)
666 var lp = loadparm_init();
667 var samdb = lp.get("sam database");
668 var ldb = ldb_init();
670 ldb.session_info = session_info;
671 ldb.credentials = credentials;
673 /* connect to the sam */
674 var ok = ldb.connect(samdb);
677 ldb.transaction_start();
679 /* find the DNs for the domain and the domain users group */
680 var attrs = new Array("defaultNamingContext");
681 res = ldb.search("defaultNamingContext=*", "", ldb.SCOPE_BASE, attrs);
682 assert(res.length == 1 && res[0].defaultNamingContext != undefined);
683 var domain_dn = res[0].defaultNamingContext;
684 assert(domain_dn != undefined);
685 var dom_users = searchone(ldb, domain_dn, "name=Domain Users", "dn");
686 assert(dom_users != undefined);
688 var user_dn = sprintf("CN=%s,CN=Users,%s", username, domain_dn);
692 the new user record. note the reliance on the samdb module to fill
703 user_dn, username, dom_users,
706 add the user to the users group as well
708 var modgroup = sprintf("
720 message("Adding user %s\n", user_dn);
723 message("Failed to add %s - %s\n", user_dn, ldb.errstring());
727 message("Modifying group %s\n", dom_users);
728 ok = ldb.modify(modgroup);
730 message("Failed to modify %s - %s\n", dom_users, ldb.errstring());
735 modify the userAccountControl to remove the disabled bit
737 ok = enable_account(ldb, user_dn);
739 ldb.transaction_commit();
744 // Check whether a name is valid as a NetBIOS name.
745 // FIXME: There are probably more constraints here.
746 // crh has a paragraph on this in his book (1.4.1.1)
747 function valid_netbios_name(name)
749 if (strlen(name) > 13) return false;
753 function provision_validate(subobj, message)
755 var lp = loadparm_init();
757 if (!valid_netbios_name(subobj.DOMAIN)) {
758 message("Invalid NetBIOS name for domain\n");
762 if (!valid_netbios_name(subobj.NETBIOSNAME)) {
763 message("Invalid NetBIOS name for host\n");
768 if (strupper(lp.get("workgroup")) != strupper(subobj.DOMAIN)) {
769 message("workgroup '%s' in smb.conf must match chosen domain '%s'\n",
770 lp.get("workgroup"), subobj.DOMAIN);
774 if (strupper(lp.get("realm")) != strupper(subobj.REALM)) {
775 message("realm '%s' in smb.conf must match chosen realm '%s'\n",
776 lp.get("realm"), subobj.REALM);
783 function join_domain(domain, netbios_name, join_type, creds, message)
785 var ctx = NetContext(creds);
786 var joindom = new Object();
787 joindom.domain = domain;
788 joindom.join_type = join_type;
789 joindom.netbios_name = netbios_name;
790 if (!ctx.JoinDomain(joindom)) {
791 message("Domain Join failed: " + joindom.error_string);
797 /* Vampire a remote domain. Session info and credentials are required for for
798 * access to our local database (might be remote ldap)
801 function vampire(domain, session_info, credentials, message) {
802 var ctx = NetContext(credentials);
803 var vampire_ctx = new Object();
804 var machine_creds = credentials_init();
805 machine_creds.set_domain(form.DOMAIN);
806 if (!machine_creds.set_machine_account()) {
807 message("Failed to access domain join information!");
810 vampire_ctx.machine_creds = machine_creds;
811 vampire_ctx.session_info = session_info;
812 if (!ctx.SamSyncLdb(vampire_ctx)) {
813 message("Migration of remote domain to Samba failed: " + vampire_ctx.error_string);