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");
169 var res = ldb.search("(&(|(objectclass=*)(dn=*))(!(dn=@BASEINFO)))", attrs);
171 if (typeof(res) == "undefined") {
175 for (i=0;i<res.length;i++) {
178 /* extra hack to ensure it's gone on remote ldap */
179 ldb.del("cn=ROOTDSE");
181 var res = ldb.search("(&(|(objectclass=*)(dn=*))(!(dn=@BASEINFO)))", attrs);
182 if (res.length != 0) {
186 assert(res.length == 0);
190 erase an ldb, removing all records
192 function ldb_erase_partitions(info, dbname)
194 var rootDSE_attrs = new Array("namingContexts");
195 var ldb = ldb_init();
196 var lp = loadparm_init();
199 ldb.session_info = info.session_info;
200 ldb.credentials = info.credentials;
203 ldb.filename = dbname;
205 var connect_ok = ldb.connect(dbname);
208 ldb.transaction_start();
210 var res = ldb.search("(objectClass=*)", "", ldb.SCOPE_BASE, rootDSE_attrs);
211 assert(typeof(res) != "undefined");
212 assert(res.length == 1);
213 for (j=0; j<res[0].namingContexts.length; j++) {
214 var attrs = new Array("dn");
215 var basedn = res[0].namingContexts[j];
217 var previous_remaining = 1;
218 var current_remaining = 0;
220 for (k=0; k < 10 && (previous_remaining != current_remaining); k++) {
222 var res2 = ldb.search("(|(objectclass=*)(dn=*))", basedn, ldb.SCOPE_SUBTREE, attrs);
224 if (typeof(res2) == "undefined") {
225 info.message("ldb search failed: " + ldb.errstring() + "\n");
228 previous_remaining = current_remaining;
229 current_remaining = res2.length;
230 for (i=0;i<res2.length;i++) {
234 var res3 = ldb.search("(|(objectclass=*)(dn=*))", basedn, ldb.SCOPE_SUBTREE, attrs);
235 if (res3.length != 0) {
236 info.message("Failed to delete all records under " + basedn + ", " + res3.length + " records remaining\n");
241 var commit_ok = ldb.transaction_commit();
243 info.message("ldb commit failed: " + ldb.errstring() + "\n");
249 setup a ldb in the private dir
251 function setup_ldb(ldif, info, dbname)
256 var ldb = ldb_init();
257 var lp = loadparm_init();
258 ldb.session_info = info.session_info;
259 ldb.credentials = info.credentials;
261 if (arguments.length >= 4) {
262 extra = arguments[3];
265 if (arguments.length >= 5) {
266 erase = arguments[4];
269 if (arguments.length == 6) {
270 failok = arguments[5];
273 var src = lp.get("setup directory") + "/" + ldif;
275 var data = sys.file_load(src);
277 data = substitute_var(data, info.subobj);
279 ldb.filename = dbname;
281 var connect_ok = ldb.connect(dbname);
283 sys.unlink(sprintf("%s/%s", lp.get("private dir"), dbname));
284 connect_ok = ldb.connect(dbname);
288 ldb.transaction_start();
294 var add_ok = ldb.add(data);
296 info.message("ldb load failed: " + ldb.errstring() + "\n");
302 var commit_ok = ldb.transaction_commit();
304 info.message("ldb commit failed: " + ldb.errstring() + "\n");
311 setup a ldb in the private dir
313 function setup_ldb_modify(ldif, info, dbname)
315 var ldb = ldb_init();
316 var lp = loadparm_init();
317 ldb.session_info = info.session_info;
318 ldb.credentials = info.credentials;
320 var src = lp.get("setup directory") + "/" + ldif;
322 var data = sys.file_load(src);
323 data = substitute_var(data, info.subobj);
325 ldb.filename = dbname;
327 var connect_ok = ldb.connect(dbname);
330 ldb.transaction_start();
332 var mod_ok = ldb.modify(data);
334 info.message("ldb load failed: " + ldb.errstring() + "\n");
337 var commit_ok = ldb.transaction_commit();
339 info.message("ldb commit failed: " + ldb.errstring() + "\n");
345 setup a file in the private dir
347 function setup_file(template, message, fname, subobj)
349 var lp = loadparm_init();
351 var src = lp.get("setup directory") + "/" + template;
355 var data = sys.file_load(src);
356 data = substitute_var(data, subobj);
358 ok = sys.file_save(f, data);
360 message("failed to create file: " + f + "\n");
365 function provision_default_paths(subobj)
367 var lp = loadparm_init();
368 var paths = new Object();
369 paths.smbconf = lp.get("config file");
370 paths.shareconf = lp.get("private dir") + "/" + "share.ldb";
371 paths.hklm = "hklm.ldb";
372 paths.hkcu = "hkcu.ldb";
373 paths.hkcr = "hkcr.ldb";
374 paths.hku = "hku.ldb";
375 paths.hkpd = "hkpd.ldb";
376 paths.hkpt = "hkpt.ldb";
377 paths.samdb = lp.get("sam database");
378 paths.secrets = "secrets.ldb";
379 paths.dns = lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".zone";
380 paths.winsdb = "wins.ldb";
381 paths.ldap_basedn_ldif = lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".ldif";
387 setup reasonable name mappings for sam names to unix names
389 function setup_name_mappings(info, subobj, session_info, credentials)
391 var lp = loadparm_init();
392 var ldb = ldb_init();
393 ldb.session_info = session_info;
394 ldb.credentials = credentials;
395 var ok = ldb.connect(lp.get("sam database"));
399 var attrs = new Array("objectSid");
400 res = ldb.search("objectSid=*", subobj.BASEDN, ldb.SCOPE_BASE, attrs);
401 assert(res.length == 1 && res[0].objectSid != undefined);
402 var sid = res[0].objectSid;
404 /* add some foreign sids if they are not present already */
405 add_foreign(ldb, subobj, "S-1-5-7", "Anonymous");
406 add_foreign(ldb, subobj, "S-1-1-0", "World");
407 add_foreign(ldb, subobj, "S-1-5-2", "Network");
408 add_foreign(ldb, subobj, "S-1-5-18", "System");
409 add_foreign(ldb, subobj, "S-1-5-11", "Authenticated Users");
411 /* some well known sids */
412 setup_name_mapping(info, ldb, "S-1-5-7", subobj.NOBODY);
413 setup_name_mapping(info, ldb, "S-1-1-0", subobj.NOGROUP);
414 setup_name_mapping(info, ldb, "S-1-5-2", subobj.NOGROUP);
415 setup_name_mapping(info, ldb, "S-1-5-18", subobj.ROOT);
416 setup_name_mapping(info, ldb, "S-1-5-11", subobj.USERS);
417 setup_name_mapping(info, ldb, "S-1-5-32-544", subobj.WHEEL);
418 setup_name_mapping(info, ldb, "S-1-5-32-545", subobj.USERS);
419 setup_name_mapping(info, ldb, "S-1-5-32-546", subobj.NOGROUP);
420 setup_name_mapping(info, ldb, "S-1-5-32-551", subobj.BACKUP);
422 /* and some well known domain rids */
423 setup_name_mapping(info, ldb, sid + "-500", subobj.ROOT);
424 setup_name_mapping(info, ldb, sid + "-518", subobj.WHEEL);
425 setup_name_mapping(info, ldb, sid + "-519", subobj.WHEEL);
426 setup_name_mapping(info, ldb, sid + "-512", subobj.WHEEL);
427 setup_name_mapping(info, ldb, sid + "-513", subobj.USERS);
428 setup_name_mapping(info, ldb, sid + "-520", subobj.WHEEL);
435 provision samba4 - caution, this wipes all existing data!
437 function provision(subobj, message, blank, paths, session_info, credentials)
440 var lp = loadparm_init();
441 var sys = sys_init();
442 var info = new Object();
445 some options need to be upper/lower case
447 subobj.REALM = strupper(subobj.REALM);
448 subobj.HOSTNAME = strlower(subobj.HOSTNAME);
449 subobj.DOMAIN = strupper(subobj.DOMAIN);
450 assert(valid_netbios_name(subobj.DOMAIN));
451 subobj.NETBIOSNAME = strupper(subobj.HOSTNAME);
452 assert(valid_netbios_name(subobj.NETBIOSNAME));
453 var rdns = split(",", subobj.BASEDN);
454 subobj.RDN_DC = substr(rdns[0], strlen("DC="));
456 info.subobj = subobj;
457 info.message = message;
458 info.credentials = credentials;
459 info.session_info = session_info;
461 /* only install a new smb.conf if there isn't one there already */
462 var st = sys.stat(paths.smbconf);
463 if (st == undefined) {
464 message("Setting up smb.conf\n");
465 setup_file("provision.smb.conf", info.message, paths.smbconf, subobj);
468 /* only install a new shares config db if there is none */
469 st = sys.stat(paths.shareconf);
470 if (st == undefined) {
471 message("Setting up sconf.ldb\n");
472 setup_ldb("share.ldif", info, paths.shareconf);
474 message("Setting up secrets.ldb\n");
475 setup_ldb("secrets.ldif", info, paths.secrets);
476 message("Setting up keytabs\n");
477 var keytab_ok = credentials_update_all_keytabs();
479 message("Setting up hklm.ldb\n");
480 setup_ldb("hklm.ldif", info, paths.hklm);
482 message("Setting up sam.ldb attributes\n");
483 setup_ldb("provision_init.ldif", info, paths.samdb);
484 message("Erasing data from partitions\n");
485 ldb_erase_partitions(info, paths.samdb);
487 message("Adding baseDN: " + subobj.BASEDN + "\n");
488 setup_ldb("provision_basedn.ldif", info, paths.samdb, NULL, false, true);
489 message("Modifying baseDN: " + subobj.BASEDN + "\n");
490 setup_ldb_modify("provision_basedn_modify.ldif", info, paths.samdb)
492 message("Setting up sam.ldb schema\n");
493 setup_ldb("schema.ldif", info, paths.samdb, NULL, false);
494 message("Setting up display specifiers\n");
495 setup_ldb("display_specifiers.ldif", info, paths.samdb, NULL, false);
496 message("Setting up sam.ldb templates\n");
497 setup_ldb("provision_templates.ldif", info, paths.samdb, NULL, false);
498 message("Setting up sam.ldb data\n");
499 setup_ldb("provision.ldif", info, paths.samdb, NULL, false);
501 if (blank != false) {
505 message("Setting up sam.ldb users and groups\n");
506 setup_ldb("provision_users.ldif", info, paths.samdb, data, false);
508 if (setup_name_mappings(info, subobj, session_info, credentials) == false) {
515 /* Write out a DNS zone file, from the info in the current database */
516 function provision_dns(subobj, message, paths, session_info, credentials)
518 message("Setting up DNS zone: " + subobj.DNSDOMAIN + " \n");
519 var ldb = ldb_init();
520 ldb.session_info = session_info;
521 ldb.credentials = credentials;
523 /* connect to the sam */
524 var ok = ldb.connect(paths.samdb);
527 /* These values may have changed, due to an incoming SamSync, so fetch them from the database */
528 var attrs = new Array("objectGUID");
529 res = ldb.search("objectGUID=*", subobj.BASEDN, ldb.SCOPE_BASE, attrs);
530 assert(res.length == 1 && res[0].objectGUID != undefined)
531 subobj.DOMAINGUID = res[0].objectGUID;
533 subobj.HOSTGUID = searchone(ldb, subobj.BASEDN, "(&(objectClass=computer)(cn=" + subobj.NETBIOSNAME + "))", "objectGUID");
534 assert(subobj.HOSTGUID != undefined);
536 setup_file("provision.zone",
540 message("Please install the zone located in " + paths.dns + " into your DNS server\n");
543 /* Write out a DNS zone file, from the info in the current database */
544 function provision_ldapbase(subobj, message, paths)
546 message("Setting up LDAP base entry: " + subobj.BASEDN + " \n");
547 var rdns = split(",", subobj.BASEDN);
548 subobj.RDN_DC = substr(rdns[0], strlen("DC="));
550 setup_file("provision_basedn.ldif",
551 message, paths.ldap_basedn_ldif,
554 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");
559 guess reasonably default options for provisioning
561 function provision_guess()
563 var subobj = new Object();
564 var nss = nss_init();
565 var lp = loadparm_init();
569 subobj.REALM = strupper(lp.get("realm"));
570 subobj.DOMAIN = lp.get("workgroup");
571 subobj.HOSTNAME = hostname();
573 assert(subobj.REALM);
574 assert(subobj.DOMAIN);
575 assert(subobj.HOSTNAME);
577 subobj.VERSION = version();
578 subobj.HOSTIP = hostip();
579 subobj.DOMAINGUID = randguid();
580 subobj.DOMAINSID = randsid();
581 subobj.HOSTGUID = randguid();
582 subobj.INVOCATIONID = randguid();
583 subobj.KRBTGTPASS = randpass(12);
584 subobj.MACHINEPASS = randpass(12);
585 subobj.ADMINPASS = randpass(12);
586 subobj.DEFAULTSITE = "Default-First-Site-Name";
587 subobj.NEWGUID = randguid;
588 subobj.NTTIME = nttime;
589 subobj.LDAPTIME = ldaptime;
590 subobj.DATESTRING = datestring;
591 subobj.ROOT = findnss(nss.getpwnam, "root");
592 subobj.NOBODY = findnss(nss.getpwnam, "nobody");
593 subobj.NOGROUP = findnss(nss.getgrnam, "nogroup", "nobody");
594 subobj.WHEEL = findnss(nss.getgrnam, "wheel", "root", "staff");
595 subobj.BACKUP = findnss(nss.getgrnam, "backup", "wheel", "root", "staff");
596 subobj.USERS = findnss(nss.getgrnam, "users", "guest", "other", "unknown");
597 subobj.DNSDOMAIN = strlower(subobj.REALM);
598 subobj.DNSNAME = sprintf("%s.%s",
599 strlower(subobj.HOSTNAME),
601 rdn_list = split(".", subobj.DNSDOMAIN);
602 subobj.BASEDN = "DC=" + join(",DC=", rdn_list);
603 subobj.LDAPBACKEND = "users.ldb";
608 search for one attribute as a string
610 function searchone(ldb, basedn, expression, attribute)
612 var attrs = new Array(attribute);
613 res = ldb.search(expression, basedn, ldb.SCOPE_SUBTREE, attrs);
614 if (res.length != 1 ||
615 res[0][attribute] == undefined) {
618 return res[0][attribute];
622 modify an account to remove the
624 function enable_account(ldb, user_dn)
626 var attrs = new Array("userAccountControl");
627 var res = ldb.search(NULL, user_dn, ldb.SCOPE_ONELEVEL, attrs);
628 assert(res.length == 1);
629 var userAccountControl = res[0].userAccountControl;
630 userAccountControl = userAccountControl - 2; /* remove disabled bit */
634 replace: userAccountControl
635 userAccountControl: %u
637 user_dn, userAccountControl);
638 var ok = ldb.modify(mod);
644 add a new user record
646 function newuser(username, unixname, password, message, session_info, credentials)
648 var lp = loadparm_init();
649 var samdb = lp.get("sam database");
650 var ldb = ldb_init();
652 ldb.session_info = session_info;
653 ldb.credentials = credentials;
655 /* connect to the sam */
656 var ok = ldb.connect(samdb);
659 ldb.transaction_start();
661 /* find the DNs for the domain and the domain users group */
662 var attrs = new Array("defaultNamingContext");
663 res = ldb.search("defaultNamingContext=*", "", ldb.SCOPE_BASE, attrs);
664 assert(res.length == 1 && res[0].defaultNamingContext != undefined);
665 var domain_dn = res[0].defaultNamingContext;
666 assert(domain_dn != undefined);
667 var dom_users = searchone(ldb, domain_dn, "name=Domain Users", "dn");
668 assert(dom_users != undefined);
670 var user_dn = sprintf("CN=%s,CN=Users,%s", username, domain_dn);
674 the new user record. note the reliance on the samdb module to fill
685 user_dn, username, dom_users,
688 add the user to the users group as well
690 var modgroup = sprintf("
702 message("Adding user %s\n", user_dn);
705 message("Failed to add %s - %s\n", user_dn, ldb.errstring());
709 message("Modifying group %s\n", dom_users);
710 ok = ldb.modify(modgroup);
712 message("Failed to modify %s - %s\n", dom_users, ldb.errstring());
717 modify the userAccountControl to remove the disabled bit
719 ok = enable_account(ldb, user_dn);
721 ldb.transaction_commit();
726 // Check whether a name is valid as a NetBIOS name.
727 // FIXME: There are probably more constraints here.
728 // crh has a paragraph on this in his book (1.4.1.1)
729 function valid_netbios_name(name)
731 if (strlen(name) > 13) return false;
735 function provision_validate(subobj, message)
737 var lp = loadparm_init();
739 if (!valid_netbios_name(subobj.DOMAIN)) {
740 message("Invalid NetBIOS name for domain\n");
744 if (!valid_netbios_name(subobj.NETBIOSNAME)) {
745 message("Invalid NetBIOS name for host\n");
750 if (strupper(lp.get("workgroup")) != strupper(subobj.DOMAIN)) {
751 message("workgroup '%s' in smb.conf must match chosen domain '%s'\n",
752 lp.get("workgroup"), subobj.DOMAIN);
756 if (strupper(lp.get("realm")) != strupper(subobj.REALM)) {
757 message("realm '%s' in smb.conf must match chosen realm '%s'\n",
758 lp.get("realm"), subobj.REALM);
765 function join_domain(domain, netbios_name, join_type, creds, message)
767 var ctx = NetContext(creds);
768 var joindom = new Object();
769 joindom.domain = domain;
770 joindom.join_type = join_type;
771 joindom.netbios_name = netbios_name;
772 if (!ctx.JoinDomain(joindom)) {
773 message("Domain Join failed: " + joindom.error_string);
779 /* Vampire a remote domain. Session info and credentials are required for for
780 * access to our local database (might be remote ldap)
783 function vampire(domain, session_info, credentials, message) {
784 var ctx = NetContext(credentials);
785 var vampire_ctx = new Object();
786 var machine_creds = credentials_init();
787 machine_creds.set_domain(form.DOMAIN);
788 if (!machine_creds.set_machine_account()) {
789 message("Failed to access domain join information!");
792 vampire_ctx.machine_creds = machine_creds;
793 vampire_ctx.session_info = session_info;
794 if (!ctx.SamSyncLdb(vampire_ctx)) {
795 message("Migration of remote domain to Samba failed: " + vampire_ctx.error_string);