64fedc7284eaac26b52494a7069ba6287bf6a95f
[kai/samba-autobuild/.git] / source / passdb / secrets.c
1 /* 
2    Unix SMB/CIFS implementation.
3    Copyright (C) Andrew Tridgell 1992-2001
4    Copyright (C) Andrew Bartlett      2002
5    Copyright (C) Rafal Szczesniak     2002
6    
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11    
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16    
17    You should have received a copy of the GNU General Public License
18    along with this program; if not, write to the Free Software
19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 */
21
22 /* the Samba secrets database stores any generated, private information
23    such as the local SID and machine trust password */
24
25 #include "includes.h"
26
27 #undef DBGC_CLASS
28 #define DBGC_CLASS DBGC_PASSDB
29
30 static TDB_CONTEXT *tdb;
31
32 /* open up the secrets database */
33 BOOL secrets_init(void)
34 {
35         pstring fname;
36
37         if (tdb)
38                 return True;
39
40         pstrcpy(fname, lp_private_dir());
41         pstrcat(fname,"/secrets.tdb");
42
43         tdb = tdb_open_log(fname, 0, TDB_DEFAULT, O_RDWR|O_CREAT, 0600);
44
45         if (!tdb) {
46                 DEBUG(0,("Failed to open %s\n", fname));
47                 return False;
48         }
49         return True;
50 }
51
52 /* read a entry from the secrets database - the caller must free the result
53    if size is non-null then the size of the entry is put in there
54  */
55 void *secrets_fetch(const char *key, size_t *size)
56 {
57         TDB_DATA kbuf, dbuf;
58         secrets_init();
59         if (!tdb)
60                 return NULL;
61         kbuf.dptr = key;
62         kbuf.dsize = strlen(key);
63         dbuf = tdb_fetch(tdb, kbuf);
64         if (size)
65                 *size = dbuf.dsize;
66         return dbuf.dptr;
67 }
68
69 /* store a secrets entry 
70  */
71 BOOL secrets_store(const char *key, const void *data, size_t size)
72 {
73         TDB_DATA kbuf, dbuf;
74         secrets_init();
75         if (!tdb)
76                 return False;
77         kbuf.dptr = key;
78         kbuf.dsize = strlen(key);
79         dbuf.dptr = data;
80         dbuf.dsize = size;
81         return tdb_store(tdb, kbuf, dbuf, TDB_REPLACE) == 0;
82 }
83
84
85 /* delete a secets database entry
86  */
87 BOOL secrets_delete(const char *key)
88 {
89         TDB_DATA kbuf;
90         secrets_init();
91         if (!tdb)
92                 return False;
93         kbuf.dptr = key;
94         kbuf.dsize = strlen(key);
95         return tdb_delete(tdb, kbuf) == 0;
96 }
97
98 BOOL secrets_store_domain_sid(const char *domain, const DOM_SID *sid)
99 {
100         fstring key;
101
102         slprintf(key, sizeof(key)-1, "%s/%s", SECRETS_DOMAIN_SID, domain);
103         strupper(key);
104         return secrets_store(key, sid, sizeof(DOM_SID));
105 }
106
107 BOOL secrets_fetch_domain_sid(const char *domain, DOM_SID *sid)
108 {
109         DOM_SID *dyn_sid;
110         fstring key;
111         size_t size;
112
113         slprintf(key, sizeof(key)-1, "%s/%s", SECRETS_DOMAIN_SID, domain);
114         strupper(key);
115         dyn_sid = (DOM_SID *)secrets_fetch(key, &size);
116
117         if (dyn_sid == NULL)
118                 return False;
119
120         if (size != sizeof(DOM_SID))
121         { 
122                 SAFE_FREE(dyn_sid);
123                 return False;
124         }
125
126         *sid = *dyn_sid;
127         SAFE_FREE(dyn_sid);
128         return True;
129 }
130
131 BOOL secrets_store_domain_guid(const char *domain, GUID *guid)
132 {
133         fstring key;
134
135         slprintf(key, sizeof(key)-1, "%s/%s", SECRETS_DOMAIN_GUID, domain);
136         strupper(key);
137         return secrets_store(key, guid, sizeof(GUID));
138 }
139
140 BOOL secrets_fetch_domain_guid(const char *domain, GUID *guid)
141 {
142         GUID *dyn_guid;
143         fstring key;
144         size_t size;
145         GUID new_guid;
146
147         slprintf(key, sizeof(key)-1, "%s/%s", SECRETS_DOMAIN_GUID, domain);
148         strupper(key);
149         dyn_guid = (GUID *)secrets_fetch(key, &size);
150
151         DEBUG(6,("key is %s, size is %d\n", key, (int)size));
152
153         if ((NULL == dyn_guid) && (ROLE_DOMAIN_PDC == lp_server_role())) {
154                 uuid_generate_random(&new_guid);
155                 if (!secrets_store_domain_guid(domain, &new_guid))
156                         return False;
157                 dyn_guid = (GUID *)secrets_fetch(key, &size);
158                 if (dyn_guid == NULL)
159                         return False;
160         }
161
162         if (size != sizeof(GUID))
163         { 
164                 SAFE_FREE(dyn_guid);
165                 return False;
166         }
167
168         *guid = *dyn_guid;
169         SAFE_FREE(dyn_guid);
170         return True;
171 }
172
173 /**
174  * Form a key for fetching the machine trust account password
175  *
176  * @param domain domain name
177  *
178  * @return stored password's key
179  **/
180 const char *trust_keystr(const char *domain)
181 {
182         static fstring keystr;
183
184         slprintf(keystr,sizeof(keystr)-1,"%s/%s", 
185                  SECRETS_MACHINE_ACCT_PASS, domain);
186         strupper(keystr);
187
188         return keystr;
189 }
190
191 /**
192  * Form a key for fetching a trusted domain password
193  *
194  * @param domain trusted domain name
195  *
196  * @return stored password's key
197  **/
198 char *trustdom_keystr(const char *domain)
199 {
200         static char* keystr;
201
202         asprintf(&keystr, "%s/%s", SECRETS_DOMTRUST_ACCT_PASS, domain);
203         strupper(keystr);
204                 
205         return keystr;
206 }
207
208 /************************************************************************
209  Lock the trust password entry.
210 ************************************************************************/
211
212 BOOL secrets_lock_trust_account_password(const char *domain, BOOL dolock)
213 {
214         if (!tdb)
215                 return False;
216
217         if (dolock)
218                 return (tdb_lock_bystring(tdb, trust_keystr(domain),0) == 0);
219         else
220                 tdb_unlock_bystring(tdb, trust_keystr(domain));
221         return True;
222 }
223
224 /************************************************************************
225  Routine to get the trust account password for a domain.
226  The user of this function must have locked the trust password file using
227  the above call.
228 ************************************************************************/
229
230 BOOL secrets_fetch_trust_account_password(const char *domain, uint8 ret_pwd[16],
231                                           time_t *pass_last_set_time)
232 {
233         struct machine_acct_pass *pass;
234         char *plaintext;
235         size_t size;
236
237         plaintext = secrets_fetch_machine_password();
238         if (plaintext) {
239                 /* we have an ADS password - use that */
240                 DEBUG(4,("Using ADS machine password\n"));
241                 E_md4hash(plaintext, ret_pwd);
242                 SAFE_FREE(plaintext);
243                 pass_last_set_time = 0;
244                 return True;
245         }
246
247         if (!(pass = secrets_fetch(trust_keystr(domain), &size))) {
248                 DEBUG(5, ("secrets_fetch failed!\n"));
249                 return False;
250         }
251         
252         if (size != sizeof(*pass)) {
253                 DEBUG(0, ("secrets were of incorrect size!\n"));
254                 return False;
255         }
256
257         if (pass_last_set_time) *pass_last_set_time = pass->mod_time;
258         memcpy(ret_pwd, pass->hash, 16);
259         SAFE_FREE(pass);
260         return True;
261 }
262
263 /************************************************************************
264  Routine to get account password to trusted domain
265 ************************************************************************/
266
267 BOOL secrets_fetch_trusted_domain_password(const char *domain, char** pwd,
268                                            DOM_SID *sid, time_t *pass_last_set_time)
269 {
270         struct trusted_dom_pass pass;
271         size_t size;
272         
273         /* unpacking structures */
274         char* pass_buf;
275         int pass_len = 0;
276
277         ZERO_STRUCT(pass);
278
279         /* fetching trusted domain password structure */
280         if (!(pass_buf = secrets_fetch(trustdom_keystr(domain), &size))) {
281                 DEBUG(5, ("secrets_fetch failed!\n"));
282                 return False;
283         }
284
285         /* unpack trusted domain password */
286         pass_len = tdb_trusted_dom_pass_unpack(pass_buf, size, &pass);
287         if (pass_len != size) {
288                 DEBUG(5, ("Invalid secrets size. Unpacked data doesn't match trusted_dom_pass structure.\n"));
289                 return False;
290         }
291                         
292         /* the trust's password */      
293         if (pwd) {
294                 *pwd = strdup(pass.pass);
295                 if (!*pwd) {
296                         return False;
297                 }
298         }
299
300         /* last change time */
301         if (pass_last_set_time) *pass_last_set_time = pass.mod_time;
302
303         /* domain sid */
304         sid_copy(sid, &pass.domain_sid);
305                 
306         return True;
307 }
308
309 /************************************************************************
310  Routine to set the trust account password for a domain.
311 ************************************************************************/
312
313 BOOL secrets_store_trust_account_password(const char *domain, uint8 new_pwd[16])
314 {
315         struct machine_acct_pass pass;
316
317         pass.mod_time = time(NULL);
318         memcpy(pass.hash, new_pwd, 16);
319
320         return secrets_store(trust_keystr(domain), (void *)&pass, sizeof(pass));
321 }
322
323 /**
324  * Routine to store the password for trusted domain
325  *
326  * @param domain remote domain name
327  * @param pwd plain text password of trust relationship
328  * @param sid remote domain sid
329  *
330  * @return true if succeeded
331  **/
332
333 BOOL secrets_store_trusted_domain_password(const char* domain, smb_ucs2_t *uni_dom_name,
334                                            size_t uni_name_len, const char* pwd,
335                                            DOM_SID sid)
336 {       
337         /* packing structures */
338         pstring pass_buf;
339         int pass_len = 0;
340         int pass_buf_len = sizeof(pass_buf);
341         
342         struct trusted_dom_pass pass;
343         ZERO_STRUCT(pass);
344         
345         /* unicode domain name and its length */
346         if (!uni_dom_name)
347                 return False;
348                 
349         strncpy_w(pass.uni_name, uni_dom_name, sizeof(pass.uni_name) - 1);
350         pass.uni_name_len = uni_name_len;
351
352         /* last change time */
353         pass.mod_time = time(NULL);
354
355         /* password of the trust */
356         pass.pass_len = strlen(pwd);
357         fstrcpy(pass.pass, pwd);
358
359         /* domain sid */
360         sid_copy(&pass.domain_sid, &sid);
361         
362         pass_len = tdb_trusted_dom_pass_pack(pass_buf, pass_buf_len, &pass);
363
364         return secrets_store(trustdom_keystr(domain), (void *)&pass_buf, pass_len);
365 }
366
367 /************************************************************************
368  Routine to set the plaintext machine account password for a realm
369 the password is assumed to be a null terminated ascii string
370 ************************************************************************/
371
372 BOOL secrets_store_machine_password(const char *pass)
373 {
374         char *key;
375         BOOL ret;
376         asprintf(&key, "%s/%s", SECRETS_MACHINE_PASSWORD, lp_workgroup());
377         strupper(key);
378         ret = secrets_store(key, pass, strlen(pass)+1);
379         free(key);
380         return ret;
381 }
382
383
384 /************************************************************************
385  Routine to fetch the plaintext machine account password for a realm
386 the password is assumed to be a null terminated ascii string
387 ************************************************************************/
388 char *secrets_fetch_machine_password(void)
389 {
390         char *key;
391         char *ret;
392         asprintf(&key, "%s/%s", SECRETS_MACHINE_PASSWORD, lp_workgroup());
393         strupper(key);
394         ret = (char *)secrets_fetch(key, NULL);
395         free(key);
396         return ret;
397 }
398
399
400
401 /************************************************************************
402  Routine to delete the machine trust account password file for a domain.
403 ************************************************************************/
404
405 BOOL trust_password_delete(const char *domain)
406 {
407         return secrets_delete(trust_keystr(domain));
408 }
409
410 /************************************************************************
411  Routine to delete the password for trusted domain
412 ************************************************************************/
413
414 BOOL trusted_domain_password_delete(const char *domain)
415 {
416         return secrets_delete(trustdom_keystr(domain));
417 }
418
419
420 /*******************************************************************
421  Reset the 'done' variables so after a client process is created
422  from a fork call these calls will be re-done. This should be
423  expanded if more variables need reseting.
424  ******************************************************************/
425
426 void reset_globals_after_fork(void)
427 {
428         unsigned char dummy;
429
430         secrets_init();
431
432         /*
433          * Increment the global seed value to ensure every smbd starts
434          * with a new random seed.
435          */
436
437         if (tdb) {
438                 uint32 initial_val = sys_getpid();
439                 tdb_change_int32_atomic(tdb, "INFO/random_seed", (int *)&initial_val, 1);
440                 set_rand_reseed_data((unsigned char *)&initial_val, sizeof(initial_val));
441         }
442
443         /*
444          * Re-seed the random crypto generator, so all smbd's
445          * started from the same parent won't generate the same
446          * sequence.
447          */
448         generate_random_buffer( &dummy, 1, True);
449 }
450
451 BOOL secrets_store_ldap_pw(const char* dn, char* pw)
452 {
453         char *key = NULL;
454         BOOL ret;
455         
456         if (asprintf(&key, "%s/%s", SECRETS_LDAP_BIND_PW, dn) < 0) {
457                 DEBUG(0, ("secrets_store_ldap_pw: asprintf failed!\n"));
458                 return False;
459         }
460                 
461         ret = secrets_store(key, pw, strlen(pw)+1);
462         
463         SAFE_FREE(key);
464         return ret;
465 }
466
467
468 /**
469  * Get trusted domains info from secrets.tdb.
470  *
471  * The linked list is allocated on the supplied talloc context, caller gets to destroy
472  * when done.
473  *
474  * @param ctx Allocation context
475  * @param enum_ctx Starting index, eg. we can start fetching at third
476  *        or sixth trusted domain entry. Zero is the first index.
477  *        Value it is set to is the enum context for the next enumeration.
478  * @param num_domains Number of domain entries to fetch at one call
479  * @param domains Pointer to array of trusted domain structs to be filled up
480  *
481  * @return nt status code of rpc response
482  **/ 
483
484 NTSTATUS secrets_get_trusted_domains(TALLOC_CTX* ctx, int* enum_ctx, unsigned int max_num_domains, int *num_domains, TRUSTDOM ***domains)
485 {
486         TDB_LIST_NODE *keys, *k;
487         TRUSTDOM *dom = NULL;
488         char *pattern;
489         unsigned int start_idx;
490         uint32 idx = 0;
491         size_t size, packed_size = 0;
492         fstring dom_name;
493         char *packed_pass;
494         struct trusted_dom_pass *pass = talloc_zero(ctx, sizeof(struct trusted_dom_pass));
495         NTSTATUS status;
496
497         if (!secrets_init()) return NT_STATUS_ACCESS_DENIED;
498
499         *num_domains = 0;
500         start_idx = *enum_ctx;
501
502         /* generate searching pattern */
503         if (!(pattern = talloc_asprintf(ctx, "%s/*", SECRETS_DOMTRUST_ACCT_PASS))) {
504                 DEBUG(0, ("secrets_get_trusted_domains: talloc_asprintf() failed!\n"));
505                 return NT_STATUS_NO_MEMORY;
506         }
507
508         DEBUG(5, ("secrets_get_trusted_domains: looking for %d domains, starting at index %d\n", 
509                   max_num_domains, *enum_ctx));
510
511         *domains = talloc_zero(ctx, sizeof(**domains)*max_num_domains);
512
513         /* fetching trusted domains' data and collecting them in a list */
514         keys = tdb_search_keys(tdb, pattern);
515
516         /* 
517          * if there's no keys returned ie. no trusted domain,
518          * return "no more entries" code
519          */
520         status = NT_STATUS_NO_MORE_ENTRIES;
521
522         /* searching for keys in secrets db -- way to go ... */
523         for (k = keys; k; k = k->next) {
524                 char *secrets_key;
525                 
526                 /* important: ensure null-termination of the key string */
527                 secrets_key = strndup(k->node_key.dptr, k->node_key.dsize);
528                 if (!secrets_key) {
529                         DEBUG(0, ("strndup failed!\n"));
530                         return NT_STATUS_NO_MEMORY;
531                 }
532                                 
533                 packed_pass = secrets_fetch(secrets_key, &size);
534                 packed_size = tdb_trusted_dom_pass_unpack(packed_pass, size, pass);
535
536                 if (size != packed_size) {
537                         DEBUG(2, ("Secrets record %s is invalid!\n", secrets_key));
538                         if (size) SAFE_FREE(packed_pass);
539
540                         continue;
541                 }
542                 
543                 /* packed representation isn't needed anymore */
544                 SAFE_FREE(packed_pass);
545                 
546                 pull_ucs2_fstring(dom_name, pass->uni_name);
547                 DEBUG(18, ("Fetched secret record num %d.\nDomain name: %s, SID: %s\n",
548                            idx, dom_name, sid_string_static(&pass->domain_sid)));
549
550                 SAFE_FREE(secrets_key);
551
552                 if (idx >= start_idx && idx < start_idx + max_num_domains) {
553                         dom = talloc_zero(ctx, sizeof(*dom));
554                         if (!dom) {
555                                 /* free returned tdb record */
556                                 return NT_STATUS_NO_MEMORY;
557                         }
558                         
559                         /* copy domain sid */
560                         SMB_ASSERT(sizeof(dom->sid) == sizeof(pass->domain_sid));
561                         memcpy(&(dom->sid), &(pass->domain_sid), sizeof(dom->sid));
562                         
563                         /* copy unicode domain name */
564                         dom->name = talloc_strdup_w(ctx, pass->uni_name);
565                         
566                         (*domains)[idx - start_idx] = dom;
567                         
568                         DEBUG(18, ("Secret record is in required range.\n \
569                                    start_idx = %d, max_num_domains = %d. Added to returned array.\n",
570                                    start_idx, max_num_domains));
571
572                         *enum_ctx = idx + 1;
573                         (*num_domains)++;
574                 
575                         /* set proper status code to return */
576                         if (k->next) {
577                                 /* there are yet some entries to enumerate */
578                                 status = STATUS_MORE_ENTRIES;
579                         } else {
580                                 /* this is the last entry in the whole enumeration */
581                                 status = NT_STATUS_OK;
582                         }
583                 } else {
584                         DEBUG(18, ("Secret is outside the required range.\n \
585                                    start_idx = %d, max_num_domains = %d. Not added to returned array\n",
586                                    start_idx, max_num_domains));
587                 }
588                 
589                 idx++;          
590         }
591         
592         DEBUG(5, ("secrets_get_trusted_domains: got %d domains\n", *num_domains));
593
594         /* free the results of searching the keys */
595         tdb_search_list_free(keys);
596
597         return status;
598 }
599
600 /*******************************************************************************
601  Lock the secrets tdb based on a string - this is used as a primitive form of mutex
602  between smbd instances.
603 *******************************************************************************/
604
605 BOOL secrets_named_mutex(const char *name, unsigned int timeout)
606 {
607         int ret = 0;
608
609         if (!message_init())
610                 return False;
611
612         ret = tdb_lock_bystring(tdb, name, timeout);
613         if (ret == 0)
614                 DEBUG(10,("secrets_named_mutex: got mutex for %s\n", name ));
615
616         return (ret == 0);
617 }
618
619 /*******************************************************************************
620  Unlock a named mutex.
621 *******************************************************************************/
622
623 void secrets_named_mutex_release(const char *name)
624 {
625         tdb_unlock_bystring(tdb, name);
626         DEBUG(10,("secrets_named_mutex: released mutex for %s\n", name ));
627 }
628
629 /*********************************************************
630  Check to see if we must talk to the PDC to avoid sam 
631  sync delays
632  ********************************************************/
633  
634 BOOL must_use_pdc( const char *domain )
635 {
636         time_t  now = time(NULL);
637         time_t  last_change_time;
638         unsigned char   passwd[16];   
639         
640         if ( !secrets_fetch_trust_account_password(domain, passwd, &last_change_time) )
641                 return False;
642                 
643         /*
644          * If the time the machine password has changed
645          * was less than about 15 minutes then we need to contact
646          * the PDC only, as we cannot be sure domain replication
647          * has yet taken place. Bug found by Gerald (way to go
648          * Gerald !). JRA.
649          */
650          
651         if ( now - last_change_time < SAM_SYNC_WINDOW )
652                 return True;
653                 
654         return False;
655
656 }
657