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