source3/registry/reg_backend_db.c

   1 /*
   2  *  Unix SMB/CIFS implementation.
   3  *  Virtual Windows Registry Layer
   4  *  Copyright (C) Gerald Carter                     2002-2005
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 3 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 /* Implementation of internal registry database functions. */
  21
  22 #include "includes.h"
  23
  24 #undef DBGC_CLASS
  25 #define DBGC_CLASS DBGC_REGISTRY
  26
  27 static struct db_context *regdb = NULL;
  28 static int regdb_refcount;
  29
  30 static bool regdb_key_exists(const char *key);
  31 static bool regdb_key_is_base_key(const char *key);
  32
  33 /* List the deepest path into the registry.  All part components will be created.*/
  34
  35 /* If you want to have a part of the path controlled by the tdb and part by
  36    a virtual registry db (e.g. printing), then you have to list the deepest path.
  37    For example,"HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion/Print"
  38    allows the reg_db backend to handle everything up to
  39    "HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion" and then we'll hook
  40    the reg_printing backend onto the last component of the path (see
  41    KEY_PRINTING_2K in include/rpc_reg.h)   --jerry */
  42
  43 static const char *builtin_registry_paths[] = {
  44         KEY_PRINTING_2K,
  45         KEY_PRINTING_PORTS,
  46         KEY_PRINTING,
  47         KEY_SHARES,
  48         KEY_EVENTLOG,
  49         KEY_SMBCONF,
  50         KEY_PERFLIB,
  51         KEY_PERFLIB_009,
  52         KEY_GROUP_POLICY,
  53         KEY_SAMBA_GROUP_POLICY,
  54         KEY_GP_MACHINE_POLICY,
  55         KEY_GP_MACHINE_WIN_POLICY,
  56         KEY_HKCU,
  57         KEY_GP_USER_POLICY,
  58         KEY_GP_USER_WIN_POLICY,
  59         KEY_WINLOGON_GPEXT_PATH,
  60         "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Print\\Monitors",
  61         KEY_PROD_OPTIONS,
  62         "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Terminal Server\\DefaultUserConfiguration",
  63         KEY_TCPIP_PARAMS,
  64         KEY_NETLOGON_PARAMS,
  65         KEY_HKU,
  66         KEY_HKCR,
  67         KEY_HKPD,
  68         KEY_HKPT,
  69          NULL };
  70
  71 struct builtin_regkey_value {
  72         const char *path;
  73         const char *valuename;
  74         uint32 type;
  75         union {
  76                 const char *string;
  77                 uint32 dw_value;
  78         } data;
  79 };
  80
  81 static struct builtin_regkey_value builtin_registry_values[] = {
  82         { KEY_PRINTING_PORTS,
  83                 SAMBA_PRINTER_PORT_NAME, REG_SZ, { "" } },
  84         { KEY_PRINTING_2K,
  85                 "DefaultSpoolDirectory", REG_SZ, { "C:\\Windows\\System32\\Spool\\Printers" } },
  86         { KEY_EVENTLOG,
  87                 "DisplayName", REG_SZ, { "Event Log" } },
  88         { KEY_EVENTLOG,
  89                 "ErrorControl", REG_DWORD, { (char*)0x00000001 } },
  90         { NULL, NULL, 0, { NULL } }
  91 };
  92
  93 /**
  94  * Initialize a key in the registry:
  95  * create each component key of the specified path.
  96  */
  97 static WERROR init_registry_key_internal(const char *add_path)
  98 {
  99         WERROR werr;
 100         TALLOC_CTX *frame = talloc_stackframe();
 101         char *path = NULL;
 102         char *base = NULL;
 103         char *remaining = NULL;
 104         char *keyname;
 105         char *subkeyname;
 106         REGSUBKEY_CTR *subkeys;
 107         const char *p, *p2;
 108
 109         DEBUG(6, ("init_registry_key: Adding [%s]\n", add_path));
 110
 111         path = talloc_strdup(frame, add_path);
 112         base = talloc_strdup(frame, "");
 113         if (!path || !base) {
 114                 werr = WERR_NOMEM;
 115                 goto fail;
 116         }
 117         p = path;
 118
 119         while (next_token_talloc(frame, &p, &keyname, "\\")) {
 120
 121                 /* build up the registry path from the components */
 122
 123                 if (*base) {
 124                         base = talloc_asprintf(frame, "%s\\", base);
 125                         if (!base) {
 126                                 werr = WERR_NOMEM;
 127                                 goto fail;
 128                         }
 129                 }
 130                 base = talloc_asprintf_append(base, "%s", keyname);
 131                 if (!base) {
 132                         werr = WERR_NOMEM;
 133                         goto fail;
 134                 }
 135
 136                 /* get the immediate subkeyname (if we have one ) */
 137
 138                 subkeyname = talloc_strdup(frame, "");
 139                 if (!subkeyname) {
 140                         werr = WERR_NOMEM;
 141                         goto fail;
 142                 }
 143                 if (*p) {
 144                         remaining = talloc_strdup(frame, p);
 145                         if (!remaining) {
 146                                 werr = WERR_NOMEM;
 147                                 goto fail;
 148                         }
 149                         p2 = remaining;
 150
 151                         if (!next_token_talloc(frame, &p2,
 152                                                 &subkeyname, "\\"))
 153                         {
 154                                 subkeyname = talloc_strdup(frame,p2);
 155                                 if (!subkeyname) {
 156                                         werr = WERR_NOMEM;
 157                                         goto fail;
 158                                 }
 159                         }
 160                 }
 161
 162                 DEBUG(10,("init_registry_key: Storing key [%s] with "
 163                           "subkey [%s]\n", base,
 164                           *subkeyname ? subkeyname : "NULL"));
 165
 166                 /* we don't really care if the lookup succeeds or not
 167                  * since we are about to update the record.
 168                  * We just want any subkeys already present */
 169
 170                 if (!(subkeys = TALLOC_ZERO_P(frame, REGSUBKEY_CTR))) {
 171                         DEBUG(0,("talloc() failure!\n"));
 172                         werr = WERR_NOMEM;
 173                         goto fail;
 174                 }
 175
 176                 regdb_fetch_keys(base, subkeys);
 177                 if (*subkeyname) {
 178                         werr = regsubkey_ctr_addkey(subkeys, subkeyname);
 179                         if (!W_ERROR_IS_OK(werr)) {
 180                                 goto fail;
 181                         }
 182                 }
 183                 if (!regdb_store_keys( base, subkeys)) {
 184                         werr = WERR_CAN_NOT_COMPLETE;
 185                         goto fail;
 186                 }
 187         }
 188
 189         werr = WERR_OK;
 190
 191 fail:
 192         TALLOC_FREE(frame);
 193         return werr;
 194 }
 195
 196 /**
 197  * Initialize a key in the registry:
 198  * create each component key of the specified path,
 199  * wrapped in one db transaction.
 200  */
 201 WERROR init_registry_key(const char *add_path)
 202 {
 203         WERROR werr;
 204
 205         if (regdb_key_exists(add_path)) {
 206                 return WERR_OK;
 207         }
 208
 209         if (regdb->transaction_start(regdb) != 0) {
 210                 DEBUG(0, ("init_registry_key: transaction_start failed\n"));
 211                 return WERR_REG_IO_FAILURE;
 212         }
 213
 214         werr = init_registry_key_internal(add_path);
 215         if (!W_ERROR_IS_OK(werr)) {
 216                 goto fail;
 217         }
 218
 219         if (regdb->transaction_commit(regdb) != 0) {
 220                 DEBUG(0, ("init_registry_key: Could not commit transaction\n"));
 221                 return WERR_REG_IO_FAILURE;
 222         }
 223
 224         return WERR_OK;
 225
 226 fail:
 227         if (regdb->transaction_cancel(regdb) != 0) {
 228                 smb_panic("init_registry_key: transaction_cancel failed\n");
 229         }
 230
 231         return werr;
 232 }
 233
 234 /***********************************************************************
 235  Open the registry data in the tdb
 236  ***********************************************************************/
 237
 238 WERROR init_registry_data(void)
 239 {
 240         WERROR werr;
 241         TALLOC_CTX *frame = talloc_stackframe();
 242         REGVAL_CTR *values;
 243         int i;
 244         UNISTR2 data;
 245
 246         /*
 247          * First, check for the existence of the needed keys and values.
 248          * If all do already exist, we can save the writes.
 249          */
 250         for (i=0; builtin_registry_paths[i] != NULL; i++) {
 251                 if (!regdb_key_exists(builtin_registry_paths[i])) {
 252                         goto do_init;
 253                 }
 254         }
 255
 256         for (i=0; builtin_registry_values[i].path != NULL; i++) {
 257                 values = TALLOC_ZERO_P(frame, REGVAL_CTR);
 258                 if (values == NULL) {
 259                         werr = WERR_NOMEM;
 260                         goto done;
 261                 }
 262
 263                 regdb_fetch_values(builtin_registry_values[i].path, values);
 264                 if (!regval_ctr_key_exists(values,
 265                                         builtin_registry_values[i].valuename))
 266                 {
 267                         TALLOC_FREE(values);
 268                         goto do_init;
 269                 }
 270
 271                 TALLOC_FREE(values);
 272         }
 273
 274         werr = WERR_OK;
 275         goto done;
 276
 277 do_init:
 278
 279         /*
 280          * There are potentially quite a few store operations which are all
 281          * indiviually wrapped in tdb transactions. Wrapping them in a single
 282          * transaction gives just a single transaction_commit() to actually do
 283          * its fsync()s. See tdb/common/transaction.c for info about nested
 284          * transaction behaviour.
 285          */
 286
 287         if (regdb->transaction_start(regdb) != 0) {
 288                 DEBUG(0, ("init_registry_data: tdb_transaction_start "
 289                           "failed\n"));
 290                 werr = WERR_REG_IO_FAILURE;
 291                 goto done;
 292         }
 293
 294         /* loop over all of the predefined paths and add each component */
 295
 296         for (i=0; builtin_registry_paths[i] != NULL; i++) {
 297                 if (regdb_key_exists(builtin_registry_paths[i])) {
 298                         continue;
 299                 }
 300                 werr = init_registry_key_internal(builtin_registry_paths[i]);
 301                 if (!W_ERROR_IS_OK(werr)) {
 302                         goto fail;
 303                 }
 304         }
 305
 306         /* loop over all of the predefined values and add each component */
 307
 308         for (i=0; builtin_registry_values[i].path != NULL; i++) {
 309
 310                 values = TALLOC_ZERO_P(frame, REGVAL_CTR);
 311                 if (values == NULL) {
 312                         werr = WERR_NOMEM;
 313                         goto fail;
 314                 }
 315
 316                 regdb_fetch_values(builtin_registry_values[i].path, values);
 317
 318                 /* preserve existing values across restarts. Only add new ones */
 319
 320                 if (!regval_ctr_key_exists(values,
 321                                         builtin_registry_values[i].valuename))
 322                 {
 323                         switch(builtin_registry_values[i].type) {
 324                         case REG_DWORD:
 325                                 regval_ctr_addvalue(values,
 326                                         builtin_registry_values[i].valuename,
 327                                         REG_DWORD,
 328                                         (char*)&builtin_registry_values[i].data.dw_value,
 329                                         sizeof(uint32));
 330                                 break;
 331
 332                         case REG_SZ:
 333                                 init_unistr2(&data,
 334                                         builtin_registry_values[i].data.string,
 335                                         UNI_STR_TERMINATE);
 336                                 regval_ctr_addvalue(values,
 337                                         builtin_registry_values[i].valuename,
 338                                         REG_SZ,
 339                                         (char*)data.buffer,
 340                                         data.uni_str_len*sizeof(uint16));
 341                                 break;
 342
 343                         default:
 344                                 DEBUG(0, ("init_registry_data: invalid value "
 345                                           "type in builtin_registry_values "
 346                                           "[%d]\n",
 347                                           builtin_registry_values[i].type));
 348                         }
 349                         regdb_store_values(builtin_registry_values[i].path,
 350                                            values);
 351                 }
 352                 TALLOC_FREE(values);
 353         }
 354
 355         if (regdb->transaction_commit(regdb) != 0) {
 356                 DEBUG(0, ("init_registry_data: Could not commit "
 357                           "transaction\n"));
 358                 werr = WERR_REG_IO_FAILURE;
 359         } else {
 360                 werr = WERR_OK;
 361         }
 362
 363         goto done;
 364
 365 fail:
 366         if (regdb->transaction_cancel(regdb) != 0) {
 367                 smb_panic("init_registry_data: tdb_transaction_cancel "
 368                           "failed\n");
 369         }
 370
 371 done:
 372         TALLOC_FREE(frame);
 373         return werr;
 374 }
 375
 376 /***********************************************************************
 377  Open the registry database
 378  ***********************************************************************/
 379
 380 WERROR regdb_init(void)
 381 {
 382         const char *vstring = "INFO/version";
 383         uint32 vers_id;
 384         WERROR werr;
 385
 386         if (regdb) {
 387                 DEBUG(10, ("regdb_init: incrementing refcount (%d)\n",
 388                           regdb_refcount));
 389                 regdb_refcount++;
 390                 return WERR_OK;
 391         }
 392
 393         regdb = db_open(NULL, state_path("registry.tdb"), 0,
 394                               REG_TDB_FLAGS, O_RDWR, 0600);
 395         if (!regdb) {
 396                 regdb = db_open(NULL, state_path("registry.tdb"), 0,
 397                                       REG_TDB_FLAGS, O_RDWR|O_CREAT, 0600);
 398                 if (!regdb) {
 399                         werr = ntstatus_to_werror(map_nt_error_from_unix(errno));
 400                         DEBUG(1,("regdb_init: Failed to open registry %s (%s)\n",
 401                                 state_path("registry.tdb"), strerror(errno) ));
 402                         return werr;
 403                 }
 404
 405                 DEBUG(10,("regdb_init: Successfully created registry tdb\n"));
 406         }
 407
 408         regdb_refcount = 1;
 409
 410         vers_id = dbwrap_fetch_int32(regdb, vstring);
 411
 412         if ( vers_id != REGVER_V1 ) {
 413                 NTSTATUS status;
 414                 /* any upgrade code here if needed */
 415                 DEBUG(10, ("regdb_init: got %s = %d != %d\n", vstring,
 416                            vers_id, REGVER_V1));
 417                 status = dbwrap_trans_store_int32(regdb, vstring, REGVER_V1);
 418                 if (!NT_STATUS_IS_OK(status)) {
 419                         DEBUG(1, ("regdb_init: error storing %s = %d: %s\n",
 420                                   vstring, REGVER_V1, nt_errstr(status)));
 421                         return ntstatus_to_werror(status);
 422                 } else {
 423                         DEBUG(10, ("regdb_init: stored %s = %d\n",
 424                                   vstring, REGVER_V1));
 425                 }
 426         }
 427
 428         return WERR_OK;
 429 }
 430
 431 /***********************************************************************
 432  Open the registry.  Must already have been initialized by regdb_init()
 433  ***********************************************************************/
 434
 435 WERROR regdb_open( void )
 436 {
 437         WERROR result = WERR_OK;
 438
 439         if ( regdb ) {
 440                 DEBUG(10,("regdb_open: incrementing refcount (%d)\n", regdb_refcount));
 441                 regdb_refcount++;
 442                 return WERR_OK;
 443         }
 444
 445         become_root();
 446
 447         regdb = db_open(NULL, state_path("registry.tdb"), 0,
 448                               REG_TDB_FLAGS, O_RDWR, 0600);
 449         if ( !regdb ) {
 450                 result = ntstatus_to_werror( map_nt_error_from_unix( errno ) );
 451                 DEBUG(0,("regdb_open: Failed to open %s! (%s)\n",
 452                         state_path("registry.tdb"), strerror(errno) ));
 453         }
 454
 455         unbecome_root();
 456
 457         regdb_refcount = 1;
 458         DEBUG(10,("regdb_open: refcount reset (%d)\n", regdb_refcount));
 459
 460         return result;
 461 }
 462
 463 /***********************************************************************
 464  ***********************************************************************/
 465
 466 int regdb_close( void )
 467 {
 468         if (regdb_refcount == 0) {
 469                 return 0;
 470         }
 471
 472         regdb_refcount--;
 473
 474         DEBUG(10,("regdb_close: decrementing refcount (%d)\n", regdb_refcount));
 475
 476         if ( regdb_refcount > 0 )
 477                 return 0;
 478
 479         SMB_ASSERT( regdb_refcount >= 0 );
 480
 481         TALLOC_FREE(regdb);
 482         return 0;
 483 }
 484
 485 /***********************************************************************
 486  return the tdb sequence number of the registry tdb.
 487  this is an indicator for the content of the registry
 488  having changed. it will change upon regdb_init, too, though.
 489  ***********************************************************************/
 490 int regdb_get_seqnum(void)
 491 {
 492         return regdb->get_seqnum(regdb);
 493 }
 494
 495 /***********************************************************************
 496  Add subkey strings to the registry tdb under a defined key
 497  fmt is the same format as tdb_pack except this function only supports
 498  fstrings
 499  ***********************************************************************/
 500
 501 static bool regdb_store_keys_internal(const char *key, REGSUBKEY_CTR *ctr)
 502 {
 503         TDB_DATA dbuf;
 504         uint8 *buffer = NULL;
 505         int i = 0;
 506         uint32 len, buflen;
 507         bool ret = true;
 508         uint32 num_subkeys = regsubkey_ctr_numkeys(ctr);
 509         char *keyname = NULL;
 510         TALLOC_CTX *ctx = talloc_stackframe();
 511         NTSTATUS status;
 512
 513         if (!key) {
 514                 return false;
 515         }
 516
 517         keyname = talloc_strdup(ctx, key);
 518         if (!keyname) {
 519                 return false;
 520         }
 521         keyname = normalize_reg_path(ctx, keyname);
 522
 523         /* allocate some initial memory */
 524
 525         buffer = (uint8 *)SMB_MALLOC(1024);
 526         if (buffer == NULL) {
 527                 return false;
 528         }
 529         buflen = 1024;
 530         len = 0;
 531
 532         /* store the number of subkeys */
 533
 534         len += tdb_pack(buffer+len, buflen-len, "d", num_subkeys);
 535
 536         /* pack all the strings */
 537
 538         for (i=0; i<num_subkeys; i++) {
 539                 size_t thistime;
 540
 541                 thistime = tdb_pack(buffer+len, buflen-len, "f",
 542                                     regsubkey_ctr_specific_key(ctr, i));
 543                 if (len+thistime > buflen) {
 544                         size_t thistime2;
 545                         /*
 546                          * tdb_pack hasn't done anything because of the short
 547                          * buffer, allocate extra space.
 548                          */
 549                         buffer = SMB_REALLOC_ARRAY(buffer, uint8_t,
 550                                                    (len+thistime)*2);
 551                         if(buffer == NULL) {
 552                                 DEBUG(0, ("regdb_store_keys: Failed to realloc "
 553                                           "memory of size [%d]\n",
 554                                           (len+thistime)*2));
 555                                 ret = false;
 556                                 goto done;
 557                         }
 558                         buflen = (len+thistime)*2;
 559                         thistime2 = tdb_pack(
 560                                 buffer+len, buflen-len, "f",
 561                                 regsubkey_ctr_specific_key(ctr, i));
 562                         if (thistime2 != thistime) {
 563                                 DEBUG(0, ("tdb_pack failed\n"));
 564                                 ret = false;
 565                                 goto done;
 566                         }
 567                 }
 568                 len += thistime;
 569         }
 570
 571         /* finally write out the data */
 572
 573         dbuf.dptr = buffer;
 574         dbuf.dsize = len;
 575         status = dbwrap_store_bystring(regdb, keyname, dbuf, TDB_REPLACE);
 576         if (!NT_STATUS_IS_OK(status)) {
 577                 ret = false;
 578                 goto done;
 579         }
 580
 581 done:
 582         TALLOC_FREE(ctx);
 583         SAFE_FREE(buffer);
 584         return ret;
 585 }
 586
 587 /***********************************************************************
 588  Store the new subkey record and create any child key records that
 589  do not currently exist
 590  ***********************************************************************/
 591
 592 bool regdb_store_keys(const char *key, REGSUBKEY_CTR *ctr)
 593 {
 594         int num_subkeys, i;
 595         char *path = NULL;
 596         REGSUBKEY_CTR *subkeys = NULL, *old_subkeys = NULL;
 597         char *oldkeyname = NULL;
 598         TALLOC_CTX *ctx = talloc_stackframe();
 599         NTSTATUS status;
 600
 601         if (!regdb_key_is_base_key(key) && !regdb_key_exists(key)) {
 602                 goto fail;
 603         }
 604
 605         /*
 606          * fetch a list of the old subkeys so we can determine if anything has
 607          * changed
 608          */
 609
 610         if (!(old_subkeys = TALLOC_ZERO_P(ctx, REGSUBKEY_CTR))) {
 611                 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
 612                 return false;
 613         }
 614
 615         regdb_fetch_keys(key, old_subkeys);
 616
 617         if ((ctr->num_subkeys && old_subkeys->num_subkeys) &&
 618             (ctr->num_subkeys == old_subkeys->num_subkeys)) {
 619
 620                 for (i = 0; i<ctr->num_subkeys; i++) {
 621                         if (strcmp(ctr->subkeys[i],
 622                                    old_subkeys->subkeys[i]) != 0) {
 623                                 break;
 624                         }
 625                 }
 626                 if (i == ctr->num_subkeys) {
 627                         /*
 628                          * Nothing changed, no point to even start a tdb
 629                          * transaction
 630                          */
 631                         TALLOC_FREE(old_subkeys);
 632                         return true;
 633                 }
 634         }
 635
 636         TALLOC_FREE(old_subkeys);
 637
 638         if (regdb->transaction_start(regdb) != 0) {
 639                 DEBUG(0, ("regdb_store_keys: transaction_start failed\n"));
 640                 goto fail;
 641         }
 642
 643         /*
 644          * Re-fetch the old keys inside the transaction
 645          */
 646
 647         if (!(old_subkeys = TALLOC_ZERO_P(ctx, REGSUBKEY_CTR))) {
 648                 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
 649                 goto cancel;
 650         }
 651
 652         regdb_fetch_keys(key, old_subkeys);
 653
 654         /*
 655          * Make the store operation as safe as possible without transactions:
 656          *
 657          * (1) For each subkey removed from ctr compared with old_subkeys:
 658          *
 659          *     (a) First delete the value db entry.
 660          *
 661          *     (b) Next delete the secdesc db record.
 662          *
 663          *     (c) Then delete the subkey list entry.
 664          *
 665          * (2) Now write the list of subkeys of the parent key,
 666          *     deleting removed entries and adding new ones.
 667          *
 668          * (3) Finally create the subkey list entries for the added keys.
 669          *
 670          * This way if we crash half-way in between deleting the subkeys
 671          * and storing the parent's list of subkeys, no old data can pop up
 672          * out of the blue when re-adding keys later on.
 673          */
 674
 675         /* (1) delete removed keys' lists (values/secdesc/subkeys) */
 676
 677         num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
 678         for (i=0; i<num_subkeys; i++) {
 679                 oldkeyname = regsubkey_ctr_specific_key(old_subkeys, i);
 680
 681                 if (regsubkey_ctr_key_exists(ctr, oldkeyname)) {
 682                         /*
 683                          * It's still around, don't delete
 684                          */
 685
 686                         continue;
 687                 }
 688
 689                 /* (a) Delete the value list for this key */
 690
 691                 path = talloc_asprintf(ctx, "%s/%s/%s",
 692                                 REG_VALUE_PREFIX,
 693                                 key,
 694                                 oldkeyname );
 695                 if (!path) {
 696                         goto cancel;
 697                 }
 698                 path = normalize_reg_path(ctx, path);
 699                 if (!path) {
 700                         goto cancel;
 701                 }
 702                 /* Ignore errors here, we might have no values around */
 703                 dbwrap_delete_bystring(regdb, path);
 704                 TALLOC_FREE(path);
 705
 706                 /* (b) Delete the secdesc for this key */
 707
 708                 path = talloc_asprintf(ctx, "%s/%s/%s",
 709                                 REG_SECDESC_PREFIX,
 710                                 key,
 711                                 oldkeyname );
 712                 if (!path) {
 713                         goto cancel;
 714                 }
 715                 path = normalize_reg_path(ctx, path);
 716                 if (!path) {
 717                         goto cancel;
 718                 }
 719                 status = dbwrap_delete_bystring(regdb, path);
 720                 /* Don't fail if there are no values around. */
 721                 if (!NT_STATUS_IS_OK(status) &&
 722                     !NT_STATUS_EQUAL(status, NT_STATUS_NOT_FOUND))
 723                 {
 724                         DEBUG(1, ("Deleting %s failed: %s\n", path,
 725                                   nt_errstr(status)));
 726                         goto cancel;
 727                 }
 728                 TALLOC_FREE(path);
 729
 730                 /* (c) Delete the list of subkeys of this key */
 731
 732                 path = talloc_asprintf(ctx, "%s/%s", key, oldkeyname);
 733                 if (!path) {
 734                         goto cancel;
 735                 }
 736                 path = normalize_reg_path(ctx, path);
 737                 if (!path) {
 738                         goto cancel;
 739                 }
 740                 status = dbwrap_delete_bystring(regdb, path);
 741                 /* Don't fail if the subkey record was not found. */
 742                 if (!NT_STATUS_IS_OK(status) &&
 743                     !NT_STATUS_EQUAL(status, NT_STATUS_NOT_FOUND))
 744                 {
 745                         DEBUG(1, ("Deleting %s failed: %s\n", path,
 746                                   nt_errstr(status)));
 747                         goto cancel;
 748                 }
 749                 TALLOC_FREE(path);
 750         }
 751
 752         TALLOC_FREE(old_subkeys);
 753
 754         /* (2) store the subkey list for the parent */
 755
 756         if (!regdb_store_keys_internal(key, ctr) ) {
 757                 DEBUG(0,("regdb_store_keys: Failed to store new subkey list "
 758                          "for parent [%s]\n", key));
 759                 goto cancel;
 760         }
 761
 762         /* (3) now create records for any subkeys that don't already exist */
 763
 764         num_subkeys = regsubkey_ctr_numkeys(ctr);
 765
 766         if (num_subkeys == 0) {
 767                 if (!(subkeys = TALLOC_ZERO_P(ctx, REGSUBKEY_CTR)) ) {
 768                         DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
 769                         goto cancel;
 770                 }
 771
 772                 if (!regdb_store_keys_internal(key, subkeys)) {
 773                         DEBUG(0,("regdb_store_keys: Failed to store "
 774                                  "new record for key [%s]\n", key));
 775                         goto cancel;
 776                 }
 777                 TALLOC_FREE(subkeys);
 778
 779         }
 780
 781         for (i=0; i<num_subkeys; i++) {
 782                 path = talloc_asprintf(ctx, "%s/%s",
 783                                         key,
 784                                         regsubkey_ctr_specific_key(ctr, i));
 785                 if (!path) {
 786                         goto cancel;
 787                 }
 788                 if (!(subkeys = TALLOC_ZERO_P(ctx, REGSUBKEY_CTR)) ) {
 789                         DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
 790                         goto cancel;
 791                 }
 792
 793                 if (regdb_fetch_keys( path, subkeys ) == -1) {
 794                         /* create a record with 0 subkeys */
 795                         if (!regdb_store_keys_internal(path, subkeys)) {
 796                                 DEBUG(0,("regdb_store_keys: Failed to store "
 797                                          "new record for key [%s]\n", path));
 798                                 goto cancel;
 799                         }
 800                 }
 801
 802                 TALLOC_FREE(subkeys);
 803                 TALLOC_FREE(path);
 804         }
 805
 806         if (regdb->transaction_commit(regdb) != 0) {
 807                 DEBUG(0, ("regdb_store_keys: Could not commit transaction\n"));
 808                 goto fail;
 809         }
 810
 811         TALLOC_FREE(ctx);
 812         return true;
 813
 814 cancel:
 815         if (regdb->transaction_cancel(regdb) != 0) {
 816                 smb_panic("regdb_store_keys: transaction_cancel failed\n");
 817         }
 818
 819 fail:
 820         TALLOC_FREE(ctx);
 821
 822         return false;
 823 }
 824
 825
 826 static TDB_DATA regdb_fetch_key_internal(TALLOC_CTX *mem_ctx, const char *key)
 827 {
 828         char *path = NULL;
 829         TDB_DATA data;
 830
 831         path = normalize_reg_path(mem_ctx, key);
 832         if (!path) {
 833                 return make_tdb_data(NULL, 0);
 834         }
 835
 836         data = dbwrap_fetch_bystring(regdb, mem_ctx, path);
 837
 838         TALLOC_FREE(path);
 839         return data;
 840 }
 841
 842
 843 /**
 844  * check whether a given key name represents a base key,
 845  * i.e one without a subkey separator ('/' or '\').
 846  */
 847 static bool regdb_key_is_base_key(const char *key)
 848 {
 849         TALLOC_CTX *mem_ctx = talloc_stackframe();
 850         bool ret = false;
 851         char *path;
 852
 853         if (key == NULL) {
 854                 goto done;
 855         }
 856
 857         path = normalize_reg_path(mem_ctx, key);
 858         if (path == NULL) {
 859                 DEBUG(0, ("out of memory! (talloc failed)\n"));
 860                 goto done;
 861         }
 862
 863         if (*path == '\0') {
 864                 goto done;
 865         }
 866
 867         ret = (strrchr(path, '/') == NULL);
 868
 869 done:
 870         TALLOC_FREE(mem_ctx);
 871         return ret;
 872 }
 873
 874
 875 /**
 876  * Check for the existence of a key.
 877  *
 878  * Existence of a key is authoritatively defined by its
 879  * existence in the list of subkeys of its parent key.
 880  * The exeption of this are keys without a parent key,
 881  * i.e. the "base" keys (HKLM, HKCU, ...).
 882  */
 883 static bool regdb_key_exists(const char *key)
 884 {
 885         TALLOC_CTX *mem_ctx = talloc_stackframe();
 886         TDB_DATA value;
 887         bool ret = false;
 888         char *path, *p;
 889
 890         if (key == NULL) {
 891                 goto done;
 892         }
 893
 894         path = normalize_reg_path(mem_ctx, key);
 895         if (path == NULL) {
 896                 DEBUG(0, ("out of memory! (talloc failed)\n"));
 897                 goto done;
 898         }
 899
 900         if (*path == '\0') {
 901                 goto done;
 902         }
 903
 904         p = strrchr(path, '/');
 905         if (p == NULL) {
 906                 /* this is a base key */
 907                 value = regdb_fetch_key_internal(mem_ctx, path);
 908                 ret = (value.dptr != NULL);
 909         } else {
 910                 /* get the list of subkeys of the parent key */
 911                 uint32 num_items, len, i;
 912                 fstring subkeyname;
 913
 914                 *p = '\0';
 915                 p++;
 916                 value = regdb_fetch_key_internal(mem_ctx, path);
 917                 if (value.dptr == NULL) {
 918                         goto done;
 919                 }
 920
 921                 len = tdb_unpack(value.dptr, value.dsize, "d", &num_items);
 922                 for (i = 0; i < num_items; i++) {
 923                         len += tdb_unpack(value.dptr +len, value.dsize -len,
 924                                           "f", &subkeyname);
 925                         if (strequal(subkeyname, p)) {
 926                                 ret = true;
 927                                 goto done;
 928                         }
 929                 }
 930         }
 931
 932 done:
 933         TALLOC_FREE(mem_ctx);
 934         return ret;
 935 }
 936
 937
 938 /***********************************************************************
 939  Retrieve an array of strings containing subkeys.  Memory should be
 940  released by the caller.
 941  ***********************************************************************/
 942
 943 int regdb_fetch_keys(const char *key, REGSUBKEY_CTR *ctr)
 944 {
 945         WERROR werr;
 946         uint32 num_items;
 947         uint8 *buf;
 948         uint32 buflen, len;
 949         int i;
 950         fstring subkeyname;
 951         int ret = -1;
 952         TALLOC_CTX *frame = talloc_stackframe();
 953         TDB_DATA value;
 954
 955         DEBUG(11,("regdb_fetch_keys: Enter key => [%s]\n", key ? key : "NULL"));
 956
 957         if (!regdb_key_exists(key)) {
 958                 goto done;
 959         }
 960
 961         ctr->seqnum = regdb_get_seqnum();
 962
 963         value = regdb_fetch_key_internal(frame, key);
 964
 965         if (value.dptr == NULL) {
 966                 DEBUG(10, ("regdb_fetch_keys: no subkeys found for key [%s]\n",
 967                            key));
 968                 ret = 0;
 969                 goto done;
 970         }
 971
 972         buf = value.dptr;
 973         buflen = value.dsize;
 974         len = tdb_unpack( buf, buflen, "d", &num_items);
 975
 976         for (i=0; i<num_items; i++) {
 977                 len += tdb_unpack(buf+len, buflen-len, "f", subkeyname);
 978                 werr = regsubkey_ctr_addkey(ctr, subkeyname);
 979                 if (!W_ERROR_IS_OK(werr)) {
 980                         DEBUG(5, ("regdb_fetch_keys: regsubkey_ctr_addkey "
 981                                   "failed: %s\n", win_errstr(werr)));
 982                         goto done;
 983                 }
 984         }
 985
 986         DEBUG(11,("regdb_fetch_keys: Exit [%d] items\n", num_items));
 987
 988         ret = num_items;
 989 done:
 990         TALLOC_FREE(frame);
 991         return ret;
 992 }
 993
 994 /****************************************************************************
 995  Unpack a list of registry values frem the TDB
 996  ***************************************************************************/
 997
 998 static int regdb_unpack_values(REGVAL_CTR *values, uint8 *buf, int buflen)
 999 {
1000         int             len = 0;
1001         uint32          type;
1002         fstring valuename;
1003         uint32          size;
1004         uint8           *data_p;
1005         uint32          num_values = 0;
1006         int             i;
1007
1008         /* loop and unpack the rest of the registry values */
1009
1010         len += tdb_unpack(buf+len, buflen-len, "d", &num_values);
1011
1012         for ( i=0; i<num_values; i++ ) {
1013                 /* unpack the next regval */
1014
1015                 type = REG_NONE;
1016                 size = 0;
1017                 data_p = NULL;
1018                 valuename[0] = '\0';
1019                 len += tdb_unpack(buf+len, buflen-len, "fdB",
1020                                   valuename,
1021                                   &type,
1022                                   &size,
1023                                   &data_p);
1024
1025                 /* add the new value. Paranoid protective code -- make sure data_p is valid */
1026
1027                 if (*valuename && size && data_p) {
1028                         regval_ctr_addvalue(values, valuename, type,
1029                                         (const char *)data_p, size);
1030                 }
1031                 SAFE_FREE(data_p); /* 'B' option to tdb_unpack does a malloc() */
1032
1033                 DEBUG(8,("specific: [%s], len: %d\n", valuename, size));
1034         }
1035
1036         return len;
1037 }
1038
1039 /****************************************************************************
1040  Pack all values in all printer keys
1041  ***************************************************************************/
1042
1043 static int regdb_pack_values(REGVAL_CTR *values, uint8 *buf, int buflen)
1044 {
1045         int             len = 0;
1046         int             i;
1047         REGISTRY_VALUE  *val;
1048         int             num_values;
1049
1050         if ( !values )
1051                 return 0;
1052
1053         num_values = regval_ctr_numvals( values );
1054
1055         /* pack the number of values first */
1056
1057         len += tdb_pack( buf+len, buflen-len, "d", num_values );
1058
1059         /* loop over all values */
1060
1061         for ( i=0; i<num_values; i++ ) {
1062                 val = regval_ctr_specific_value( values, i );
1063                 len += tdb_pack(buf+len, buflen-len, "fdB",
1064                                 regval_name(val),
1065                                 regval_type(val),
1066                                 regval_size(val),
1067                                 regval_data_p(val) );
1068         }
1069
1070         return len;
1071 }
1072
1073 /***********************************************************************
1074  Retrieve an array of strings containing subkeys.  Memory should be
1075  released by the caller.
1076  ***********************************************************************/
1077
1078 int regdb_fetch_values( const char* key, REGVAL_CTR *values )
1079 {
1080         char *keystr = NULL;
1081         TALLOC_CTX *ctx = talloc_stackframe();
1082         int ret = 0;
1083         TDB_DATA value;
1084
1085         DEBUG(10,("regdb_fetch_values: Looking for value of key [%s] \n", key));
1086
1087         if (!regdb_key_exists(key)) {
1088                 goto done;
1089         }
1090
1091         keystr = talloc_asprintf(ctx, "%s/%s", REG_VALUE_PREFIX, key);
1092         if (!keystr) {
1093                 goto done;
1094         }
1095
1096         values->seqnum = regdb_get_seqnum();
1097
1098         value = regdb_fetch_key_internal(ctx, keystr);
1099
1100         if (!value.dptr) {
1101                 /* all keys have zero values by default */
1102                 goto done;
1103         }
1104
1105         regdb_unpack_values(values, value.dptr, value.dsize);
1106         ret = regval_ctr_numvals(values);
1107
1108 done:
1109         TALLOC_FREE(ctx);
1110         return ret;
1111 }
1112
1113 bool regdb_store_values( const char *key, REGVAL_CTR *values )
1114 {
1115         TDB_DATA old_data, data;
1116         char *keystr = NULL;
1117         TALLOC_CTX *ctx = talloc_stackframe();
1118         int len;
1119         NTSTATUS status;
1120         bool result = false;
1121
1122         DEBUG(10,("regdb_store_values: Looking for value of key [%s] \n", key));
1123
1124         if (!regdb_key_exists(key)) {
1125                 goto done;
1126         }
1127
1128         ZERO_STRUCT(data);
1129
1130         len = regdb_pack_values(values, data.dptr, data.dsize);
1131         if (len <= 0) {
1132                 DEBUG(0,("regdb_store_values: unable to pack values. len <= 0\n"));
1133                 goto done;
1134         }
1135
1136         data.dptr = TALLOC_ARRAY(ctx, uint8, len);
1137         data.dsize = len;
1138
1139         len = regdb_pack_values(values, data.dptr, data.dsize);
1140
1141         SMB_ASSERT( len == data.dsize );
1142
1143         keystr = talloc_asprintf(ctx, "%s/%s", REG_VALUE_PREFIX, key );
1144         if (!keystr) {
1145                 goto done;
1146         }
1147         keystr = normalize_reg_path(ctx, keystr);
1148         if (!keystr) {
1149                 goto done;
1150         }
1151
1152         old_data = dbwrap_fetch_bystring(regdb, ctx, keystr);
1153
1154         if ((old_data.dptr != NULL)
1155             && (old_data.dsize == data.dsize)
1156             && (memcmp(old_data.dptr, data.dptr, data.dsize) == 0))
1157         {
1158                 result = true;
1159                 goto done;
1160         }
1161
1162         status = dbwrap_trans_store_bystring(regdb, keystr, data, TDB_REPLACE);
1163
1164         result = NT_STATUS_IS_OK(status);
1165
1166 done:
1167         TALLOC_FREE(ctx);
1168         return result;
1169 }
1170
1171 static WERROR regdb_get_secdesc(TALLOC_CTX *mem_ctx, const char *key,
1172                                 struct security_descriptor **psecdesc)
1173 {
1174         char *tdbkey;
1175         TDB_DATA data;
1176         NTSTATUS status;
1177         TALLOC_CTX *tmp_ctx = talloc_stackframe();
1178         WERROR err = WERR_OK;
1179
1180         DEBUG(10, ("regdb_get_secdesc: Getting secdesc of key [%s]\n", key));
1181
1182         if (!regdb_key_exists(key)) {
1183                 err = WERR_BADFILE;
1184                 goto done;
1185         }
1186
1187         tdbkey = talloc_asprintf(tmp_ctx, "%s/%s", REG_SECDESC_PREFIX, key);
1188         if (tdbkey == NULL) {
1189                 err = WERR_NOMEM;
1190                 goto done;
1191         }
1192         normalize_dbkey(tdbkey);
1193
1194         data = dbwrap_fetch_bystring(regdb, tmp_ctx, tdbkey);
1195         if (data.dptr == NULL) {
1196                 err = WERR_BADFILE;
1197                 goto done;
1198         }
1199
1200         status = unmarshall_sec_desc(mem_ctx, (uint8 *)data.dptr, data.dsize,
1201                                      psecdesc);
1202
1203         if (NT_STATUS_EQUAL(status, NT_STATUS_NO_MEMORY)) {
1204                 err = WERR_NOMEM;
1205         } else if (!NT_STATUS_IS_OK(status)) {
1206                 err = WERR_REG_CORRUPT;
1207         }
1208
1209 done:
1210         TALLOC_FREE(tmp_ctx);
1211         return err;
1212 }
1213
1214 static WERROR regdb_set_secdesc(const char *key,
1215                                 struct security_descriptor *secdesc)
1216 {
1217         TALLOC_CTX *mem_ctx = talloc_stackframe();
1218         char *tdbkey;
1219         NTSTATUS status;
1220         WERROR err = WERR_NOMEM;
1221         TDB_DATA tdbdata;
1222
1223         if (!regdb_key_exists(key)) {
1224                 err = WERR_BADFILE;
1225                 goto done;
1226         }
1227
1228         tdbkey = talloc_asprintf(mem_ctx, "%s/%s", REG_SECDESC_PREFIX, key);
1229         if (tdbkey == NULL) {
1230                 goto done;
1231         }
1232         normalize_dbkey(tdbkey);
1233
1234         if (secdesc == NULL) {
1235                 /* assuming a delete */
1236                 status = dbwrap_trans_delete_bystring(regdb, tdbkey);
1237                 if (NT_STATUS_IS_OK(status)) {
1238                         err = WERR_OK;
1239                 } else {
1240                         err = ntstatus_to_werror(status);
1241                 }
1242                 goto done;
1243         }
1244
1245         err = ntstatus_to_werror(marshall_sec_desc(mem_ctx, secdesc,
1246                                                    &tdbdata.dptr,
1247                                                    &tdbdata.dsize));
1248         if (!W_ERROR_IS_OK(err)) {
1249                 goto done;
1250         }
1251
1252         status = dbwrap_trans_store_bystring(regdb, tdbkey, tdbdata, 0);
1253         if (!NT_STATUS_IS_OK(status)) {
1254                 err = ntstatus_to_werror(status);
1255                 goto done;
1256         }
1257
1258  done:
1259         TALLOC_FREE(mem_ctx);
1260         return err;
1261 }
1262
1263 bool regdb_subkeys_need_update(REGSUBKEY_CTR *subkeys)
1264 {
1265         return (regdb_get_seqnum() != subkeys->seqnum);
1266 }
1267
1268 bool regdb_values_need_update(REGVAL_CTR *values)
1269 {
1270         return (regdb_get_seqnum() != values->seqnum);
1271 }
1272
1273 /*
1274  * Table of function pointers for default access
1275  */
1276
1277 REGISTRY_OPS regdb_ops = {
1278         .fetch_subkeys = regdb_fetch_keys,
1279         .fetch_values = regdb_fetch_values,
1280         .store_subkeys = regdb_store_keys,
1281         .store_values = regdb_store_values,
1282         .get_secdesc = regdb_get_secdesc,
1283         .set_secdesc = regdb_set_secdesc,
1284         .subkeys_need_update = regdb_subkeys_need_update,
1285         .values_need_update = regdb_values_need_update
1286 };