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()
  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.rootdse = "rootdse.ldb";
 242         paths.secrets = "secrets.ldb";
 243         paths.dns = lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".zone";
 244         paths.winsdb = "wins.ldb";
 245         return paths;
 246 }
 247
 248 /*
 249   provision samba4 - caution, this wipes all existing data!
 250 */
 251 function provision(subobj, message, blank, paths)
 252 {
 253         var data = "";
 254         var lp = loadparm_init();
 255         var sys = sys_init();
 256
 257         /*
 258           some options need to be upper/lower case
 259         */
 260         subobj.REALM       = strupper(subobj.REALM);
 261         subobj.HOSTNAME    = strlower(subobj.HOSTNAME);
 262         subobj.DOMAIN      = strupper(subobj.DOMAIN);
 263         assert(valid_netbios_name(subobj.DOMAIN));
 264         subobj.NETBIOSNAME = strupper(subobj.HOSTNAME);
 265         assert(valid_netbios_name(subobj.NETBIOSNAME));
 266         var rdns = split(",", subobj.BASEDN);
 267         subobj.RDN_DC = substr(rdns[0], strlen("DC="));
 268
 269         data = add_foreign(data, "S-1-5-7",  "Anonymous",           "${NOBODY}");
 270         data = add_foreign(data, "S-1-1-0",  "World",               "${NOGROUP}");
 271         data = add_foreign(data, "S-1-5-2",  "Network",             "${NOGROUP}");
 272         data = add_foreign(data, "S-1-5-18", "System",              "${ROOT}");
 273         data = add_foreign(data, "S-1-5-11", "Authenticated Users", "${USERS}");
 274
 275         provision_next_usn = 1;
 276
 277         /* only install a new smb.conf if there isn't one there already */
 278         var st = sys.stat(paths.smbconf);
 279         if (st == undefined) {
 280                 message("Setting up smb.conf\n");
 281                 setup_file("provision.smb.conf", paths.smbconf, subobj);
 282                 lp.reload();
 283         }
 284         message("Setting up hklm.ldb\n");
 285         setup_ldb("hklm.ldif", paths.hklm, subobj);
 286         message("Setting up sam.ldb attributes\n");
 287         setup_ldb("provision_init.ldif", paths.samdb, subobj);
 288         message("Setting up sam.ldb schema\n");
 289         setup_ldb("schema.ldif", paths.samdb, subobj, NULL, false);
 290         message("Setting up sam.ldb templates\n");
 291         setup_ldb("provision_templates.ldif", paths.samdb, subobj, NULL, false);
 292         message("Setting up sam.ldb data\n");
 293         setup_ldb("provision.ldif", paths.samdb, subobj, NULL, false);
 294         if (blank == false) {
 295                 message("Setting up sam.ldb users and groups\n");
 296                 setup_ldb("provision_users.ldif", paths.samdb, subobj, data, false);
 297         }
 298         message("Setting up rootdse.ldb\n");
 299         setup_ldb("rootdse.ldif", paths.rootdse, subobj);
 300         message("Setting up secrets.ldb\n");
 301         setup_ldb("secrets.ldif", paths.secrets, subobj);
 302         message("Setting up DNS zone file\n");
 303         setup_file("provision.zone",
 304                    paths.dns,
 305                    subobj);
 306 }
 307
 308 /*
 309   guess reasonably default options for provisioning
 310 */
 311 function provision_guess()
 312 {
 313         var subobj = new Object();
 314         var nss = nss_init();
 315         var lp = loadparm_init();
 316         var rdn_list;
 317         random_init(local);
 318
 319         subobj.REALM        = strupper(lp.get("realm"));
 320         subobj.DOMAIN       = lp.get("workgroup");
 321         subobj.HOSTNAME     = hostname();
 322
 323         assert(subobj.REALM);
 324         assert(subobj.DOMAIN);
 325         assert(subobj.HOSTNAME);
 326
 327         subobj.HOSTIP       = hostip();
 328         subobj.DOMAINGUID   = randguid();
 329         subobj.DOMAINSID    = randsid();
 330         subobj.HOSTGUID     = randguid();
 331         subobj.INVOCATIONID = randguid();
 332         subobj.KRBTGTPASS   = randpass(12);
 333         subobj.MACHINEPASS  = randpass(12);
 334         subobj.ADMINPASS    = randpass(12);
 335         subobj.DEFAULTSITE  = "Default-First-Site-Name";
 336         subobj.NEWGUID      = randguid;
 337         subobj.NTTIME       = nttime;
 338         subobj.LDAPTIME     = ldaptime;
 339         subobj.DATESTRING   = datestring;
 340         subobj.USN          = nextusn;
 341         subobj.ROOT         = findnss(nss.getpwnam, "root");
 342         subobj.NOBODY       = findnss(nss.getpwnam, "nobody");
 343         subobj.NOGROUP      = findnss(nss.getgrnam, "nogroup", "nobody");
 344         subobj.WHEEL        = findnss(nss.getgrnam, "wheel", "root", "staff");
 345         subobj.USERS        = findnss(nss.getgrnam, "users", "guest", "other");
 346         subobj.DNSDOMAIN    = strlower(subobj.REALM);
 347         subobj.DNSNAME      = sprintf("%s.%s",
 348                                       strlower(subobj.HOSTNAME),
 349                                       subobj.DNSDOMAIN);
 350         rdn_list = split(".", subobj.DNSDOMAIN);
 351         subobj.BASEDN       = "DC=" + join(",DC=", rdn_list);
 352         return subobj;
 353 }
 354
 355 /*
 356   search for one attribute as a string
 357  */
 358 function searchone(ldb, expression, attribute)
 359 {
 360         var attrs = new Array(attribute);
 361         res = ldb.search(expression, attrs);
 362         if (res.length != 1 ||
 363             res[0][attribute] == undefined) {
 364                 return undefined;
 365         }
 366         return res[0][attribute];
 367 }
 368
 369 /*
 370   modify an account to remove the
 371 */
 372 function enable_account(ldb, user_dn)
 373 {
 374         var attrs = new Array("userAccountControl");
 375         var res = ldb.search(NULL, user_dn, ldb.SCOPE_ONELEVEL, attrs);
 376         assert(res.length == 1);
 377         var userAccountControl = res[0].userAccountControl;
 378         userAccountControl = userAccountControl - 2; /* remove disabled bit */
 379         var mod = sprintf("
 380 dn: %s
 381 changetype: modify
 382 replace: userAccountControl
 383 userAccountControl: %u
 384 ",
 385                           user_dn, userAccountControl);
 386         var ok = ldb.modify(mod);
 387         return ok;
 388 }
 389
 390
 391 /*
 392   add a new user record
 393 */
 394 function newuser(username, unixname, password, message)
 395 {
 396         var lp = loadparm_init();
 397         var samdb = lp.get("sam database");
 398         var ldb = ldb_init();
 399         random_init(local);
 400
 401         /* connect to the sam */
 402         var ok = ldb.connect(samdb);
 403         assert(ok);
 404
 405         ldb.transaction_start();
 406
 407         /* find the DNs for the domain and the domain users group */
 408         var domain_dn = searchone(ldb, "objectClass=domainDNS", "dn");
 409         assert(domain_dn != undefined);
 410         var dom_users = searchone(ldb, "name=Domain Users", "dn");
 411         assert(dom_users != undefined);
 412
 413         var user_dn = sprintf("CN=%s,CN=Users,%s", username, domain_dn);
 414
 415
 416         /*
 417           the new user record. note the reliance on the samdb module to fill
 418           in a sid, guid etc
 419         */
 420         var ldif = sprintf("
 421 dn: %s
 422 sAMAccountName: %s
 423 name: %s
 424 memberOf: %s
 425 unixName: %s
 426 objectGUID: %s
 427 unicodePwd: %s
 428 objectClass: user
 429 ",
 430                            user_dn, username, username, dom_users,
 431                            unixname, randguid(), password);
 432         /*
 433           add the user to the users group as well
 434         */
 435         var modgroup = sprintf("
 436 dn: %s
 437 changetype: modify
 438 add: member
 439 member: %s
 440 ",
 441                                dom_users, user_dn);
 442
 443
 444         /*
 445           now the real work
 446         */
 447         message("Adding user %s\n", user_dn);
 448         ok = ldb.add(ldif);
 449         if (ok != true) {
 450                 message("Failed to add %s - %s\n", user_dn, ldb.errstring());
 451                 return false;
 452         }
 453
 454         message("Modifying group %s\n", dom_users);
 455         ok = ldb.modify(modgroup);
 456         if (ok != true) {
 457                 message("Failed to modify %s - %s\n", dom_users, ldb.errstring());
 458                 return false;
 459         }
 460
 461         /*
 462           modify the userAccountControl to remove the disabled bit
 463         */
 464         ok = enable_account(ldb, user_dn);
 465         if (ok) {
 466                 ldb.transaction_commit();
 467         }
 468         return ok;
 469 }
 470
 471 // Check whether a name is valid as a NetBIOS name.
 472 // FIXME: There are probably more constraints here
 473 function valid_netbios_name(name)
 474 {
 475         if (strlen(name) > 13) return false;
 476         if (strstr(name, ".")) return false;
 477         return true;
 478 }
 479
 480 function provision_validate(subobj, message)
 481 {
 482         if (!valid_netbios_name(subobj.DOMAIN)) {
 483                 message("Invalid NetBIOS name for domain\n");
 484                 return false;
 485         }
 486
 487         if (!valid_netbios_name(subobj.NETBIOSNAME)) {
 488                 message("Invalid NetBIOS name for host\n");
 489                 return false;
 490         }
 491
 492         return true;
 493 }
 494
 495
 496 return 0;