source4/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()
  16 {
  17         var lp = loadparm_init();
  18         var ldb = ldb_init();
  19         if (lp.get("realm") == "") {
  20                 return false;
  21         }
  22         var ok = ldb.connect(lp.get("sam database"));
  23         if (!ok) {
  24                 return false;
  25         }
  26         var res = ldb.search("(name=Administrator)");
  27         if (res.length != 1) {
  28                 return false;
  29         }
  30         return true;
  31 }
  32
  33 /*
  34   find a user or group from a list of possibilities
  35 */
  36 function findnss()
  37 {
  38         var i;
  39         assert(arguments.length >= 2);
  40         var nssfn = arguments[0];
  41         for (i=1;i<arguments.length;i++) {
  42                 if (nssfn(arguments[i]) != undefined) {
  43                         return arguments[i];
  44                 }
  45         }
  46         printf("Unable to find user/group for %s\n", arguments[1]);
  47         assert(i<arguments.length);
  48 }
  49
  50 /*
  51    add a foreign security principle
  52  */
  53 function add_foreign(str, sid, desc, unixname)
  54 {
  55         var add = "
  56 dn: CN=${SID},CN=ForeignSecurityPrincipals,${BASEDN}
  57 objectClass: top
  58 objectClass: foreignSecurityPrincipal
  59 description: ${DESC}
  60 unixName: ${UNIXNAME}
  61 uSNCreated: 1
  62 uSNChanged: 1
  63 ";
  64         var sub = new Object();
  65         sub.SID = sid;
  66         sub.DESC = desc;
  67         sub.UNIXNAME = unixname;
  68         return str + substitute_var(add, sub);
  69 }
  70
  71 /*
  72   return current time as a nt time string
  73 */
  74 function nttime()
  75 {
  76         return "" + sys.nttime();
  77 }
  78
  79 /*
  80   return current time as a ldap time string
  81 */
  82 function ldaptime()
  83 {
  84         return sys.ldaptime(sys.nttime());
  85 }
  86
  87 /*
  88   return a date string suitable for a dns zone serial number
  89 */
  90 function datestring()
  91 {
  92         var t = sys.gmtime(sys.nttime());
  93         return sprintf("%04u%02u%02u%02u",
  94                        t.tm_year+1900, t.tm_mon+1, t.tm_mday, t.tm_hour);
  95 }
  96
  97 /*
  98   return first host IP
  99 */
 100 function hostip()
 101 {
 102         var list = sys.interfaces();
 103         return list[0];
 104 }
 105
 106 /*
 107   return next USN in the sequence
 108 */
 109 function nextusn()
 110 {
 111         provision_next_usn = provision_next_usn+1;
 112         return provision_next_usn;
 113 }
 114
 115 /*
 116   return first part of hostname
 117 */
 118 function hostname()
 119 {
 120         var s = split(".", sys.hostname());
 121         return s[0];
 122 }
 123
 124
 125 /* the ldb is in bad shape, possibly due to being built from an
 126    incompatible previous version of the code, so delete it
 127    completely */
 128 function ldb_delete(ldb)
 129 {
 130         println("Deleting " + ldb.filename);
 131         var lp = loadparm_init();
 132         sys.unlink(sprintf("%s/%s", lp.get("private dir"), ldb.filename));
 133         ldb.transaction_cancel();
 134         ldb.close();
 135         var ok = ldb.connect(ldb.filename);
 136         ldb.transaction_start();
 137         assert(ok);
 138 }
 139
 140 /*
 141   erase an ldb, removing all records
 142 */
 143 function ldb_erase(ldb)
 144 {
 145         var attrs = new Array("dn");
 146
 147         /* delete the specials */
 148         ldb.del("@INDEXLIST");
 149         ldb.del("@ATTRIBUTES");
 150         ldb.del("@SUBCLASSES");
 151         ldb.del("@MODULES");
 152
 153         /* and the rest */
 154         var res = ldb.search("(&(|(objectclass=*)(dn=*))(!(dn=@BASEINFO)))", attrs);
 155         var i;
 156         if (typeof(res) == "undefined") {
 157                 ldb_delete(ldb);
 158                 return;
 159         }
 160         for (i=0;i<res.length;i++) {
 161                 ldb.del(res[i].dn);
 162         }
 163         var res = ldb.search("(&(|(objectclass=*)(dn=*))(!(dn=@BASEINFO)))", attrs);
 164         if (res.length != 0) {
 165                 ldb_delete(ldb);
 166                 return;
 167         }
 168         assert(res.length == 0);
 169 }
 170
 171 /*
 172   setup a ldb in the private dir
 173  */
 174 function setup_ldb(ldif, dbname, subobj)
 175 {
 176         var erase = true;
 177         var extra = "";
 178         var ldb = ldb_init();
 179         var lp = loadparm_init();
 180
 181         if (arguments.length >= 4) {
 182                 extra = arguments[3];
 183         }
 184
 185         if (arguments.length == 5) {
 186                 erase = arguments[4];
 187         }
 188
 189         var src = lp.get("setup directory") + "/" + ldif;
 190
 191         var data = sys.file_load(src);
 192         data = data + extra;
 193         data = substitute_var(data, subobj);
 194
 195         ldb.filename = dbname;
 196
 197         var connect_ok = ldb.connect(dbname);
 198         assert(connect_ok);
 199
 200         ldb.transaction_start();
 201
 202         if (erase) {
 203                 ldb_erase(ldb);
 204         }
 205
 206         var add_ok = ldb.add(data);
 207         assert(add_ok);
 208         ldb.transaction_commit();
 209 }
 210
 211 /*
 212   setup a file in the private dir
 213  */
 214 function setup_file(template, fname, subobj)
 215 {
 216         var lp = loadparm_init();
 217         var f = fname;
 218         var src = lp.get("setup directory") + "/" + template;
 219
 220         sys.unlink(f);
 221
 222         var data = sys.file_load(src);
 223         data = substitute_var(data, subobj);
 224
 225         ok = sys.file_save(f, data);
 226         assert(ok);
 227 }
 228
 229 function provision_default_paths(subobj)
 230 {
 231         var lp = loadparm_init();
 232         var paths = new Object();
 233         paths.smbconf = lp.get("config file");
 234         paths.hklm = "hklm.ldb";
 235         paths.hkcu = "hkcu.ldb";
 236         paths.hkcr = "hkcr.ldb";
 237         paths.hku = "hku.ldb";
 238         paths.hkpd = "hkpd.ldb";
 239         paths.hkpt = "hkpt.ldb";
 240         paths.samdb = "sam.ldb";
 241         paths.secrets = "secrets.ldb";
 242         paths.dns = lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".zone";
 243         paths.winsdb = "wins.ldb";
 244         return paths;
 245 }
 246
 247 /*
 248   provision samba4 - caution, this wipes all existing data!
 249 */
 250 function provision(subobj, message, blank, paths)
 251 {
 252         var data = "";
 253         var lp = loadparm_init();
 254         var sys = sys_init();
 255
 256         /*
 257           some options need to be upper/lower case
 258         */
 259         subobj.REALM       = strupper(subobj.REALM);
 260         subobj.HOSTNAME    = strlower(subobj.HOSTNAME);
 261         subobj.DOMAIN      = strupper(subobj.DOMAIN);
 262         assert(valid_netbios_name(subobj.DOMAIN));
 263         subobj.NETBIOSNAME = strupper(subobj.HOSTNAME);
 264         assert(valid_netbios_name(subobj.NETBIOSNAME));
 265         var rdns = split(",", subobj.BASEDN);
 266         subobj.RDN_DC = substr(rdns[0], strlen("DC="));
 267
 268         data = add_foreign(data, "S-1-5-7",  "Anonymous",           "${NOBODY}");
 269         data = add_foreign(data, "S-1-1-0",  "World",               "${NOGROUP}");
 270         data = add_foreign(data, "S-1-5-2",  "Network",             "${NOGROUP}");
 271         data = add_foreign(data, "S-1-5-18", "System",              "${ROOT}");
 272         data = add_foreign(data, "S-1-5-11", "Authenticated Users", "${USERS}");
 273
 274         provision_next_usn = 1;
 275
 276         /* only install a new smb.conf if there isn't one there already */
 277         var st = sys.stat(paths.smbconf);
 278         if (st == undefined) {
 279                 message("Setting up smb.conf\n");
 280                 setup_file("provision.smb.conf", paths.smbconf, subobj);
 281                 lp.reload();
 282         }
 283         message("Setting up hklm.ldb\n");
 284         setup_ldb("hklm.ldif", paths.hklm, subobj);
 285         message("Setting up sam.ldb attributes\n");
 286         setup_ldb("provision_init.ldif", paths.samdb, subobj);
 287         message("Setting up sam.ldb schema\n");
 288         setup_ldb("schema.ldif", paths.samdb, subobj, NULL, false);
 289         message("Setting up display specifiers\n");
 290         setup_ldb("display_specifiers.ldif", paths.samdb, subobj, NULL, false);
 291         message("Setting up sam.ldb templates\n");
 292         setup_ldb("provision_templates.ldif", paths.samdb, subobj, NULL, false);
 293         message("Setting up sam.ldb data\n");
 294         setup_ldb("provision.ldif", paths.samdb, subobj, NULL, false);
 295         if (blank == false) {
 296                 message("Setting up sam.ldb users and groups\n");
 297                 setup_ldb("provision_users.ldif", paths.samdb, subobj, data, false);
 298         }
 299         message("Setting up secrets.ldb\n");
 300         setup_ldb("secrets.ldif", paths.secrets, subobj);
 301         message("Setting up DNS zone file\n");
 302         setup_file("provision.zone",
 303                    paths.dns,
 304                    subobj);
 305 }
 306
 307 /*
 308   guess reasonably default options for provisioning
 309 */
 310 function provision_guess()
 311 {
 312         var subobj = new Object();
 313         var nss = nss_init();
 314         var lp = loadparm_init();
 315         var rdn_list;
 316         random_init(local);
 317
 318         subobj.REALM        = strupper(lp.get("realm"));
 319         subobj.DOMAIN       = lp.get("workgroup");
 320         subobj.HOSTNAME     = hostname();
 321
 322         assert(subobj.REALM);
 323         assert(subobj.DOMAIN);
 324         assert(subobj.HOSTNAME);
 325
 326         subobj.HOSTIP       = hostip();
 327         subobj.DOMAINGUID   = randguid();
 328         subobj.DOMAINSID    = randsid();
 329         subobj.HOSTGUID     = randguid();
 330         subobj.INVOCATIONID = randguid();
 331         subobj.KRBTGTPASS   = randpass(12);
 332         subobj.MACHINEPASS  = randpass(12);
 333         subobj.ADMINPASS    = randpass(12);
 334         subobj.DEFAULTSITE  = "Default-First-Site-Name";
 335         subobj.NEWGUID      = randguid;
 336         subobj.NTTIME       = nttime;
 337         subobj.LDAPTIME     = ldaptime;
 338         subobj.DATESTRING   = datestring;
 339         subobj.USN          = nextusn;
 340         subobj.ROOT         = findnss(nss.getpwnam, "root");
 341         subobj.NOBODY       = findnss(nss.getpwnam, "nobody");
 342         subobj.NOGROUP      = findnss(nss.getgrnam, "nogroup", "nobody");
 343         subobj.WHEEL        = findnss(nss.getgrnam, "wheel", "root", "staff");
 344         subobj.USERS        = findnss(nss.getgrnam, "users", "guest", "other");
 345         subobj.DNSDOMAIN    = strlower(subobj.REALM);
 346         subobj.DNSNAME      = sprintf("%s.%s",
 347                                       strlower(subobj.HOSTNAME),
 348                                       subobj.DNSDOMAIN);
 349         rdn_list = split(".", subobj.DNSDOMAIN);
 350         subobj.BASEDN       = "DC=" + join(",DC=", rdn_list);
 351         return subobj;
 352 }
 353
 354 /*
 355   search for one attribute as a string
 356  */
 357 function searchone(ldb, expression, attribute)
 358 {
 359         var attrs = new Array(attribute);
 360         res = ldb.search(expression, attrs);
 361         if (res.length != 1 ||
 362             res[0][attribute] == undefined) {
 363                 return undefined;
 364         }
 365         return res[0][attribute];
 366 }
 367
 368 /*
 369   modify an account to remove the
 370 */
 371 function enable_account(ldb, user_dn)
 372 {
 373         var attrs = new Array("userAccountControl");
 374         var res = ldb.search(NULL, user_dn, ldb.SCOPE_ONELEVEL, attrs);
 375         assert(res.length == 1);
 376         var userAccountControl = res[0].userAccountControl;
 377         userAccountControl = userAccountControl - 2; /* remove disabled bit */
 378         var mod = sprintf("
 379 dn: %s
 380 changetype: modify
 381 replace: userAccountControl
 382 userAccountControl: %u
 383 ",
 384                           user_dn, userAccountControl);
 385         var ok = ldb.modify(mod);
 386         return ok;
 387 }
 388
 389
 390 /*
 391   add a new user record
 392 */
 393 function newuser(username, unixname, password, message)
 394 {
 395         var lp = loadparm_init();
 396         var samdb = lp.get("sam database");
 397         var ldb = ldb_init();
 398         random_init(local);
 399
 400         /* connect to the sam */
 401         var ok = ldb.connect(samdb);
 402         assert(ok);
 403
 404         ldb.transaction_start();
 405
 406         /* find the DNs for the domain and the domain users group */
 407         var domain_dn = searchone(ldb, "objectClass=domainDNS", "dn");
 408         assert(domain_dn != undefined);
 409         var dom_users = searchone(ldb, "name=Domain Users", "dn");
 410         assert(dom_users != undefined);
 411
 412         var user_dn = sprintf("CN=%s,CN=Users,%s", username, domain_dn);
 413
 414
 415         /*
 416           the new user record. note the reliance on the samdb module to fill
 417           in a sid, guid etc
 418         */
 419         var ldif = sprintf("
 420 dn: %s
 421 sAMAccountName: %s
 422 name: %s
 423 memberOf: %s
 424 unixName: %s
 425 objectGUID: %s
 426 unicodePwd: %s
 427 objectClass: user
 428 ",
 429                            user_dn, username, username, dom_users,
 430                            unixname, randguid(), password);
 431         /*
 432           add the user to the users group as well
 433         */
 434         var modgroup = sprintf("
 435 dn: %s
 436 changetype: modify
 437 add: member
 438 member: %s
 439 ",
 440                                dom_users, user_dn);
 441
 442
 443         /*
 444           now the real work
 445         */
 446         message("Adding user %s\n", user_dn);
 447         ok = ldb.add(ldif);
 448         if (ok != true) {
 449                 message("Failed to add %s - %s\n", user_dn, ldb.errstring());
 450                 return false;
 451         }
 452
 453         message("Modifying group %s\n", dom_users);
 454         ok = ldb.modify(modgroup);
 455         if (ok != true) {
 456                 message("Failed to modify %s - %s\n", dom_users, ldb.errstring());
 457                 return false;
 458         }
 459
 460         /*
 461           modify the userAccountControl to remove the disabled bit
 462         */
 463         ok = enable_account(ldb, user_dn);
 464         if (ok) {
 465                 ldb.transaction_commit();
 466         }
 467         return ok;
 468 }
 469
 470 // Check whether a name is valid as a NetBIOS name.
 471 // FIXME: There are probably more constraints here
 472 function valid_netbios_name(name)
 473 {
 474         if (strlen(name) > 13) return false;
 475         if (strstr(name, ".")) return false;
 476         return true;
 477 }
 478
 479 function provision_validate(subobj, message)
 480 {
 481         if (!valid_netbios_name(subobj.DOMAIN)) {
 482                 message("Invalid NetBIOS name for domain\n");
 483                 return false;
 484         }
 485
 486         if (!valid_netbios_name(subobj.NETBIOSNAME)) {
 487                 message("Invalid NetBIOS name for host\n");
 488                 return false;
 489         }
 490
 491         return true;
 492 }
 493
 494
 495 return 0;