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