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 /*
 126   erase an ldb, removing all records
 127 */
 128 function ldb_erase(ldb)
 129 {
 130         var attrs = new Array("dn");
 131
 132         /* delete the specials */
 133         ldb.del("@INDEXLIST");
 134         ldb.del("@ATTRIBUTES");
 135         ldb.del("@SUBCLASSES");
 136         ldb.del("@MODULES");
 137
 138         /* and the rest */
 139         var res = ldb.search("(|(objectclass=*)(dn=*))", attrs);
 140         var i;
 141         for (i=0;i<res.length;i++) {
 142                 ldb.del(res[i].dn);
 143         }
 144         res = ldb.search("(objectclass=*)", attrs);
 145         assert(res.length == 0);
 146 }
 147
 148
 149 /*
 150   setup a ldb in the private dir
 151  */
 152 function setup_ldb(ldif, dbname, subobj)
 153 {
 154         var erase = true;
 155         var extra = "";
 156         var ldb = ldb_init();
 157         var lp = loadparm_init();
 158
 159         if (arguments.length >= 4) {
 160                 extra = arguments[3];
 161         }
 162
 163         if (arguments.length == 5) {
 164                 erase = arguments[4];
 165         }
 166
 167         var src = lp.get("setup directory") + "/" + ldif;
 168
 169         var data = sys.file_load(src);
 170         data = data + extra;
 171         data = substitute_var(data, subobj);
 172
 173         var ok = ldb.connect(dbname);
 174         assert(ok);
 175
 176         if (erase) {
 177                 ldb_erase(ldb);
 178         }
 179
 180         ok = ldb.add(data);
 181         assert(ok);
 182 }
 183
 184 /*
 185   setup a file in the private dir
 186  */
 187 function setup_file(template, fname, subobj)
 188 {
 189         var lp = loadparm_init();
 190         var f = fname;
 191         var src = lp.get("setup directory") + "/" + template;
 192
 193         sys.unlink(f);
 194
 195         var data = sys.file_load(src);
 196         data = substitute_var(data, subobj);
 197
 198         ok = sys.file_save(f, data);
 199         assert(ok);
 200 }
 201
 202 function provision_default_paths(subobj)
 203 {
 204         var lp = loadparm_init();
 205         var paths = new Object();
 206         paths.smbconf = lp.get("config file");
 207         paths.hklm = "hklm.ldb";
 208         paths.hkcu = "hkcu.ldb";
 209         paths.hkcr = "hkcr.ldb";
 210         paths.hku = "hku.ldb";
 211         paths.hkpd = "hkpd.ldb";
 212         paths.hkpt = "hkpt.ldb";
 213         paths.samdb = "sam.ldb";
 214         paths.rootdse = "rootdse.ldb";
 215         paths.secrets = "secrets.ldb";
 216         paths.dns = lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".zone";
 217         paths.winsdb = "wins.ldb";
 218         return paths;
 219 }
 220
 221 /*
 222   provision samba4 - caution, this wipes all existing data!
 223 */
 224 function provision(subobj, message, blank, paths)
 225 {
 226         var data = "";
 227         var lp = loadparm_init();
 228         var sys = sys_init();
 229
 230         /*
 231           some options need to be upper/lower case
 232         */
 233         subobj.REALM       = strlower(subobj.REALM);
 234         subobj.HOSTNAME    = strlower(subobj.HOSTNAME);
 235         subobj.DOMAIN      = strupper(subobj.DOMAIN);
 236         assert(valid_netbios_name(subobj.DOMAIN));
 237         subobj.NETBIOSNAME = strupper(subobj.HOSTNAME);
 238         assert(valid_netbios_name(subobj.NETBIOSNAME));
 239         var rdns = split(",", subobj.BASEDN);
 240         subobj.RDN_DC = substr(rdns[0], strlen("DC="));
 241
 242         data = add_foreign(data, "S-1-5-7",  "Anonymous",           "${NOBODY}");
 243         data = add_foreign(data, "S-1-1-0",  "World",               "${NOGROUP}");
 244         data = add_foreign(data, "S-1-5-2",  "Network",             "${NOGROUP}");
 245         data = add_foreign(data, "S-1-5-18", "System",              "${ROOT}");
 246         data = add_foreign(data, "S-1-5-11", "Authenticated Users", "${USERS}");
 247
 248         provision_next_usn = 1;
 249
 250         /* only install a new smb.conf if there isn't one there already */
 251         var st = sys.stat(paths.smbconf);
 252         if (st == undefined) {
 253                 message("Setting up smb.conf\n");
 254                 setup_file("provision.smb.conf", paths.smbconf, subobj);
 255                 lp.reload();
 256         }
 257         message("Setting up hklm.ldb\n");
 258         setup_ldb("hklm.ldif", paths.hklm, subobj);
 259         message("Setting up sam.ldb attributes\n");
 260         setup_ldb("provision_init.ldif", paths.samdb, subobj);
 261         message("Setting up sam.ldb templates\n");
 262         setup_ldb("provision_templates.ldif", paths.samdb, subobj, NULL, false);
 263         message("Setting up sam.ldb data\n");
 264         setup_ldb("provision.ldif", paths.samdb, subobj, NULL, false);
 265         if (blank == false) {
 266                 message("Setting up sam.ldb users and groups\n");
 267                 setup_ldb("provision_users.ldif", paths.samdb, subobj, data, false);
 268         }
 269         message("Setting up rootdse.ldb\n");
 270         setup_ldb("rootdse.ldif", paths.rootdse, subobj);
 271         message("Setting up secrets.ldb\n");
 272         setup_ldb("secrets.ldif", paths.secrets, subobj);
 273         message("Setting up DNS zone file\n");
 274         setup_file("provision.zone",
 275                    paths.dns,
 276                    subobj);
 277 }
 278
 279 /*
 280   guess reasonably default options for provisioning
 281 */
 282 function provision_guess()
 283 {
 284         var subobj = new Object();
 285         var nss = nss_init();
 286         var lp = loadparm_init();
 287         var rdn_list;
 288         random_init(local);
 289
 290         subobj.REALM        = lp.get("realm");
 291         subobj.DOMAIN       = lp.get("workgroup");
 292         subobj.HOSTNAME     = hostname();
 293
 294         assert(subobj.REALM);
 295         assert(subobj.DOMAIN);
 296         assert(subobj.HOSTNAME);
 297
 298         subobj.HOSTIP       = hostip();
 299         subobj.DOMAINGUID   = randguid();
 300         subobj.DOMAINSID    = randsid();
 301         subobj.HOSTGUID     = randguid();
 302         subobj.INVOCATIONID = randguid();
 303         subobj.KRBTGTPASS   = randpass(12);
 304         subobj.MACHINEPASS  = randpass(12);
 305         subobj.ADMINPASS    = randpass(12);
 306         subobj.DEFAULTSITE  = "Default-First-Site-Name";
 307         subobj.NEWGUID      = randguid;
 308         subobj.NTTIME       = nttime;
 309         subobj.LDAPTIME     = ldaptime;
 310         subobj.DATESTRING   = datestring;
 311         subobj.USN          = nextusn;
 312         subobj.ROOT         = findnss(nss.getpwnam, "root");
 313         subobj.NOBODY       = findnss(nss.getpwnam, "nobody");
 314         subobj.NOGROUP      = findnss(nss.getgrnam, "nogroup", "nobody");
 315         subobj.WHEEL        = findnss(nss.getgrnam, "wheel", "root", "staff");
 316         subobj.USERS        = findnss(nss.getgrnam, "users", "guest", "other");
 317         subobj.DNSDOMAIN    = strlower(subobj.REALM);
 318         subobj.DNSNAME      = sprintf("%s.%s",
 319                                       strlower(subobj.HOSTNAME),
 320                                       subobj.DNSDOMAIN);
 321         rdn_list = split(".", subobj.REALM);
 322         subobj.BASEDN       = "DC=" + join(",DC=", rdn_list);
 323         return subobj;
 324 }
 325
 326 /*
 327   search for one attribute as a string
 328  */
 329 function searchone(ldb, expression, attribute)
 330 {
 331         var attrs = new Array(attribute);
 332         res = ldb.search(expression, attrs);
 333         if (res.length != 1 ||
 334             res[0][attribute] == undefined) {
 335                 return undefined;
 336         }
 337         return res[0][attribute];
 338 }
 339
 340 /*
 341   modify an account to remove the
 342 */
 343 function enable_account(ldb, user_dn)
 344 {
 345         var attrs = new Array("userAccountControl");
 346         var res = ldb.search(NULL, user_dn, ldb.SCOPE_ONELEVEL, attrs);
 347         assert(res.length == 1);
 348         var userAccountControl = res[0].userAccountControl;
 349         userAccountControl = userAccountControl - 2; /* remove disabled bit */
 350         var mod = sprintf("
 351 dn: %s
 352 changetype: modify
 353 replace: userAccountControl
 354 userAccountControl: %u
 355 ",
 356                           user_dn, userAccountControl);
 357         var ok = ldb.modify(mod);
 358         return ok;
 359 }
 360
 361
 362 /*
 363   add a new user record
 364 */
 365 function newuser(username, unixname, password, message)
 366 {
 367         var lp = loadparm_init();
 368         var samdb = lp.get("sam database");
 369         var ldb = ldb_init();
 370         random_init(local);
 371
 372         /* connect to the sam */
 373         var ok = ldb.connect(samdb);
 374         assert(ok);
 375
 376         /* find the DNs for the domain and the domain users group */
 377         var domain_dn = searchone(ldb, "objectClass=domainDNS", "dn");
 378         assert(domain_dn != undefined);
 379         var dom_users = searchone(ldb, "name=Domain Users", "dn");
 380         assert(dom_users != undefined);
 381
 382         var user_dn = sprintf("CN=%s,CN=Users,%s", username, domain_dn);
 383
 384
 385         /*
 386           the new user record. note the reliance on the samdb module to fill
 387           in a sid, guid etc
 388         */
 389         var ldif = sprintf("
 390 dn: %s
 391 sAMAccountName: %s
 392 name: %s
 393 memberOf: %s
 394 unixName: %s
 395 objectGUID: %s
 396 unicodePwd: %s
 397 objectClass: user
 398 ",
 399                            user_dn, username, username, dom_users,
 400                            unixname, randguid(), password);
 401         /*
 402           add the user to the users group as well
 403         */
 404         var modgroup = sprintf("
 405 dn: %s
 406 changetype: modify
 407 add: member
 408 member: %s
 409 ",
 410                                dom_users, user_dn);
 411
 412
 413         /*
 414           now the real work
 415         */
 416         message("Adding user %s\n", user_dn);
 417         ok = ldb.add(ldif);
 418         if (ok != true) {
 419                 message("Failed to add %s - %s\n", user_dn, ldb.errstring());
 420                 return false;
 421         }
 422
 423         message("Modifying group %s\n", dom_users);
 424         ok = ldb.modify(modgroup);
 425         if (ok != true) {
 426                 message("Failed to modify %s - %s\n", dom_users, ldb.errstring());
 427                 return false;
 428         }
 429
 430         /*
 431           modify the userAccountControl to remove the disabled bit
 432         */
 433         return enable_account(ldb, user_dn);
 434 }
 435
 436 // Check whether a name is valid as a NetBIOS name.
 437 // FIXME: There are probably more constraints here
 438 function valid_netbios_name(name)
 439 {
 440         if (strlen(name) > 13) return false;
 441         if (strstr(name, ".")) return false;
 442         return true;
 443 }
 444
 445 function provision_validate(subobj, message)
 446 {
 447         if (!valid_netbios_name(subobj.DOMAIN)) {
 448                 message("Invalid NetBIOS name for domain\n");
 449                 return false;
 450         }
 451
 452         if (!valid_netbios_name(subobj.NETBIOSNAME)) {
 453                 message("Invalid NetBIOS name for host\n");
 454                 return false;
 455         }
 456
 457         return true;
 458 }
 459
 460
 461 return 0;