source/scripting/libjs/provision.js

   1 /*
   2         backend code for provisioning a Samba4 server
   3         Copyright Andrew Tridgell 2005
   4         Released under the GNU GPL v2 or later
   5 */
   6
   7 sys = sys_init();
   8
   9 /*
  10   return true if the current install seems to be OK
  11 */
  12 function install_ok(session_info, credentials)
  13 {
  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;
  30 }
  31
  32 /*
  33   find a user or group from a list of possibilities
  34 */
  35 function findnss()
  36 {
  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);
  47 }
  48
  49 /*
  50    add a foreign security principle
  51  */
  52 function add_foreign(ldb, subobj, sid, desc)
  53 {
  54         var add = sprintf("
  55 dn: CN=%s,CN=ForeignSecurityPrincipals,%s
  56 objectClass: top
  57 objectClass: foreignSecurityPrincipal
  58 description: %s
  59 ",
  60                           sid, subobj.DOMAINDN, desc);
  61         /* deliberately ignore errors from this, as the records may
  62            already exist */
  63         ldb.add(add);
  64 }
  65
  66
  67 /*
  68   setup a mapping between a sam name and a unix name
  69  */
  70 function setup_name_mapping(info, ldb, sid, unixname)
  71 {
  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
  84 ",
  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;
  93 }
  94
  95 /*
  96   return current time as a nt time string
  97 */
  98 function nttime()
  99 {
 100         return "" + sys.nttime();
 101 }
 102
 103 /*
 104   return current time as a ldap time string
 105 */
 106 function ldaptime()
 107 {
 108         return sys.ldaptime(sys.nttime());
 109 }
 110
 111 /*
 112   return a date string suitable for a dns zone serial number
 113 */
 114 function datestring()
 115 {
 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);
 119 }
 120
 121 /*
 122   return first host IP
 123 */
 124 function hostip()
 125 {
 126         var list = sys.interfaces();
 127         return list[0];
 128 }
 129
 130
 131 /*
 132   return first part of hostname
 133 */
 134 function hostname()
 135 {
 136         var s = split(".", sys.hostname());
 137         return s[0];
 138 }
 139
 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)
 144 {
 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);
 153 }
 154
 155 /*
 156   erase an ldb, removing all records
 157 */
 158 function ldb_erase(info, ldb)
 159 {
 160         var res;
 161
 162         /* delete the specials */
 163         ldb.del("@INDEXLIST");
 164         ldb.del("@ATTRIBUTES");
 165         ldb.del("@OPTIONS");
 166         ldb.del("@MODULES");
 167         ldb.del("@PARTITION");
 168         ldb.del("@KLUDGEACL");
 169
 170         /* and the rest */
 171         attrs = new Array("dn");
 172         var basedn = "";
 173         var res = ldb.search("(&(|(objectclass=*)(distinguishedName=*))(!(distinguishedName=@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         }
 182
 183         var res = ldb.search("(&(|(objectclass=*)(distinguishedName=*))(!(distinguishedName=@BASEINFO)))", basedn, ldb.SCOPE_SUBTREE, attrs);
 184         if (res.error != 0 || res.msgs.length != 0) {
 185                 ldb_delete(info, ldb);
 186                 return;
 187         }
 188         assert(res.msgs.length == 0);
 189 }
 190
 191 /*
 192   erase an ldb, removing all records
 193 */
 194 function ldb_erase_partitions(info, ldb, ldapbackend)
 195 {
 196         var rootDSE_attrs = new Array("namingContexts");
 197         var lp = loadparm_init();
 198         var j;
 199
 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);
 204         }
 205         assert(res.msgs.length == 1);
 206         if (typeof(res.msgs[0].namingContexts) == "undefined") {
 207                 return;
 208         }
 209         for (j=0; j<res.msgs[0].namingContexts.length; j++) {
 210                 var anything = "(|(objectclass=*)(distinguishedName=*))";
 211                 var attrs = new Array("distinguishedName");
 212                 var basedn = res.msgs[0].namingContexts[j];
 213                 var k;
 214                 var previous_remaining = 1;
 215                 var current_remaining = 0;
 216
 217                 if (ldapbackend && (basedn == info.subobj.DOMAINDN)) {
 218                         /* Only delete objects that were created by provision */
 219                         anything = "(objectcategory=*)";
 220                 }
 221
 222                 for (k=0; k < 10 && (previous_remaining != current_remaining); k++) {
 223                         /* and the rest */
 224                         var res2 = ldb.search(anything, basedn, ldb.SCOPE_SUBTREE, attrs);
 225                         var i;
 226                         if (res2.error != 0) {
 227                                 if (res2.error == 32) {
 228                                         break;
 229                                 } else {
 230                                         info.message("ldb search(2) failed: " + res2.errstr + "\n");
 231                                         continue;
 232                                 }
 233                         }
 234                         previous_remaining = current_remaining;
 235                         current_remaining = res2.msgs.length;
 236                         for (i=0;i<res2.msgs.length;i++) {
 237                                 ldb.del(res2.msgs[i].dn);
 238                         }
 239
 240                         var res3 = ldb.search(anything, basedn, ldb.SCOPE_SUBTREE, attrs);
 241                         if (res3.error != 0) {
 242                                 info.message("ldb search(3) failed: " + res3.errstr + "\n");
 243                                 continue;
 244                         }
 245                         if (res3.msgs.length != 0) {
 246                                 info.message("Failed to delete all records under " + basedn + ", " + res3.msgs.length + " records remaining\n");
 247                         }
 248                 }
 249         }
 250 }
 251
 252 function open_ldb(info, dbname, erase)
 253 {
 254         var ldb = ldb_init();
 255         ldb.session_info = info.session_info;
 256         ldb.credentials = info.credentials;
 257         ldb.filename = dbname;
 258
 259         var connect_ok = ldb.connect(dbname);
 260         if (!connect_ok) {
 261                 var lp = loadparm_init();
 262                 sys.unlink(sprintf("%s/%s", lp.get("private dir"), dbname));
 263                 connect_ok = ldb.connect(dbname);
 264                 assert(connect_ok);
 265         }
 266
 267         ldb.transaction_start();
 268
 269         if (erase) {
 270                 ldb_erase(info, ldb);
 271         }
 272         return ldb;
 273 }
 274
 275
 276 /*
 277   setup a ldb in the private dir
 278  */
 279 function setup_add_ldif(ldif, info, ldb, failok)
 280 {
 281         var lp = loadparm_init();
 282         var src = lp.get("setup directory") + "/" + ldif;
 283
 284         var data = sys.file_load(src);
 285         data = substitute_var(data, info.subobj);
 286
 287         var add_res = ldb.add(data);
 288         if (add_res.error != 0) {
 289                 info.message("ldb load failed: " + add_res.errstr + "\n");
 290                 if (!failok) {
 291                         assert(add_res.error == 0);
 292                 }
 293         }
 294         return (add_res.error == 0);
 295 }
 296
 297 function setup_modify_ldif(ldif, info, ldb, failok)
 298 {
 299         var lp = loadparm_init();
 300         var src = lp.get("setup directory") + "/" + ldif;
 301
 302         var data = sys.file_load(src);
 303         data = substitute_var(data, info.subobj);
 304
 305         var mod_res = ldb.modify(data);
 306         if (mod_res.error != 0) {
 307                 info.message("ldb load failed: " + mod_res.errstr + "\n");
 308                 if (!failok) {
 309                         assert(mod_res.error == 0);
 310                 }
 311         }
 312         return (mod_res.error == 0);
 313 }
 314
 315
 316 function setup_ldb(ldif, info, dbname)
 317 {
 318         var erase = true;
 319         var failok = false;
 320
 321         if (arguments.length >= 4) {
 322                 erase = arguments[3];
 323         }
 324         if (arguments.length == 5) {
 325                 failok = arguments[4];
 326         }
 327         var ldb = open_ldb(info, dbname, erase);
 328         if (setup_add_ldif(ldif, info, ldb, failok)) {
 329                 var commit_ok = ldb.transaction_commit();
 330                 if (!commit_ok) {
 331                         info.message("ldb commit failed: " + ldb.errstring() + "\n");
 332                         assert(commit_ok);
 333                 }
 334         }
 335 }
 336
 337 /*
 338   setup a ldb in the private dir
 339  */
 340 function setup_ldb_modify(ldif, info, ldb)
 341 {
 342         var lp = loadparm_init();
 343
 344         var src = lp.get("setup directory") + "/" + ldif;
 345
 346         var data = sys.file_load(src);
 347         data = substitute_var(data, info.subobj);
 348
 349         var mod_res = ldb.modify(data);
 350         if (mod_res.error != 0) {
 351                 info.message("ldb load failed: " + mod_res.errstr + "\n");
 352                 return (mod_res.error == 0);
 353         }
 354         return (mod_res.error == 0);
 355 }
 356
 357 /*
 358   setup a file in the private dir
 359  */
 360 function setup_file(template, message, fname, subobj)
 361 {
 362         var lp = loadparm_init();
 363         var f = fname;
 364         var src = lp.get("setup directory") + "/" + template;
 365
 366         if (! sys.stat(src)) {
 367                 message("Template file not found: %s\n",src);
 368                 assert(0);
 369         }
 370
 371         sys.unlink(f);
 372
 373         var data = sys.file_load(src);
 374         data = substitute_var(data, subobj);
 375
 376         ok = sys.file_save(f, data);
 377         if (!ok) {
 378                 message("failed to create file: " + f + "\n");
 379                 assert(ok);
 380         }
 381 }
 382
 383 function provision_default_paths(subobj)
 384 {
 385         /* subobj.DNSDOMAIN isn't available at this point */
 386         var dnsdomain = strlower(subobj.REALM);
 387         var lp = loadparm_init();
 388         var paths = new Object();
 389         paths.smbconf = lp.filename()
 390         paths.shareconf = lp.get("private dir") + "/" + "share.ldb";
 391         paths.samdb = lp.get("sam database");
 392         paths.secrets = lp.get("secrets database");
 393         paths.templates = lp.get("private dir") + "/" + "templates.ldb";
 394         paths.keytab = "secrets.keytab";
 395         paths.dns_keytab = "dns.keytab";
 396         paths.dns_keytab_abs = lp.get("private dir") + "/" + paths.dns_keytab;
 397         paths.dns = lp.get("private dir") + "/" + dnsdomain + ".zone";
 398         paths.named_conf = lp.get("private dir") + "/named.conf";
 399         paths.winsdb = "wins.ldb";
 400         paths.ldapdir = lp.get("private dir") + "/ldap";
 401
 402         paths.s4_ldapi_socket = lp.get("private dir") + "/ldapi";
 403         paths.phpldapadminconfig = lp.get("private dir") + "/phpldapadmin-config.php";
 404
 405         paths.sysvol = lp.get("sysvol", "path");
 406
 407         if (paths.sysvol == undefined) {
 408                 paths.sysvol = lp.get("lock dir") + "/sysvol";
 409         }
 410
 411         paths.netlogon = lp.get("netlogon", "path");
 412
 413         if (paths.netlogon == undefined) {
 414                 paths.netlogon = paths.sysvol + "/" + dnsdomain + "/scripts";
 415         }
 416
 417         return paths;
 418 }
 419
 420
 421 /*
 422   setup reasonable name mappings for sam names to unix names
 423 */
 424 function setup_name_mappings(info, ldb)
 425 {
 426         var lp = loadparm_init();
 427         var attrs = new Array("objectSid");
 428         var subobj = info.subobj;
 429
 430         res = ldb.search("objectSid=*", subobj.DOMAINDN, ldb.SCOPE_BASE, attrs);
 431         assert(res.error == 0);
 432         assert(res.msgs.length == 1 && res.msgs[0].objectSid != undefined);
 433         var sid = res.msgs[0].objectSid;
 434
 435         /* add some foreign sids if they are not present already */
 436         add_foreign(ldb, subobj, "S-1-5-7",  "Anonymous");
 437         add_foreign(ldb, subobj, "S-1-1-0",  "World");
 438         add_foreign(ldb, subobj, "S-1-5-2",  "Network");
 439         add_foreign(ldb, subobj, "S-1-5-18", "System");
 440         add_foreign(ldb, subobj, "S-1-5-11", "Authenticated Users");
 441
 442         /* some well known sids */
 443         setup_name_mapping(info, ldb, "S-1-5-7",  subobj.NOBODY);
 444         setup_name_mapping(info, ldb, "S-1-1-0",  subobj.NOGROUP);
 445         setup_name_mapping(info, ldb, "S-1-5-2",  subobj.NOGROUP);
 446         setup_name_mapping(info, ldb, "S-1-5-18", subobj.ROOT);
 447         setup_name_mapping(info, ldb, "S-1-5-11", subobj.USERS);
 448         setup_name_mapping(info, ldb, "S-1-5-32-544", subobj.WHEEL);
 449         setup_name_mapping(info, ldb, "S-1-5-32-545", subobj.USERS);
 450         setup_name_mapping(info, ldb, "S-1-5-32-546", subobj.NOGROUP);
 451         setup_name_mapping(info, ldb, "S-1-5-32-551", subobj.BACKUP);
 452
 453         /* and some well known domain rids */
 454         setup_name_mapping(info, ldb, sid + "-500", subobj.ROOT);
 455         setup_name_mapping(info, ldb, sid + "-518", subobj.WHEEL);
 456         setup_name_mapping(info, ldb, sid + "-519", subobj.WHEEL);
 457         setup_name_mapping(info, ldb, sid + "-512", subobj.WHEEL);
 458         setup_name_mapping(info, ldb, sid + "-513", subobj.USERS);
 459         setup_name_mapping(info, ldb, sid + "-520", subobj.WHEEL);
 460
 461         return true;
 462 }
 463
 464 function provision_fix_subobj(subobj, paths)
 465 {
 466         var ldb = ldb_init();
 467
 468         subobj.REALM       = strupper(subobj.REALM);
 469         subobj.HOSTNAME    = strlower(subobj.HOSTNAME);
 470         subobj.DOMAIN      = strupper(subobj.DOMAIN);
 471         subobj.NETBIOSNAME = strupper(subobj.HOSTNAME);
 472         subobj.DNSDOMAIN    = strlower(subobj.REALM);
 473         subobj.DNSNAME      = sprintf("%s.%s",
 474                                       strlower(subobj.HOSTNAME),
 475                                       subobj.DNSDOMAIN);
 476         var rdn_list = split(".", subobj.DNSDOMAIN);
 477         subobj.DOMAINDN     = "DC=" + join(",DC=", rdn_list);
 478         subobj.ROOTDN       = subobj.DOMAINDN;
 479         subobj.CONFIGDN     = "CN=Configuration," + subobj.ROOTDN;
 480         subobj.SCHEMADN     = "CN=Schema," + subobj.CONFIGDN;
 481
 482         subobj.MACHINEPASS_B64 = ldb.encode(subobj.MACHINEPASS);
 483         subobj.KRBTGTPASS_B64  = ldb.encode(subobj.KRBTGTPASS);
 484         subobj.ADMINPASS_B64   = ldb.encode(subobj.ADMINPASS);
 485         subobj.DNSPASS_B64     = ldb.encode(subobj.DNSPASS);
 486
 487         subobj.SAM_LDB          = "tdb://" + paths.samdb;
 488         subobj.SECRETS_KEYTAB   = paths.keytab;
 489         subobj.DNS_KEYTAB       = paths.dns_keytab;
 490         subobj.DNS_KEYTAB_ABS   = paths.dns_keytab_abs;
 491
 492         subobj.LDAPDIR = paths.ldapdir;
 493         var ldap_path_list = split("/", paths.ldapdir);
 494         subobj.LDAPI_URI = "ldapi://" + join("%2F", ldap_path_list) + "%2Fldapi";
 495
 496         var s4ldap_path_list = split("/", paths.s4_ldapi_socket);
 497         subobj.S4_LDAPI_URI = "ldapi://" + join("%2F", s4ldap_path_list);
 498
 499         subobj.LDAPMANAGERDN = "cn=Manager," + subobj.DOMAINDN;
 500
 501         subobj.NETLOGONPATH = paths.netlogon;
 502         subobj.SYSVOLPATH = paths.sysvol;
 503
 504         if (subobj.DOMAIN_CONF == undefined) {
 505                 subobj.DOMAIN_CONF = subobj.DOMAIN;
 506         }
 507         if (subobj.REALM_CONF == undefined) {
 508                 subobj.REALM_CONF = subobj.REALM;
 509         }
 510         if (strlower(subobj.SERVERROLE) != strlower("domain controller")) {
 511                 subobj.REALM = subobj.HOSTNAME;
 512                 subobj.DOMAIN = subobj.HOSTNAME;
 513         }
 514
 515         return true;
 516 }
 517
 518 function provision_become_dc(subobj, message, erase, paths, session_info)
 519 {
 520         var lp = loadparm_init();
 521         var sys = sys_init();
 522         var info = new Object();
 523
 524         var ok = provision_fix_subobj(subobj, paths);
 525         assert(ok);
 526
 527         info.subobj = subobj;
 528         info.message = message;
 529         info.session_info = session_info;
 530
 531         message("Setting up templates into " + paths.templates + "\n");
 532         setup_ldb("provision_templates.ldif", info, paths.templates);
 533
 534         /* Also wipes the database */
 535         message("Setting up " + paths.samdb + " partitions\n");
 536         setup_ldb("provision_partitions.ldif", info, paths.samdb);
 537
 538         var samdb = open_ldb(info, paths.samdb, false);
 539
 540         message("Setting up " + paths.samdb + " attributes\n");
 541         setup_add_ldif("provision_init.ldif", info, samdb, false);
 542
 543         message("Setting up " + paths.samdb + " rootDSE\n");
 544         setup_add_ldif("provision_rootdse_add.ldif", info, samdb, false);
 545
 546         if (erase) {
 547                 message("Erasing data from partitions\n");
 548                 ldb_erase_partitions(info, samdb, undefined);
 549         }
 550
 551         message("Setting up " + paths.samdb + " indexes\n");
 552         setup_add_ldif("provision_index.ldif", info, samdb, false);
 553
 554         ok = samdb.transaction_commit();
 555         assert(ok);
 556
 557         message("Setting up " + paths.secrets + "\n");
 558         setup_ldb("secrets_init.ldif", info, paths.secrets);
 559
 560         setup_ldb("secrets.ldif", info, paths.secrets, false);
 561
 562         setup_ldb("secrets_dc.ldif", info, paths.secrets, false);
 563
 564         return true;
 565 }
 566
 567 function load_schema(subobj, message, samdb)
 568 {
 569         var lp = loadparm_init();
 570         var src = lp.get("setup directory") + "/" + "schema.ldif";
 571
 572         if (! sys.stat(src)) {
 573                 message("Template file not found: %s\n",src);
 574                 assert(0);
 575         }
 576
 577         var schema_data = sys.file_load(src);
 578
 579         src = lp.get("setup directory") + "/" + "schema_samba4.ldif";
 580
 581         if (! sys.stat(src)) {
 582                 message("Template file not found: %s\n",src);
 583                 assert(0);
 584         }
 585
 586         schema_data = schema_data + sys.file_load(src);
 587
 588         schema_data = substitute_var(schema_data, subobj);
 589
 590         src = lp.get("setup directory") + "/" + "provision_schema_basedn_modify.ldif";
 591
 592         if (! sys.stat(src)) {
 593                 message("Template file not found: %s\n",src);
 594                 assert(0);
 595         }
 596
 597         var head_data = sys.file_load(src);
 598         head_data = substitute_var(head_data, subobj);
 599
 600         var ok = samdb.attach_dsdb_schema_from_ldif(head_data, schema_data);
 601         return ok;
 602 }
 603
 604
 605 /*
 606   provision samba4 - caution, this wipes all existing data!
 607 */
 608 function provision(subobj, message, blank, paths, session_info, credentials, ldapbackend)
 609 {
 610         var lp = loadparm_init();
 611         var sys = sys_init();
 612         var info = new Object();
 613
 614         var ok = provision_fix_subobj(subobj, paths);
 615         assert(ok);
 616
 617         if (subobj.DOMAINGUID != undefined) {
 618                 subobj.DOMAINGUID_MOD = sprintf("replace: objectGUID\nobjectGUID: %s\n-", subobj.DOMAINGUID);
 619         } else {
 620                 subobj.DOMAINGUID_MOD = "";
 621         }
 622
 623         if (subobj.HOSTGUID != undefined) {
 624                 subobj.HOSTGUID_ADD = sprintf("objectGUID: %s", subobj.HOSTGUID);
 625         } else {
 626                 subobj.HOSTGUID_ADD = "";
 627         }
 628
 629         info.subobj = subobj;
 630         info.message = message;
 631         info.credentials = credentials;
 632         info.session_info = session_info;
 633
 634         /* only install a new smb.conf if there isn't one there already */
 635         var st = sys.stat(paths.smbconf);
 636         if (st == undefined) {
 637                 var smbconfsuffix;
 638                 if (strlower(subobj.SERVERROLE) == strlower("domain controller")) {
 639                         smbconfsuffix = "dc";
 640                 } else if (strlower(subobj.SERVERROLE) == strlower("member server")) {
 641                         smbconfsuffix = "member";
 642                 } else {
 643                         smbconfsuffix = subobj.SERVERROLE;
 644                 }
 645                 message("Setting up " + paths.smbconf +"\n");
 646                 setup_file("provision.smb.conf." + smbconfsuffix, info.message, paths.smbconf, subobj);
 647                 lp.reload();
 648         }
 649         /* only install a new shares config db if there is none */
 650         st = sys.stat(paths.shareconf);
 651         if (st == undefined) {
 652                 message("Setting up share.ldb\n");
 653                 setup_ldb("share.ldif", info, paths.shareconf);
 654         }
 655
 656         message("Setting up " + paths.secrets + "\n");
 657         setup_ldb("secrets_init.ldif", info, paths.secrets);
 658         setup_ldb("secrets.ldif", info, paths.secrets, false);
 659
 660         message("Setting up the registry\n");
 661         var reg = reg_open();
 662         reg.apply_patchfile(lp.get("setup directory") + "/provision.reg")
 663
 664         message("Setting up templates into " + paths.templates + "\n");
 665         setup_ldb("provision_templates.ldif", info, paths.templates);
 666
 667         message("Setting up sam.ldb partitions\n");
 668         /* Also wipes the database */
 669         setup_ldb("provision_partitions.ldif", info, paths.samdb);
 670
 671         var samdb = open_ldb(info, paths.samdb, false);
 672
 673         message("Setting up sam.ldb attributes\n");
 674         setup_add_ldif("provision_init.ldif", info, samdb, false);
 675
 676         message("Setting up sam.ldb rootDSE\n");
 677         setup_add_ldif("provision_rootdse_add.ldif", info, samdb, false);
 678
 679         message("Erasing data from partitions\n");
 680         ldb_erase_partitions(info, samdb, ldapbackend);
 681
 682         // (hack) Reload, now we have the partitions and rootdse loaded.
 683         var commit_ok = samdb.transaction_commit();
 684         if (!commit_ok) {
 685                 info.message("samdb commit failed: " + samdb.errstring() + "\n");
 686                 assert(commit_ok);
 687         }
 688         samdb.close();
 689
 690         message("Pre-loading the Samba4 and AD schema\n");
 691
 692         samdb = open_ldb(info, paths.samdb, false);
 693
 694         samdb.set_domain_sid(subobj.DOMAINSID);
 695
 696         samdb.set_ntds_invocationId(subobj.INVOCATIONID);
 697
 698         var load_schema_ok = load_schema(subobj, message, samdb);
 699         assert(load_schema_ok.is_ok);
 700
 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) {
 706                 if (!add_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");
 709                 };
 710                 assert(modify_basedn_ok);
 711         };
 712
 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");
 721                 }
 722                 assert(modify_config_ok);
 723         }
 724
 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");
 733                 }
 734                 message("Failed to modify the schema container: " + samdb.errstring() + "\n");
 735                 assert(modify_schema_ok);
 736         }
 737
 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);
 742
 743         message("Setting up sam.ldb configuration data\n");
 744         setup_add_ldif("provision_configuration.ldif", info, samdb, false);
 745
 746         message("Setting up display specifiers\n");
 747         setup_add_ldif("display_specifiers.ldif", info, samdb, false);
 748
 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) {
 754                 if (!add_users_ok) {
 755                         message("Failed to both add and modify the users container\n");
 756                 }
 757                 assert(modify_users_ok);
 758         }
 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");
 766                 }
 767                 assert(modify_computers_ok);
 768         }
 769
 770         message("Setting up sam.ldb data\n");
 771         setup_add_ldif("provision.ldif", info, samdb, false);
 772
 773         if (blank != false) {
 774                 message("Setting up sam.ldb index\n");
 775                 setup_add_ldif("provision_index.ldif", info, samdb, false);
 776
 777                 message("Setting up sam.ldb rootDSE marking as syncronized\n");
 778                 setup_modify_ldif("provision_rootdse_modify.ldif", info, samdb, false);
 779
 780                 var commit_ok = samdb.transaction_commit();
 781                 if (!commit_ok) {
 782                         info.message("ldb commit failed: " + samdb.errstring() + "\n");
 783                         assert(commit_ok);
 784                 }
 785                 return true;
 786         }
 787
 788 //      message("Activate schema module");
 789 //      setup_modify_ldif("schema_activation.ldif", info, samdb, false);
 790 //
 791 //      // (hack) Reload, now we have the schema loaded.
 792 //      var commit_ok = samdb.transaction_commit();
 793 //      if (!commit_ok) {
 794 //              info.message("samdb commit failed: " + samdb.errstring() + "\n");
 795 //              assert(commit_ok);
 796 //      }
 797 //      samdb.close();
 798 //
 799 //      samdb = open_ldb(info, paths.samdb, false);
 800 //
 801         message("Setting up sam.ldb users and groups\n");
 802         setup_add_ldif("provision_users.ldif", info, samdb, false);
 803
 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);
 808
 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);
 815
 816                 sys.mkdir(paths.netlogon, 0755);
 817
 818                 setup_ldb("secrets_dc.ldif", info, paths.secrets, false);
 819
 820         }
 821
 822         if (setup_name_mappings(info, samdb) == false) {
 823                 return false;
 824         }
 825
 826         message("Setting up sam.ldb index\n");
 827         setup_add_ldif("provision_index.ldif", info, samdb, false);
 828
 829         message("Setting up sam.ldb rootDSE marking as syncronized\n");
 830         setup_modify_ldif("provision_rootdse_modify.ldif", info, samdb, false);
 831
 832         var commit_ok = samdb.transaction_commit();
 833         if (!commit_ok) {
 834                 info.message("samdb commit failed: " + samdb.errstring() + "\n");
 835                 assert(commit_ok);
 836         }
 837
 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");
 841
 842         return true;
 843 }
 844
 845 /*
 846   provision just the schema into a temporary ldb, so we can run ad2oLschema on it
 847 */
 848 function provision_schema(subobj, message, tmp_schema_path, paths)
 849 {
 850         var lp = loadparm_init();
 851         var sys = sys_init();
 852         var info = new Object();
 853
 854         var ok = provision_fix_subobj(subobj, paths);
 855         assert(ok);
 856
 857         info.subobj = subobj;
 858         info.message = message;
 859
 860         message("Setting up sam.ldb partitions\n");
 861
 862         /* This will erase anything in the tmp db */
 863         var samdb = open_ldb(info, tmp_schema_path, true);
 864
 865         message("Setting up sam.ldb attributes\n");
 866         setup_add_ldif("provision_init.ldif", info, samdb, false);
 867
 868         message("Setting up sam.ldb rootDSE\n");
 869         setup_add_ldif("provision_rootdse_add.ldif", info, samdb, false);
 870
 871         message("Adding schema container (permitted to fail)\n");
 872         var add_ok = setup_add_ldif("provision_schema_basedn.ldif", info, samdb, true);
 873         message("Modifying schema container\n");
 874         var modify_ok = setup_ldb_modify("provision_schema_basedn_modify.ldif", info, samdb);
 875         if (!modify_ok) {
 876                 if (!add_ok) {
 877                         message("Failed to both add and modify schema dn: " + samdb.errstring() + "\n");
 878                         message("Perhaps you need to run the provision script with the --ldap-base-dn option, and add this record to the backend manually\n");
 879                         assert(modify_ok);
 880                 }
 881                 message("Failed to modify the schema container: " + samdb.errstring() + "\n");
 882                 assert(modify_ok);
 883         }
 884
 885         message("Setting up sam.ldb Samba4 schema\n");
 886         setup_add_ldif("schema_samba4.ldif", info, samdb, false);
 887         message("Setting up sam.ldb AD schema\n");
 888         setup_add_ldif("schema.ldif", info, samdb, false);
 889
 890         var commit_ok = samdb.transaction_commit();
 891         if (!commit_ok) {
 892                 info.message("samdb commit failed: " + samdb.errstring() + "\n");
 893                 assert(commit_ok);
 894         }
 895         samdb.close();
 896 }
 897
 898 /* Write out a DNS zone file, from the info in the current database */
 899 function provision_dns(subobj, message, paths, session_info, credentials)
 900 {
 901         var lp = loadparm_init();
 902         if (strlower(subobj.SERVERROLE) != strlower("domain controller")) {
 903                 message("No DNS zone required for role %s\n", subobj.SERVERROLE);
 904                 return;
 905         }
 906         message("Setting up DNS zone: " + subobj.DNSDOMAIN + " \n");
 907         var ldb = ldb_init();
 908         ldb.session_info = session_info;
 909         ldb.credentials = credentials;
 910
 911         /* connect to the sam */
 912         var ok = ldb.connect(paths.samdb);
 913         assert(ok);
 914
 915         /* These values may have changed, due to an incoming SamSync,
 916            or may not have been specified, so fetch them from the database */
 917
 918         var attrs = new Array("objectGUID");
 919         res = ldb.search("objectGUID=*", subobj.DOMAINDN, ldb.SCOPE_BASE, attrs);
 920         assert(res.error == 0);
 921         assert(res.msgs.length == 1);
 922         assert(res.msgs[0].objectGUID != undefined);
 923         subobj.DOMAINGUID = res.msgs[0].objectGUID;
 924
 925         subobj.HOSTGUID = searchone(ldb, subobj.DOMAINDN, "(&(objectClass=computer)(cn=" + subobj.NETBIOSNAME + "))", "objectGUID");
 926         assert(subobj.HOSTGUID != undefined);
 927
 928         setup_file("provision.zone",
 929                    message, paths.dns,
 930                    subobj);
 931
 932         setup_file("named.conf",
 933                    message, paths.named_conf,
 934                    subobj);
 935
 936         message("Please install the zone located in " + paths.dns + " into your DNS server.  A sample BIND configuration snippit is at " + paths.named_conf + "\n");
 937 }
 938
 939
 940 /*
 941   guess reasonably default options for provisioning
 942 */
 943 function provision_guess()
 944 {
 945         var subobj = new Object();
 946         var nss = nss_init();
 947         var lp = loadparm_init();
 948         var rdn_list;
 949         random_init(local);
 950
 951         subobj.SERVERROLE   = strlower(lp.get("server role"));
 952         subobj.REALM        = strupper(lp.get("realm"));
 953         subobj.DOMAIN       = lp.get("workgroup");
 954         subobj.HOSTNAME     = hostname();
 955
 956         assert(subobj.REALM);
 957         assert(subobj.DOMAIN);
 958         assert(subobj.HOSTNAME);
 959
 960         subobj.VERSION      = version();
 961         subobj.HOSTIP       = hostip();
 962         subobj.DOMAINSID    = randsid();
 963         subobj.INVOCATIONID = randguid();
 964         subobj.POLICYGUID   = randguid();
 965         subobj.KRBTGTPASS   = randpass(12);
 966         subobj.MACHINEPASS  = randpass(12);
 967         subobj.DNSPASS  = randpass(12);
 968         subobj.ADMINPASS    = randpass(12);
 969         subobj.LDAPMANAGERPASS     = randpass(12);
 970         subobj.DEFAULTSITE  = "Default-First-Site-Name";
 971         subobj.DATESTRING   = datestring;
 972         subobj.ROOT         = findnss(nss.getpwnam, "root");
 973         subobj.NOBODY       = findnss(nss.getpwnam, "nobody");
 974         subobj.NOGROUP      = findnss(nss.getgrnam, "nogroup", "nobody");
 975         subobj.WHEEL        = findnss(nss.getgrnam, "wheel", "root", "staff", "adm");
 976         subobj.BACKUP       = findnss(nss.getgrnam, "backup", "wheel", "root", "staff");
 977         subobj.USERS        = findnss(nss.getgrnam, "users", "guest", "other", "unknown", "usr");
 978
 979         //Add modules to the list to activate them by default
 980         //beware often order is important
 981         //
 982         // Some Known ordering constraints:
 983         // - rootdse must be first, as it makes redirects from "" -> cn=rootdse
 984         // - objectclass must be before password_hash, because password_hash checks
 985         //   that the objectclass is of type person (filled in by the objectclass
 986         //   module when expanding the objectclass list)
 987         // - partition must be last
 988         // - each partition has its own module list then
 989         var modules_list     = new Array("rootdse",
 990                                          "paged_results",
 991                                          "ranged_results",
 992                                          "anr",
 993                                          "server_sort",
 994                                          "extended_dn",
 995                                          "asq",
 996                                          "samldb",
 997                                          "rdn_name",
 998                                          "objectclass",
 999                                          "kludge_acl",
1000                                          "operational");
1001         var tdb_modules_list = new Array("subtree_rename",
1002                                          "subtree_delete",
1003                                          "linked_attributes");
1004         var modules_list2    = new Array("show_deleted",
1005                                          "partition");
1006         subobj.MODULES_LIST = join(",", modules_list);
1007         subobj.TDB_MODULES_LIST = "," + join(",", tdb_modules_list);
1008         subobj.MODULES_LIST2 = join(",", modules_list2);
1009         subobj.DOMAINDN_LDB = "users.ldb";
1010         subobj.CONFIGDN_LDB = "configuration.ldb";
1011         subobj.SCHEMADN_LDB = "schema.ldb";
1012         subobj.DOMAINDN_MOD = "pdc_fsmo,password_hash,instancetype";
1013         subobj.CONFIGDN_MOD = "naming_fsmo,instancetype";
1014         subobj.SCHEMADN_MOD = "schema_fsmo,instancetype";
1015         subobj.DOMAINDN_MOD2 = ",repl_meta_data";
1016         subobj.CONFIGDN_MOD2 = ",repl_meta_data";
1017         subobj.SCHEMADN_MOD2 = ",repl_meta_data";
1018
1019         subobj.ACI              = "# no aci for local ldb";
1020
1021         return subobj;
1022 }
1023
1024 /*
1025   search for one attribute as a string
1026  */
1027 function searchone(ldb, basedn, expression, attribute)
1028 {
1029         var attrs = new Array(attribute);
1030         res = ldb.search(expression, basedn, ldb.SCOPE_SUBTREE, attrs);
1031         if (res.error != 0 ||
1032             res.msgs.length != 1 ||
1033             res.msgs[0][attribute] == undefined) {
1034                 return undefined;
1035         }
1036         return res.msgs[0][attribute];
1037 }
1038
1039 /*
1040   modify an account to remove the
1041 */
1042 function enable_account(ldb, user_dn)
1043 {
1044         var attrs = new Array("userAccountControl");
1045         var res = ldb.search(NULL, user_dn, ldb.SCOPE_ONELEVEL, attrs);
1046         assert(res.error == 0);
1047         assert(res.msgs.length == 1);
1048         var userAccountControl = res.msgs[0].userAccountControl;
1049         userAccountControl = userAccountControl - 2; /* remove disabled bit */
1050         var mod = sprintf("
1051 dn: %s
1052 changetype: modify
1053 replace: userAccountControl
1054 userAccountControl: %u
1055 ",
1056                           user_dn, userAccountControl);
1057         var ok = ldb.modify(mod);
1058         return (ok.error == 0);
1059 }
1060
1061
1062 /*
1063   add a new user record
1064 */
1065 function newuser(username, unixname, password, message, session_info, credentials)
1066 {
1067         var lp = loadparm_init();
1068         var samdb = lp.get("sam database");
1069         var ldb = ldb_init();
1070         random_init(local);
1071         ldb.session_info = session_info;
1072         ldb.credentials = credentials;
1073
1074         /* connect to the sam */
1075         var ok = ldb.connect(samdb);
1076         assert(ok);
1077
1078         ldb.transaction_start();
1079
1080         /* find the DNs for the domain and the domain users group */
1081         var attrs = new Array("defaultNamingContext");
1082         res = ldb.search("defaultNamingContext=*", "", ldb.SCOPE_BASE, attrs);
1083         assert(res.error == 0);
1084         assert(res.msgs.length == 1 && res.msgs[0].defaultNamingContext != undefined);
1085         var domain_dn = res.msgs[0].defaultNamingContext;
1086         assert(domain_dn != undefined);
1087         var dom_users = searchone(ldb, domain_dn, "name=Domain Users", "dn");
1088         assert(dom_users != undefined);
1089
1090         var user_dn = sprintf("CN=%s,CN=Users,%s", username, domain_dn);
1091
1092
1093         /*
1094           the new user record. note the reliance on the samdb module to fill
1095           in a sid, guid etc
1096         */
1097         var ldif = sprintf("
1098 dn: %s
1099 sAMAccountName: %s
1100 unixName: %s
1101 sambaPassword: %s
1102 objectClass: user
1103 ",
1104                            user_dn, username, dom_users,
1105                            unixname, password);
1106         /*
1107           add the user to the users group as well
1108         */
1109         var modgroup = sprintf("
1110 dn: %s
1111 changetype: modify
1112 add: member
1113 member: %s
1114 ",
1115                                dom_users, user_dn);
1116
1117
1118         /*
1119           now the real work
1120         */
1121         message("Adding user %s\n", user_dn);
1122         ok = ldb.add(ldif);
1123         if (ok.error != 0) {
1124                 message("Failed to add %s - %s\n", user_dn, ok.errstr);
1125                 return false;
1126         }
1127
1128         message("Modifying group %s\n", dom_users);
1129         ok = ldb.modify(modgroup);
1130         if (ok.error != 0) {
1131                 message("Failed to modify %s - %s\n", dom_users, ok.errstr);
1132                 return false;
1133         }
1134
1135         /*
1136           modify the userAccountControl to remove the disabled bit
1137         */
1138         ok = enable_account(ldb, user_dn);
1139         if (ok) {
1140                 ldb.transaction_commit();
1141         }
1142         return ok;
1143 }
1144
1145 // Check whether a name is valid as a NetBIOS name.
1146 // FIXME: There are probably more constraints here.
1147 // crh has a paragraph on this in his book (1.4.1.1)
1148 function valid_netbios_name(name)
1149 {
1150         if (strlen(name) > 13) return false;
1151         return true;
1152 }
1153
1154 function provision_validate(subobj, message)
1155 {
1156         var lp = loadparm_init();
1157
1158         if (!valid_netbios_name(subobj.DOMAIN)) {
1159                 message("Invalid NetBIOS name for domain\n");
1160                 return false;
1161         }
1162
1163         if (!valid_netbios_name(subobj.NETBIOSNAME)) {
1164                 message("Invalid NetBIOS name for host\n");
1165                 return false;
1166         }
1167
1168
1169         if (strupper(lp.get("workgroup")) != strupper(subobj.DOMAIN_CONF)) {
1170                 message("workgroup '%s' in smb.conf must match chosen domain '%s'\n",
1171                         lp.get("workgroup"), subobj.DOMAIN_CONF);
1172                 return false;
1173         }
1174
1175         if (strupper(lp.get("realm")) != strupper(subobj.REALM_CONF)) {
1176                 message("realm '%s' in smb.conf must match chosen realm '%s'\n",
1177                         lp.get("realm"), subobj.REALM_CONF);
1178                 return false;
1179         }
1180
1181         if (strlower(lp.get("server role")) != strlower(subobj.SERVERROLE)) {
1182                 message("server role '%s' in smb.conf must match chosen role '%s'\n",
1183                         lp.get("server role"), subobj.SERVERROLE);
1184                 return false;
1185         }
1186
1187         return true;
1188 }
1189
1190 function join_domain(domain, netbios_name, join_type, creds, message)
1191 {
1192         var ctx = NetContext(creds);
1193         var joindom = new Object();
1194         joindom.domain = domain;
1195         joindom.join_type = join_type;
1196         joindom.netbios_name = netbios_name;
1197         if (!ctx.JoinDomain(joindom)) {
1198                 message("Domain Join failed: " + joindom.error_string);
1199                 return false;
1200         }
1201         return true;
1202 }
1203
1204 /* Vampire a remote domain.  Session info and credentials are required for for
1205  * access to our local database (might be remote ldap)
1206  */
1207
1208 function vampire(domain, session_info, credentials, message) {
1209         var ctx = NetContext(credentials);
1210         var vampire_ctx = new Object();
1211         var machine_creds = credentials_init();
1212         machine_creds.set_domain(form.DOMAIN);
1213         if (!machine_creds.set_machine_account()) {
1214                 message("Failed to access domain join information!");
1215                 return false;
1216         }
1217         vampire_ctx.machine_creds = machine_creds;
1218         vampire_ctx.session_info = session_info;
1219         if (!ctx.SamSyncLdb(vampire_ctx)) {
1220                 message("Migration of remote domain to Samba failed: " + vampire_ctx.error_string);
1221                 return false;
1222         }
1223
1224         return true;
1225 }
1226
1227 return 0;