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  *  Copyright (C) Michael Adam                      2007-2009
   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 3 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, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 /* Implementation of internal registry database functions. */
  22
  23 #include "includes.h"
  24 #include "system/filesys.h"
  25 #include "registry.h"
  26 #include "reg_db.h"
  27 #include "reg_util_internal.h"
  28 #include "reg_backend_db.h"
  29 #include "reg_objects.h"
  30 #include "nt_printing.h"
  31 #include "util_tdb.h"
  32 #include "dbwrap.h"
  33 #include "../libcli/security/secdesc.h"
  34
  35 #undef DBGC_CLASS
  36 #define DBGC_CLASS DBGC_REGISTRY
  37
  38 static struct db_context *regdb = NULL;
  39 static int regdb_refcount;
  40
  41 static bool regdb_key_exists(struct db_context *db, const char *key);
  42 static bool regdb_key_is_base_key(const char *key);
  43 static WERROR regdb_fetch_keys_internal(struct db_context *db, const char *key,
  44                                         struct regsubkey_ctr *ctr);
  45 static bool regdb_store_keys_internal(struct db_context *db, const char *key,
  46                                       struct regsubkey_ctr *ctr);
  47 static int regdb_fetch_values_internal(struct db_context *db, const char* key,
  48                                        struct regval_ctr *values);
  49 static bool regdb_store_values_internal(struct db_context *db, const char *key,
  50                                         struct regval_ctr *values);
  51
  52 static NTSTATUS create_sorted_subkeys(const char *key);
  53
  54 /* List the deepest path into the registry.  All part components will be created.*/
  55
  56 /* If you want to have a part of the path controlled by the tdb and part by
  57    a virtual registry db (e.g. printing), then you have to list the deepest path.
  58    For example,"HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion/Print"
  59    allows the reg_db backend to handle everything up to
  60    "HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion" and then we'll hook
  61    the reg_printing backend onto the last component of the path (see
  62    KEY_PRINTING_2K in include/rpc_reg.h)   --jerry */
  63
  64 static const char *builtin_registry_paths[] = {
  65         KEY_PRINTING_2K,
  66         KEY_PRINTING_PORTS,
  67         KEY_PRINTING,
  68         KEY_PRINTING "\\Forms",
  69         KEY_PRINTING "\\Printers",
  70         KEY_PRINTING "\\Environments\\Windows NT x86\\Print Processors\\winprint",
  71         KEY_SHARES,
  72         KEY_EVENTLOG,
  73         KEY_SMBCONF,
  74         KEY_PERFLIB,
  75         KEY_PERFLIB_009,
  76         KEY_GROUP_POLICY,
  77         KEY_SAMBA_GROUP_POLICY,
  78         KEY_GP_MACHINE_POLICY,
  79         KEY_GP_MACHINE_WIN_POLICY,
  80         KEY_HKCU,
  81         KEY_GP_USER_POLICY,
  82         KEY_GP_USER_WIN_POLICY,
  83         "HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion\\Winlogon\\GPExtensions",
  84         "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Print\\Monitors",
  85         KEY_PROD_OPTIONS,
  86         "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Terminal Server\\DefaultUserConfiguration",
  87         KEY_TCPIP_PARAMS,
  88         KEY_NETLOGON_PARAMS,
  89         KEY_HKU,
  90         KEY_HKCR,
  91         KEY_HKPD,
  92         KEY_HKPT,
  93          NULL };
  94
  95 struct builtin_regkey_value {
  96         const char *path;
  97         const char *valuename;
  98         uint32 type;
  99         union {
 100                 const char *string;
 101                 uint32 dw_value;
 102         } data;
 103 };
 104
 105 static struct builtin_regkey_value builtin_registry_values[] = {
 106         { KEY_PRINTING_PORTS,
 107                 SAMBA_PRINTER_PORT_NAME, REG_SZ, { "" } },
 108         { KEY_PRINTING_2K,
 109                 "DefaultSpoolDirectory", REG_SZ, { "C:\\Windows\\System32\\Spool\\Printers" } },
 110         { KEY_EVENTLOG,
 111                 "DisplayName", REG_SZ, { "Event Log" } },
 112         { KEY_EVENTLOG,
 113                 "ErrorControl", REG_DWORD, { (char*)0x00000001 } },
 114         { NULL, NULL, 0, { NULL } }
 115 };
 116
 117 /**
 118  * Initialize a key in the registry:
 119  * create each component key of the specified path.
 120  */
 121 static WERROR init_registry_key_internal(struct db_context *db,
 122                                          const char *add_path)
 123 {
 124         WERROR werr;
 125         TALLOC_CTX *frame = talloc_stackframe();
 126         char *path = NULL;
 127         char *base = NULL;
 128         char *remaining = NULL;
 129         char *keyname;
 130         char *subkeyname;
 131         struct regsubkey_ctr *subkeys;
 132         const char *p, *p2;
 133
 134         DEBUG(6, ("init_registry_key: Adding [%s]\n", add_path));
 135
 136         path = talloc_strdup(frame, add_path);
 137         base = talloc_strdup(frame, "");
 138         if (!path || !base) {
 139                 werr = WERR_NOMEM;
 140                 goto fail;
 141         }
 142         p = path;
 143
 144         while (next_token_talloc(frame, &p, &keyname, "\\")) {
 145
 146                 /* build up the registry path from the components */
 147
 148                 if (*base) {
 149                         base = talloc_asprintf(frame, "%s\\", base);
 150                         if (!base) {
 151                                 werr = WERR_NOMEM;
 152                                 goto fail;
 153                         }
 154                 }
 155                 base = talloc_asprintf_append(base, "%s", keyname);
 156                 if (!base) {
 157                         werr = WERR_NOMEM;
 158                         goto fail;
 159                 }
 160
 161                 /* get the immediate subkeyname (if we have one ) */
 162
 163                 subkeyname = talloc_strdup(frame, "");
 164                 if (!subkeyname) {
 165                         werr = WERR_NOMEM;
 166                         goto fail;
 167                 }
 168                 if (*p) {
 169                         remaining = talloc_strdup(frame, p);
 170                         if (!remaining) {
 171                                 werr = WERR_NOMEM;
 172                                 goto fail;
 173                         }
 174                         p2 = remaining;
 175
 176                         if (!next_token_talloc(frame, &p2,
 177                                                 &subkeyname, "\\"))
 178                         {
 179                                 subkeyname = talloc_strdup(frame,p2);
 180                                 if (!subkeyname) {
 181                                         werr = WERR_NOMEM;
 182                                         goto fail;
 183                                 }
 184                         }
 185                 }
 186
 187                 DEBUG(10,("init_registry_key: Storing key [%s] with "
 188                           "subkey [%s]\n", base,
 189                           *subkeyname ? subkeyname : "NULL"));
 190
 191                 /* we don't really care if the lookup succeeds or not
 192                  * since we are about to update the record.
 193                  * We just want any subkeys already present */
 194
 195                 werr = regsubkey_ctr_init(frame, &subkeys);
 196                 if (!W_ERROR_IS_OK(werr)) {
 197                         DEBUG(0,("talloc() failure!\n"));
 198                         goto fail;
 199                 }
 200
 201                 werr = regdb_fetch_keys_internal(db, base, subkeys);
 202                 if (!W_ERROR_IS_OK(werr) &&
 203                     !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
 204                 {
 205                         goto fail;
 206                 }
 207
 208                 if (*subkeyname) {
 209                         werr = regsubkey_ctr_addkey(subkeys, subkeyname);
 210                         if (!W_ERROR_IS_OK(werr)) {
 211                                 goto fail;
 212                         }
 213                 }
 214                 if (!regdb_store_keys_internal(db, base, subkeys)) {
 215                         werr = WERR_CAN_NOT_COMPLETE;
 216                         goto fail;
 217                 }
 218         }
 219
 220         werr = WERR_OK;
 221
 222 fail:
 223         TALLOC_FREE(frame);
 224         return werr;
 225 }
 226
 227 struct init_registry_key_context {
 228         const char *add_path;
 229 };
 230
 231 static NTSTATUS init_registry_key_action(struct db_context *db,
 232                                          void *private_data)
 233 {
 234         struct init_registry_key_context *init_ctx =
 235                 (struct init_registry_key_context *)private_data;
 236
 237         return werror_to_ntstatus(init_registry_key_internal(
 238                                         db, init_ctx->add_path));
 239 }
 240
 241 /**
 242  * Initialize a key in the registry:
 243  * create each component key of the specified path,
 244  * wrapped in one db transaction.
 245  */
 246 WERROR init_registry_key(const char *add_path)
 247 {
 248         struct init_registry_key_context init_ctx;
 249
 250         if (regdb_key_exists(regdb, add_path)) {
 251                 return WERR_OK;
 252         }
 253
 254         init_ctx.add_path = add_path;
 255
 256         return ntstatus_to_werror(dbwrap_trans_do(regdb,
 257                                                   init_registry_key_action,
 258                                                   &init_ctx));
 259 }
 260
 261 /***********************************************************************
 262  Open the registry data in the tdb
 263  ***********************************************************************/
 264
 265 static void regdb_ctr_add_value(struct regval_ctr *ctr,
 266                                 struct builtin_regkey_value *value)
 267 {
 268         switch(value->type) {
 269         case REG_DWORD:
 270                 regval_ctr_addvalue(ctr, value->valuename, REG_DWORD,
 271                                     (uint8_t *)&value->data.dw_value,
 272                                     sizeof(uint32));
 273                 break;
 274
 275         case REG_SZ:
 276                 regval_ctr_addvalue_sz(ctr, value->valuename,
 277                                        value->data.string);
 278                 break;
 279
 280         default:
 281                 DEBUG(0, ("regdb_ctr_add_value: invalid value type in "
 282                           "registry values [%d]\n", value->type));
 283         }
 284 }
 285
 286 static NTSTATUS init_registry_data_action(struct db_context *db,
 287                                           void *private_data)
 288 {
 289         NTSTATUS status;
 290         TALLOC_CTX *frame = talloc_stackframe();
 291         struct regval_ctr *values;
 292         int i;
 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(db, builtin_registry_paths[i])) {
 298                         continue;
 299                 }
 300                 status = werror_to_ntstatus(init_registry_key_internal(db,
 301                                                   builtin_registry_paths[i]));
 302                 if (!NT_STATUS_IS_OK(status)) {
 303                         goto done;
 304                 }
 305         }
 306
 307         /* loop over all of the predefined values and add each component */
 308
 309         for (i=0; builtin_registry_values[i].path != NULL; i++) {
 310                 WERROR werr;
 311
 312                 werr = regval_ctr_init(frame, &values);
 313                 if (!W_ERROR_IS_OK(werr)) {
 314                         status = werror_to_ntstatus(werr);
 315                         goto done;
 316                 }
 317
 318                 regdb_fetch_values_internal(db,
 319                                             builtin_registry_values[i].path,
 320                                             values);
 321
 322                 /* preserve existing values across restarts. Only add new ones */
 323
 324                 if (!regval_ctr_key_exists(values,
 325                                         builtin_registry_values[i].valuename))
 326                 {
 327                         regdb_ctr_add_value(values,
 328                                             &builtin_registry_values[i]);
 329                         regdb_store_values_internal(db,
 330                                         builtin_registry_values[i].path,
 331                                         values);
 332                 }
 333                 TALLOC_FREE(values);
 334         }
 335
 336         status = NT_STATUS_OK;
 337
 338 done:
 339
 340         TALLOC_FREE(frame);
 341         return status;
 342 }
 343
 344 WERROR init_registry_data(void)
 345 {
 346         WERROR werr;
 347         TALLOC_CTX *frame = talloc_stackframe();
 348         struct regval_ctr *values;
 349         int i;
 350
 351         /*
 352          * First, check for the existence of the needed keys and values.
 353          * If all do already exist, we can save the writes.
 354          */
 355         for (i=0; builtin_registry_paths[i] != NULL; i++) {
 356                 if (!regdb_key_exists(regdb, builtin_registry_paths[i])) {
 357                         goto do_init;
 358                 }
 359         }
 360
 361         for (i=0; builtin_registry_values[i].path != NULL; i++) {
 362                 werr = regval_ctr_init(frame, &values);
 363                 W_ERROR_NOT_OK_GOTO_DONE(werr);
 364
 365                 regdb_fetch_values_internal(regdb,
 366                                             builtin_registry_values[i].path,
 367                                             values);
 368                 if (!regval_ctr_key_exists(values,
 369                                         builtin_registry_values[i].valuename))
 370                 {
 371                         TALLOC_FREE(values);
 372                         goto do_init;
 373                 }
 374
 375                 TALLOC_FREE(values);
 376         }
 377
 378         werr = WERR_OK;
 379         goto done;
 380
 381 do_init:
 382
 383         /*
 384          * There are potentially quite a few store operations which are all
 385          * indiviually wrapped in tdb transactions. Wrapping them in a single
 386          * transaction gives just a single transaction_commit() to actually do
 387          * its fsync()s. See tdb/common/transaction.c for info about nested
 388          * transaction behaviour.
 389          */
 390
 391         werr = ntstatus_to_werror(dbwrap_trans_do(regdb,
 392                                                   init_registry_data_action,
 393                                                   NULL));
 394
 395 done:
 396         TALLOC_FREE(frame);
 397         return werr;
 398 }
 399
 400 static int regdb_normalize_keynames_fn(struct db_record *rec,
 401                                        void *private_data)
 402 {
 403         TALLOC_CTX *mem_ctx = talloc_tos();
 404         const char *keyname;
 405         NTSTATUS status;
 406
 407         if (rec->key.dptr == NULL || rec->key.dsize == 0) {
 408                 return 0;
 409         }
 410
 411         keyname = strchr((const char *) rec->key.dptr, '/');
 412         if (keyname) {
 413                 struct db_record new_rec;
 414
 415                 keyname = talloc_string_sub(mem_ctx,
 416                                             (const char *) rec->key.dptr,
 417                                             "/",
 418                                             "\\");
 419
 420                 DEBUG(2, ("regdb_normalize_keynames_fn: Convert %s to %s\n",
 421                           (const char *) rec->key.dptr,
 422                           keyname));
 423
 424                 new_rec.value = rec->value;
 425                 new_rec.key = string_term_tdb_data(keyname);
 426                 new_rec.private_data = rec->private_data;
 427
 428                 /* Delete the original record and store the normalized key */
 429                 status = rec->delete_rec(rec);
 430                 if (!NT_STATUS_IS_OK(status)) {
 431                         DEBUG(0,("regdb_normalize_keynames_fn: "
 432                                  "tdb_delete for [%s] failed!\n",
 433                                  rec->key.dptr));
 434                         return 1;
 435                 }
 436
 437                 status = rec->store(&new_rec, new_rec.value, TDB_REPLACE);
 438                 if (!NT_STATUS_IS_OK(status)) {
 439                         DEBUG(0,("regdb_normalize_keynames_fn: "
 440                                  "failed to store new record for [%s]!\n",
 441                                  keyname));
 442                         return 1;
 443                 }
 444         }
 445
 446         return 0;
 447 }
 448
 449 static WERROR regdb_store_regdb_version(uint32_t version)
 450 {
 451         NTSTATUS status;
 452         const char *version_keyname = "INFO/version";
 453
 454         if (!regdb) {
 455                 return WERR_CAN_NOT_COMPLETE;
 456         }
 457
 458         status = dbwrap_trans_store_int32(regdb, version_keyname, version);
 459         if (!NT_STATUS_IS_OK(status)) {
 460                 DEBUG(1, ("regdb_store_regdb_version: error storing %s = %d: %s\n",
 461                           version_keyname, version, nt_errstr(status)));
 462                 return ntstatus_to_werror(status);
 463         } else {
 464                 DEBUG(10, ("regdb_store_regdb_version: stored %s = %d\n",
 465                           version_keyname, version));
 466                 return WERR_OK;
 467         }
 468 }
 469
 470 static WERROR regdb_upgrade_v1_to_v2(void)
 471 {
 472         TALLOC_CTX *mem_ctx;
 473         int rc;
 474         WERROR werr;
 475
 476         mem_ctx = talloc_stackframe();
 477         if (mem_ctx == NULL) {
 478                 return WERR_NOMEM;
 479         }
 480
 481         rc = regdb->traverse(regdb, regdb_normalize_keynames_fn, mem_ctx);
 482
 483         talloc_destroy(mem_ctx);
 484
 485         if (rc < 0) {
 486                 return WERR_REG_IO_FAILURE;
 487         }
 488
 489         werr = regdb_store_regdb_version(REGVER_V2);
 490         return werr;
 491 }
 492
 493 /***********************************************************************
 494  Open the registry database
 495  ***********************************************************************/
 496
 497 WERROR regdb_init(void)
 498 {
 499         const char *vstring = "INFO/version";
 500         uint32 vers_id, expected_version;
 501         WERROR werr;
 502
 503         if (regdb) {
 504                 DEBUG(10, ("regdb_init: incrementing refcount (%d->%d)\n",
 505                            regdb_refcount, regdb_refcount+1));
 506                 regdb_refcount++;
 507                 return WERR_OK;
 508         }
 509
 510         regdb = db_open(NULL, state_path("registry.tdb"), 0,
 511                               REG_TDB_FLAGS, O_RDWR, 0600);
 512         if (!regdb) {
 513                 regdb = db_open(NULL, state_path("registry.tdb"), 0,
 514                                       REG_TDB_FLAGS, O_RDWR|O_CREAT, 0600);
 515                 if (!regdb) {
 516                         werr = ntstatus_to_werror(map_nt_error_from_unix(errno));
 517                         DEBUG(1,("regdb_init: Failed to open registry %s (%s)\n",
 518                                 state_path("registry.tdb"), strerror(errno) ));
 519                         return werr;
 520                 }
 521
 522                 DEBUG(10,("regdb_init: Successfully created registry tdb\n"));
 523         }
 524
 525         regdb_refcount = 1;
 526         DEBUG(10, ("regdb_init: registry db openend. refcount reset (%d)\n",
 527                    regdb_refcount));
 528
 529         expected_version = REGVER_V2;
 530
 531         vers_id = dbwrap_fetch_int32(regdb, vstring);
 532         if (vers_id == -1) {
 533                 DEBUG(10, ("regdb_init: registry version uninitialized "
 534                            "(got %d), initializing to version %d\n",
 535                            vers_id, expected_version));
 536
 537                 werr = regdb_store_regdb_version(expected_version);
 538                 return werr;
 539         }
 540
 541         if (vers_id > expected_version || vers_id == 0) {
 542                 DEBUG(1, ("regdb_init: unknown registry version %d "
 543                           "(code version = %d), refusing initialization\n",
 544                           vers_id, expected_version));
 545                 return WERR_CAN_NOT_COMPLETE;
 546         }
 547
 548         if (vers_id == REGVER_V1) {
 549                 DEBUG(10, ("regdb_init: got registry db version %d, upgrading "
 550                            "to version %d\n", REGVER_V1, REGVER_V2));
 551
 552                 if (regdb->transaction_start(regdb) != 0) {
 553                         return WERR_REG_IO_FAILURE;
 554                 }
 555
 556                 werr = regdb_upgrade_v1_to_v2();
 557                 if (!W_ERROR_IS_OK(werr)) {
 558                         regdb->transaction_cancel(regdb);
 559                         return werr;
 560                 }
 561
 562                 if (regdb->transaction_commit(regdb) != 0) {
 563                         return WERR_REG_IO_FAILURE;
 564                 }
 565
 566                 vers_id = REGVER_V2;
 567         }
 568
 569         /* future upgrade code should go here */
 570
 571         return WERR_OK;
 572 }
 573
 574 /***********************************************************************
 575  Open the registry.  Must already have been initialized by regdb_init()
 576  ***********************************************************************/
 577
 578 WERROR regdb_open( void )
 579 {
 580         WERROR result = WERR_OK;
 581
 582         if ( regdb ) {
 583                 DEBUG(10, ("regdb_open: incrementing refcount (%d->%d)\n",
 584                            regdb_refcount, regdb_refcount+1));
 585                 regdb_refcount++;
 586                 return WERR_OK;
 587         }
 588
 589         become_root();
 590
 591         regdb = db_open(NULL, state_path("registry.tdb"), 0,
 592                               REG_TDB_FLAGS, O_RDWR, 0600);
 593         if ( !regdb ) {
 594                 result = ntstatus_to_werror( map_nt_error_from_unix( errno ) );
 595                 DEBUG(0,("regdb_open: Failed to open %s! (%s)\n",
 596                         state_path("registry.tdb"), strerror(errno) ));
 597         }
 598
 599         unbecome_root();
 600
 601         regdb_refcount = 1;
 602         DEBUG(10, ("regdb_open: registry db opened. refcount reset (%d)\n",
 603                    regdb_refcount));
 604
 605         return result;
 606 }
 607
 608 /***********************************************************************
 609  ***********************************************************************/
 610
 611 int regdb_close( void )
 612 {
 613         if (regdb_refcount == 0) {
 614                 return 0;
 615         }
 616
 617         regdb_refcount--;
 618
 619         DEBUG(10, ("regdb_close: decrementing refcount (%d->%d)\n",
 620                    regdb_refcount+1, regdb_refcount));
 621
 622         if ( regdb_refcount > 0 )
 623                 return 0;
 624
 625         SMB_ASSERT( regdb_refcount >= 0 );
 626
 627         TALLOC_FREE(regdb);
 628         return 0;
 629 }
 630
 631 WERROR regdb_transaction_start(void)
 632 {
 633         return (regdb->transaction_start(regdb) == 0) ?
 634                 WERR_OK : WERR_REG_IO_FAILURE;
 635 }
 636
 637 WERROR regdb_transaction_commit(void)
 638 {
 639         return (regdb->transaction_commit(regdb) == 0) ?
 640                 WERR_OK : WERR_REG_IO_FAILURE;
 641 }
 642
 643 WERROR regdb_transaction_cancel(void)
 644 {
 645         return (regdb->transaction_cancel(regdb) == 0) ?
 646                 WERR_OK : WERR_REG_IO_FAILURE;
 647 }
 648
 649 /***********************************************************************
 650  return the tdb sequence number of the registry tdb.
 651  this is an indicator for the content of the registry
 652  having changed. it will change upon regdb_init, too, though.
 653  ***********************************************************************/
 654 int regdb_get_seqnum(void)
 655 {
 656         return regdb->get_seqnum(regdb);
 657 }
 658
 659
 660 static WERROR regdb_delete_key_with_prefix(struct db_context *db,
 661                                            const char *keyname,
 662                                            const char *prefix)
 663 {
 664         char *path;
 665         WERROR werr = WERR_NOMEM;
 666         TALLOC_CTX *mem_ctx = talloc_stackframe();
 667
 668         if (keyname == NULL) {
 669                 werr = WERR_INVALID_PARAM;
 670                 goto done;
 671         }
 672
 673         if (prefix == NULL) {
 674                 path = discard_const_p(char, keyname);
 675         } else {
 676                 path = talloc_asprintf(mem_ctx, "%s\\%s", prefix, keyname);
 677                 if (path == NULL) {
 678                         goto done;
 679                 }
 680         }
 681
 682         path = normalize_reg_path(mem_ctx, path);
 683         if (path == NULL) {
 684                 goto done;
 685         }
 686
 687         werr = ntstatus_to_werror(dbwrap_delete_bystring(db, path));
 688
 689         /* treat "not" found" as ok */
 690         if (W_ERROR_EQUAL(werr, WERR_NOT_FOUND)) {
 691                 werr = WERR_OK;
 692         }
 693
 694 done:
 695         talloc_free(mem_ctx);
 696         return werr;
 697 }
 698
 699
 700 static WERROR regdb_delete_values(struct db_context *db, const char *keyname)
 701 {
 702         return regdb_delete_key_with_prefix(db, keyname, REG_VALUE_PREFIX);
 703 }
 704
 705 static WERROR regdb_delete_secdesc(struct db_context *db, const char *keyname)
 706 {
 707         return regdb_delete_key_with_prefix(db, keyname, REG_SECDESC_PREFIX);
 708 }
 709
 710 static WERROR regdb_delete_subkeylist(struct db_context *db, const char *keyname)
 711 {
 712         return regdb_delete_key_with_prefix(db, keyname, NULL);
 713 }
 714
 715 static WERROR regdb_delete_sorted_subkeys(struct db_context *db,
 716                                           const char *keyname)
 717 {
 718         return regdb_delete_key_with_prefix(db, keyname, REG_SORTED_SUBKEYS_PREFIX);
 719 }
 720
 721
 722 static WERROR regdb_delete_key_lists(struct db_context *db, const char *keyname)
 723 {
 724         WERROR werr;
 725
 726         werr = regdb_delete_values(db, keyname);
 727         if (!W_ERROR_IS_OK(werr)) {
 728                 DEBUG(1, (__location__ " Deleting %s\\%s failed: %s\n",
 729                           REG_VALUE_PREFIX, keyname, win_errstr(werr)));
 730                 goto done;
 731         }
 732
 733         werr = regdb_delete_secdesc(db, keyname);
 734         if (!W_ERROR_IS_OK(werr)) {
 735                 DEBUG(1, (__location__ " Deleting %s\\%s failed: %s\n",
 736                           REG_SECDESC_PREFIX, keyname, win_errstr(werr)));
 737                 goto done;
 738         }
 739
 740         werr = regdb_delete_sorted_subkeys(db, keyname);
 741         if (!W_ERROR_IS_OK(werr)) {
 742                 DEBUG(1, (__location__ " Deleting %s\\%s failed: %s\n",
 743                           REG_SORTED_SUBKEYS_PREFIX, keyname,
 744                           win_errstr(werr)));
 745                 goto done;
 746         }
 747
 748         werr = regdb_delete_subkeylist(db, keyname);
 749         if (!W_ERROR_IS_OK(werr)) {
 750                 DEBUG(1, (__location__ " Deleting %s failed: %s\n",
 751                           keyname, win_errstr(werr)));
 752                 goto done;
 753         }
 754
 755 done:
 756         return werr;
 757 }
 758
 759 /***********************************************************************
 760  Add subkey strings to the registry tdb under a defined key
 761  fmt is the same format as tdb_pack except this function only supports
 762  fstrings
 763  ***********************************************************************/
 764
 765 static WERROR regdb_store_keys_internal2(struct db_context *db,
 766                                          const char *key,
 767                                          struct regsubkey_ctr *ctr)
 768 {
 769         TDB_DATA dbuf;
 770         uint8 *buffer = NULL;
 771         int i = 0;
 772         uint32 len, buflen;
 773         uint32 num_subkeys = regsubkey_ctr_numkeys(ctr);
 774         char *keyname = NULL;
 775         TALLOC_CTX *ctx = talloc_stackframe();
 776         WERROR werr;
 777
 778         if (!key) {
 779                 werr = WERR_INVALID_PARAM;
 780                 goto done;
 781         }
 782
 783         keyname = talloc_strdup(ctx, key);
 784         if (!keyname) {
 785                 werr = WERR_NOMEM;
 786                 goto done;
 787         }
 788
 789         keyname = normalize_reg_path(ctx, keyname);
 790         if (!keyname) {
 791                 werr = WERR_NOMEM;
 792                 goto done;
 793         }
 794
 795         /* allocate some initial memory */
 796
 797         buffer = (uint8 *)SMB_MALLOC(1024);
 798         if (buffer == NULL) {
 799                 werr = WERR_NOMEM;
 800                 goto done;
 801         }
 802         buflen = 1024;
 803         len = 0;
 804
 805         /* store the number of subkeys */
 806
 807         len += tdb_pack(buffer+len, buflen-len, "d", num_subkeys);
 808
 809         /* pack all the strings */
 810
 811         for (i=0; i<num_subkeys; i++) {
 812                 size_t thistime;
 813
 814                 thistime = tdb_pack(buffer+len, buflen-len, "f",
 815                                     regsubkey_ctr_specific_key(ctr, i));
 816                 if (len+thistime > buflen) {
 817                         size_t thistime2;
 818                         /*
 819                          * tdb_pack hasn't done anything because of the short
 820                          * buffer, allocate extra space.
 821                          */
 822                         buffer = SMB_REALLOC_ARRAY(buffer, uint8_t,
 823                                                    (len+thistime)*2);
 824                         if(buffer == NULL) {
 825                                 DEBUG(0, ("regdb_store_keys: Failed to realloc "
 826                                           "memory of size [%u]\n",
 827                                           (unsigned int)(len+thistime)*2));
 828                                 werr = WERR_NOMEM;
 829                                 goto done;
 830                         }
 831                         buflen = (len+thistime)*2;
 832                         thistime2 = tdb_pack(
 833                                 buffer+len, buflen-len, "f",
 834                                 regsubkey_ctr_specific_key(ctr, i));
 835                         if (thistime2 != thistime) {
 836                                 DEBUG(0, ("tdb_pack failed\n"));
 837                                 werr = WERR_CAN_NOT_COMPLETE;
 838                                 goto done;
 839                         }
 840                 }
 841                 len += thistime;
 842         }
 843
 844         /* finally write out the data */
 845
 846         dbuf.dptr = buffer;
 847         dbuf.dsize = len;
 848         werr = ntstatus_to_werror(dbwrap_store_bystring(db, keyname, dbuf,
 849                                                         TDB_REPLACE));
 850
 851 done:
 852         TALLOC_FREE(ctx);
 853         SAFE_FREE(buffer);
 854         return werr;
 855 }
 856
 857 /**
 858  * Utility function to store a new empty list of
 859  * subkeys of given key specified as parent and subkey name
 860  * (thereby creating the key).
 861  * If the parent keyname is NULL, then the "subkey" is
 862  * interpreted as a base key.
 863  * If the subkey list does already exist, it is not modified.
 864  *
 865  * Must be called from within a transaction.
 866  */
 867 static WERROR regdb_store_subkey_list(struct db_context *db, const char *parent,
 868                                       const char *key)
 869 {
 870         WERROR werr;
 871         char *path = NULL;
 872         struct regsubkey_ctr *subkeys = NULL;
 873         TALLOC_CTX *frame = talloc_stackframe();
 874
 875         if (parent == NULL) {
 876                 path = talloc_strdup(frame, key);
 877         } else {
 878                 path = talloc_asprintf(frame, "%s\\%s", parent, key);
 879         }
 880         if (!path) {
 881                 werr = WERR_NOMEM;
 882                 goto done;
 883         }
 884
 885         werr = regsubkey_ctr_init(frame, &subkeys);
 886         W_ERROR_NOT_OK_GOTO_DONE(werr);
 887
 888         werr = regdb_fetch_keys_internal(db, path, subkeys);
 889         if (W_ERROR_IS_OK(werr)) {
 890                 /* subkey list exists already - don't modify */
 891                 goto done;
 892         }
 893
 894         werr = regsubkey_ctr_reinit(subkeys);
 895         W_ERROR_NOT_OK_GOTO_DONE(werr);
 896
 897         /* create a record with 0 subkeys */
 898         werr = regdb_store_keys_internal2(db, path, subkeys);
 899         if (!W_ERROR_IS_OK(werr)) {
 900                 DEBUG(0, ("regdb_store_keys: Failed to store new record for "
 901                           "key [%s]: %s\n", path, win_errstr(werr)));
 902                 goto done;
 903         }
 904
 905 done:
 906         talloc_free(frame);
 907         return werr;
 908 }
 909
 910 /***********************************************************************
 911  Store the new subkey record and create any child key records that
 912  do not currently exist
 913  ***********************************************************************/
 914
 915 struct regdb_store_keys_context {
 916         const char *key;
 917         struct regsubkey_ctr *ctr;
 918 };
 919
 920 static NTSTATUS regdb_store_keys_action(struct db_context *db,
 921                                         void *private_data)
 922 {
 923         struct regdb_store_keys_context *store_ctx;
 924         WERROR werr;
 925         int num_subkeys, i;
 926         char *path = NULL;
 927         struct regsubkey_ctr *old_subkeys = NULL;
 928         char *oldkeyname = NULL;
 929         TALLOC_CTX *mem_ctx = talloc_stackframe();
 930
 931         store_ctx = (struct regdb_store_keys_context *)private_data;
 932
 933         /*
 934          * Re-fetch the old keys inside the transaction
 935          */
 936
 937         werr = regsubkey_ctr_init(mem_ctx, &old_subkeys);
 938         W_ERROR_NOT_OK_GOTO_DONE(werr);
 939
 940         werr = regdb_fetch_keys_internal(db, store_ctx->key, old_subkeys);
 941         if (!W_ERROR_IS_OK(werr) &&
 942             !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
 943         {
 944                 goto done;
 945         }
 946
 947         /*
 948          * Make the store operation as safe as possible without transactions:
 949          *
 950          * (1) For each subkey removed from ctr compared with old_subkeys:
 951          *
 952          *     (a) First delete the value db entry.
 953          *
 954          *     (b) Next delete the secdesc db record.
 955          *
 956          *     (c) Then delete the subkey list entry.
 957          *
 958          * (2) Now write the list of subkeys of the parent key,
 959          *     deleting removed entries and adding new ones.
 960          *
 961          * (3) Finally create the subkey list entries for the added keys.
 962          *
 963          * This way if we crash half-way in between deleting the subkeys
 964          * and storing the parent's list of subkeys, no old data can pop up
 965          * out of the blue when re-adding keys later on.
 966          */
 967
 968         /* (1) delete removed keys' lists (values/secdesc/subkeys) */
 969
 970         num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
 971         for (i=0; i<num_subkeys; i++) {
 972                 oldkeyname = regsubkey_ctr_specific_key(old_subkeys, i);
 973
 974                 if (regsubkey_ctr_key_exists(store_ctx->ctr, oldkeyname)) {
 975                         /*
 976                          * It's still around, don't delete
 977                          */
 978                         continue;
 979                 }
 980
 981                 path = talloc_asprintf(mem_ctx, "%s\\%s", store_ctx->key,
 982                                        oldkeyname);
 983                 if (!path) {
 984                         werr = WERR_NOMEM;
 985                         goto done;
 986                 }
 987
 988                 werr = regdb_delete_key_lists(db, path);
 989                 W_ERROR_NOT_OK_GOTO_DONE(werr);
 990
 991                 TALLOC_FREE(path);
 992         }
 993
 994         TALLOC_FREE(old_subkeys);
 995
 996         /* (2) store the subkey list for the parent */
 997
 998         werr = regdb_store_keys_internal2(db, store_ctx->key, store_ctx->ctr);
 999         if (!W_ERROR_IS_OK(werr)) {
1000                 DEBUG(0,("regdb_store_keys: Failed to store new subkey list "
1001                          "for parent [%s]: %s\n", store_ctx->key,
1002                          win_errstr(werr)));
1003                 goto done;
1004         }
1005
1006         /* (3) now create records for any subkeys that don't already exist */
1007
1008         num_subkeys = regsubkey_ctr_numkeys(store_ctx->ctr);
1009
1010         for (i=0; i<num_subkeys; i++) {
1011                 const char *subkey;
1012
1013                 subkey = regsubkey_ctr_specific_key(store_ctx->ctr, i);
1014
1015                 werr = regdb_store_subkey_list(db, store_ctx->key, subkey);
1016                 W_ERROR_NOT_OK_GOTO_DONE(werr);
1017         }
1018
1019         werr = WERR_OK;
1020
1021 done:
1022         talloc_free(mem_ctx);
1023         return werror_to_ntstatus(werr);
1024 }
1025
1026 static bool regdb_store_keys_internal(struct db_context *db, const char *key,
1027                                       struct regsubkey_ctr *ctr)
1028 {
1029         int num_subkeys, old_num_subkeys, i;
1030         struct regsubkey_ctr *old_subkeys = NULL;
1031         TALLOC_CTX *ctx = talloc_stackframe();
1032         WERROR werr;
1033         bool ret = false;
1034         struct regdb_store_keys_context store_ctx;
1035
1036         if (!regdb_key_exists(db, key)) {
1037                 goto done;
1038         }
1039
1040         /*
1041          * fetch a list of the old subkeys so we can determine if anything has
1042          * changed
1043          */
1044
1045         werr = regsubkey_ctr_init(ctx, &old_subkeys);
1046         if (!W_ERROR_IS_OK(werr)) {
1047                 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
1048                 goto done;
1049         }
1050
1051         werr = regdb_fetch_keys_internal(db, key, old_subkeys);
1052         if (!W_ERROR_IS_OK(werr) &&
1053             !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
1054         {
1055                 goto done;
1056         }
1057
1058         num_subkeys = regsubkey_ctr_numkeys(ctr);
1059         old_num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
1060         if ((num_subkeys && old_num_subkeys) &&
1061             (num_subkeys == old_num_subkeys)) {
1062
1063                 for (i = 0; i < num_subkeys; i++) {
1064                         if (strcmp(regsubkey_ctr_specific_key(ctr, i),
1065                                    regsubkey_ctr_specific_key(old_subkeys, i))
1066                             != 0)
1067                         {
1068                                 break;
1069                         }
1070                 }
1071                 if (i == num_subkeys) {
1072                         /*
1073                          * Nothing changed, no point to even start a tdb
1074                          * transaction
1075                          */
1076
1077                         ret = true;
1078                         goto done;
1079                 }
1080         }
1081
1082         TALLOC_FREE(old_subkeys);
1083
1084         store_ctx.key = key;
1085         store_ctx.ctr = ctr;
1086
1087         werr = ntstatus_to_werror(dbwrap_trans_do(db,
1088                                                   regdb_store_keys_action,
1089                                                   &store_ctx));
1090
1091         ret = W_ERROR_IS_OK(werr);
1092
1093 done:
1094         TALLOC_FREE(ctx);
1095
1096         return ret;
1097 }
1098
1099 bool regdb_store_keys(const char *key, struct regsubkey_ctr *ctr)
1100 {
1101         return regdb_store_keys_internal(regdb, key, ctr);
1102 }
1103
1104 /**
1105  * create a subkey of a given key
1106  */
1107
1108 struct regdb_create_subkey_context {
1109         const char *key;
1110         const char *subkey;
1111 };
1112
1113 static NTSTATUS regdb_create_subkey_action(struct db_context *db,
1114                                            void *private_data)
1115 {
1116         WERROR werr;
1117         struct regdb_create_subkey_context *create_ctx;
1118         struct regsubkey_ctr *subkeys;
1119         TALLOC_CTX *mem_ctx = talloc_stackframe();
1120
1121         create_ctx = (struct regdb_create_subkey_context *)private_data;
1122
1123         werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1124         W_ERROR_NOT_OK_GOTO_DONE(werr);
1125
1126         werr = regdb_fetch_keys_internal(db, create_ctx->key, subkeys);
1127         W_ERROR_NOT_OK_GOTO_DONE(werr);
1128
1129         werr = regsubkey_ctr_addkey(subkeys, create_ctx->subkey);
1130         W_ERROR_NOT_OK_GOTO_DONE(werr);
1131
1132         werr = regdb_store_keys_internal2(db, create_ctx->key, subkeys);
1133         if (!W_ERROR_IS_OK(werr)) {
1134                 DEBUG(0, (__location__ " failed to store new subkey list for "
1135                          "parent key %s: %s\n", create_ctx->key,
1136                          win_errstr(werr)));
1137         }
1138
1139         werr = regdb_store_subkey_list(db, create_ctx->key, create_ctx->subkey);
1140
1141 done:
1142         talloc_free(mem_ctx);
1143         return werror_to_ntstatus(werr);
1144 }
1145
1146 static WERROR regdb_create_subkey(const char *key, const char *subkey)
1147 {
1148         WERROR werr;
1149         struct regsubkey_ctr *subkeys;
1150         TALLOC_CTX *mem_ctx = talloc_stackframe();
1151         struct regdb_create_subkey_context create_ctx;
1152
1153         if (!regdb_key_exists(regdb, key)) {
1154                 werr = WERR_NOT_FOUND;
1155                 goto done;
1156         }
1157
1158         werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1159         W_ERROR_NOT_OK_GOTO_DONE(werr);
1160
1161         werr = regdb_fetch_keys_internal(regdb, key, subkeys);
1162         W_ERROR_NOT_OK_GOTO_DONE(werr);
1163
1164         if (regsubkey_ctr_key_exists(subkeys, subkey)) {
1165                 werr = WERR_OK;
1166                 goto done;
1167         }
1168
1169         talloc_free(subkeys);
1170
1171         create_ctx.key = key;
1172         create_ctx.subkey = subkey;
1173
1174         werr = ntstatus_to_werror(dbwrap_trans_do(regdb,
1175                                                   regdb_create_subkey_action,
1176                                                   &create_ctx));
1177
1178 done:
1179         talloc_free(mem_ctx);
1180         return werr;
1181 }
1182
1183 /**
1184  * create a subkey of a given key
1185  */
1186
1187 struct regdb_delete_subkey_context {
1188         const char *key;
1189         const char *subkey;
1190         const char *path;
1191 };
1192
1193 static NTSTATUS regdb_delete_subkey_action(struct db_context *db,
1194                                            void *private_data)
1195 {
1196         WERROR werr;
1197         struct regdb_delete_subkey_context *delete_ctx;
1198         struct regsubkey_ctr *subkeys;
1199         TALLOC_CTX *mem_ctx = talloc_stackframe();
1200
1201         delete_ctx = (struct regdb_delete_subkey_context *)private_data;
1202
1203         werr = regdb_delete_key_lists(db, delete_ctx->path);
1204         W_ERROR_NOT_OK_GOTO_DONE(werr);
1205
1206         werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1207         W_ERROR_NOT_OK_GOTO_DONE(werr);
1208
1209         werr = regdb_fetch_keys_internal(db, delete_ctx->key, subkeys);
1210         W_ERROR_NOT_OK_GOTO_DONE(werr);
1211
1212         werr = regsubkey_ctr_delkey(subkeys, delete_ctx->subkey);
1213         W_ERROR_NOT_OK_GOTO_DONE(werr);
1214
1215         werr = regdb_store_keys_internal2(db, delete_ctx->key, subkeys);
1216         if (!W_ERROR_IS_OK(werr)) {
1217                 DEBUG(0, (__location__ " failed to store new subkey_list for "
1218                          "parent key %s: %s\n", delete_ctx->key,
1219                          win_errstr(werr)));
1220         }
1221
1222 done:
1223         talloc_free(mem_ctx);
1224         return werror_to_ntstatus(werr);
1225 }
1226
1227 static WERROR regdb_delete_subkey(const char *key, const char *subkey)
1228 {
1229         WERROR werr;
1230         char *path;
1231         struct regdb_delete_subkey_context delete_ctx;
1232         TALLOC_CTX *mem_ctx = talloc_stackframe();
1233
1234         if (!regdb_key_exists(regdb, key)) {
1235                 werr = WERR_NOT_FOUND;
1236                 goto done;
1237         }
1238
1239         path = talloc_asprintf(mem_ctx, "%s\\%s", key, subkey);
1240         if (path == NULL) {
1241                 werr = WERR_NOMEM;
1242                 goto done;
1243         }
1244
1245         if (!regdb_key_exists(regdb, path)) {
1246                 werr = WERR_OK;
1247                 goto done;
1248         }
1249
1250         delete_ctx.key = key;
1251         delete_ctx.subkey = subkey;
1252         delete_ctx.path = path;
1253
1254         werr = ntstatus_to_werror(dbwrap_trans_do(regdb,
1255                                                   regdb_delete_subkey_action,
1256                                                   &delete_ctx));
1257
1258 done:
1259         talloc_free(mem_ctx);
1260         return werr;
1261 }
1262
1263 static TDB_DATA regdb_fetch_key_internal(struct db_context *db,
1264                                          TALLOC_CTX *mem_ctx, const char *key)
1265 {
1266         char *path = NULL;
1267         TDB_DATA data;
1268
1269         path = normalize_reg_path(mem_ctx, key);
1270         if (!path) {
1271                 return make_tdb_data(NULL, 0);
1272         }
1273
1274         data = dbwrap_fetch_bystring(db, mem_ctx, path);
1275
1276         TALLOC_FREE(path);
1277         return data;
1278 }
1279
1280
1281 /**
1282  * check whether a given key name represents a base key,
1283  * i.e one without a subkey separator ('\').
1284  */
1285 static bool regdb_key_is_base_key(const char *key)
1286 {
1287         TALLOC_CTX *mem_ctx = talloc_stackframe();
1288         bool ret = false;
1289         char *path;
1290
1291         if (key == NULL) {
1292                 goto done;
1293         }
1294
1295         path = normalize_reg_path(mem_ctx, key);
1296         if (path == NULL) {
1297                 DEBUG(0, ("out of memory! (talloc failed)\n"));
1298                 goto done;
1299         }
1300
1301         if (*path == '\0') {
1302                 goto done;
1303         }
1304
1305         ret = (strrchr(path, '\\') == NULL);
1306
1307 done:
1308         TALLOC_FREE(mem_ctx);
1309         return ret;
1310 }
1311
1312 /*
1313  * regdb_key_exists() is a very frequent operation. It can be quite
1314  * time-consuming to fully fetch the parent's subkey list, talloc_strdup all
1315  * subkeys and then compare the keyname linearly to all the parent's subkeys.
1316  *
1317  * The following code tries to make this operation as efficient as possible:
1318  * Per registry key we create a list of subkeys that is very efficient to
1319  * search for existence of a subkey. Its format is:
1320  *
1321  * 4 bytes num_subkeys
1322  * 4*num_subkey bytes offset into the string array
1323  * then follows a sorted list of subkeys in uppercase
1324  *
1325  * This record is created by create_sorted_subkeys() on demand if it does not
1326  * exist. scan_parent_subkeys() uses regdb->parse_record to search the sorted
1327  * list, the parsing code and the binary search can be found in
1328  * parent_subkey_scanner. The code uses parse_record() to avoid a memcpy of
1329  * the potentially large subkey record.
1330  *
1331  * The sorted subkey record is deleted in regdb_store_keys_internal2 and
1332  * recreated on demand.
1333  */
1334
1335 static int cmp_keynames(char **p1, char **p2)
1336 {
1337         return strcasecmp_m(*p1, *p2);
1338 }
1339
1340 struct create_sorted_subkeys_context {
1341         const char *key;
1342         const char *sorted_keyname;
1343 };
1344
1345 static NTSTATUS create_sorted_subkeys_action(struct db_context *db,
1346                                              void *private_data)
1347 {
1348         char **sorted_subkeys;
1349         struct regsubkey_ctr *ctr;
1350         NTSTATUS status;
1351         char *buf;
1352         char *p;
1353         int i;
1354         size_t len;
1355         int num_subkeys;
1356         struct create_sorted_subkeys_context *sorted_ctx;
1357
1358         sorted_ctx = (struct create_sorted_subkeys_context *)private_data;
1359
1360         /*
1361          * In this function, we only treat failing of the actual write to
1362          * the db as a real error. All preliminary errors, at a stage when
1363          * nothing has been written to the DB yet are treated as success
1364          * to be committed (as an empty transaction).
1365          *
1366          * The reason is that this (disposable) call might be nested in other
1367          * transactions. Doing a cancel here would destroy the possibility of
1368          * a transaction_commit for transactions that we might be wrapped in.
1369          */
1370
1371         status = werror_to_ntstatus(regsubkey_ctr_init(talloc_tos(), &ctr));
1372         if (!NT_STATUS_IS_OK(status)) {
1373                 /* don't treat this as an error */
1374                 status = NT_STATUS_OK;
1375                 goto done;
1376         }
1377
1378         status = werror_to_ntstatus(regdb_fetch_keys_internal(db,
1379                                                               sorted_ctx->key,
1380                                                               ctr));
1381         if (!NT_STATUS_IS_OK(status)) {
1382                 /* don't treat this as an error */
1383                 status = NT_STATUS_OK;
1384                 goto done;
1385         }
1386
1387         num_subkeys = regsubkey_ctr_numkeys(ctr);
1388         sorted_subkeys = talloc_array(ctr, char *, num_subkeys);
1389         if (sorted_subkeys == NULL) {
1390                 /* don't treat this as an error */
1391                 goto done;
1392         }
1393
1394         len = 4 + 4*num_subkeys;
1395
1396         for (i = 0; i < num_subkeys; i++) {
1397                 sorted_subkeys[i] = talloc_strdup_upper(sorted_subkeys,
1398                                         regsubkey_ctr_specific_key(ctr, i));
1399                 if (sorted_subkeys[i] == NULL) {
1400                         /* don't treat this as an error */
1401                         goto done;
1402                 }
1403                 len += strlen(sorted_subkeys[i])+1;
1404         }
1405
1406         TYPESAFE_QSORT(sorted_subkeys, num_subkeys, cmp_keynames);
1407
1408         buf = talloc_array(ctr, char, len);
1409         if (buf == NULL) {
1410                 /* don't treat this as an error */
1411                 goto done;
1412         }
1413         p = buf + 4 + 4*num_subkeys;
1414
1415         SIVAL(buf, 0, num_subkeys);
1416
1417         for (i=0; i < num_subkeys; i++) {
1418                 ptrdiff_t offset = p - buf;
1419                 SIVAL(buf, 4 + 4*i, offset);
1420                 strlcpy(p, sorted_subkeys[i], len-offset);
1421                 p += strlen(sorted_subkeys[i]) + 1;
1422         }
1423
1424         status = dbwrap_store_bystring(
1425                 db, sorted_ctx->sorted_keyname, make_tdb_data((uint8_t *)buf,
1426                 len),
1427                 TDB_REPLACE);
1428
1429 done:
1430         talloc_free(ctr);
1431         return status;
1432 }
1433
1434 static NTSTATUS create_sorted_subkeys_internal(const char *key,
1435                                                const char *sorted_keyname)
1436 {
1437         NTSTATUS status;
1438         struct create_sorted_subkeys_context sorted_ctx;
1439
1440         sorted_ctx.key = key;
1441         sorted_ctx.sorted_keyname = sorted_keyname;
1442
1443         status = dbwrap_trans_do(regdb,
1444                                  create_sorted_subkeys_action,
1445                                  &sorted_ctx);
1446
1447         return status;
1448 }
1449
1450 static NTSTATUS create_sorted_subkeys(const char *key)
1451 {
1452         char *sorted_subkeys_keyname;
1453         NTSTATUS status;
1454
1455         sorted_subkeys_keyname = talloc_asprintf(talloc_tos(), "%s\\%s",
1456                                                  REG_SORTED_SUBKEYS_PREFIX,
1457                                                  key);
1458         if (sorted_subkeys_keyname == NULL) {
1459                 status = NT_STATUS_NO_MEMORY;
1460                 goto done;
1461         }
1462
1463         status = create_sorted_subkeys_internal(key, sorted_subkeys_keyname);
1464
1465 done:
1466         return status;
1467 }
1468
1469 struct scan_subkey_state {
1470         char *name;
1471         bool scanned;
1472         bool found;
1473 };
1474
1475 static int parent_subkey_scanner(TDB_DATA key, TDB_DATA data,
1476                                  void *private_data)
1477 {
1478         struct scan_subkey_state *state =
1479                 (struct scan_subkey_state *)private_data;
1480         uint32_t num_subkeys;
1481         uint32_t l, u;
1482
1483         if (data.dsize < sizeof(uint32_t)) {
1484                 return -1;
1485         }
1486
1487         state->scanned = true;
1488         state->found = false;
1489
1490         tdb_unpack(data.dptr, data.dsize, "d", &num_subkeys);
1491
1492         l = 0;
1493         u = num_subkeys;
1494
1495         while (l < u) {
1496                 uint32_t idx = (l+u)/2;
1497                 char *s = (char *)data.dptr + IVAL(data.dptr, 4 + 4*idx);
1498                 int comparison = strcmp(state->name, s);
1499
1500                 if (comparison < 0) {
1501                         u = idx;
1502                 } else if (comparison > 0) {
1503                         l = idx + 1;
1504                 } else {
1505                         state->found = true;
1506                         return 0;
1507                 }
1508         }
1509         return 0;
1510 }
1511
1512 static bool scan_parent_subkeys(struct db_context *db, const char *parent,
1513                                 const char *name)
1514 {
1515         char *path = NULL;
1516         char *key = NULL;
1517         struct scan_subkey_state state = { 0, };
1518         bool result = false;
1519         int res;
1520
1521         state.name = NULL;
1522
1523         path = normalize_reg_path(talloc_tos(), parent);
1524         if (path == NULL) {
1525                 goto fail;
1526         }
1527
1528         key = talloc_asprintf(talloc_tos(), "%s\\%s",
1529                               REG_SORTED_SUBKEYS_PREFIX, path);
1530         if (key == NULL) {
1531                 goto fail;
1532         }
1533
1534         state.name = talloc_strdup_upper(talloc_tos(), name);
1535         if (state.name == NULL) {
1536                 goto fail;
1537         }
1538         state.scanned = false;
1539
1540         res = db->parse_record(db, string_term_tdb_data(key),
1541                                parent_subkey_scanner, &state);
1542
1543         if (state.scanned) {
1544                 result = state.found;
1545         } else {
1546                 NTSTATUS status;
1547
1548                 res = db->transaction_start(db);
1549                 if (res != 0) {
1550                         DEBUG(0, ("error starting transaction\n"));
1551                         goto fail;
1552                 }
1553
1554                 DEBUG(2, (__location__ " WARNING: recreating the sorted "
1555                           "subkeys cache for key '%s' from scan_parent_subkeys "
1556                           "this should not happen (too frequently)...\n",
1557                           path));
1558
1559                 status = create_sorted_subkeys_internal(path, key);
1560                 if (!NT_STATUS_IS_OK(status)) {
1561                         res = db->transaction_cancel(db);
1562                         if (res != 0) {
1563                                 smb_panic("Failed to cancel transaction.");
1564                         }
1565                         goto fail;
1566                 }
1567
1568                 res = db->parse_record(db, string_term_tdb_data(key),
1569                                        parent_subkey_scanner, &state);
1570                 if ((res == 0) && (state.scanned)) {
1571                         result = state.found;
1572                 }
1573
1574                 res = db->transaction_commit(db);
1575                 if (res != 0) {
1576                         DEBUG(0, ("error committing transaction\n"));
1577                         result = false;
1578                 }
1579         }
1580
1581  fail:
1582         TALLOC_FREE(path);
1583         TALLOC_FREE(state.name);
1584         return result;
1585 }
1586
1587 /**
1588  * Check for the existence of a key.
1589  *
1590  * Existence of a key is authoritatively defined by its
1591  * existence in the list of subkeys of its parent key.
1592  * The exeption of this are keys without a parent key,
1593  * i.e. the "base" keys (HKLM, HKCU, ...).
1594  */
1595 static bool regdb_key_exists(struct db_context *db, const char *key)
1596 {
1597         TALLOC_CTX *mem_ctx = talloc_stackframe();
1598         TDB_DATA value;
1599         bool ret = false;
1600         char *path, *p;
1601
1602         if (key == NULL) {
1603                 goto done;
1604         }
1605
1606         path = normalize_reg_path(mem_ctx, key);
1607         if (path == NULL) {
1608                 DEBUG(0, ("out of memory! (talloc failed)\n"));
1609                 goto done;
1610         }
1611
1612         if (*path == '\0') {
1613                 goto done;
1614         }
1615
1616         p = strrchr(path, '\\');
1617         if (p == NULL) {
1618                 /* this is a base key */
1619                 value = regdb_fetch_key_internal(db, mem_ctx, path);
1620                 ret = (value.dptr != NULL);
1621         } else {
1622                 *p = '\0';
1623                 ret = scan_parent_subkeys(db, path, p+1);
1624         }
1625
1626 done:
1627         TALLOC_FREE(mem_ctx);
1628         return ret;
1629 }
1630
1631
1632 /***********************************************************************
1633  Retrieve an array of strings containing subkeys.  Memory should be
1634  released by the caller.
1635  ***********************************************************************/
1636
1637 static WERROR regdb_fetch_keys_internal(struct db_context *db, const char *key,
1638                                         struct regsubkey_ctr *ctr)
1639 {
1640         WERROR werr;
1641         uint32_t num_items;
1642         uint8 *buf;
1643         uint32 buflen, len;
1644         int i;
1645         fstring subkeyname;
1646         TALLOC_CTX *frame = talloc_stackframe();
1647         TDB_DATA value;
1648
1649         DEBUG(11,("regdb_fetch_keys: Enter key => [%s]\n", key ? key : "NULL"));
1650
1651         if (!regdb_key_exists(db, key)) {
1652                 DEBUG(10, ("key [%s] not found\n", key));
1653                 werr = WERR_NOT_FOUND;
1654                 goto done;
1655         }
1656
1657         werr = regsubkey_ctr_set_seqnum(ctr, db->get_seqnum(db));
1658         W_ERROR_NOT_OK_GOTO_DONE(werr);
1659
1660         value = regdb_fetch_key_internal(db, frame, key);
1661
1662         if (value.dsize == 0 || value.dptr == NULL) {
1663                 DEBUG(10, ("regdb_fetch_keys: no subkeys found for key [%s]\n",
1664                            key));
1665                 goto done;
1666         }
1667
1668         buf = value.dptr;
1669         buflen = value.dsize;
1670         len = tdb_unpack( buf, buflen, "d", &num_items);
1671         if (len == (uint32_t)-1) {
1672                 werr = WERR_NOT_FOUND;
1673                 goto done;
1674         }
1675
1676         werr = regsubkey_ctr_reinit(ctr);
1677         W_ERROR_NOT_OK_GOTO_DONE(werr);
1678
1679         for (i=0; i<num_items; i++) {
1680                 len += tdb_unpack(buf+len, buflen-len, "f", subkeyname);
1681                 werr = regsubkey_ctr_addkey(ctr, subkeyname);
1682                 if (!W_ERROR_IS_OK(werr)) {
1683                         DEBUG(5, ("regdb_fetch_keys: regsubkey_ctr_addkey "
1684                                   "failed: %s\n", win_errstr(werr)));
1685                         num_items = 0;
1686                         goto done;
1687                 }
1688         }
1689
1690         DEBUG(11,("regdb_fetch_keys: Exit [%d] items\n", num_items));
1691
1692 done:
1693         TALLOC_FREE(frame);
1694         return werr;
1695 }
1696
1697 int regdb_fetch_keys(const char *key, struct regsubkey_ctr *ctr)
1698 {
1699         WERROR werr;
1700
1701         werr = regdb_fetch_keys_internal(regdb, key, ctr);
1702         if (!W_ERROR_IS_OK(werr)) {
1703                 return -1;
1704         }
1705
1706         return regsubkey_ctr_numkeys(ctr);
1707 }
1708
1709 /****************************************************************************
1710  Unpack a list of registry values frem the TDB
1711  ***************************************************************************/
1712
1713 static int regdb_unpack_values(struct regval_ctr *values, uint8 *buf, int buflen)
1714 {
1715         int             len = 0;
1716         uint32          type;
1717         fstring valuename;
1718         uint32          size;
1719         uint8           *data_p;
1720         uint32          num_values = 0;
1721         int             i;
1722
1723         /* loop and unpack the rest of the registry values */
1724
1725         len += tdb_unpack(buf+len, buflen-len, "d", &num_values);
1726
1727         for ( i=0; i<num_values; i++ ) {
1728                 /* unpack the next regval */
1729
1730                 type = REG_NONE;
1731                 size = 0;
1732                 data_p = NULL;
1733                 valuename[0] = '\0';
1734                 len += tdb_unpack(buf+len, buflen-len, "fdB",
1735                                   valuename,
1736                                   &type,
1737                                   &size,
1738                                   &data_p);
1739
1740                 regval_ctr_addvalue(values, valuename, type,
1741                                 (uint8_t *)data_p, size);
1742                 SAFE_FREE(data_p); /* 'B' option to tdb_unpack does a malloc() */
1743
1744                 DEBUG(8,("specific: [%s], len: %d\n", valuename, size));
1745         }
1746
1747         return len;
1748 }
1749
1750 /****************************************************************************
1751  Pack all values in all printer keys
1752  ***************************************************************************/
1753
1754 static int regdb_pack_values(struct regval_ctr *values, uint8 *buf, int buflen)
1755 {
1756         int             len = 0;
1757         int             i;
1758         struct regval_blob      *val;
1759         int             num_values;
1760
1761         if ( !values )
1762                 return 0;
1763
1764         num_values = regval_ctr_numvals( values );
1765
1766         /* pack the number of values first */
1767
1768         len += tdb_pack( buf+len, buflen-len, "d", num_values );
1769
1770         /* loop over all values */
1771
1772         for ( i=0; i<num_values; i++ ) {
1773                 val = regval_ctr_specific_value( values, i );
1774                 len += tdb_pack(buf+len, buflen-len, "fdB",
1775                                 regval_name(val),
1776                                 regval_type(val),
1777                                 regval_size(val),
1778                                 regval_data_p(val) );
1779         }
1780
1781         return len;
1782 }
1783
1784 /***********************************************************************
1785  Retrieve an array of strings containing subkeys.  Memory should be
1786  released by the caller.
1787  ***********************************************************************/
1788
1789 static int regdb_fetch_values_internal(struct db_context *db, const char* key,
1790                                        struct regval_ctr *values)
1791 {
1792         char *keystr = NULL;
1793         TALLOC_CTX *ctx = talloc_stackframe();
1794         int ret = 0;
1795         TDB_DATA value;
1796         WERROR werr;
1797
1798         DEBUG(10,("regdb_fetch_values: Looking for value of key [%s] \n", key));
1799
1800         if (!regdb_key_exists(db, key)) {
1801                 goto done;
1802         }
1803
1804         keystr = talloc_asprintf(ctx, "%s\\%s", REG_VALUE_PREFIX, key);
1805         if (!keystr) {
1806                 goto done;
1807         }
1808
1809         werr = regval_ctr_set_seqnum(values, db->get_seqnum(db));
1810         W_ERROR_NOT_OK_GOTO_DONE(werr);
1811
1812         value = regdb_fetch_key_internal(db, ctx, keystr);
1813
1814         if (!value.dptr) {
1815                 /* all keys have zero values by default */
1816                 goto done;
1817         }
1818
1819         regdb_unpack_values(values, value.dptr, value.dsize);
1820         ret = regval_ctr_numvals(values);
1821
1822 done:
1823         TALLOC_FREE(ctx);
1824         return ret;
1825 }
1826
1827 int regdb_fetch_values(const char* key, struct regval_ctr *values)
1828 {
1829         return regdb_fetch_values_internal(regdb, key, values);
1830 }
1831
1832 static bool regdb_store_values_internal(struct db_context *db, const char *key,
1833                                         struct regval_ctr *values)
1834 {
1835         TDB_DATA old_data, data;
1836         char *keystr = NULL;
1837         TALLOC_CTX *ctx = talloc_stackframe();
1838         int len;
1839         NTSTATUS status;
1840         bool result = false;
1841
1842         DEBUG(10,("regdb_store_values: Looking for value of key [%s] \n", key));
1843
1844         if (!regdb_key_exists(db, key)) {
1845                 goto done;
1846         }
1847
1848         ZERO_STRUCT(data);
1849
1850         len = regdb_pack_values(values, data.dptr, data.dsize);
1851         if (len <= 0) {
1852                 DEBUG(0,("regdb_store_values: unable to pack values. len <= 0\n"));
1853                 goto done;
1854         }
1855
1856         data.dptr = talloc_array(ctx, uint8, len);
1857         data.dsize = len;
1858
1859         len = regdb_pack_values(values, data.dptr, data.dsize);
1860
1861         SMB_ASSERT( len == data.dsize );
1862
1863         keystr = talloc_asprintf(ctx, "%s\\%s", REG_VALUE_PREFIX, key );
1864         if (!keystr) {
1865                 goto done;
1866         }
1867         keystr = normalize_reg_path(ctx, keystr);
1868         if (!keystr) {
1869                 goto done;
1870         }
1871
1872         old_data = dbwrap_fetch_bystring(db, ctx, keystr);
1873
1874         if ((old_data.dptr != NULL)
1875             && (old_data.dsize == data.dsize)
1876             && (memcmp(old_data.dptr, data.dptr, data.dsize) == 0))
1877         {
1878                 result = true;
1879                 goto done;
1880         }
1881
1882         status = dbwrap_trans_store_bystring(db, keystr, data, TDB_REPLACE);
1883
1884         result = NT_STATUS_IS_OK(status);
1885
1886 done:
1887         TALLOC_FREE(ctx);
1888         return result;
1889 }
1890
1891 bool regdb_store_values(const char *key, struct regval_ctr *values)
1892 {
1893         return regdb_store_values_internal(regdb, key, values);
1894 }
1895
1896 static WERROR regdb_get_secdesc(TALLOC_CTX *mem_ctx, const char *key,
1897                                 struct security_descriptor **psecdesc)
1898 {
1899         char *tdbkey;
1900         TDB_DATA data;
1901         NTSTATUS status;
1902         TALLOC_CTX *tmp_ctx = talloc_stackframe();
1903         WERROR err = WERR_OK;
1904
1905         DEBUG(10, ("regdb_get_secdesc: Getting secdesc of key [%s]\n", key));
1906
1907         if (!regdb_key_exists(regdb, key)) {
1908                 err = WERR_BADFILE;
1909                 goto done;
1910         }
1911
1912         tdbkey = talloc_asprintf(tmp_ctx, "%s\\%s", REG_SECDESC_PREFIX, key);
1913         if (tdbkey == NULL) {
1914                 err = WERR_NOMEM;
1915                 goto done;
1916         }
1917
1918         tdbkey = normalize_reg_path(tmp_ctx, tdbkey);
1919         if (tdbkey == NULL) {
1920                 err = WERR_NOMEM;
1921                 goto done;
1922         }
1923
1924         data = dbwrap_fetch_bystring(regdb, tmp_ctx, tdbkey);
1925         if (data.dptr == NULL) {
1926                 err = WERR_BADFILE;
1927                 goto done;
1928         }
1929
1930         status = unmarshall_sec_desc(mem_ctx, (uint8 *)data.dptr, data.dsize,
1931                                      psecdesc);
1932
1933         if (NT_STATUS_EQUAL(status, NT_STATUS_NO_MEMORY)) {
1934                 err = WERR_NOMEM;
1935         } else if (!NT_STATUS_IS_OK(status)) {
1936                 err = WERR_REG_CORRUPT;
1937         }
1938
1939 done:
1940         TALLOC_FREE(tmp_ctx);
1941         return err;
1942 }
1943
1944 static WERROR regdb_set_secdesc(const char *key,
1945                                 struct security_descriptor *secdesc)
1946 {
1947         TALLOC_CTX *mem_ctx = talloc_stackframe();
1948         char *tdbkey;
1949         WERROR err = WERR_NOMEM;
1950         TDB_DATA tdbdata;
1951
1952         if (!regdb_key_exists(regdb, key)) {
1953                 err = WERR_BADFILE;
1954                 goto done;
1955         }
1956
1957         tdbkey = talloc_asprintf(mem_ctx, "%s\\%s", REG_SECDESC_PREFIX, key);
1958         if (tdbkey == NULL) {
1959                 goto done;
1960         }
1961
1962         tdbkey = normalize_reg_path(mem_ctx, tdbkey);
1963         if (tdbkey == NULL) {
1964                 err = WERR_NOMEM;
1965                 goto done;
1966         }
1967
1968         if (secdesc == NULL) {
1969                 /* assuming a delete */
1970                 err = ntstatus_to_werror(dbwrap_trans_delete_bystring(regdb,
1971                                                                       tdbkey));
1972                 goto done;
1973         }
1974
1975         err = ntstatus_to_werror(marshall_sec_desc(mem_ctx, secdesc,
1976                                                    &tdbdata.dptr,
1977                                                    &tdbdata.dsize));
1978         W_ERROR_NOT_OK_GOTO_DONE(err);
1979
1980         err = ntstatus_to_werror(dbwrap_trans_store_bystring(regdb, tdbkey,
1981                                                              tdbdata, 0));
1982
1983  done:
1984         TALLOC_FREE(mem_ctx);
1985         return err;
1986 }
1987
1988 bool regdb_subkeys_need_update(struct regsubkey_ctr *subkeys)
1989 {
1990         return (regdb_get_seqnum() != regsubkey_ctr_get_seqnum(subkeys));
1991 }
1992
1993 bool regdb_values_need_update(struct regval_ctr *values)
1994 {
1995         return (regdb_get_seqnum() != regval_ctr_get_seqnum(values));
1996 }
1997
1998 /*
1999  * Table of function pointers for default access
2000  */
2001
2002 struct registry_ops regdb_ops = {
2003         .fetch_subkeys = regdb_fetch_keys,
2004         .fetch_values = regdb_fetch_values,
2005         .store_subkeys = regdb_store_keys,
2006         .store_values = regdb_store_values,
2007         .create_subkey = regdb_create_subkey,
2008         .delete_subkey = regdb_delete_subkey,
2009         .get_secdesc = regdb_get_secdesc,
2010         .set_secdesc = regdb_set_secdesc,
2011         .subkeys_need_update = regdb_subkeys_need_update,
2012         .values_need_update = regdb_values_need_update
2013 };