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 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 next USN in the sequence
 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 erase = true;
 164         var extra = "";
 165         var ldb = ldb_init();
 166         var lp = loadparm_init();
 167
 168         if (arguments.length >= 4) {
 169                 extra = arguments[3];
 170         }
 171
 172         if (arguments.length == 5) {
 173                 erase = arguments[4];
 174         }
 175
 176         var dbfile = dbname;
 177         var src = lp.get("setup directory") + "/" + ldif;
 178
 179         var data = sys.file_load(src);
 180         data = data + extra;
 181         data = substitute_var(data, subobj);
 182
 183         var ok = ldb.connect(dbfile);
 184         assert(ok);
 185
 186         if (erase) {
 187                 ldb_erase(ldb);
 188         }
 189
 190         ok = ldb.add(data);
 191         assert(ok);
 192 }
 193
 194 /*
 195   setup a file in the private dir
 196  */
 197 function setup_file(template, fname, subobj)
 198 {
 199         var lp = loadparm_init();
 200         var f = fname;
 201         var src = lp.get("setup directory") + "/" + template;
 202
 203         sys.unlink(f);
 204
 205         var data = sys.file_load(src);
 206         data = substitute_var(data, subobj);
 207
 208         ok = sys.file_save(f, data);
 209         assert(ok);
 210 }
 211
 212 /*
 213   provision samba4 - caution, this wipes all existing data!
 214 */
 215 function provision(subobj, message)
 216 {
 217         var data = "";
 218         var lp = loadparm_init();
 219         var sys = sys_init();
 220         var smbconf = lp.get("config file");
 221
 222         /*
 223           some options need to be upper/lower case
 224         */
 225         subobj.REALM       = strlower(subobj.REALM);
 226         subobj.HOSTNAME    = strlower(subobj.HOSTNAME);
 227         subobj.DOMAIN      = strupper(subobj.DOMAIN);
 228         subobj.NETBIOSNAME = strupper(subobj.HOSTNAME);
 229
 230         data = add_foreign(data, "S-1-5-7",  "Anonymous",           "${NOBODY}");
 231         data = add_foreign(data, "S-1-1-0",  "World",               "${NOGROUP}");
 232         data = add_foreign(data, "S-1-5-2",  "Network",             "${NOGROUP}");
 233         data = add_foreign(data, "S-1-5-18", "System",              "${ROOT}");
 234         data = add_foreign(data, "S-1-5-11", "Authenticated Users", "${USERS}");
 235
 236         provision_next_usn = 1;
 237
 238         /* only install a new smb.conf if there isn't one there already */
 239         var st = sys.stat(smbconf);
 240         if (st == undefined) {
 241                 message("Setting up smb.conf\n");
 242                 setup_file("provision.smb.conf", smbconf, subobj);
 243                 lp.reload();
 244         }
 245         message("Setting up hklm.ldb\n");
 246         setup_ldb("hklm.ldif", "hklm.ldb", subobj);
 247         message("Setting up sam.ldb attributes\n");
 248         setup_ldb("provision_init.ldif", "sam.ldb", subobj);
 249         message("Setting up sam.ldb templates\n");
 250         setup_ldb("provision_templates.ldif", "sam.ldb", subobj, NULL, false);
 251         message("Setting up sam.ldb data\n");
 252         setup_ldb("provision.ldif", "sam.ldb", subobj, data, false);
 253         message("Setting up rootdse.ldb\n");
 254         setup_ldb("rootdse.ldif", "rootdse.ldb", subobj);
 255         message("Setting up secrets.ldb\n");
 256         setup_ldb("secrets.ldif", "secrets.ldb", subobj);
 257         message("Setting up DNS zone file\n");
 258         setup_file("provision.zone",
 259                    lp.get("private dir") + "/" + subobj.DNSDOMAIN + ".zone",
 260                    subobj);
 261 }
 262
 263 /*
 264   guess reasonably default options for provisioning
 265 */
 266 function provision_guess()
 267 {
 268         var subobj = new Object();
 269         var nss = nss_init();
 270         var lp = loadparm_init();
 271         random_init(local);
 272
 273         subobj.REALM        = lp.get("realm");
 274         subobj.DOMAIN       = lp.get("workgroup");
 275         subobj.HOSTNAME     = hostname();
 276
 277         assert(subobj.REALM);
 278         assert(subobj.DOMAIN);
 279         assert(subobj.HOSTNAME);
 280
 281         subobj.HOSTIP       = hostip();
 282         subobj.DOMAINGUID   = randguid();
 283         subobj.DOMAINSID    = randsid();
 284         subobj.HOSTGUID     = randguid();
 285         subobj.INVOCATIONID = randguid();
 286         subobj.KRBTGTPASS   = randpass(12);
 287         subobj.MACHINEPASS  = randpass(12);
 288         subobj.ADMINPASS    = randpass(12);
 289         subobj.DEFAULTSITE  = "Default-First-Site-Name";
 290         subobj.NEWGUID      = randguid;
 291         subobj.NTTIME       = nttime;
 292         subobj.LDAPTIME     = ldaptime;
 293         subobj.DATESTRING   = datestring;
 294         subobj.USN          = nextusn;
 295         subobj.ROOT         = findnss(nss.getpwnam, "root");
 296         subobj.NOBODY       = findnss(nss.getpwnam, "nobody");
 297         subobj.NOGROUP      = findnss(nss.getgrnam, "nogroup", "nobody");
 298         subobj.WHEEL        = findnss(nss.getgrnam, "wheel", "root");
 299         subobj.USERS        = findnss(nss.getgrnam, "users", "guest", "other");
 300         subobj.DNSDOMAIN    = strlower(subobj.REALM);
 301         subobj.DNSNAME      = sprintf("%s.%s",
 302                                       strlower(subobj.HOSTNAME),
 303                                       subobj.DNSDOMAIN);
 304         subobj.BASEDN       = "DC=" + join(",DC=", split(".", subobj.REALM));
 305         return subobj;
 306 }
 307
 308 /*
 309   search for one attribute as a string
 310  */
 311 function searchone(ldb, expression, attribute)
 312 {
 313         var attrs = new Array(attribute);
 314         res = ldb.search(expression, attrs);
 315         if (res.length != 1 ||
 316             res[0][attribute] == undefined) {
 317                 return undefined;
 318         }
 319         return res[0][attribute];
 320 }
 321
 322 /*
 323   add a new user record
 324 */
 325 function newuser(username, unixname, password, message)
 326 {
 327         var lp = loadparm_init();
 328         var samdb = lp.get("sam database");
 329         var ldb = ldb_init();
 330         random_init(local);
 331
 332         /* connect to the sam */
 333         var ok = ldb.connect(samdb);
 334         assert(ok);
 335
 336         /* find the DNs for the domain and the domain users group */
 337         var domain_dn = searchone(ldb, "objectClass=domainDNS", "dn");
 338         assert(domain_dn != undefined);
 339         var dom_users = searchone(ldb, "name=Domain Users", "dn");
 340         assert(dom_users != undefined);
 341
 342         var user_dn = sprintf("CN=%s,CN=Users,%s", username, domain_dn);
 343
 344
 345         /*
 346           the new user record. note the reliance on the samdb module to fill
 347           in a sid, guid etc
 348         */
 349         var ldif = sprintf("
 350 dn: %s
 351 sAMAccountName: %s
 352 name: %s
 353 memberOf: %s
 354 unixName: %s
 355 objectGUID: %s
 356 unicodePwd: %s
 357 objectClass: user
 358 ",
 359                            user_dn, username, username, dom_users,
 360                            unixname, randguid(), password);
 361         /*
 362           add the user to the users group as well
 363         */
 364         var modgroup = sprintf("
 365 dn: %s
 366 changetype: modify
 367 add: member
 368 member: %s
 369 ",
 370                                dom_users, user_dn);
 371
 372
 373         /*
 374           now the real work
 375         */
 376         message("Adding user %s\n", user_dn);
 377         ok = ldb.add(ldif);
 378         if (ok != true) {
 379                 message("Failed to add %s - %s\n", user_dn, ldb.errstring());
 380                 return false;
 381         }
 382
 383         message("Modifying group %s\n", dom_users);
 384         ok = ldb.modify(modgroup);
 385         if (ok != true) {
 386                 message("Failed to modify %s - %s\n", dom_users, ldb.errstring());
 387                 return false;
 388         }
 389
 390         return true;
 391 }
 392
 393
 394 return 0;