2 Unix SMB/CIFS implementation.
3 Copyright (C) Andrew Tridgell 1992-2001
4 Copyright (C) Andrew Bartlett 2002
5 Copyright (C) Rafal Szczesniak 2002
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.
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.
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.
22 /* the Samba secrets database stores any generated, private information
23 such as the local SID and machine trust password */
28 #define DBGC_CLASS DBGC_PASSDB
30 static TDB_CONTEXT *tdb;
32 /* open up the secrets database */
33 BOOL secrets_init(void)
40 pstrcpy(fname, lp_private_dir());
41 pstrcat(fname,"/secrets.tdb");
43 tdb = tdb_open_log(fname, 0, TDB_DEFAULT, O_RDWR|O_CREAT, 0600);
46 DEBUG(0,("Failed to open %s\n", fname));
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
55 void *secrets_fetch(const char *key, size_t *size)
62 kbuf.dsize = strlen(key);
63 dbuf = tdb_fetch(tdb, kbuf);
69 /* store a secrets entry
71 BOOL secrets_store(const char *key, const void *data, size_t size)
78 kbuf.dsize = strlen(key);
81 return tdb_store(tdb, kbuf, dbuf, TDB_REPLACE) == 0;
85 /* delete a secets database entry
87 BOOL secrets_delete(const char *key)
94 kbuf.dsize = strlen(key);
95 return tdb_delete(tdb, kbuf) == 0;
98 BOOL secrets_store_domain_sid(const char *domain, const DOM_SID *sid)
102 slprintf(key, sizeof(key)-1, "%s/%s", SECRETS_DOMAIN_SID, domain);
104 return secrets_store(key, sid, sizeof(DOM_SID));
107 BOOL secrets_fetch_domain_sid(const char *domain, DOM_SID *sid)
113 slprintf(key, sizeof(key)-1, "%s/%s", SECRETS_DOMAIN_SID, domain);
115 dyn_sid = (DOM_SID *)secrets_fetch(key, &size);
120 if (size != sizeof(DOM_SID))
131 BOOL secrets_store_domain_guid(const char *domain, GUID *guid)
135 slprintf(key, sizeof(key)-1, "%s/%s", SECRETS_DOMAIN_GUID, domain);
137 return secrets_store(key, guid, sizeof(GUID));
140 BOOL secrets_fetch_domain_guid(const char *domain, GUID *guid)
147 slprintf(key, sizeof(key)-1, "%s/%s", SECRETS_DOMAIN_GUID, domain);
149 dyn_guid = (GUID *)secrets_fetch(key, &size);
151 DEBUG(6,("key is %s, size is %d\n", key, (int)size));
153 if ((NULL == dyn_guid) && (ROLE_DOMAIN_PDC == lp_server_role())) {
154 smb_uuid_generate_random(&new_guid);
155 if (!secrets_store_domain_guid(domain, &new_guid))
157 dyn_guid = (GUID *)secrets_fetch(key, &size);
158 if (dyn_guid == NULL)
162 if (size != sizeof(GUID))
174 * Form a key for fetching the machine trust account password
176 * @param domain domain name
178 * @return stored password's key
180 const char *trust_keystr(const char *domain)
182 static fstring keystr;
184 slprintf(keystr,sizeof(keystr)-1,"%s/%s",
185 SECRETS_MACHINE_ACCT_PASS, domain);
192 * Form a key for fetching a trusted domain password
194 * @param domain trusted domain name
196 * @return stored password's key
198 char *trustdom_keystr(const char *domain)
202 asprintf(&keystr, "%s/%s", SECRETS_DOMTRUST_ACCT_PASS, domain);
208 /************************************************************************
209 Lock the trust password entry.
210 ************************************************************************/
212 BOOL secrets_lock_trust_account_password(const char *domain, BOOL dolock)
218 return (tdb_lock_bystring(tdb, trust_keystr(domain),0) == 0);
220 tdb_unlock_bystring(tdb, trust_keystr(domain));
224 /************************************************************************
225 Routine to get the default secure channel type for trust accounts
226 ************************************************************************/
228 uint32 get_default_sec_channel(void)
230 if (lp_server_role() == ROLE_DOMAIN_BDC ||
231 lp_server_role() == ROLE_DOMAIN_PDC) {
234 return SEC_CHAN_WKSTA;
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
242 ************************************************************************/
244 BOOL secrets_fetch_trust_account_password(const char *domain, uint8 ret_pwd[16],
245 time_t *pass_last_set_time,
248 struct machine_acct_pass *pass;
252 plaintext = secrets_fetch_machine_password(domain, pass_last_set_time,
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);
262 if (!(pass = secrets_fetch(trust_keystr(domain), &size))) {
263 DEBUG(5, ("secrets_fetch failed!\n"));
267 if (size != sizeof(*pass)) {
268 DEBUG(0, ("secrets were of incorrect size!\n"));
272 if (pass_last_set_time) *pass_last_set_time = pass->mod_time;
273 memcpy(ret_pwd, pass->hash, 16);
277 *channel = get_default_sec_channel();
282 /************************************************************************
283 Routine to get account password to trusted domain
284 ************************************************************************/
286 BOOL secrets_fetch_trusted_domain_password(const char *domain, char** pwd,
287 DOM_SID *sid, time_t *pass_last_set_time)
289 struct trusted_dom_pass pass;
292 /* unpacking structures */
298 /* fetching trusted domain password structure */
299 if (!(pass_buf = secrets_fetch(trustdom_keystr(domain), &size))) {
300 DEBUG(5, ("secrets_fetch failed!\n"));
304 /* unpack trusted domain password */
305 pass_len = tdb_trusted_dom_pass_unpack(pass_buf, size, &pass);
308 if (pass_len != size) {
309 DEBUG(5, ("Invalid secrets size. Unpacked data doesn't match trusted_dom_pass structure.\n"));
313 /* the trust's password */
315 *pwd = strdup(pass.pass);
321 /* last change time */
322 if (pass_last_set_time) *pass_last_set_time = pass.mod_time;
325 sid_copy(sid, &pass.domain_sid);
330 /************************************************************************
331 Routine to set the trust account password for a domain.
332 ************************************************************************/
334 BOOL secrets_store_trust_account_password(const char *domain, uint8 new_pwd[16])
336 struct machine_acct_pass pass;
338 pass.mod_time = time(NULL);
339 memcpy(pass.hash, new_pwd, 16);
341 return secrets_store(trust_keystr(domain), (void *)&pass, sizeof(pass));
345 * Routine to store the password for trusted domain
347 * @param domain remote domain name
348 * @param pwd plain text password of trust relationship
349 * @param sid remote domain sid
351 * @return true if succeeded
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,
358 /* packing structures */
361 int pass_buf_len = sizeof(pass_buf);
363 struct trusted_dom_pass pass;
366 /* unicode domain name and its length */
370 strncpy_w(pass.uni_name, uni_dom_name, sizeof(pass.uni_name) - 1);
371 pass.uni_name_len = uni_name_len;
373 /* last change time */
374 pass.mod_time = time(NULL);
376 /* password of the trust */
377 pass.pass_len = strlen(pwd);
378 fstrcpy(pass.pass, pwd);
381 sid_copy(&pass.domain_sid, &sid);
383 pass_len = tdb_trusted_dom_pass_pack(pass_buf, pass_buf_len, &pass);
385 return secrets_store(trustdom_keystr(domain), (void *)&pass_buf, pass_len);
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 ************************************************************************/
393 BOOL secrets_store_machine_password(const char *pass, const char *domain, uint32 sec_channel)
397 uint32 last_change_time;
398 uint32 sec_channel_type;
400 asprintf(&key, "%s/%s", SECRETS_MACHINE_PASSWORD, domain);
405 ret = secrets_store(key, pass, strlen(pass)+1);
411 asprintf(&key, "%s/%s", SECRETS_MACHINE_LAST_CHANGE_TIME, domain);
416 SIVAL(&last_change_time, 0, time(NULL));
417 ret = secrets_store(key, &last_change_time, sizeof(last_change_time));
420 asprintf(&key, "%s/%s", SECRETS_MACHINE_SEC_CHANNEL_TYPE, domain);
425 SIVAL(&sec_channel_type, 0, sec_channel);
426 ret = secrets_store(key, &sec_channel_type, sizeof(sec_channel_type));
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,
443 asprintf(&key, "%s/%s", SECRETS_MACHINE_PASSWORD, domain);
445 ret = (char *)secrets_fetch(key, NULL);
448 if (pass_last_set_time) {
450 uint32 *last_set_time;
451 asprintf(&key, "%s/%s", SECRETS_MACHINE_LAST_CHANGE_TIME, domain);
453 last_set_time = secrets_fetch(key, &size);
455 *pass_last_set_time = IVAL(last_set_time,0);
456 SAFE_FREE(last_set_time);
458 *pass_last_set_time = 0;
465 uint32 *channel_type;
466 asprintf(&key, "%s/%s", SECRETS_MACHINE_SEC_CHANNEL_TYPE, domain);
468 channel_type = secrets_fetch(key, &size);
470 *channel = IVAL(channel_type,0);
471 SAFE_FREE(channel_type);
473 *channel = get_default_sec_channel();
483 /************************************************************************
484 Routine to delete the machine trust account password file for a domain.
485 ************************************************************************/
487 BOOL trust_password_delete(const char *domain)
489 return secrets_delete(trust_keystr(domain));
492 /************************************************************************
493 Routine to delete the password for trusted domain
494 ************************************************************************/
496 BOOL trusted_domain_password_delete(const char *domain)
498 return secrets_delete(trustdom_keystr(domain));
502 /*******************************************************************
503 Reset the 'done' variables so after a client process is created
504 from a fork call these calls will be re-done. This should be
505 expanded if more variables need reseting.
506 ******************************************************************/
508 void reset_globals_after_fork(void)
515 * Increment the global seed value to ensure every smbd starts
516 * with a new random seed.
520 uint32 initial_val = sys_getpid();
521 tdb_change_int32_atomic(tdb, "INFO/random_seed", (int *)&initial_val, 1);
522 set_rand_reseed_data((unsigned char *)&initial_val, sizeof(initial_val));
526 * Re-seed the random crypto generator, so all smbd's
527 * started from the same parent won't generate the same
530 generate_random_buffer( &dummy, 1, True);
533 BOOL secrets_store_ldap_pw(const char* dn, char* pw)
538 if (asprintf(&key, "%s/%s", SECRETS_LDAP_BIND_PW, dn) < 0) {
539 DEBUG(0, ("secrets_store_ldap_pw: asprintf failed!\n"));
543 ret = secrets_store(key, pw, strlen(pw)+1);
551 * Get trusted domains info from secrets.tdb.
553 * The linked list is allocated on the supplied talloc context, caller gets to destroy
556 * @param ctx Allocation context
557 * @param enum_ctx Starting index, eg. we can start fetching at third
558 * or sixth trusted domain entry. Zero is the first index.
559 * Value it is set to is the enum context for the next enumeration.
560 * @param num_domains Number of domain entries to fetch at one call
561 * @param domains Pointer to array of trusted domain structs to be filled up
563 * @return nt status code of rpc response
566 NTSTATUS secrets_get_trusted_domains(TALLOC_CTX* ctx, int* enum_ctx, unsigned int max_num_domains, int *num_domains, TRUSTDOM ***domains)
568 TDB_LIST_NODE *keys, *k;
569 TRUSTDOM *dom = NULL;
571 unsigned int start_idx;
573 size_t size, packed_size = 0;
576 struct trusted_dom_pass *pass = talloc_zero(ctx, sizeof(struct trusted_dom_pass));
579 if (!secrets_init()) return NT_STATUS_ACCESS_DENIED;
582 DEBUG(0, ("talloc_zero failed!\n"));
583 return NT_STATUS_NO_MEMORY;
587 start_idx = *enum_ctx;
589 /* generate searching pattern */
590 if (!(pattern = talloc_asprintf(ctx, "%s/*", SECRETS_DOMTRUST_ACCT_PASS))) {
591 DEBUG(0, ("secrets_get_trusted_domains: talloc_asprintf() failed!\n"));
592 return NT_STATUS_NO_MEMORY;
595 DEBUG(5, ("secrets_get_trusted_domains: looking for %d domains, starting at index %d\n",
596 max_num_domains, *enum_ctx));
598 *domains = talloc_zero(ctx, sizeof(**domains)*max_num_domains);
600 /* fetching trusted domains' data and collecting them in a list */
601 keys = tdb_search_keys(tdb, pattern);
604 * if there's no keys returned ie. no trusted domain,
605 * return "no more entries" code
607 status = NT_STATUS_NO_MORE_ENTRIES;
609 /* searching for keys in secrets db -- way to go ... */
610 for (k = keys; k; k = k->next) {
613 /* important: ensure null-termination of the key string */
614 secrets_key = strndup(k->node_key.dptr, k->node_key.dsize);
616 DEBUG(0, ("strndup failed!\n"));
617 return NT_STATUS_NO_MEMORY;
620 packed_pass = secrets_fetch(secrets_key, &size);
621 packed_size = tdb_trusted_dom_pass_unpack(packed_pass, size, pass);
622 /* packed representation isn't needed anymore */
623 SAFE_FREE(packed_pass);
625 if (size != packed_size) {
626 DEBUG(2, ("Secrets record %s is invalid!\n", secrets_key));
630 pull_ucs2_fstring(dom_name, pass->uni_name);
631 DEBUG(18, ("Fetched secret record num %d.\nDomain name: %s, SID: %s\n",
632 idx, dom_name, sid_string_static(&pass->domain_sid)));
634 SAFE_FREE(secrets_key);
636 if (idx >= start_idx && idx < start_idx + max_num_domains) {
637 dom = talloc_zero(ctx, sizeof(*dom));
639 /* free returned tdb record */
640 return NT_STATUS_NO_MEMORY;
643 /* copy domain sid */
644 SMB_ASSERT(sizeof(dom->sid) == sizeof(pass->domain_sid));
645 memcpy(&(dom->sid), &(pass->domain_sid), sizeof(dom->sid));
647 /* copy unicode domain name */
648 dom->name = talloc_strdup_w(ctx, pass->uni_name);
650 (*domains)[idx - start_idx] = dom;
652 DEBUG(18, ("Secret record is in required range.\n \
653 start_idx = %d, max_num_domains = %d. Added to returned array.\n",
654 start_idx, max_num_domains));
659 /* set proper status code to return */
661 /* there are yet some entries to enumerate */
662 status = STATUS_MORE_ENTRIES;
664 /* this is the last entry in the whole enumeration */
665 status = NT_STATUS_OK;
668 DEBUG(18, ("Secret is outside the required range.\n \
669 start_idx = %d, max_num_domains = %d. Not added to returned array\n",
670 start_idx, max_num_domains));
676 DEBUG(5, ("secrets_get_trusted_domains: got %d domains\n", *num_domains));
678 /* free the results of searching the keys */
679 tdb_search_list_free(keys);
684 /*******************************************************************************
685 Lock the secrets tdb based on a string - this is used as a primitive form of mutex
686 between smbd instances.
687 *******************************************************************************/
689 BOOL secrets_named_mutex(const char *name, unsigned int timeout)
696 ret = tdb_lock_bystring(tdb, name, timeout);
698 DEBUG(10,("secrets_named_mutex: got mutex for %s\n", name ));
703 /*******************************************************************************
704 Unlock a named mutex.
705 *******************************************************************************/
707 void secrets_named_mutex_release(const char *name)
709 tdb_unlock_bystring(tdb, name);
710 DEBUG(10,("secrets_named_mutex: released mutex for %s\n", name ));
713 /*********************************************************
714 Check to see if we must talk to the PDC to avoid sam
716 ********************************************************/
718 BOOL must_use_pdc( const char *domain )
720 time_t now = time(NULL);
721 time_t last_change_time;
722 unsigned char passwd[16];
724 if ( !secrets_fetch_trust_account_password(domain, passwd, &last_change_time, NULL) )
728 * If the time the machine password has changed
729 * was less than about 15 minutes then we need to contact
730 * the PDC only, as we cannot be sure domain replication
731 * has yet taken place. Bug found by Gerald (way to go
735 if ( now - last_change_time < SAM_SYNC_WINDOW )