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