source3/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(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                 return True;
 244         }
 245
 246         if (!(pass = secrets_fetch(trust_keystr(domain), &size))) {
 247                 DEBUG(5, ("secrets_fetch failed!\n"));
 248                 return False;
 249         }
 250
 251         if (size != sizeof(*pass)) {
 252                 DEBUG(0, ("secrets were of incorrect size!\n"));
 253                 return False;
 254         }
 255
 256         if (pass_last_set_time) *pass_last_set_time = pass->mod_time;
 257         memcpy(ret_pwd, pass->hash, 16);
 258         SAFE_FREE(pass);
 259         return True;
 260 }
 261
 262 /************************************************************************
 263  Routine to get account password to trusted domain
 264 ************************************************************************/
 265
 266 BOOL secrets_fetch_trusted_domain_password(char *domain, char** pwd,
 267                                            DOM_SID *sid, time_t *pass_last_set_time)
 268 {
 269         struct trusted_dom_pass *pass;
 270         size_t size;
 271
 272         /* fetching trusted domain password structure */
 273         if (!(pass = secrets_fetch(trustdom_keystr(domain), &size))) {
 274                 DEBUG(5, ("secrets_fetch failed!\n"));
 275                 return False;
 276         }
 277
 278         if (size != sizeof(*pass)) {
 279                 DEBUG(0, ("secrets were of incorrect size!\n"));
 280                 return False;
 281         }
 282
 283         /* the trust's password */
 284         if (pwd) {
 285                 *pwd = strdup(pass->pass);
 286                 if (!*pwd) {
 287                         return False;
 288                 }
 289         }
 290
 291         /* last change time */
 292         if (pass_last_set_time) *pass_last_set_time = pass->mod_time;
 293
 294         /* domain sid */
 295         memcpy(&sid, &(pass->domain_sid), sizeof(sid));
 296
 297         SAFE_FREE(pass);
 298
 299         return True;
 300 }
 301
 302 /************************************************************************
 303  Routine to set the trust account password for a domain.
 304 ************************************************************************/
 305 BOOL secrets_store_trust_account_password(char *domain, uint8 new_pwd[16])
 306 {
 307         struct machine_acct_pass pass;
 308
 309         pass.mod_time = time(NULL);
 310         memcpy(pass.hash, new_pwd, 16);
 311
 312         return secrets_store(trust_keystr(domain), (void *)&pass, sizeof(pass));
 313 }
 314
 315 /**
 316  * Routine to set the password for trusted domain
 317  *
 318  * @param domain remote domain name
 319  * @param pwd plain text password of trust relationship
 320  * @param sid remote domain sid
 321  *
 322  * @return true if succeeded
 323  **/
 324
 325 BOOL secrets_store_trusted_domain_password(char* domain, smb_ucs2_t *uni_dom_name,
 326                                            size_t uni_name_len, char* pwd,
 327                                            DOM_SID sid)
 328 {
 329         struct trusted_dom_pass pass;
 330         ZERO_STRUCT(pass);
 331
 332         /* unicode domain name and its length */
 333         if (!uni_dom_name)
 334                 return False;
 335
 336         strncpy_w(pass.uni_name, uni_dom_name, sizeof(pass.uni_name) - 1);
 337         pass.uni_name_len = uni_name_len;
 338
 339         /* last change time */
 340         pass.mod_time = time(NULL);
 341
 342         /* password of the trust */
 343         pass.pass_len = strlen(pwd);
 344         fstrcpy(pass.pass, pwd);
 345
 346         /* domain sid */
 347         memcpy(&(pass.domain_sid), &sid, sizeof(sid));
 348
 349         return secrets_store(trustdom_keystr(domain), (void *)&pass, sizeof(pass));
 350 }
 351
 352 /************************************************************************
 353  Routine to set the plaintext machine account password for a realm
 354 the password is assumed to be a null terminated ascii string
 355 ************************************************************************/
 356 BOOL secrets_store_machine_password(char *pass)
 357 {
 358         char *key;
 359         BOOL ret;
 360         asprintf(&key, "%s/%s", SECRETS_MACHINE_PASSWORD, lp_workgroup());
 361         strupper(key);
 362         ret = secrets_store(key, pass, strlen(pass)+1);
 363         free(key);
 364         return ret;
 365 }
 366
 367
 368 /************************************************************************
 369  Routine to fetch the plaintext machine account password for a realm
 370 the password is assumed to be a null terminated ascii string
 371 ************************************************************************/
 372 char *secrets_fetch_machine_password(void)
 373 {
 374         char *key;
 375         char *ret;
 376         asprintf(&key, "%s/%s", SECRETS_MACHINE_PASSWORD, lp_workgroup());
 377         strupper(key);
 378         ret = (char *)secrets_fetch(key, NULL);
 379         free(key);
 380         return ret;
 381 }
 382
 383
 384
 385 /************************************************************************
 386  Routine to delete the machine trust account password file for a domain.
 387 ************************************************************************/
 388
 389 BOOL trust_password_delete(const char *domain)
 390 {
 391         return secrets_delete(trust_keystr(domain));
 392 }
 393
 394 /************************************************************************
 395  Routine to delete the password for trusted domain
 396 ************************************************************************/
 397 BOOL trusted_domain_password_delete(const char *domain)
 398 {
 399         return secrets_delete(trustdom_keystr(domain));
 400 }
 401
 402
 403 /*******************************************************************
 404  Reset the 'done' variables so after a client process is created
 405  from a fork call these calls will be re-done. This should be
 406  expanded if more variables need reseting.
 407  ******************************************************************/
 408
 409 void reset_globals_after_fork(void)
 410 {
 411         unsigned char dummy;
 412
 413         secrets_init();
 414
 415         /*
 416          * Increment the global seed value to ensure every smbd starts
 417          * with a new random seed.
 418          */
 419
 420         if (tdb) {
 421                 uint32 initial_val = sys_getpid();
 422                 tdb_change_int32_atomic(tdb, "INFO/random_seed", (int *)&initial_val, 1);
 423                 set_rand_reseed_data((unsigned char *)&initial_val, sizeof(initial_val));
 424         }
 425
 426         /*
 427          * Re-seed the random crypto generator, so all smbd's
 428          * started from the same parent won't generate the same
 429          * sequence.
 430          */
 431         generate_random_buffer( &dummy, 1, True);
 432 }
 433
 434 BOOL secrets_store_ldap_pw(const char* dn, char* pw)
 435 {
 436         char *key = NULL;
 437         BOOL ret;
 438
 439         if (asprintf(&key, "%s/%s", SECRETS_LDAP_BIND_PW, dn) < 0) {
 440                 DEBUG(0, ("secrets_store_ldap_pw: asprintf failed!\n"));
 441                 return False;
 442         }
 443
 444         ret = secrets_store(key, pw, strlen(pw)+1);
 445
 446         SAFE_FREE(key);
 447         return ret;
 448 }
 449
 450
 451 /**
 452  * Get trusted domains info from secrets.tdb.
 453  *
 454  * The linked list is allocated on the supplied talloc context, caller gets to destroy
 455  * when done.
 456  *
 457  * @param ctx Allocation context
 458  * @param enum_ctx Starting index, eg. we can start fetching at third
 459  *        or sixth trusted domain entry. Zero is the first index.
 460  *        Value it is set to is the enum context for the next enumeration.
 461  * @param num_domains Number of domain entries to fetch at one call
 462  * @param domains Pointer to array of trusted domain structs to be filled up
 463  *
 464  * @return nt status code of rpc response
 465  **/
 466
 467 NTSTATUS secrets_get_trusted_domains(TALLOC_CTX* ctx, int* enum_ctx, int max_num_domains, int *num_domains, TRUSTDOM ***domains)
 468 {
 469         TDB_LIST_NODE *keys, *k;
 470         TRUSTDOM *dom = NULL;
 471         char *pattern;
 472         int start_idx;
 473         uint32 idx = 0;
 474         size_t size;
 475         fstring dom_name;
 476         struct trusted_dom_pass *pass;
 477         NTSTATUS status;
 478
 479         if (!secrets_init()) return NT_STATUS_ACCESS_DENIED;
 480
 481         *num_domains = 0;
 482         start_idx = *enum_ctx;
 483
 484         /* generate searching pattern */
 485         if (!(pattern = talloc_asprintf(ctx, "%s/*", SECRETS_DOMTRUST_ACCT_PASS))) {
 486                 DEBUG(0, ("secrets_get_trusted_domains: talloc_asprintf() failed!\n"));
 487                 return NT_STATUS_NO_MEMORY;
 488         }
 489
 490         DEBUG(5, ("secrets_get_trusted_domains: looking for %d domains, starting at index %d\n",
 491                   max_num_domains, *enum_ctx));
 492
 493         *domains = talloc_zero(ctx, sizeof(**domains)*max_num_domains);
 494
 495         /* fetching trusted domains' data and collecting them in a list */
 496         keys = tdb_search_keys(tdb, pattern);
 497
 498         /*
 499          * if there's no keys returned ie. no trusted domain,
 500          * return "no more entries" code
 501          */
 502         status = NT_STATUS_NO_MORE_ENTRIES;
 503
 504         /* searching for keys in sectrets db -- way to go ... */
 505         for (k = keys; k; k = k->next) {
 506                 char *secrets_key;
 507
 508                 /* important: ensure null-termination of the key string */
 509                 secrets_key = strndup(k->node_key.dptr, k->node_key.dsize);
 510                 if (!secrets_key) {
 511                         DEBUG(0, ("strndup failed!\n"));
 512                         return NT_STATUS_NO_MEMORY;
 513                 }
 514
 515                 pass = secrets_fetch(secrets_key, &size);
 516
 517                 if (size != sizeof(*pass)) {
 518                         DEBUG(2, ("Secrets record %s is invalid!\n", secrets_key));
 519                         SAFE_FREE(pass);
 520                         continue;
 521                 }
 522
 523                 pull_ucs2_fstring(dom_name, pass->uni_name);
 524                 DEBUG(18, ("Fetched secret record num %d.\nDomain name: %s, SID: %s\n",
 525                            idx, dom_name, sid_string_static(&pass->domain_sid)));
 526
 527                 SAFE_FREE(secrets_key);
 528
 529                 if (idx >= start_idx && idx < start_idx + max_num_domains) {
 530                         dom = talloc_zero(ctx, sizeof(*dom));
 531                         if (!dom) {
 532                                 /* free returned tdb record */
 533                                 SAFE_FREE(pass);
 534
 535                                 return NT_STATUS_NO_MEMORY;
 536                         }
 537
 538                         /* copy domain sid */
 539                         SMB_ASSERT(sizeof(dom->sid) == sizeof(pass->domain_sid));
 540                         memcpy(&(dom->sid), &(pass->domain_sid), sizeof(dom->sid));
 541
 542                         /* copy unicode domain name */
 543                         dom->name = talloc_strdup_w(ctx, pass->uni_name);
 544
 545                         (*domains)[idx - start_idx] = dom;
 546
 547                         DEBUG(18, ("Secret record is in required range.\n \
 548                                    start_idx = %d, max_num_domains = %d. Added to returned array.\n",
 549                                    start_idx, max_num_domains));
 550
 551                         *enum_ctx = idx + 1;
 552                         (*num_domains)++;
 553
 554                         /* set proper status code to return */
 555                         if (k->next) {
 556                                 /* there are yet some entries to enumerate */
 557                                 status = STATUS_MORE_ENTRIES;
 558                         } else {
 559                                 /* this is the last entry in the whole enumeration */
 560                                 status = NT_STATUS_OK;
 561                         }
 562                 } else {
 563                         DEBUG(18, ("Secret is outside the required range.\n \
 564                                    start_idx = %d, max_num_domains = %d. Not added to returned array\n",
 565                                    start_idx, max_num_domains));
 566                 }
 567
 568                 idx++;
 569
 570                 /* free returned tdb record */
 571                 SAFE_FREE(pass);
 572         }
 573
 574         DEBUG(5, ("secrets_get_trusted_domains: got %d domains\n", *num_domains));
 575
 576         /* free the results of searching the keys */
 577         tdb_search_list_free(keys);
 578
 579         return status;
 580 }
 581
 582 /*******************************************************************************
 583  Lock the secrets tdb based on a string - this is used as a primitive form of mutex
 584  between smbd instances.
 585 *******************************************************************************/
 586
 587 BOOL secrets_named_mutex(const char *name, unsigned int timeout)
 588 {
 589         int ret;
 590
 591         if (!message_init())
 592                 return False;
 593
 594         ret = tdb_lock_bystring(tdb, name, timeout);
 595         if (ret == 0)
 596                 DEBUG(10,("secrets_named_mutex: got mutex for %s\n", name ));
 597
 598         return (ret == 0);
 599 }
 600
 601 /*******************************************************************************
 602  Unlock a named mutex.
 603 *******************************************************************************/
 604
 605 void secrets_named_mutex_release(char *name)
 606 {
 607         tdb_unlock_bystring(tdb, name);
 608         DEBUG(10,("secrets_named_mutex: released mutex for %s\n", name ));
 609 }