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 /* used to generate sequence numbers for records */
   8 provision_next_usn = 1;
   9
  10 sys = sys_init();
  11
  12 /*
  13   return true if the current install seems to be OK
  14 */
  15 function install_ok(session_info, credentials)
  16 {
  17         var lp = loadparm_init();
  18         var ldb = ldb_init();
  19         ldb.session_info = session_info;
  20         ldb.credentials = credentials;
  21         if (lp.get("realm") == "") {
  22                 return false;
  23         }
  24         var ok = ldb.connect(lp.get("sam database"));
  25         if (!ok) {
  26                 return false;
  27         }
  28         var res = ldb.search("(cn=Administrator)");
  29         if (res.length != 1) {
  30                 return false;
  31         }
  32         return true;
  33 }
  34
  35 /*
  36   find a user or group from a list of possibilities
  37 */
  38 function findnss()
  39 {
  40         var i;
  41         assert(arguments.length >= 2);
  42         var nssfn = arguments[0];
  43         for (i=1;i<arguments.length;i++) {
  44                 if (nssfn(arguments[i]) != undefined) {
  45                         return arguments[i];
  46                 }
  47         }
  48         printf("Unable to find user/group for %s\n", arguments[1]);
  49         assert(i<arguments.length);
  50 }
  51
  52 /*
  53    add a foreign security principle
  54  */
  55 function add_foreign(ldb, subobj, sid, desc)
  56 {
  57         var add = sprintf("
  58 dn: CN=%s,CN=ForeignSecurityPrincipals,%s
  59 objectClass: top
  60 objectClass: foreignSecurityPrincipal
  61 description: %s
  62 uSNCreated: 1
  63 uSNChanged: 1
  64 ",
  65                           sid, subobj.BASEDN, desc);
  66         /* deliberately ignore errors from this, as the records may
  67            already exist */
  68         ldb.add(add);
  69 }
  70
  71
  72 /*
  73   setup a mapping between a sam name and a unix name
  74  */
  75 function setup_name_mapping(info, ldb, sid, unixname)
  76 {
  77         var attrs = new Array("dn");
  78         var res = ldb.search(sprintf("objectSid=%s", sid),
  79                              NULL, ldb.SCOPE_DEFAULT, attrs);
  80         if (res.length != 1) {
  81                 info.message("Failed to find record for objectSid %s\n", sid);
  82                 return false;
  83         }
  84         var mod = sprintf("
  85 dn: %s
  86 changetype: modify
  87 replace: unixName
  88 unixName: %s
  89 ",
  90                           res[0].dn, unixname);
  91         var ok = ldb.modify(mod);
  92         if (!ok) {
  93                 info.message("name mapping for %s failed - %s\n",
  94                              sid, ldb.errstring());
  95                 return false;
  96         }
  97         return true;
  98 }
  99
 100 /*
 101   return current time as a nt time string
 102 */
 103 function nttime()
 104 {
 105         return "" + sys.nttime();
 106 }
 107
 108 /*
 109   return current time as a ldap time string
 110 */
 111 function ldaptime()
 112 {
 113         return sys.ldaptime(sys.nttime());
 114 }
 115
 116 /*
 117   return a date string suitable for a dns zone serial number
 118 */
 119 function datestring()
 120 {
 121         var t = sys.gmtime(sys.nttime());
 122         return sprintf("%04u%02u%02u%02u",
 123                        t.tm_year+1900, t.tm_mon+1, t.tm_mday, t.tm_hour);
 124 }
 125
 126 /*
 127   return first host IP
 128 */
 129 function hostip()
 130 {
 131         var list = sys.interfaces();
 132         return list[0];
 133 }
 134
 135 /*
 136   return next USN in the sequence
 137 */
 138 function nextusn()
 139 {
 140         provision_next_usn = provision_next_usn+1;
 141         return provision_next_usn;
 142 }
 143
 144 /*
 145   return first part of hostname
 146 */
 147 function hostname()
 148 {
 149         var s = split(".", sys.hostname());
 150         return s[0];
 151 }
 152
 153
 154 /* the ldb is in bad shape, possibly due to being built from an
 155    incompatible previous version of the code, so delete it
 156    completely */
 157 function ldb_delete(ldb)
 158 {
 159         println("Deleting " + ldb.filename);
 160         var lp = loadparm_init();
 161         sys.unlink(sprintf("%s/%s", lp.get("private dir"), ldb.filename));
 162         ldb.transaction_cancel();
 163         ldb.close();
 164         var ok = ldb.connect(ldb.filename);
 165         ldb.transaction_start();
 166         assert(ok);
 167 }
 168
 169 /*
 170   erase an ldb, removing all records
 171 */
 172 function ldb_erase(ldb)
 173 {
 174         var attrs = new Array("dn");
 175
 176         /* delete the specials */
 177         ldb.del("@INDEXLIST");
 178         ldb.del("@ATTRIBUTES");
 179         ldb.del("@SUBCLASSES");
 180         ldb.del("@MODULES");
 181
 182         /* and the rest */
 183         var res = ldb.search("(&(|(objectclass=*)(dn=*))(!(dn=@BASEINFO)))", attrs);
 184         var i;
 185         if (typeof(res) == "undefined") {
 186                 ldb_delete(ldb);
 187                 return;
 188         }
 189         for (i=0;i<res.length;i++) {
 190                 ldb.del(res[i].dn);
 191         }
 192         /* extra hack to ensure it's gone on remote ldap */
 193         ldb.del("cn=ROOTDSE");
 194
 195         var res = ldb.search("(&(|(objectclass=*)(dn=*))(!(dn=@BASEINFO)))", attrs);
 196         if (res.length != 0) {
 197                 ldb_delete(ldb);
 198                 return;
 199         }
 200         assert(res.length == 0);
 201 }
 202
 203 /*
 204   setup a ldb in the private dir
 205  */
 206 function setup_ldb(ldif, info, dbname)
 207 {
 208         var erase = true;
 209         var extra = "";
 210         var ldb = ldb_init();
 211         var lp = loadparm_init();
 212         ldb.session_info = info.session_info;
 213         ldb.credentials = info.credentials;
 214
 215         if (arguments.length >= 4) {
 216                 extra = arguments[3];
 217         }
 218
 219         if (arguments.length == 5) {
 220                 erase = arguments[4];
 221         }
 222
 223         var src = lp.get("setup directory") + "/" + ldif;
 224
 225         var data = sys.file_load(src);
 226         data = data + extra;
 227         data = substitute_var(data, info.subobj);
 228
 229         ldb.filename = dbname;
 230
 231         var connect_ok = ldb.connect(dbname);
 232         assert(connect_ok);
 233
 234         ldb.transaction_start();
 235
 236         if (erase) {
 237                 ldb_erase(ldb);
 238         }
 239
 240         var add_ok = ldb.add(data);
 241         if (!add_ok) {
 242                 info.message("ldb load failed: " + ldb.errstring() + "\n");
 243                 assert(add_ok);
 244         }
 245         var commit_ok = ldb.transaction_commit();
 246         if (!commit_ok) {
 247                 info.message("ldb commit failed: " + ldb.errstring() + "\n");
 248                 assert(add_ok);
 249         }
 250 }
 251
 252 /*
 253   setup a file in the private dir
 254  */
 255 function setup_file(template, fname, subobj)
 256 {
 257         var lp = loadparm_init();
 258         var f = fname;
 259         var src = lp.get("setup directory") + "/" + template;
 260
 261         sys.unlink(f);
 262
 263         var data = sys.file_load(src);
 264         data = substitute_var(data, subobj);
 265
 266         ok = sys.file_save(f, data);
 267         assert(ok);
 268 }
 269
 270 function provision_default_paths(subobj)
 271 {
 272         var lp = loadparm_init();
 273         var paths = new Object();
 274         paths.smbconf = lp.get("config file");
 275         paths.hklm = "hklm.ldb";
 276         paths.hkcu = "hkcu.ldb";
 277         paths.hkcr = "hkcr.ldb";
 278         paths.hku = "hku.ldb";
 279         paths.hkpd = "hkpd.ldb";
 280         paths.hkpt = "hkpt.ldb";
 281         paths.samdb = lp.get("sam database");
 282         paths.secrets = "secrets.ldb";
 283         paths.dns = lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".zone";
 284         paths.winsdb = "wins.ldb";
 285         return paths;
 286 }
 287
 288
 289 /*
 290   setup reasonable name mappings for sam names to unix names
 291 */
 292 function setup_name_mappings(info, subobj, session_info, credentials)
 293 {
 294         var lp = loadparm_init();
 295         var ldb = ldb_init();
 296         ldb.session_info = session_info;
 297         ldb.credentials = credentials;
 298         var ok = ldb.connect(lp.get("sam database"));
 299         if (!ok) {
 300                 return false;
 301         }
 302         var attrs = new Array("objectSid");
 303         var res = ldb.search("dnsDomain=" + subobj.REALM,
 304                              NULL, ldb.SCOPE_DEFAULT, attrs);
 305         if (res.length != 1) {
 306                 info.message("Failed to find dnsDomain %s\n", subobj.REALM);
 307                 return false;
 308         }
 309         var sid = res[0].objectSid;
 310
 311         /* add some foreign sids if they are not present already */
 312         add_foreign(ldb, subobj, "S-1-5-7",  "Anonymous");
 313         add_foreign(ldb, subobj, "S-1-1-0",  "World");
 314         add_foreign(ldb, subobj, "S-1-5-2",  "Network");
 315         add_foreign(ldb, subobj, "S-1-5-18", "System");
 316         add_foreign(ldb, subobj, "S-1-5-11", "Authenticated Users");
 317
 318         /* some well known sids */
 319         setup_name_mapping(info, ldb, "S-1-5-7",  subobj.NOBODY);
 320         setup_name_mapping(info, ldb, "S-1-1-0",  subobj.NOGROUP);
 321         setup_name_mapping(info, ldb, "S-1-5-2",  subobj.NOGROUP);
 322         setup_name_mapping(info, ldb, "S-1-5-18", subobj.ROOT);
 323         setup_name_mapping(info, ldb, "S-1-5-11", subobj.USERS);
 324         setup_name_mapping(info, ldb, "S-1-5-32-544", subobj.WHEEL);
 325         setup_name_mapping(info, ldb, "S-1-5-32-546", subobj.NOGROUP);
 326         setup_name_mapping(info, ldb, "S-1-5-32-551", subobj.BACKUP);
 327
 328         /* and some well known domain rids */
 329         setup_name_mapping(info, ldb, sid + "-500", subobj.ROOT);
 330         setup_name_mapping(info, ldb, sid + "-518", subobj.WHEEL);
 331         setup_name_mapping(info, ldb, sid + "-519", subobj.WHEEL);
 332         setup_name_mapping(info, ldb, sid + "-512", subobj.WHEEL);
 333         setup_name_mapping(info, ldb, sid + "-513", subobj.USERS);
 334         setup_name_mapping(info, ldb, sid + "-520", subobj.WHEEL);
 335
 336         return true;
 337 }
 338
 339
 340 /*
 341   provision samba4 - caution, this wipes all existing data!
 342 */
 343 function provision(subobj, message, blank, paths, session_info, credentials)
 344 {
 345         var data = "";
 346         var lp = loadparm_init();
 347         var sys = sys_init();
 348         var info = new Object();
 349
 350         /*
 351           some options need to be upper/lower case
 352         */
 353         subobj.REALM       = strupper(subobj.REALM);
 354         subobj.HOSTNAME    = strlower(subobj.HOSTNAME);
 355         subobj.DOMAIN      = strupper(subobj.DOMAIN);
 356         assert(valid_netbios_name(subobj.DOMAIN));
 357         subobj.NETBIOSNAME = strupper(subobj.HOSTNAME);
 358         assert(valid_netbios_name(subobj.NETBIOSNAME));
 359         var rdns = split(",", subobj.BASEDN);
 360         subobj.RDN_DC = substr(rdns[0], strlen("DC="));
 361
 362         provision_next_usn = 1;
 363
 364         info.subobj = subobj;
 365         info.message = message;
 366         info.credentials = credentials;
 367         info.session_info = session_info;
 368
 369         /* only install a new smb.conf if there isn't one there already */
 370         var st = sys.stat(paths.smbconf);
 371         if (st == undefined) {
 372                 message("Setting up smb.conf\n");
 373                 setup_file("provision.smb.conf", paths.smbconf, subobj);
 374                 lp.reload();
 375         }
 376         message("Setting up secrets.ldb\n");
 377         setup_ldb("secrets.ldif", info, paths.secrets);
 378         message("Setting up keytabs\n");
 379         var keytab_ok = credentials_update_all_keytabs();
 380         assert(keytab_ok);
 381         message("Setting up hklm.ldb\n");
 382         setup_ldb("hklm.ldif", info, paths.hklm);
 383
 384
 385         message("Setting up sam.ldb attributes\n");
 386         setup_ldb("provision_init.ldif", info, paths.samdb);
 387         message("Setting up sam.ldb schema\n");
 388         setup_ldb("schema.ldif", info, paths.samdb, NULL, false);
 389         message("Setting up display specifiers\n");
 390         setup_ldb("display_specifiers.ldif", info, paths.samdb, NULL, false);
 391         message("Setting up sam.ldb templates\n");
 392         setup_ldb("provision_templates.ldif", info, paths.samdb, NULL, false);
 393         message("Setting up sam.ldb data\n");
 394         setup_ldb("provision.ldif", info, paths.samdb, NULL, false);
 395
 396         if (blank != false) {
 397                 return true;
 398         }
 399
 400         message("Setting up sam.ldb users and groups\n");
 401         setup_ldb("provision_users.ldif", info, paths.samdb, data, false);
 402
 403         if (setup_name_mappings(info, subobj, session_info, credentials) == false) {
 404                 return false;
 405         }
 406
 407         return true;
 408 }
 409
 410 /* Write out a DNS zone file, from the info in the current database */
 411 function provision_dns(subobj, message, paths, session_info, credentials)
 412 {
 413         message("Setting up DNS zone: " + subobj.DNSDOMAIN + " \n");
 414         var ldb = ldb_init();
 415         ldb.session_info = session_info;
 416         ldb.credentials = credentials;
 417
 418         /* connect to the sam */
 419         var ok = ldb.connect(paths.samdb);
 420         assert(ok);
 421
 422         /* These values may have changed, due to an incoming SamSync, so fetch them from the database */
 423         subobj.DOMAINGUID = searchone(ldb, "(&(objectClass=domainDNS)(dnsDomain=" + subobj.DNSDOMAIN + "))", "objectGUID");
 424         assert(subobj.DOMAINGUID != undefined);
 425
 426         subobj.HOSTGUID = searchone(ldb, "(&(objectClass=computer)(cn=" + subobj.NETBIOSNAME + "))", "objectGUID");
 427         assert(subobj.HOSTGUID != undefined);
 428
 429         setup_file("provision.zone",
 430                    paths.dns,
 431                    subobj);
 432
 433         message("Please install the zone located in " + paths.dns + " into your DNS server\n");
 434 }
 435
 436 /*
 437   guess reasonably default options for provisioning
 438 */
 439 function provision_guess()
 440 {
 441         var subobj = new Object();
 442         var nss = nss_init();
 443         var lp = loadparm_init();
 444         var rdn_list;
 445         random_init(local);
 446
 447         subobj.REALM        = strupper(lp.get("realm"));
 448         subobj.DOMAIN       = lp.get("workgroup");
 449         subobj.HOSTNAME     = hostname();
 450
 451         assert(subobj.REALM);
 452         assert(subobj.DOMAIN);
 453         assert(subobj.HOSTNAME);
 454
 455         subobj.HOSTIP       = hostip();
 456         subobj.DOMAINGUID   = randguid();
 457         subobj.DOMAINSID    = randsid();
 458         subobj.HOSTGUID     = randguid();
 459         subobj.INVOCATIONID = randguid();
 460         subobj.KRBTGTPASS   = randpass(12);
 461         subobj.MACHINEPASS  = randpass(12);
 462         subobj.ADMINPASS    = randpass(12);
 463         subobj.DEFAULTSITE  = "Default-First-Site-Name";
 464         subobj.NEWGUID      = randguid;
 465         subobj.NTTIME       = nttime;
 466         subobj.LDAPTIME     = ldaptime;
 467         subobj.DATESTRING   = datestring;
 468         subobj.USN          = nextusn;
 469         subobj.ROOT         = findnss(nss.getpwnam, "root");
 470         subobj.NOBODY       = findnss(nss.getpwnam, "nobody");
 471         subobj.NOGROUP      = findnss(nss.getgrnam, "nogroup", "nobody");
 472         subobj.WHEEL        = findnss(nss.getgrnam, "wheel", "root", "staff");
 473         subobj.BACKUP       = findnss(nss.getgrnam, "backup", "wheel", "root", "staff");
 474         subobj.USERS        = findnss(nss.getgrnam, "users", "guest", "other");
 475         subobj.DNSDOMAIN    = strlower(subobj.REALM);
 476         subobj.DNSNAME      = sprintf("%s.%s",
 477                                       strlower(subobj.HOSTNAME),
 478                                       subobj.DNSDOMAIN);
 479         rdn_list = split(".", subobj.DNSDOMAIN);
 480         subobj.BASEDN       = "DC=" + join(",DC=", rdn_list);
 481         return subobj;
 482 }
 483
 484 /*
 485   search for one attribute as a string
 486  */
 487 function searchone(ldb, expression, attribute)
 488 {
 489         var attrs = new Array(attribute);
 490         res = ldb.search(expression, attrs);
 491         if (res.length != 1 ||
 492             res[0][attribute] == undefined) {
 493                 return undefined;
 494         }
 495         return res[0][attribute];
 496 }
 497
 498 /*
 499   modify an account to remove the
 500 */
 501 function enable_account(ldb, user_dn)
 502 {
 503         var attrs = new Array("userAccountControl");
 504         var res = ldb.search(NULL, user_dn, ldb.SCOPE_ONELEVEL, attrs);
 505         assert(res.length == 1);
 506         var userAccountControl = res[0].userAccountControl;
 507         userAccountControl = userAccountControl - 2; /* remove disabled bit */
 508         var mod = sprintf("
 509 dn: %s
 510 changetype: modify
 511 replace: userAccountControl
 512 userAccountControl: %u
 513 ",
 514                           user_dn, userAccountControl);
 515         var ok = ldb.modify(mod);
 516         return ok;
 517 }
 518
 519
 520 /*
 521   add a new user record
 522 */
 523 function newuser(username, unixname, password, message, session_info, credentials)
 524 {
 525         var lp = loadparm_init();
 526         var samdb = lp.get("sam database");
 527         var ldb = ldb_init();
 528         random_init(local);
 529         ldb.session_info = session_info;
 530         ldb.credentials = credentials;
 531
 532         /* connect to the sam */
 533         var ok = ldb.connect(samdb);
 534         assert(ok);
 535
 536         ldb.transaction_start();
 537
 538         /* find the DNs for the domain and the domain users group */
 539         var domain_dn = searchone(ldb, "objectClass=domainDNS", "dn");
 540         assert(domain_dn != undefined);
 541         var dom_users = searchone(ldb, "name=Domain Users", "dn");
 542         assert(dom_users != undefined);
 543
 544         var user_dn = sprintf("CN=%s,CN=Users,%s", username, domain_dn);
 545
 546
 547         /*
 548           the new user record. note the reliance on the samdb module to fill
 549           in a sid, guid etc
 550         */
 551         var ldif = sprintf("
 552 dn: %s
 553 sAMAccountName: %s
 554 memberOf: %s
 555 unixName: %s
 556 sambaPassword: %s
 557 objectClass: user
 558 ",
 559                            user_dn, username, dom_users,
 560                            unixname, password);
 561         /*
 562           add the user to the users group as well
 563         */
 564         var modgroup = sprintf("
 565 dn: %s
 566 changetype: modify
 567 add: member
 568 member: %s
 569 ",
 570                                dom_users, user_dn);
 571
 572
 573         /*
 574           now the real work
 575         */
 576         message("Adding user %s\n", user_dn);
 577         ok = ldb.add(ldif);
 578         if (ok != true) {
 579                 message("Failed to add %s - %s\n", user_dn, ldb.errstring());
 580                 return false;
 581         }
 582
 583         message("Modifying group %s\n", dom_users);
 584         ok = ldb.modify(modgroup);
 585         if (ok != true) {
 586                 message("Failed to modify %s - %s\n", dom_users, ldb.errstring());
 587                 return false;
 588         }
 589
 590         /*
 591           modify the userAccountControl to remove the disabled bit
 592         */
 593         ok = enable_account(ldb, user_dn);
 594         if (ok) {
 595                 ldb.transaction_commit();
 596         }
 597         return ok;
 598 }
 599
 600 // Check whether a name is valid as a NetBIOS name.
 601 // FIXME: There are probably more constraints here.
 602 // crh has a paragraph on this in his book (1.4.1.1)
 603 function valid_netbios_name(name)
 604 {
 605         if (strlen(name) > 13) return false;
 606         return true;
 607 }
 608
 609 function provision_validate(subobj, message)
 610 {
 611         var lp = loadparm_init();
 612
 613         if (!valid_netbios_name(subobj.DOMAIN)) {
 614                 message("Invalid NetBIOS name for domain\n");
 615                 return false;
 616         }
 617
 618         if (!valid_netbios_name(subobj.NETBIOSNAME)) {
 619                 message("Invalid NetBIOS name for host\n");
 620                 return false;
 621         }
 622
 623
 624         if (strupper(lp.get("workgroup")) != strupper(subobj.DOMAIN)) {
 625                 message("workgroup '%s' in smb.conf must match chosen domain '%s'\n",
 626                         lp.get("workgroup"), subobj.DOMAIN);
 627                 return false;
 628         }
 629
 630         if (strupper(lp.get("realm")) != strupper(subobj.REALM)) {
 631                 message("realm '%s' in smb.conf must match chosen realm '%s'\n",
 632                         lp.get("realm"), subobj.REALM);
 633                 return false;
 634         }
 635
 636         return true;
 637 }
 638
 639 function join_domain(domain, netbios_name, join_type, creds, message)
 640 {
 641         var ctx = NetContext(creds);
 642         var joindom = new Object();
 643         joindom.domain = domain;
 644         joindom.join_type = join_type;
 645         joindom.netbios_name = netbios_name;
 646         if (!ctx.JoinDomain(joindom)) {
 647                 message("Domain Join failed: " + joindom.error_string);
 648                 return false;
 649         }
 650         return true;
 651 }
 652
 653 /* Vampire a remote domain.  Session info and credentials are required for for
 654  * access to our local database (might be remote ldap)
 655  */
 656
 657 function vampire(domain, session_info, credentials, message) {
 658         var ctx = NetContext(credentials);
 659         var vampire_ctx = new Object();
 660         var machine_creds = credentials_init();
 661         machine_creds.set_domain(form.DOMAIN);
 662         if (!machine_creds.set_machine_account()) {
 663                 message("Failed to access domain join information!");
 664                 return false;
 665         }
 666         vampire_ctx.machine_creds = machine_creds;
 667         vampire_ctx.session_info = session_info;
 668         if (!ctx.SamSyncLdb(vampire_ctx)) {
 669                 message("Migration of remote domain to Samba failed: " + vampire_ctx.error_string);
 670                 return false;
 671         }
 672
 673         return true;
 674 }
 675
 676 return 0;