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 cn: ${SID}
  60 description: ${DESC}
  61 instanceType: 4
  62 whenCreated: ${LDAPTIME}
  63 whenChanged: ${LDAPTIME}
  64 uSNCreated: 1
  65 uSNChanged: 1
  66 showInAdvancedViewOnly: TRUE
  67 name: ${SID}
  68 objectGUID: ${NEWGUID}
  69 objectSid: ${SID}
  70 objectCategory: CN=Foreign-Security-Principal,CN=Schema,CN=Configuration,${BASEDN}
  71 unixName: ${UNIXNAME}
  72 ";
  73         var sub = new Object();
  74         sub.SID = sid;
  75         sub.DESC = desc;
  76         sub.UNIXNAME = unixname;
  77         return str + substitute_var(add, sub);
  78 }
  79
  80 /*
  81   return current time as a nt time string
  82 */
  83 function nttime()
  84 {
  85         return "" + sys.nttime();
  86 }
  87
  88 /*
  89   return current time as a ldap time string
  90 */
  91 function ldaptime()
  92 {
  93         return sys.ldaptime(sys.nttime());
  94 }
  95
  96 /*
  97   return a date string suitable for a dns zone serial number
  98 */
  99 function datestring()
 100 {
 101         var t = sys.gmtime(sys.nttime());
 102         return sprintf("%04u%02u%02u%02u",
 103                        t.tm_year+1900, t.tm_mon+1, t.tm_mday, t.tm_hour);
 104 }
 105
 106 /*
 107   return first host IP
 108 */
 109 function hostip()
 110 {
 111         var list = sys.interfaces();
 112         return list[0];
 113 }
 114
 115 /*
 116   return current time as a ldap time string
 117 */
 118 function nextusn()
 119 {
 120         provision_next_usn = provision_next_usn+1;
 121         return provision_next_usn;
 122 }
 123
 124 /*
 125   return first part of hostname
 126 */
 127 function hostname()
 128 {
 129         var s = split(".", sys.hostname());
 130         return s[0];
 131 }
 132
 133
 134 /*
 135   erase an ldb, removing all records
 136 */
 137 function ldb_erase(ldb)
 138 {
 139         var attrs = new Array("dn");
 140
 141         /* delete the specials */
 142         ldb.del("@INDEXLIST");
 143         ldb.del("@ATTRIBUTES");
 144         ldb.del("@SUBCLASSES");
 145         ldb.del("@MODULES");
 146
 147         /* and the rest */
 148         var res = ldb.search("(|(objectclass=*)(dn=*))", attrs);
 149         var i;
 150         for (i=0;i<res.length;i++) {
 151                 ldb.del(res[i].dn);
 152         }
 153         res = ldb.search("(objectclass=*)", attrs);
 154         assert(res.length == 0);
 155 }
 156
 157
 158 /*
 159   setup a ldb in the private dir
 160  */
 161 function setup_ldb(ldif, dbname, subobj)
 162 {
 163         var extra = "";
 164         var ldb = ldb_init();
 165         var lp = loadparm_init();
 166
 167         if (arguments.length == 4) {
 168                 extra = arguments[3];
 169         }
 170
 171         var dbfile = dbname;
 172         var src = lp.get("setup directory") + "/" + ldif;
 173
 174         var data = sys.file_load(src);
 175         data = data + extra;
 176         data = substitute_var(data, subobj);
 177
 178         var ok = ldb.connect(dbfile);
 179         assert(ok);
 180
 181         ldb_erase(ldb);
 182
 183         ok = ldb.add(data);
 184         assert(ok);
 185 }
 186
 187 /*
 188   setup a file in the private dir
 189  */
 190 function setup_file(template, fname, subobj)
 191 {
 192         var lp = loadparm_init();
 193         var f = fname;
 194         var src = lp.get("setup directory") + "/" + template;
 195
 196         sys.unlink(f);
 197
 198         var data = sys.file_load(src);
 199         data = substitute_var(data, subobj);
 200
 201         ok = sys.file_save(f, data);
 202         assert(ok);
 203 }
 204
 205 /*
 206   provision samba4 - caution, this wipes all existing data!
 207 */
 208 function provision(subobj, message)
 209 {
 210         var data = "";
 211         var lp = loadparm_init();
 212         var sys = sys_init();
 213         var smbconf = lp.get("config file");
 214
 215         /*
 216           some options need to be upper/lower case
 217         */
 218         subobj.REALM       = strlower(subobj.REALM);
 219         subobj.HOSTNAME    = strlower(subobj.HOSTNAME);
 220         subobj.DOMAIN      = strupper(subobj.DOMAIN);
 221         subobj.NETBIOSNAME = strupper(subobj.HOSTNAME);
 222
 223         data = add_foreign(data, "S-1-5-7",  "Anonymous",           "${NOBODY}");
 224         data = add_foreign(data, "S-1-1-0",  "World",               "${NOGROUP}");
 225         data = add_foreign(data, "S-1-5-2",  "Network",             "${NOGROUP}");
 226         data = add_foreign(data, "S-1-5-18", "System",              "${ROOT}");
 227         data = add_foreign(data, "S-1-5-11", "Authenticated Users", "${USERS}");
 228
 229         provision_next_usn = 1;
 230
 231         /* only install a new smb.conf if there isn't one there already */
 232         var st = sys.stat(smbconf);
 233         if (st == undefined) {
 234                 message("Setting up smb.conf\n");
 235                 setup_file("provision.smb.conf", smbconf, subobj);
 236                 lp.reload();
 237         }
 238         message("Setting up hklm.ldb\n");
 239         setup_ldb("hklm.ldif", "hklm.ldb", subobj);
 240         message("Setting up sam.ldb\n");
 241         setup_ldb("provision.ldif", "sam.ldb", subobj, data);
 242         message("Setting up rootdse.ldb\n");
 243         setup_ldb("rootdse.ldif", "rootdse.ldb", subobj);
 244         message("Setting up secrets.ldb\n");
 245         setup_ldb("secrets.ldif", "secrets.ldb", subobj);
 246         message("Setting up DNS zone file\n");
 247         setup_file("provision.zone",
 248                    lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".zone",
 249                    subobj);
 250 }
 251
 252 /*
 253   guess reasonably default options for provisioning
 254 */
 255 function provision_guess()
 256 {
 257         var subobj = new Object();
 258         var nss = nss_init();
 259         var lp = loadparm_init();
 260         random_init(local);
 261
 262         subobj.REALM        = lp.get("realm");
 263         subobj.DOMAIN       = lp.get("workgroup");
 264         subobj.HOSTNAME     = hostname();
 265
 266         assert(subobj.REALM);
 267         assert(subobj.DOMAIN);
 268         assert(subobj.HOSTNAME);
 269
 270         subobj.HOSTIP       = hostip();
 271         subobj.DOMAINGUID   = randguid();
 272         subobj.DOMAINSID    = randsid();
 273         subobj.HOSTGUID     = randguid();
 274         subobj.INVOCATIONID = randguid();
 275         subobj.KRBTGTPASS   = randpass(12);
 276         subobj.MACHINEPASS  = randpass(12);
 277         subobj.ADMINPASS    = randpass(12);
 278         subobj.DEFAULTSITE  = "Default-First-Site-Name";
 279         subobj.NEWGUID      = randguid;
 280         subobj.NTTIME       = nttime;
 281         subobj.LDAPTIME     = ldaptime;
 282         subobj.DATESTRING   = datestring;
 283         subobj.USN          = nextusn;
 284         subobj.ROOT         = findnss(nss.getpwnam, "root");
 285         subobj.NOBODY       = findnss(nss.getpwnam, "nobody");
 286         subobj.NOGROUP      = findnss(nss.getgrnam, "nogroup", "nobody");
 287         subobj.WHEEL        = findnss(nss.getgrnam, "wheel", "root");
 288         subobj.USERS        = findnss(nss.getgrnam, "users", "guest", "other");
 289         subobj.DNSDOMAIN    = strlower(subobj.REALM);
 290         subobj.DNSNAME      = sprintf("%s.%s",
 291                                       strlower(subobj.HOSTNAME),
 292                                       subobj.DNSDOMAIN);
 293         subobj.BASEDN       = "DC=" + join(",DC=", split(".", subobj.REALM));
 294         return subobj;
 295 }
 296
 297 /*
 298   search for one attribute as a string
 299  */
 300 function searchone(ldb, expression, attribute)
 301 {
 302         var attrs = new Array(attribute);
 303         res = ldb.search(expression, attrs);
 304         if (res.length != 1 ||
 305             res[0][attribute] == undefined) {
 306                 return undefined;
 307         }
 308         return res[0][attribute];
 309 }
 310
 311 /*
 312   add a new user record
 313 */
 314 function newuser(username, unixname, password, message)
 315 {
 316         var lp = loadparm_init();
 317         var samdb = lp.get("sam database");
 318         var ldb = ldb_init();
 319         random_init(local);
 320
 321         /* connect to the sam */
 322         var ok = ldb.connect(samdb);
 323         assert(ok);
 324
 325         /* find the DNs for the domain and the domain users group */
 326         var domain_dn = searchone(ldb, "objectClass=domainDNS", "dn");
 327         assert(domain_dn != undefined);
 328         var dom_users = searchone(ldb, "name=Domain Users", "dn");
 329         assert(dom_users != undefined);
 330
 331         var user_dn = sprintf("CN=%s,CN=Users,%s", username, domain_dn);
 332
 333
 334         /*
 335           the new user record. note the reliance on the samdb module to fill
 336           in a sid, guid etc
 337         */
 338         var ldif = sprintf("
 339 dn: %s
 340 sAMAccountName: %s
 341 name: %s
 342 memberOf: %s
 343 unixName: %s
 344 objectGUID: %s
 345 unicodePwd: %s
 346 objectClass: user
 347 ",
 348                            user_dn, username, username, dom_users,
 349                            unixname, randguid(), password);
 350         /*
 351           add the user to the users group as well
 352         */
 353         var modgroup = sprintf("
 354 dn: %s
 355 changetype: modify
 356 add: member
 357 member: %s
 358 ",
 359                                dom_users, user_dn);
 360
 361
 362         /*
 363           now the real work
 364         */
 365         message("Adding user %s\n", user_dn);
 366         ok = ldb.add(ldif);
 367         if (ok != true) {
 368                 message("Failed to add %s - %s\n", user_dn, ldb.errstring());
 369                 return false;
 370         }
 371
 372         message("Modifying group %s\n", dom_users);
 373         ok = ldb.modify(modgroup);
 374         if (ok != true) {
 375                 message("Failed to modify %s - %s\n", dom_users, ldb.errstring());
 376                 return false;
 377         }
 378
 379         return true;
 380 }
 381
 382
 383 return 0;