This commit was manufactured by cvs2svn to create branch 'SAMBA_3_0'.
[samba.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 default secure channel type for trust accounts
226 ************************************************************************/
227
228 uint32 get_default_sec_channel(void) 
229 {
230         if (lp_server_role() == ROLE_DOMAIN_BDC || 
231             lp_server_role() == ROLE_DOMAIN_PDC) {
232                 return SEC_CHAN_BDC;
233         } else {
234                 return SEC_CHAN_WKSTA;
235         }
236 }
237
238 /************************************************************************
239  Routine to get the trust account password for a domain.
240  The user of this function must have locked the trust password file using
241  the above call.
242 ************************************************************************/
243
244 BOOL secrets_fetch_trust_account_password(const char *domain, uint8 ret_pwd[16],
245                                           time_t *pass_last_set_time,
246                                           uint32 *channel)
247 {
248         struct machine_acct_pass *pass;
249         char *plaintext;
250         size_t size;
251
252         plaintext = secrets_fetch_machine_password(domain, pass_last_set_time, 
253                                                    channel);
254         if (plaintext) {
255                 /* we have an ADS password - use that */
256                 DEBUG(4,("Using ADS machine password\n"));
257                 E_md4hash(plaintext, ret_pwd);
258                 SAFE_FREE(plaintext);
259                 return True;
260         }
261
262         if (!(pass = secrets_fetch(trust_keystr(domain), &size))) {
263                 DEBUG(5, ("secrets_fetch failed!\n"));
264                 return False;
265         }
266         
267         if (size != sizeof(*pass)) {
268                 DEBUG(0, ("secrets were of incorrect size!\n"));
269                 return False;
270         }
271
272         if (pass_last_set_time) *pass_last_set_time = pass->mod_time;
273         memcpy(ret_pwd, pass->hash, 16);
274         SAFE_FREE(pass);
275
276         if (channel) 
277                 *channel = get_default_sec_channel();
278
279         return True;
280 }
281
282 /************************************************************************
283  Routine to get account password to trusted domain
284 ************************************************************************/
285
286 BOOL secrets_fetch_trusted_domain_password(const char *domain, char** pwd,
287                                            DOM_SID *sid, time_t *pass_last_set_time)
288 {
289         struct trusted_dom_pass pass;
290         size_t size;
291         
292         /* unpacking structures */
293         char* pass_buf;
294         int pass_len = 0;
295
296         ZERO_STRUCT(pass);
297
298         /* fetching trusted domain password structure */
299         if (!(pass_buf = secrets_fetch(trustdom_keystr(domain), &size))) {
300                 DEBUG(5, ("secrets_fetch failed!\n"));
301                 return False;
302         }
303
304         /* unpack trusted domain password */
305         pass_len = tdb_trusted_dom_pass_unpack(pass_buf, size, &pass);
306         SAFE_FREE(pass_buf);
307
308         if (pass_len != size) {
309                 DEBUG(5, ("Invalid secrets size. Unpacked data doesn't match trusted_dom_pass structure.\n"));
310                 return False;
311         }
312                         
313         /* the trust's password */      
314         if (pwd) {
315                 *pwd = strdup(pass.pass);
316                 if (!*pwd) {
317                         return False;
318                 }
319         }
320
321         /* last change time */
322         if (pass_last_set_time) *pass_last_set_time = pass.mod_time;
323
324         /* domain sid */
325         sid_copy(sid, &pass.domain_sid);
326                 
327         return True;
328 }
329
330 /************************************************************************
331  Routine to set the trust account password for a domain.
332 ************************************************************************/
333
334 BOOL secrets_store_trust_account_password(const char *domain, uint8 new_pwd[16])
335 {
336         struct machine_acct_pass pass;
337
338         pass.mod_time = time(NULL);
339         memcpy(pass.hash, new_pwd, 16);
340
341         return secrets_store(trust_keystr(domain), (void *)&pass, sizeof(pass));
342 }
343
344 /**
345  * Routine to store the password for trusted domain
346  *
347  * @param domain remote domain name
348  * @param pwd plain text password of trust relationship
349  * @param sid remote domain sid
350  *
351  * @return true if succeeded
352  **/
353
354 BOOL secrets_store_trusted_domain_password(const char* domain, smb_ucs2_t *uni_dom_name,
355                                            size_t uni_name_len, const char* pwd,
356                                            DOM_SID sid)
357 {       
358         /* packing structures */
359         pstring pass_buf;
360         int pass_len = 0;
361         int pass_buf_len = sizeof(pass_buf);
362         
363         struct trusted_dom_pass pass;
364         ZERO_STRUCT(pass);
365         
366         /* unicode domain name and its length */
367         if (!uni_dom_name)
368                 return False;
369                 
370         strncpy_w(pass.uni_name, uni_dom_name, sizeof(pass.uni_name) - 1);
371         pass.uni_name_len = uni_name_len;
372
373         /* last change time */
374         pass.mod_time = time(NULL);
375
376         /* password of the trust */
377         pass.pass_len = strlen(pwd);
378         fstrcpy(pass.pass, pwd);
379
380         /* domain sid */
381         sid_copy(&pass.domain_sid, &sid);
382         
383         pass_len = tdb_trusted_dom_pass_pack(pass_buf, pass_buf_len, &pass);
384
385         return secrets_store(trustdom_keystr(domain), (void *)&pass_buf, pass_len);
386 }
387
388 /************************************************************************
389  Routine to set the plaintext machine account password for a realm
390 the password is assumed to be a null terminated ascii string
391 ************************************************************************/
392
393 BOOL secrets_store_machine_password(const char *pass, const char *domain, uint32 sec_channel)
394 {
395         char *key = NULL;
396         BOOL ret;
397         uint32 last_change_time;
398         uint32 sec_channel_type;
399
400         asprintf(&key, "%s/%s", SECRETS_MACHINE_PASSWORD, domain);
401         if (!key) 
402                 return False;
403         strupper(key);
404
405         ret = secrets_store(key, pass, strlen(pass)+1);
406         SAFE_FREE(key);
407
408         if (!ret)
409                 return ret;
410         
411         asprintf(&key, "%s/%s", SECRETS_MACHINE_LAST_CHANGE_TIME, domain);
412         if (!key) 
413                 return False;
414         strupper(key);
415
416         SIVAL(&last_change_time, 0, time(NULL));
417         ret = secrets_store(key, &last_change_time, sizeof(last_change_time));
418         SAFE_FREE(key);
419
420         asprintf(&key, "%s/%s", SECRETS_MACHINE_SEC_CHANNEL_TYPE, domain);
421         if (!key) 
422                 return False;
423         strupper(key);
424
425         SIVAL(&sec_channel_type, 0, sec_channel);
426         ret = secrets_store(key, &sec_channel_type, sizeof(sec_channel_type));
427         SAFE_FREE(key);
428
429         return ret;
430 }
431
432
433 /************************************************************************
434  Routine to fetch the plaintext machine account password for a realm
435 the password is assumed to be a null terminated ascii string
436 ************************************************************************/
437 char *secrets_fetch_machine_password(const char *domain, 
438                                      time_t *pass_last_set_time,
439                                      uint32 *channel)
440 {
441         char *key = NULL;
442         char *ret;
443         asprintf(&key, "%s/%s", SECRETS_MACHINE_PASSWORD, domain);
444         strupper(key);
445         ret = (char *)secrets_fetch(key, NULL);
446         SAFE_FREE(key);
447         
448         if (pass_last_set_time) {
449                 size_t size;
450                 uint32 *last_set_time;
451                 asprintf(&key, "%s/%s", SECRETS_MACHINE_LAST_CHANGE_TIME, domain);
452                 strupper(key);
453                 last_set_time = secrets_fetch(key, &size);
454                 if (last_set_time) {
455                         *pass_last_set_time = IVAL(last_set_time,0);
456                 } else {
457                         *pass_last_set_time = 0;
458                 }
459                 SAFE_FREE(key);
460         }
461         
462         if (channel) {
463                 size_t size;
464                 uint32 *channel_type;
465                 asprintf(&key, "%s/%s", SECRETS_MACHINE_SEC_CHANNEL_TYPE, domain);
466                 strupper(key);
467                 channel_type = secrets_fetch(key, &size);
468                 if (channel_type) {
469                         *channel = IVAL(channel_type,0);
470                 } else {
471                         *channel = get_default_sec_channel();
472                 }
473                 SAFE_FREE(key);
474         }
475         
476         return ret;
477 }
478
479
480
481 /************************************************************************
482  Routine to delete the machine trust account password file for a domain.
483 ************************************************************************/
484
485 BOOL trust_password_delete(const char *domain)
486 {
487         return secrets_delete(trust_keystr(domain));
488 }
489
490 /************************************************************************
491  Routine to delete the password for trusted domain
492 ************************************************************************/
493
494 BOOL trusted_domain_password_delete(const char *domain)
495 {
496         return secrets_delete(trustdom_keystr(domain));
497 }
498
499
500 /*******************************************************************
501  Reset the 'done' variables so after a client process is created
502  from a fork call these calls will be re-done. This should be
503  expanded if more variables need reseting.
504  ******************************************************************/
505
506 void reset_globals_after_fork(void)
507 {
508         unsigned char dummy;
509
510         secrets_init();
511
512         /*
513          * Increment the global seed value to ensure every smbd starts
514          * with a new random seed.
515          */
516
517         if (tdb) {
518                 uint32 initial_val = sys_getpid();
519                 tdb_change_int32_atomic(tdb, "INFO/random_seed", (int *)&initial_val, 1);
520                 set_rand_reseed_data((unsigned char *)&initial_val, sizeof(initial_val));
521         }
522
523         /*
524          * Re-seed the random crypto generator, so all smbd's
525          * started from the same parent won't generate the same
526          * sequence.
527          */
528         generate_random_buffer( &dummy, 1, True);
529 }
530
531 BOOL secrets_store_ldap_pw(const char* dn, char* pw)
532 {
533         char *key = NULL;
534         BOOL ret;
535         
536         if (asprintf(&key, "%s/%s", SECRETS_LDAP_BIND_PW, dn) < 0) {
537                 DEBUG(0, ("secrets_store_ldap_pw: asprintf failed!\n"));
538                 return False;
539         }
540                 
541         ret = secrets_store(key, pw, strlen(pw)+1);
542         
543         SAFE_FREE(key);
544         return ret;
545 }
546
547
548 /**
549  * Get trusted domains info from secrets.tdb.
550  *
551  * The linked list is allocated on the supplied talloc context, caller gets to destroy
552  * when done.
553  *
554  * @param ctx Allocation context
555  * @param enum_ctx Starting index, eg. we can start fetching at third
556  *        or sixth trusted domain entry. Zero is the first index.
557  *        Value it is set to is the enum context for the next enumeration.
558  * @param num_domains Number of domain entries to fetch at one call
559  * @param domains Pointer to array of trusted domain structs to be filled up
560  *
561  * @return nt status code of rpc response
562  **/ 
563
564 NTSTATUS secrets_get_trusted_domains(TALLOC_CTX* ctx, int* enum_ctx, unsigned int max_num_domains, int *num_domains, TRUSTDOM ***domains)
565 {
566         TDB_LIST_NODE *keys, *k;
567         TRUSTDOM *dom = NULL;
568         char *pattern;
569         unsigned int start_idx;
570         uint32 idx = 0;
571         size_t size, packed_size = 0;
572         fstring dom_name;
573         char *packed_pass;
574         struct trusted_dom_pass *pass = talloc_zero(ctx, sizeof(struct trusted_dom_pass));
575         NTSTATUS status;
576
577         if (!secrets_init()) return NT_STATUS_ACCESS_DENIED;
578         
579         if (!pass) {
580                 DEBUG(0, ("talloc_zero failed!\n"));
581                 return NT_STATUS_NO_MEMORY;
582         }
583                                 
584         *num_domains = 0;
585         start_idx = *enum_ctx;
586
587         /* generate searching pattern */
588         if (!(pattern = talloc_asprintf(ctx, "%s/*", SECRETS_DOMTRUST_ACCT_PASS))) {
589                 DEBUG(0, ("secrets_get_trusted_domains: talloc_asprintf() failed!\n"));
590                 return NT_STATUS_NO_MEMORY;
591         }
592
593         DEBUG(5, ("secrets_get_trusted_domains: looking for %d domains, starting at index %d\n", 
594                   max_num_domains, *enum_ctx));
595
596         *domains = talloc_zero(ctx, sizeof(**domains)*max_num_domains);
597
598         /* fetching trusted domains' data and collecting them in a list */
599         keys = tdb_search_keys(tdb, pattern);
600
601         /* 
602          * if there's no keys returned ie. no trusted domain,
603          * return "no more entries" code
604          */
605         status = NT_STATUS_NO_MORE_ENTRIES;
606
607         /* searching for keys in secrets db -- way to go ... */
608         for (k = keys; k; k = k->next) {
609                 char *secrets_key;
610                 
611                 /* important: ensure null-termination of the key string */
612                 secrets_key = strndup(k->node_key.dptr, k->node_key.dsize);
613                 if (!secrets_key) {
614                         DEBUG(0, ("strndup failed!\n"));
615                         return NT_STATUS_NO_MEMORY;
616                 }
617                                 
618                 packed_pass = secrets_fetch(secrets_key, &size);
619                 packed_size = tdb_trusted_dom_pass_unpack(packed_pass, size, pass);
620                 /* packed representation isn't needed anymore */
621                 SAFE_FREE(packed_pass);
622                 
623                 if (size != packed_size) {
624                         DEBUG(2, ("Secrets record %s is invalid!\n", secrets_key));
625                         continue;
626                 }
627                 
628                 pull_ucs2_fstring(dom_name, pass->uni_name);
629                 DEBUG(18, ("Fetched secret record num %d.\nDomain name: %s, SID: %s\n",
630                            idx, dom_name, sid_string_static(&pass->domain_sid)));
631
632                 SAFE_FREE(secrets_key);
633
634                 if (idx >= start_idx && idx < start_idx + max_num_domains) {
635                         dom = talloc_zero(ctx, sizeof(*dom));
636                         if (!dom) {
637                                 /* free returned tdb record */
638                                 return NT_STATUS_NO_MEMORY;
639                         }
640                         
641                         /* copy domain sid */
642                         SMB_ASSERT(sizeof(dom->sid) == sizeof(pass->domain_sid));
643                         memcpy(&(dom->sid), &(pass->domain_sid), sizeof(dom->sid));
644                         
645                         /* copy unicode domain name */
646                         dom->name = talloc_strdup_w(ctx, pass->uni_name);
647                         
648                         (*domains)[idx - start_idx] = dom;
649                         
650                         DEBUG(18, ("Secret record is in required range.\n \
651                                    start_idx = %d, max_num_domains = %d. Added to returned array.\n",
652                                    start_idx, max_num_domains));
653
654                         *enum_ctx = idx + 1;
655                         (*num_domains)++;
656                 
657                         /* set proper status code to return */
658                         if (k->next) {
659                                 /* there are yet some entries to enumerate */
660                                 status = STATUS_MORE_ENTRIES;
661                         } else {
662                                 /* this is the last entry in the whole enumeration */
663                                 status = NT_STATUS_OK;
664                         }
665                 } else {
666                         DEBUG(18, ("Secret is outside the required range.\n \
667                                    start_idx = %d, max_num_domains = %d. Not added to returned array\n",
668                                    start_idx, max_num_domains));
669                 }
670                 
671                 idx++;          
672         }
673         
674         DEBUG(5, ("secrets_get_trusted_domains: got %d domains\n", *num_domains));
675
676         /* free the results of searching the keys */
677         tdb_search_list_free(keys);
678
679         return status;
680 }
681
682 /*******************************************************************************
683  Lock the secrets tdb based on a string - this is used as a primitive form of mutex
684  between smbd instances.
685 *******************************************************************************/
686
687 BOOL secrets_named_mutex(const char *name, unsigned int timeout)
688 {
689         int ret = 0;
690
691         if (!message_init())
692                 return False;
693
694         ret = tdb_lock_bystring(tdb, name, timeout);
695         if (ret == 0)
696                 DEBUG(10,("secrets_named_mutex: got mutex for %s\n", name ));
697
698         return (ret == 0);
699 }
700
701 /*******************************************************************************
702  Unlock a named mutex.
703 *******************************************************************************/
704
705 void secrets_named_mutex_release(const char *name)
706 {
707         tdb_unlock_bystring(tdb, name);
708         DEBUG(10,("secrets_named_mutex: released mutex for %s\n", name ));
709 }
710
711 /*********************************************************
712  Check to see if we must talk to the PDC to avoid sam 
713  sync delays
714  ********************************************************/
715  
716 BOOL must_use_pdc( const char *domain )
717 {
718         time_t  now = time(NULL);
719         time_t  last_change_time;
720         unsigned char   passwd[16];   
721         
722         if ( !secrets_fetch_trust_account_password(domain, passwd, &last_change_time, NULL) )
723                 return False;
724                 
725         /*
726          * If the time the machine password has changed
727          * was less than about 15 minutes then we need to contact
728          * the PDC only, as we cannot be sure domain replication
729          * has yet taken place. Bug found by Gerald (way to go
730          * Gerald !). JRA.
731          */
732          
733         if ( now - last_change_time < SAM_SYNC_WINDOW )
734                 return True;
735                 
736         return False;
737
738 }
739