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 static char *trustdom_keystr(const char *domain
)
200 static pstring keystr
;
202 pstr_sprintf(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 DEBUG(4,("Using cleartext machine password\n"));
256 E_md4hash(plaintext
, ret_pwd
);
257 SAFE_FREE(plaintext
);
261 if (!(pass
= secrets_fetch(trust_keystr(domain
), &size
))) {
262 DEBUG(5, ("secrets_fetch failed!\n"));
266 if (size
!= sizeof(*pass
)) {
267 DEBUG(0, ("secrets were of incorrect size!\n"));
271 if (pass_last_set_time
) *pass_last_set_time
= pass
->mod_time
;
272 memcpy(ret_pwd
, pass
->hash
, 16);
276 *channel
= get_default_sec_channel();
281 /************************************************************************
282 Routine to get account password to trusted domain
283 ************************************************************************/
285 BOOL
secrets_fetch_trusted_domain_password(const char *domain
, char** pwd
,
286 DOM_SID
*sid
, time_t *pass_last_set_time
)
288 struct trusted_dom_pass pass
;
291 /* unpacking structures */
297 /* fetching trusted domain password structure */
298 if (!(pass_buf
= secrets_fetch(trustdom_keystr(domain
), &size
))) {
299 DEBUG(5, ("secrets_fetch failed!\n"));
303 /* unpack trusted domain password */
304 pass_len
= tdb_trusted_dom_pass_unpack(pass_buf
, size
, &pass
);
307 if (pass_len
!= size
) {
308 DEBUG(5, ("Invalid secrets size. Unpacked data doesn't match trusted_dom_pass structure.\n"));
312 /* the trust's password */
314 *pwd
= strdup(pass
.pass
);
320 /* last change time */
321 if (pass_last_set_time
) *pass_last_set_time
= pass
.mod_time
;
324 sid_copy(sid
, &pass
.domain_sid
);
329 /************************************************************************
330 Routine to set the trust account password for a domain.
331 ************************************************************************/
333 BOOL
secrets_store_trust_account_password(const char *domain
, uint8 new_pwd
[16])
335 struct machine_acct_pass pass
;
337 pass
.mod_time
= time(NULL
);
338 memcpy(pass
.hash
, new_pwd
, 16);
340 return secrets_store(trust_keystr(domain
), (void *)&pass
, sizeof(pass
));
344 * Routine to store the password for trusted domain
346 * @param domain remote domain name
347 * @param pwd plain text password of trust relationship
348 * @param sid remote domain sid
350 * @return true if succeeded
353 BOOL
secrets_store_trusted_domain_password(const char* domain
, smb_ucs2_t
*uni_dom_name
,
354 size_t uni_name_len
, const char* pwd
,
357 /* packing structures */
360 int pass_buf_len
= sizeof(pass_buf
);
362 struct trusted_dom_pass pass
;
365 /* unicode domain name and its length */
369 strncpy_w(pass
.uni_name
, uni_dom_name
, sizeof(pass
.uni_name
) - 1);
370 pass
.uni_name_len
= uni_name_len
;
372 /* last change time */
373 pass
.mod_time
= time(NULL
);
375 /* password of the trust */
376 pass
.pass_len
= strlen(pwd
);
377 fstrcpy(pass
.pass
, pwd
);
380 sid_copy(&pass
.domain_sid
, &sid
);
382 pass_len
= tdb_trusted_dom_pass_pack(pass_buf
, pass_buf_len
, &pass
);
384 return secrets_store(trustdom_keystr(domain
), (void *)&pass_buf
, pass_len
);
387 /************************************************************************
388 Routine to set the plaintext machine account password for a realm
389 the password is assumed to be a null terminated ascii string
390 ************************************************************************/
392 BOOL
secrets_store_machine_password(const char *pass
, const char *domain
, uint32 sec_channel
)
396 uint32 last_change_time
;
397 uint32 sec_channel_type
;
399 asprintf(&key
, "%s/%s", SECRETS_MACHINE_PASSWORD
, domain
);
404 ret
= secrets_store(key
, pass
, strlen(pass
)+1);
410 asprintf(&key
, "%s/%s", SECRETS_MACHINE_LAST_CHANGE_TIME
, domain
);
415 SIVAL(&last_change_time
, 0, time(NULL
));
416 ret
= secrets_store(key
, &last_change_time
, sizeof(last_change_time
));
419 asprintf(&key
, "%s/%s", SECRETS_MACHINE_SEC_CHANNEL_TYPE
, domain
);
424 SIVAL(&sec_channel_type
, 0, sec_channel
);
425 ret
= secrets_store(key
, &sec_channel_type
, sizeof(sec_channel_type
));
432 /************************************************************************
433 Routine to fetch the plaintext machine account password for a realm
434 the password is assumed to be a null terminated ascii string
435 ************************************************************************/
436 char *secrets_fetch_machine_password(const char *domain
,
437 time_t *pass_last_set_time
,
442 asprintf(&key
, "%s/%s", SECRETS_MACHINE_PASSWORD
, domain
);
444 ret
= (char *)secrets_fetch(key
, NULL
);
447 if (pass_last_set_time
) {
449 uint32
*last_set_time
;
450 asprintf(&key
, "%s/%s", SECRETS_MACHINE_LAST_CHANGE_TIME
, domain
);
452 last_set_time
= secrets_fetch(key
, &size
);
454 *pass_last_set_time
= IVAL(last_set_time
,0);
455 SAFE_FREE(last_set_time
);
457 *pass_last_set_time
= 0;
464 uint32
*channel_type
;
465 asprintf(&key
, "%s/%s", SECRETS_MACHINE_SEC_CHANNEL_TYPE
, domain
);
467 channel_type
= secrets_fetch(key
, &size
);
469 *channel
= IVAL(channel_type
,0);
470 SAFE_FREE(channel_type
);
472 *channel
= get_default_sec_channel();
482 /************************************************************************
483 Routine to delete the machine trust account password file for a domain.
484 ************************************************************************/
486 BOOL
trust_password_delete(const char *domain
)
488 return secrets_delete(trust_keystr(domain
));
491 /************************************************************************
492 Routine to delete the password for trusted domain
493 ************************************************************************/
495 BOOL
trusted_domain_password_delete(const char *domain
)
497 return secrets_delete(trustdom_keystr(domain
));
501 /*******************************************************************
502 Reset the 'done' variables so after a client process is created
503 from a fork call these calls will be re-done. This should be
504 expanded if more variables need reseting.
505 ******************************************************************/
507 void reset_globals_after_fork(void)
514 * Increment the global seed value to ensure every smbd starts
515 * with a new random seed.
519 uint32 initial_val
= sys_getpid();
520 tdb_change_int32_atomic(tdb
, "INFO/random_seed", (int *)&initial_val
, 1);
521 set_rand_reseed_data((unsigned char *)&initial_val
, sizeof(initial_val
));
525 * Re-seed the random crypto generator, so all smbd's
526 * started from the same parent won't generate the same
529 generate_random_buffer( &dummy
, 1, True
);
532 BOOL
secrets_store_ldap_pw(const char* dn
, char* pw
)
537 if (asprintf(&key
, "%s/%s", SECRETS_LDAP_BIND_PW
, dn
) < 0) {
538 DEBUG(0, ("secrets_store_ldap_pw: asprintf failed!\n"));
542 ret
= secrets_store(key
, pw
, strlen(pw
)+1);
550 * Get trusted domains info from secrets.tdb.
552 * The linked list is allocated on the supplied talloc context, caller gets to destroy
555 * @param ctx Allocation context
556 * @param enum_ctx Starting index, eg. we can start fetching at third
557 * or sixth trusted domain entry. Zero is the first index.
558 * Value it is set to is the enum context for the next enumeration.
559 * @param num_domains Number of domain entries to fetch at one call
560 * @param domains Pointer to array of trusted domain structs to be filled up
562 * @return nt status code of rpc response
565 NTSTATUS
secrets_get_trusted_domains(TALLOC_CTX
* ctx
, int* enum_ctx
, unsigned int max_num_domains
, int *num_domains
, TRUSTDOM
***domains
)
567 TDB_LIST_NODE
*keys
, *k
;
568 TRUSTDOM
*dom
= NULL
;
570 unsigned int start_idx
;
572 size_t size
, packed_size
= 0;
575 struct trusted_dom_pass
*pass
= talloc_zero(ctx
, sizeof(struct trusted_dom_pass
));
578 if (!secrets_init()) return NT_STATUS_ACCESS_DENIED
;
581 DEBUG(0, ("talloc_zero failed!\n"));
582 return NT_STATUS_NO_MEMORY
;
586 start_idx
= *enum_ctx
;
588 /* generate searching pattern */
589 if (!(pattern
= talloc_asprintf(ctx
, "%s/*", SECRETS_DOMTRUST_ACCT_PASS
))) {
590 DEBUG(0, ("secrets_get_trusted_domains: talloc_asprintf() failed!\n"));
591 return NT_STATUS_NO_MEMORY
;
594 DEBUG(5, ("secrets_get_trusted_domains: looking for %d domains, starting at index %d\n",
595 max_num_domains
, *enum_ctx
));
597 *domains
= talloc_zero(ctx
, sizeof(**domains
)*max_num_domains
);
599 /* fetching trusted domains' data and collecting them in a list */
600 keys
= tdb_search_keys(tdb
, pattern
);
603 * if there's no keys returned ie. no trusted domain,
604 * return "no more entries" code
606 status
= NT_STATUS_NO_MORE_ENTRIES
;
608 /* searching for keys in secrets db -- way to go ... */
609 for (k
= keys
; k
; k
= k
->next
) {
612 /* important: ensure null-termination of the key string */
613 secrets_key
= strndup(k
->node_key
.dptr
, k
->node_key
.dsize
);
615 DEBUG(0, ("strndup failed!\n"));
616 return NT_STATUS_NO_MEMORY
;
619 packed_pass
= secrets_fetch(secrets_key
, &size
);
620 packed_size
= tdb_trusted_dom_pass_unpack(packed_pass
, size
, pass
);
621 /* packed representation isn't needed anymore */
622 SAFE_FREE(packed_pass
);
624 if (size
!= packed_size
) {
625 DEBUG(2, ("Secrets record %s is invalid!\n", secrets_key
));
629 pull_ucs2_fstring(dom_name
, pass
->uni_name
);
630 DEBUG(18, ("Fetched secret record num %d.\nDomain name: %s, SID: %s\n",
631 idx
, dom_name
, sid_string_static(&pass
->domain_sid
)));
633 SAFE_FREE(secrets_key
);
635 if (idx
>= start_idx
&& idx
< start_idx
+ max_num_domains
) {
636 dom
= talloc_zero(ctx
, sizeof(*dom
));
638 /* free returned tdb record */
639 return NT_STATUS_NO_MEMORY
;
642 /* copy domain sid */
643 SMB_ASSERT(sizeof(dom
->sid
) == sizeof(pass
->domain_sid
));
644 memcpy(&(dom
->sid
), &(pass
->domain_sid
), sizeof(dom
->sid
));
646 /* copy unicode domain name */
647 dom
->name
= talloc_strdup_w(ctx
, pass
->uni_name
);
649 (*domains
)[idx
- start_idx
] = dom
;
651 DEBUG(18, ("Secret record is in required range.\n \
652 start_idx = %d, max_num_domains = %d. Added to returned array.\n",
653 start_idx
, max_num_domains
));
658 /* set proper status code to return */
660 /* there are yet some entries to enumerate */
661 status
= STATUS_MORE_ENTRIES
;
663 /* this is the last entry in the whole enumeration */
664 status
= NT_STATUS_OK
;
667 DEBUG(18, ("Secret is outside the required range.\n \
668 start_idx = %d, max_num_domains = %d. Not added to returned array\n",
669 start_idx
, max_num_domains
));
675 DEBUG(5, ("secrets_get_trusted_domains: got %d domains\n", *num_domains
));
677 /* free the results of searching the keys */
678 tdb_search_list_free(keys
);
683 /*******************************************************************************
684 Lock the secrets tdb based on a string - this is used as a primitive form of mutex
685 between smbd instances.
686 *******************************************************************************/
688 BOOL
secrets_named_mutex(const char *name
, unsigned int timeout
)
695 ret
= tdb_lock_bystring(tdb
, name
, timeout
);
697 DEBUG(10,("secrets_named_mutex: got mutex for %s\n", name
));
702 /*******************************************************************************
703 Unlock a named mutex.
704 *******************************************************************************/
706 void secrets_named_mutex_release(const char *name
)
708 tdb_unlock_bystring(tdb
, name
);
709 DEBUG(10,("secrets_named_mutex: released mutex for %s\n", name
));
712 /*********************************************************
713 Check to see if we must talk to the PDC to avoid sam
715 ********************************************************/
717 BOOL
must_use_pdc( const char *domain
)
719 time_t now
= time(NULL
);
720 time_t last_change_time
;
721 unsigned char passwd
[16];
723 if ( !secrets_fetch_trust_account_password(domain
, passwd
, &last_change_time
, NULL
) )
727 * If the time the machine password has changed
728 * was less than about 15 minutes then we need to contact
729 * the PDC only, as we cannot be sure domain replication
730 * has yet taken place. Bug found by Gerald (way to go
734 if ( now
- last_change_time
< SAM_SYNC_WINDOW
)