r23177: Add in a new provision-backend script. This helps set up the OpenLDAP or...
[Samba.git] / source / scripting / libjs / provision.js
blobd25c0f38ebd269a41e3c4606aeccf9458c596323
1 /*
2         backend code for provisioning a Samba4 server
3         Copyright Andrew Tridgell 2005
4         Released under the GNU GPL v2 or later
5 */
7 sys = sys_init();
9 /*
10   return true if the current install seems to be OK
12 function install_ok(session_info, credentials)
14         var lp = loadparm_init();
15         var ldb = ldb_init();
16         ldb.session_info = session_info;
17         ldb.credentials = credentials;
18         if (lp.get("realm") == "") {
19                 return false;
20         }
21         var ok = ldb.connect(lp.get("sam database"));
22         if (!ok) {
23                 return false;
24         }
25         var res = ldb.search("(cn=Administrator)");
26         if (res.error != 0 || res.msgs.length != 1) {
27                 return false;
28         }
29         return true;
33   find a user or group from a list of possibilities
35 function findnss()
37         var i;
38         assert(arguments.length >= 2);
39         var nssfn = arguments[0];
40         for (i=1;i<arguments.length;i++) {
41                 if (nssfn(arguments[i]) != undefined) {
42                         return arguments[i];
43                 }
44         }
45         printf("Unable to find user/group for %s\n", arguments[1]);
46         assert(i<arguments.length);
50    add a foreign security principle
51  */
52 function add_foreign(ldb, subobj, sid, desc)
54         var add = sprintf("
55 dn: CN=%s,CN=ForeignSecurityPrincipals,%s
56 objectClass: top
57 objectClass: foreignSecurityPrincipal
58 description: %s
60                           sid, subobj.DOMAINDN, desc);
61         /* deliberately ignore errors from this, as the records may
62            already exist */
63         ldb.add(add);
68   setup a mapping between a sam name and a unix name
69  */
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);
77                 return false;
78         }
79         var mod = sprintf("
80 dn: %s
81 changetype: modify
82 replace: unixName
83 unixName: %s
85                           res.msgs[0].dn, unixname);
86         var ok = ldb.modify(mod);
87         if (ok.error != 0) {
88                 info.message("name mapping for %s failed - %s\n",
89                              sid, ldb.errstring());
90                 return false;
91         }
92         return true;
96   return current time as a nt time string
98 function nttime()
100         return "" + sys.nttime();
104   return current time as a ldap time string
106 function ldaptime()
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);
122   return first host IP
124 function hostip()
126         var list = sys.interfaces();
127         return list[0];
132   return first part of hostname
134 function hostname()
136         var s = split(".", sys.hostname());
137         return s[0];
140 /* the ldb is in bad shape, possibly due to being built from an
141    incompatible previous version of the code, so delete it
142    completely */
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();
149         ldb.close();
150         var ok = ldb.connect(ldb.filename);
151         ldb.transaction_start();
152         assert(ok);
156   erase an ldb, removing all records
158 function ldb_erase(info, ldb)
160         var res;
162         /* delete the specials */
163         ldb.del("@INDEXLIST");
164         ldb.del("@ATTRIBUTES");
165         ldb.del("@SUBCLASSES");
166         ldb.del("@MODULES");
167         ldb.del("@PARTITION");
168         ldb.del("@KLUDGEACL");
170         /* and the rest */
171         attrs = new Array("dn");
172         var basedn = "";
173         var res = ldb.search("(&(|(objectclass=*)(dn=*))(!(dn=@BASEINFO)))", basedn, ldb.SCOPE_SUBTREE, attrs);
174         var i;
175         if (res.error != 0) {
176                 ldb_delete(info, ldb);
177                 return;
178         }
179         for (i=0;i<res.msgs.length;i++) {
180                 ldb.del(res.msgs[i].dn);
181         }
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);
186                 return;
187         }
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();
198         var j;
200         var res = ldb.search("(objectClass=*)", "", ldb.SCOPE_BASE, rootDSE_attrs);
201         assert(res.error == 0);
202         assert(res.msgs.length == 1);
203         if (typeof(res.msgs[0].namingContexts) == "undefined") {
204                 return;
205         }       
206         for (j=0; j<res.msgs[0].namingContexts.length; j++) {
207                 var anything = "(|(objectclass=*)(dn=*))";
208                 var attrs = new Array("dn");
209                 var basedn = res.msgs[0].namingContexts[j];
210                 var k;
211                 var previous_remaining = 1;
212                 var current_remaining = 0;
214                 if (ldapbackend && (basedn == info.subobj.DOMAINDN)) {
215                         /* Only delete objects that were created by provision */
216                         anything = "(objectcategory=*)";
217                 }
219                 for (k=0; k < 10 && (previous_remaining != current_remaining); k++) {
220                         /* and the rest */
221                         var res2 = ldb.search(anything, basedn, ldb.SCOPE_SUBTREE, attrs);
222                         var i;
223                         if (res2.error != 0) {
224                                 info.message("ldb search failed: " + res.errstr + "\n");
225                                 continue;
226                         }
227                         previous_remaining = current_remaining;
228                         current_remaining = res2.msgs.length;
229                         for (i=0;i<res2.msgs.length;i++) {
230                                 ldb.del(res2.msgs[i].dn);
231                         }
232                         
233                         var res3 = ldb.search(anything, basedn, ldb.SCOPE_SUBTREE, attrs);
234                         if (res3.error != 0) {
235                                 info.message("ldb search failed: " + res.errstr + "\n");
236                                 continue;
237                         }
238                         if (res3.msgs.length != 0) {
239                                 info.message("Failed to delete all records under " + basedn + ", " + res3.msgs.length + " records remaining\n");
240                         }
241                 }
242         }
245 function open_ldb(info, dbname, erase)
247         var ldb = ldb_init();
248         ldb.session_info = info.session_info;
249         ldb.credentials = info.credentials;
250         ldb.filename = dbname;
252         var connect_ok = ldb.connect(dbname);
253         if (!connect_ok) {
254                 var lp = loadparm_init();
255                 sys.unlink(sprintf("%s/%s", lp.get("private dir"), dbname));
256                 connect_ok = ldb.connect(dbname);
257                 assert(connect_ok);
258         }
260         ldb.transaction_start();
262         if (erase) {
263                 ldb_erase(info, ldb);   
264         }
265         return ldb;
270   setup a ldb in the private dir
271  */
272 function setup_add_ldif(ldif, info, ldb, failok)
274         var lp = loadparm_init();
275         var src = lp.get("setup directory") + "/" + ldif;
277         var data = sys.file_load(src);
278         data = substitute_var(data, info.subobj);
280         var add_res = ldb.add(data);
281         if (add_res.error != 0) {
282                 info.message("ldb load failed: " + add_res.errstr + "\n");
283                 if (!failok) {
284                         assert(add_res.error == 0);
285                 }
286         }
287         return (add_res.error == 0);
290 function setup_modify_ldif(ldif, info, ldb, failok)
292         var lp = loadparm_init();
293         var src = lp.get("setup directory") + "/" + ldif;
295         var data = sys.file_load(src);
296         data = substitute_var(data, info.subobj);
298         var mod_res = ldb.modify(data);
299         if (mod_res.error != 0) {
300                 info.message("ldb load failed: " + mod_res.errstr + "\n");
301                 if (!failok) {
302                         assert(mod_res.error == 0);
303                 }
304         }
305         return (mod_res.error == 0);
309 function setup_ldb(ldif, info, dbname) 
311         var erase = true;
312         var failok = false;
314         if (arguments.length >= 4) {
315                 erase = arguments[3];
316         }
317         if (arguments.length == 5) {
318                 failok = arguments[4];
319         }
320         var ldb = open_ldb(info, dbname, erase);
321         if (setup_add_ldif(ldif, info, ldb, failok)) {
322                 var commit_ok = ldb.transaction_commit();
323                 if (!commit_ok) {
324                         info.message("ldb commit failed: " + ldb.errstring() + "\n");
325                         assert(commit_ok);
326                 }
327         }
331   setup a ldb in the private dir
332  */
333 function setup_ldb_modify(ldif, info, ldb)
335         var lp = loadparm_init();
337         var src = lp.get("setup directory") + "/" + ldif;
339         var data = sys.file_load(src);
340         data = substitute_var(data, info.subobj);
342         var mod_res = ldb.modify(data);
343         if (mod_res.error != 0) {
344                 info.message("ldb load failed: " + mod_res.errstr + "\n");
345                 return (mod_res.error == 0);
346         }
347         return (mod_res.error == 0);
351   setup a file in the private dir
352  */
353 function setup_file(template, message, fname, subobj)
355         var lp = loadparm_init();
356         var f = fname;
357         var src = lp.get("setup directory") + "/" + template;
359         sys.unlink(f);
361         var data = sys.file_load(src);
362         data = substitute_var(data, subobj);
364         ok = sys.file_save(f, data);
365         if (!ok) {
366                 message("failed to create file: " + f + "\n");
367                 assert(ok);
368         }
371 function provision_default_paths(subobj)
373         var lp = loadparm_init();
374         var paths = new Object();
375         paths.smbconf = lp.get("config file");
376         paths.shareconf = lp.get("private dir") + "/" + "share.ldb";
377         paths.hklm = "hklm.ldb";
378         paths.hkcu = "hkcu.ldb";
379         paths.hkcr = "hkcr.ldb";
380         paths.hku = "hku.ldb";
381         paths.hkpd = "hkpd.ldb";
382         paths.hkpt = "hkpt.ldb";
383         paths.samdb = lp.get("sam database");
384         paths.secrets = lp.get("secrets database");
385         paths.keytab = "secrets.keytab";
386         paths.dns = lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".zone";
387         paths.winsdb = "wins.ldb";
388         paths.ldap_basedn_ldif = lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".ldif";
389         paths.ldap_config_basedn_ldif = lp.get("private dir") + "/" + subobj.DNSDOMAIN + "-config.ldif";
390         paths.ldap_schema_basedn_ldif = lp.get("private dir") + "/" + subobj.DNSDOMAIN + "-schema.ldif";
391         paths.ldapdir = lp.get("private dir") + "/ldap";
392         return paths;
397   setup reasonable name mappings for sam names to unix names
399 function setup_name_mappings(info, ldb)
401         var lp = loadparm_init();
402         var attrs = new Array("objectSid");
403         var subobj = info.subobj;
405         res = ldb.search("objectSid=*", subobj.DOMAINDN, ldb.SCOPE_BASE, attrs);
406         assert(res.error == 0);
407         assert(res.msgs.length == 1 && res.msgs[0].objectSid != undefined);
408         var sid = res.msgs[0].objectSid;
410         /* add some foreign sids if they are not present already */
411         add_foreign(ldb, subobj, "S-1-5-7",  "Anonymous");
412         add_foreign(ldb, subobj, "S-1-1-0",  "World");
413         add_foreign(ldb, subobj, "S-1-5-2",  "Network");
414         add_foreign(ldb, subobj, "S-1-5-18", "System");
415         add_foreign(ldb, subobj, "S-1-5-11", "Authenticated Users");
417         /* some well known sids */
418         setup_name_mapping(info, ldb, "S-1-5-7",  subobj.NOBODY);
419         setup_name_mapping(info, ldb, "S-1-1-0",  subobj.NOGROUP);
420         setup_name_mapping(info, ldb, "S-1-5-2",  subobj.NOGROUP);
421         setup_name_mapping(info, ldb, "S-1-5-18", subobj.ROOT);
422         setup_name_mapping(info, ldb, "S-1-5-11", subobj.USERS);
423         setup_name_mapping(info, ldb, "S-1-5-32-544", subobj.WHEEL);
424         setup_name_mapping(info, ldb, "S-1-5-32-545", subobj.USERS);
425         setup_name_mapping(info, ldb, "S-1-5-32-546", subobj.NOGROUP);
426         setup_name_mapping(info, ldb, "S-1-5-32-551", subobj.BACKUP);
428         /* and some well known domain rids */
429         setup_name_mapping(info, ldb, sid + "-500", subobj.ROOT);
430         setup_name_mapping(info, ldb, sid + "-518", subobj.WHEEL);
431         setup_name_mapping(info, ldb, sid + "-519", subobj.WHEEL);
432         setup_name_mapping(info, ldb, sid + "-512", subobj.WHEEL);
433         setup_name_mapping(info, ldb, sid + "-513", subobj.USERS);
434         setup_name_mapping(info, ldb, sid + "-520", subobj.WHEEL);
436         return true;
439 function provision_fix_subobj(subobj, message, paths)
441         subobj.REALM       = strupper(subobj.REALM);
442         subobj.HOSTNAME    = strlower(subobj.HOSTNAME);
443         subobj.DOMAIN      = strupper(subobj.DOMAIN);
444         assert(valid_netbios_name(subobj.DOMAIN));
445         subobj.NETBIOSNAME = strupper(subobj.HOSTNAME);
446         assert(valid_netbios_name(subobj.NETBIOSNAME));
447         var rdns = split(",", subobj.DOMAINDN);
448         subobj.RDN_DC = substr(rdns[0], strlen("DC="));
450         subobj.SAM_LDB          = "tdb://" + paths.samdb;
451         subobj.SECRETS_KEYTAB   = paths.keytab;
453         subobj.LDAPDIR = paths.ldapdir;
455         return true;
458 function provision_become_dc(subobj, message, erase, paths, session_info)
460         var lp = loadparm_init();
461         var sys = sys_init();
462         var info = new Object();
464         var ok = provision_fix_subobj(subobj, message, paths);
465         assert(ok);
467         info.subobj = subobj;
468         info.message = message;
469         info.session_info = session_info;
471         /* Also wipes the database */
472         message("Setting up " + paths.samdb + " partitions\n");
473         setup_ldb("provision_partitions.ldif", info, paths.samdb);
475         var samdb = open_ldb(info, paths.samdb, false);
477         message("Setting up " + paths.samdb + " attributes\n");
478         setup_add_ldif("provision_init.ldif", info, samdb, false);
480         message("Setting up " + paths.samdb + " rootDSE\n");
481         setup_add_ldif("provision_rootdse_add.ldif", info, samdb, false);
483         if (erase) {
484                 message("Erasing data from partitions\n");
485                 ldb_erase_partitions(info, samdb, undefined);
486         }
488         message("Setting up " + paths.samdb + " indexes\n");
489         setup_add_ldif("provision_index.ldif", info, samdb, false);
491         message("Setting up " + paths.samdb + " templates\n");
492         setup_add_ldif("provision_templates.ldif", info, samdb, false);
494         ok = samdb.transaction_commit();
495         assert(ok);
497         message("Setting up " + paths.secrets + "\n");
498         setup_ldb("secrets_init.ldif", info, paths.secrets);
500         setup_ldb("secrets.ldif", info, paths.secrets, false);
502         return true;
506   provision samba4 - caution, this wipes all existing data!
508 function provision(subobj, message, blank, paths, session_info, credentials, ldapbackend)
510         var lp = loadparm_init();
511         var sys = sys_init();
512         var info = new Object();
514         var ok = provision_fix_subobj(subobj, message, paths);
515         assert(ok);
517         if (subobj.DOMAINGUID != undefined) {
518                 subobj.DOMAINGUID_MOD = sprintf("replace: objectGUID\nobjectGUID: %s\n-", subobj.DOMAINGUID);
519         } else {
520                 subobj.DOMAINGUID_MOD = "";
521         }
523         if (subobj.HOSTGUID != undefined) {
524                 subobj.HOSTGUID_ADD = sprintf("objectGUID: %s", subobj.HOSTGUID);
525         } else {
526                 subobj.HOSTGUID_ADD = "";
527         }
529         info.subobj = subobj;
530         info.message = message;
531         info.credentials = credentials;
532         info.session_info = session_info;
534         /* only install a new smb.conf if there isn't one there already */
535         var st = sys.stat(paths.smbconf);
536         if (st == undefined) {
537                 message("Setting up smb.conf\n");
538                 setup_file("provision.smb.conf", info.message, paths.smbconf, subobj);
539                 lp.reload();
540         }
541         /* only install a new shares config db if there is none */
542         st = sys.stat(paths.shareconf);
543         if (st == undefined) {
544                 message("Setting up share.ldb\n");
545                 setup_ldb("share.ldif", info, paths.shareconf);
546         }
548         message("Setting up " + paths.secrets + "\n");
549         setup_ldb("secrets_init.ldif", info, paths.secrets);
550         setup_ldb("secrets.ldif", info, paths.secrets, false);
552         message("Setting up hklm.ldb\n");
553         setup_ldb("hklm.ldif", info, paths.hklm);
555         message("Setting up sam.ldb partitions\n");
556         /* Also wipes the database */
557         setup_ldb("provision_partitions.ldif", info, paths.samdb);
559         var samdb = open_ldb(info, paths.samdb, false);
561         message("Setting up sam.ldb attributes\n");
562         setup_add_ldif("provision_init.ldif", info, samdb, false);
564         message("Setting up sam.ldb rootDSE\n");
565         setup_add_ldif("provision_rootdse_add.ldif", info, samdb, false);
567         message("Erasing data from partitions\n");
568         ldb_erase_partitions(info, samdb, ldapbackend);
569         
570         message("Adding DomainDN: " + subobj.DOMAINDN + " (permitted to fail)\n");
571         var add_ok = setup_add_ldif("provision_basedn.ldif", info, samdb, true);
572         message("Modifying DomainDN: " + subobj.DOMAINDN + "\n");
573         var modify_ok = setup_ldb_modify("provision_basedn_modify.ldif", info, samdb);
574         if (!modify_ok) {
575                 if (!add_ok) {
576                         message("Failed to both add and modify " + subobj.DOMAINDN + " in target " + subobj.DOMAINDN_LDB + ": " + samdb.errstring() + "\n");
577                         message("Perhaps you need to run the provision script with the --ldap-base-dn option, and add this record to the backend manually\n"); 
578                 };
579                 assert(modify_ok);
580         };
582         message("Adding configuration container (permitted to fail)\n");
583         var add_ok = setup_add_ldif("provision_configuration_basedn.ldif", info, samdb, true);
584         message("Modifying configuration container\n");
585         var modify_ok = setup_ldb_modify("provision_configuration_basedn_modify.ldif", info, samdb);
586         if (!modify_ok) {
587                 if (!add_ok) {
588                         message("Failed to both add and modify configuration dn: " + samdb.errstring() + "\n");
589                         message("Perhaps you need to run the provision script with the --ldap-base-dn option, and add this record to the backend manually\n"); 
590                         assert(modify_ok);
591                 }
592                 assert(modify_ok);
593         }
595         message("Adding schema container (permitted to fail)\n");
596         var add_ok = setup_add_ldif("provision_schema_basedn.ldif", info, samdb, true);
597         message("Modifying schema container\n");
598         var modify_ok = setup_ldb_modify("provision_schema_basedn_modify.ldif", info, samdb);
599         if (!modify_ok) {
600                 if (!add_ok) {
601                         message("Failed to both add and modify schema dn: + samdb.errstring() + "\n");
602                         message("Perhaps you need to run the provision script with the --ldap-base-dn option, and add this record to the backend manually\n"); 
603                         assert(modify_ok);
604                 }
605                 message("Failed to modify the schema container: " + samdb.errstring() + "\n");
606                 assert(modify_ok);
607         }
609         message("Setting up sam.ldb Samba4 schema\n");
610         setup_add_ldif("schema_samba4.ldif", info, samdb, false);
611         message("Setting up sam.ldb AD schema\n");
612         setup_add_ldif("schema.ldif", info, samdb, false);
614         // (hack) Reload, now we have the schema loaded.  
615         var commit_ok = samdb.transaction_commit();
616         if (!commit_ok) {
617                 info.message("samdb commit failed: " + samdb.errstring() + "\n");
618                 assert(commit_ok);
619         }
620         samdb.close();
622         samdb = open_ldb(info, paths.samdb, false);
624         message("Setting up sam.ldb configuration data\n");
625         setup_add_ldif("provision_configuration.ldif", info, samdb, false);
627         message("Setting up display specifiers\n");
628         setup_add_ldif("display_specifiers.ldif", info, samdb, false);
629         message("Setting up sam.ldb templates\n");
630         setup_add_ldif("provision_templates.ldif", info, samdb, false);
632         message("Adding users container (permitted to fail)\n");
633         var add_ok = setup_add_ldif("provision_users_add.ldif", info, samdb, true);
634         message("Modifying users container\n");
635         var modify_ok = setup_ldb_modify("provision_users_modify.ldif", info, samdb);
636         if (!modify_ok) {
637                 if (!add_ok) {
638                         message("Failed to both add and modify the users container\n");
639                         assert(modify_ok);
640                 }
641                 assert(modify_ok);
642         }
643         message("Adding computers container (permitted to fail)\n");
644         var add_ok = setup_add_ldif("provision_computers_add.ldif", info, samdb, true);
645         message("Modifying computers container\n");
646         var modify_ok = setup_ldb_modify("provision_computers_modify.ldif", info, samdb);
647         if (!modify_ok) {
648                 if (!add_ok) {
649                         message("Failed to both add and modify the computers container\n");
650                         assert(modify_ok);
651                 }
652                 assert(modify_ok);
653         }
655         message("Setting up sam.ldb data\n");
656         setup_add_ldif("provision.ldif", info, samdb, false);
658         if (blank != false) {
659                 message("Setting up sam.ldb index\n");
660                 setup_add_ldif("provision_index.ldif", info, samdb, false);
662                 message("Setting up sam.ldb rootDSE marking as syncronized\n");
663                 setup_modify_ldif("provision_rootdse_modify.ldif", info, samdb, false);
665                 var commit_ok = samdb.transaction_commit();
666                 if (!commit_ok) {
667                         info.message("ldb commit failed: " + samdb.errstring() + "\n");
668                         assert(commit_ok);
669                 }
670                 return true;
671         }
673 //      message("Activate schema module");
674 //      setup_modify_ldif("schema_activation.ldif", info, samdb, false);
676 //      // (hack) Reload, now we have the schema loaded.  
677 //      var commit_ok = samdb.transaction_commit();
678 //      if (!commit_ok) {
679 //              info.message("samdb commit failed: " + samdb.errstring() + "\n");
680 //              assert(commit_ok);
681 //      }
682 //      samdb.close();
684 //      samdb = open_ldb(info, paths.samdb, false);
686         message("Setting up sam.ldb users and groups\n");
687         setup_add_ldif("provision_users.ldif", info, samdb, false);
689         if (setup_name_mappings(info, samdb) == false) {
690                 return false;
691         }
693         message("Setting up sam.ldb index\n");
694         setup_add_ldif("provision_index.ldif", info, samdb, false);
696         message("Setting up sam.ldb rootDSE marking as syncronized\n");
697         setup_modify_ldif("provision_rootdse_modify.ldif", info, samdb, false);
699         var commit_ok = samdb.transaction_commit();
700         if (!commit_ok) {
701                 info.message("samdb commit failed: " + samdb.errstring() + "\n");
702                 assert(commit_ok);
703         }
705         return true;
709   provision just the schema into a temporary ldb, so we can run ad2oLschema on it
711 function provision_schema(subobj, message, tmp_schema_path, paths)
713         var lp = loadparm_init();
714         var sys = sys_init();
715         var info = new Object();
717         var ok = provision_fix_subobj(subobj, message, paths);
718         assert(ok);
720         info.subobj = subobj;
721         info.message = message;
723         message("Setting up sam.ldb partitions\n");
725         /* This will erase anything in the tmp db */
726         var samdb = open_ldb(info, tmp_schema_path, true);
728         message("Adding schema container (permitted to fail)\n");
729         var add_ok = setup_add_ldif("provision_schema_basedn.ldif", info, samdb, true);
730         message("Modifying schema container\n");
731         var modify_ok = setup_ldb_modify("provision_schema_basedn_modify.ldif", info, samdb);
732         if (!modify_ok) {
733                 if (!add_ok) {
734                         message("Failed to both add and modify schema dn: + 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"); 
736                         assert(modify_ok);
737                 }
738                 message("Failed to modify the schema container: " + samdb.errstring() + "\n");
739                 assert(modify_ok);
740         }
742         message("Setting up sam.ldb Samba4 schema\n");
743         setup_add_ldif("schema_samba4.ldif", info, samdb, false);
744         message("Setting up sam.ldb AD schema\n");
745         setup_add_ldif("schema.ldif", info, samdb, false);
747         var commit_ok = samdb.transaction_commit();
748         if (!commit_ok) {
749                 info.message("samdb commit failed: " + samdb.errstring() + "\n");
750                 assert(commit_ok);
751         }
752         samdb.close();
755 /* Write out a DNS zone file, from the info in the current database */
756 function provision_dns(subobj, message, paths, session_info, credentials)
758         message("Setting up DNS zone: " + subobj.DNSDOMAIN + " \n");
759         var ldb = ldb_init();
760         ldb.session_info = session_info;
761         ldb.credentials = credentials;
763         /* connect to the sam */
764         var ok = ldb.connect(paths.samdb);
765         assert(ok);
767         /* These values may have changed, due to an incoming SamSync,
768            or may not have been specified, so fetch them from the database */
770         var attrs = new Array("objectGUID");
771         res = ldb.search("objectGUID=*", subobj.DOMAINDN, ldb.SCOPE_BASE, attrs);
772         assert(res.error == 0);
773         assert(res.msgs.length == 1);
774         assert(res.msgs[0].objectGUID != undefined);
775         subobj.DOMAINGUID = res.msgs[0].objectGUID;
777         subobj.HOSTGUID = searchone(ldb, subobj.DOMAINDN, "(&(objectClass=computer)(cn=" + subobj.NETBIOSNAME + "))", "objectGUID");
778         assert(subobj.HOSTGUID != undefined);
780         setup_file("provision.zone", 
781                    message, paths.dns, 
782                    subobj);
784         message("Please install the zone located in " + paths.dns + " into your DNS server\n");
787 /* Write out a DNS zone file, from the info in the current database */
788 function provision_ldapbase(subobj, message, paths)
790         message("Setting up LDAP base entry: " + subobj.DOMAINDN + " \n");
791         var rdns = split(",", subobj.DOMAINDN);
792         subobj.EXTENSIBLEOBJECT = "objectClass: extensibleObject";
794         subobj.RDN_DC = substr(rdns[0], strlen("DC="));
796         setup_file("provision_basedn.ldif", 
797                    message, paths.ldap_basedn_ldif, 
798                    subobj);
800         setup_file("provision_configuration_basedn.ldif", 
801                    message, paths.ldap_config_basedn_ldif, 
802                    subobj);
804         setup_file("provision_schema_basedn.ldif", 
805                    message, paths.ldap_schema_basedn_ldif, 
806                    subobj);
808         message("Please install the LDIF located in " + paths.ldap_basedn_ldif + ", " + paths.ldap_config_basedn_ldif + " and " + paths.ldap_schema_basedn_ldif + " into your LDAP server, and re-run with --ldap-backend=ldap://my.ldap.server\n");
813   guess reasonably default options for provisioning
815 function provision_guess()
817         var subobj = new Object();
818         var nss = nss_init();
819         var lp = loadparm_init();
820         var rdn_list;
821         random_init(local);
823         subobj.REALM        = strupper(lp.get("realm"));
824         subobj.DOMAIN       = lp.get("workgroup");
825         subobj.HOSTNAME     = hostname();
827         assert(subobj.REALM);
828         assert(subobj.DOMAIN);
829         assert(subobj.HOSTNAME);
830         
831         subobj.VERSION      = version();
832         subobj.HOSTIP       = hostip();
833         subobj.DOMAINSID    = randsid();
834         subobj.INVOCATIONID = randguid();
835         subobj.POLICYGUID   = randguid();
836         subobj.KRBTGTPASS   = randpass(12);
837         subobj.MACHINEPASS  = randpass(12);
838         subobj.ADMINPASS    = randpass(12);
839         subobj.LDAPMANAGERPASS     = randpass(12);
840         subobj.DEFAULTSITE  = "Default-First-Site-Name";
841         subobj.NEWGUID      = randguid;
842         subobj.NTTIME       = nttime;
843         subobj.LDAPTIME     = ldaptime;
844         subobj.DATESTRING   = datestring;
845         subobj.ROOT         = findnss(nss.getpwnam, "root");
846         subobj.NOBODY       = findnss(nss.getpwnam, "nobody");
847         subobj.NOGROUP      = findnss(nss.getgrnam, "nogroup", "nobody");
848         subobj.WHEEL        = findnss(nss.getgrnam, "wheel", "root", "staff", "adm");
849         subobj.BACKUP       = findnss(nss.getgrnam, "backup", "wheel", "root", "staff");
850         subobj.USERS        = findnss(nss.getgrnam, "users", "guest", "other", "unknown", "usr");
852         subobj.DNSDOMAIN    = strlower(subobj.REALM);
853         subobj.DNSNAME      = sprintf("%s.%s", 
854                                       strlower(subobj.HOSTNAME), 
855                                       subobj.DNSDOMAIN);
856         rdn_list = split(".", subobj.DNSDOMAIN);
857         subobj.DOMAINDN     = "DC=" + join(",DC=", rdn_list);
858         subobj.DOMAINDN_LDB = "users.ldb";
859         subobj.ROOTDN       = subobj.DOMAINDN;
860         subobj.CONFIGDN     = "CN=Configuration," + subobj.ROOTDN;
861         subobj.CONFIGDN_LDB = "configuration.ldb";
862         subobj.SCHEMADN     = "CN=Schema," + subobj.CONFIGDN;
863         subobj.SCHEMADN_LDB = "schema.ldb";
865         //Add modules to the list to activate them by default
866         //beware often order is important
867         //
868         // Some Known ordering constraints:
869         // - rootdse must be first, as it makes redirects from "" -> cn=rootdse
870         // - samldb must be before password_hash, because password_hash checks
871         //   that the objectclass is of type person (filled in by samldb)
872         // - partition must be last
873         // - each partition has its own module list then
874         modules_list        = new Array("rootdse",
875                                         "kludge_acl",
876                                         "paged_results",
877                                         "server_sort",
878                                         "extended_dn",
879                                         "asq",
880                                         "samldb",
881                                         "password_hash",
882                                         "operational",
883                                         "objectclass",
884                                         "rdn_name",
885                                         "show_deleted",
886                                         "partition");
887         subobj.MODULES_LIST = join(",", modules_list);
888         subobj.DOMAINDN_MOD = "objectguid";
889         subobj.CONFIGDN_MOD = "objectguid";
890         subobj.SCHEMADN_MOD = "objectguid";
892         subobj.EXTENSIBLEOBJECT = "# no objectClass: extensibleObject for local ldb";
893         subobj.ACI              = "# no aci for local ldb";
894         return subobj;
898   search for one attribute as a string
899  */
900 function searchone(ldb, basedn, expression, attribute)
902         var attrs = new Array(attribute);
903         res = ldb.search(expression, basedn, ldb.SCOPE_SUBTREE, attrs);
904         if (res.error != 0 ||
905             res.msgs.length != 1 ||
906             res.msgs[0][attribute] == undefined) {
907                 return undefined;
908         }
909         return res.msgs[0][attribute];
913   modify an account to remove the 
915 function enable_account(ldb, user_dn)
917         var attrs = new Array("userAccountControl");
918         var res = ldb.search(NULL, user_dn, ldb.SCOPE_ONELEVEL, attrs);
919         assert(res.error == 0);
920         assert(res.msgs.length == 1);
921         var userAccountControl = res.msgs[0].userAccountControl;
922         userAccountControl = userAccountControl - 2; /* remove disabled bit */
923         var mod = sprintf("
924 dn: %s
925 changetype: modify
926 replace: userAccountControl
927 userAccountControl: %u
928 ", 
929                           user_dn, userAccountControl);
930         var ok = ldb.modify(mod);
931         return (ok.error == 0); 
936   add a new user record
938 function newuser(username, unixname, password, message, session_info, credentials)
940         var lp = loadparm_init();
941         var samdb = lp.get("sam database");
942         var ldb = ldb_init();
943         random_init(local);
944         ldb.session_info = session_info;
945         ldb.credentials = credentials;
947         /* connect to the sam */
948         var ok = ldb.connect(samdb);
949         assert(ok);
951         ldb.transaction_start();
953         /* find the DNs for the domain and the domain users group */
954         var attrs = new Array("defaultNamingContext");
955         res = ldb.search("defaultNamingContext=*", "", ldb.SCOPE_BASE, attrs);
956         assert(res.error == 0);
957         assert(res.msgs.length == 1 && res.msgs[0].defaultNamingContext != undefined);
958         var domain_dn = res.msgs[0].defaultNamingContext;
959         assert(domain_dn != undefined);
960         var dom_users = searchone(ldb, domain_dn, "name=Domain Users", "dn");
961         assert(dom_users != undefined);
963         var user_dn = sprintf("CN=%s,CN=Users,%s", username, domain_dn);
966         /*
967           the new user record. note the reliance on the samdb module to fill
968           in a sid, guid etc
969         */
970         var ldif = sprintf("
971 dn: %s
972 sAMAccountName: %s
973 memberOf: %s
974 unixName: %s
975 sambaPassword: %s
976 objectClass: user
978                            user_dn, username, dom_users,
979                            unixname, password);
980         /*
981           add the user to the users group as well
982         */
983         var modgroup = sprintf("
984 dn: %s
985 changetype: modify
986 add: member
987 member: %s
988 ", 
989                                dom_users, user_dn);
992         /*
993           now the real work
994         */
995         message("Adding user %s\n", user_dn);
996         ok = ldb.add(ldif);
997         if (ok.error != 0) {
998                 message("Failed to add %s - %s\n", user_dn, ok.errstr);
999                 return false;
1000         }
1002         message("Modifying group %s\n", dom_users);
1003         ok = ldb.modify(modgroup);
1004         if (ok.error != 0) {
1005                 message("Failed to modify %s - %s\n", dom_users, ok.errstr);
1006                 return false;
1007         }
1009         /*
1010           modify the userAccountControl to remove the disabled bit
1011         */
1012         ok = enable_account(ldb, user_dn);
1013         if (ok) {
1014                 ldb.transaction_commit();
1015         }
1016         return ok;
1019 // Check whether a name is valid as a NetBIOS name. 
1020 // FIXME: There are probably more constraints here. 
1021 // crh has a paragraph on this in his book (1.4.1.1)
1022 function valid_netbios_name(name)
1024         if (strlen(name) > 13) return false;
1025         return true;
1028 function provision_validate(subobj, message)
1030         var lp = loadparm_init();
1032         if (!valid_netbios_name(subobj.DOMAIN)) {
1033                 message("Invalid NetBIOS name for domain\n");
1034                 return false;
1035         }
1037         if (!valid_netbios_name(subobj.NETBIOSNAME)) {
1038                 message("Invalid NetBIOS name for host\n");
1039                 return false;
1040         }
1043         if (strupper(lp.get("workgroup")) != strupper(subobj.DOMAIN)) {
1044                 message("workgroup '%s' in smb.conf must match chosen domain '%s'\n",
1045                         lp.get("workgroup"), subobj.DOMAIN);
1046                 return false;
1047         }
1049         if (strupper(lp.get("realm")) != strupper(subobj.REALM)) {
1050                 message("realm '%s' in smb.conf must match chosen realm '%s'\n",
1051                         lp.get("realm"), subobj.REALM);
1052                 return false;
1053         }
1055         return true;
1058 function join_domain(domain, netbios_name, join_type, creds, message) 
1060         var ctx = NetContext(creds);
1061         var joindom = new Object();
1062         joindom.domain = domain;
1063         joindom.join_type = join_type;
1064         joindom.netbios_name = netbios_name;
1065         if (!ctx.JoinDomain(joindom)) {
1066                 message("Domain Join failed: " + joindom.error_string);
1067                 return false;
1068         }
1069         return true;
1072 /* Vampire a remote domain.  Session info and credentials are required for for
1073  * access to our local database (might be remote ldap)
1074  */ 
1076 function vampire(domain, session_info, credentials, message) {
1077         var ctx = NetContext(credentials);
1078         var vampire_ctx = new Object();
1079         var machine_creds = credentials_init();
1080         machine_creds.set_domain(form.DOMAIN);
1081         if (!machine_creds.set_machine_account()) {
1082                 message("Failed to access domain join information!");
1083                 return false;
1084         }
1085         vampire_ctx.machine_creds = machine_creds;
1086         vampire_ctx.session_info = session_info;
1087         if (!ctx.SamSyncLdb(vampire_ctx)) {
1088                 message("Migration of remote domain to Samba failed: " + vampire_ctx.error_string);
1089                 return false;
1090         }
1092         return true;
1095 return 0;