Add sorted subkey cache
[ira/wip.git] / 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 [%u]\n",
554                                           (unsigned int)(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         /*
582          * Delete a sorted subkey cache for regdb_key_exists, will be
583          * recreated automatically
584          */
585         keyname = talloc_asprintf(ctx, "%s/%s", REG_SORTED_SUBKEYS_PREFIX,
586                                   keyname);
587         if (keyname != NULL) {
588                 dbwrap_delete_bystring(regdb, keyname);
589         }
590
591 done:
592         TALLOC_FREE(ctx);
593         SAFE_FREE(buffer);
594         return ret;
595 }
596
597 /***********************************************************************
598  Store the new subkey record and create any child key records that
599  do not currently exist
600  ***********************************************************************/
601
602 bool regdb_store_keys(const char *key, REGSUBKEY_CTR *ctr)
603 {
604         int num_subkeys, i;
605         char *path = NULL;
606         REGSUBKEY_CTR *subkeys = NULL, *old_subkeys = NULL;
607         char *oldkeyname = NULL;
608         TALLOC_CTX *ctx = talloc_stackframe();
609         NTSTATUS status;
610
611         if (!regdb_key_is_base_key(key) && !regdb_key_exists(key)) {
612                 goto fail;
613         }
614
615         /*
616          * fetch a list of the old subkeys so we can determine if anything has
617          * changed
618          */
619
620         if (!(old_subkeys = TALLOC_ZERO_P(ctx, REGSUBKEY_CTR))) {
621                 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
622                 return false;
623         }
624
625         regdb_fetch_keys(key, old_subkeys);
626
627         if ((ctr->num_subkeys && old_subkeys->num_subkeys) &&
628             (ctr->num_subkeys == old_subkeys->num_subkeys)) {
629
630                 for (i = 0; i<ctr->num_subkeys; i++) {
631                         if (strcmp(ctr->subkeys[i],
632                                    old_subkeys->subkeys[i]) != 0) {
633                                 break;
634                         }
635                 }
636                 if (i == ctr->num_subkeys) {
637                         /*
638                          * Nothing changed, no point to even start a tdb
639                          * transaction
640                          */
641                         TALLOC_FREE(old_subkeys);
642                         return true;
643                 }
644         }
645
646         TALLOC_FREE(old_subkeys);
647
648         if (regdb->transaction_start(regdb) != 0) {
649                 DEBUG(0, ("regdb_store_keys: transaction_start failed\n"));
650                 goto fail;
651         }
652
653         /*
654          * Re-fetch the old keys inside the transaction
655          */
656
657         if (!(old_subkeys = TALLOC_ZERO_P(ctx, REGSUBKEY_CTR))) {
658                 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
659                 goto cancel;
660         }
661
662         regdb_fetch_keys(key, old_subkeys);
663
664         /*
665          * Make the store operation as safe as possible without transactions:
666          *
667          * (1) For each subkey removed from ctr compared with old_subkeys:
668          *
669          *     (a) First delete the value db entry.
670          *
671          *     (b) Next delete the secdesc db record.
672          *
673          *     (c) Then delete the subkey list entry.
674          *
675          * (2) Now write the list of subkeys of the parent key,
676          *     deleting removed entries and adding new ones.
677          *
678          * (3) Finally create the subkey list entries for the added keys.
679          *
680          * This way if we crash half-way in between deleting the subkeys
681          * and storing the parent's list of subkeys, no old data can pop up
682          * out of the blue when re-adding keys later on.
683          */
684
685         /* (1) delete removed keys' lists (values/secdesc/subkeys) */
686
687         num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
688         for (i=0; i<num_subkeys; i++) {
689                 oldkeyname = regsubkey_ctr_specific_key(old_subkeys, i);
690
691                 if (regsubkey_ctr_key_exists(ctr, oldkeyname)) {
692                         /*
693                          * It's still around, don't delete
694                          */
695
696                         continue;
697                 }
698
699                 /* (a) Delete the value list for this key */
700
701                 path = talloc_asprintf(ctx, "%s/%s/%s",
702                                 REG_VALUE_PREFIX,
703                                 key,
704                                 oldkeyname );
705                 if (!path) {
706                         goto cancel;
707                 }
708                 path = normalize_reg_path(ctx, path);
709                 if (!path) {
710                         goto cancel;
711                 }
712                 /* Ignore errors here, we might have no values around */
713                 dbwrap_delete_bystring(regdb, path);
714                 TALLOC_FREE(path);
715
716                 /* (b) Delete the secdesc for this key */
717
718                 path = talloc_asprintf(ctx, "%s/%s/%s",
719                                 REG_SECDESC_PREFIX,
720                                 key,
721                                 oldkeyname );
722                 if (!path) {
723                         goto cancel;
724                 }
725                 path = normalize_reg_path(ctx, path);
726                 if (!path) {
727                         goto cancel;
728                 }
729                 status = dbwrap_delete_bystring(regdb, path);
730                 /* Don't fail if there are no values around. */
731                 if (!NT_STATUS_IS_OK(status) &&
732                     !NT_STATUS_EQUAL(status, NT_STATUS_NOT_FOUND))
733                 {
734                         DEBUG(1, ("Deleting %s failed: %s\n", path,
735                                   nt_errstr(status)));
736                         goto cancel;
737                 }
738                 TALLOC_FREE(path);
739
740                 /* (c) Delete the list of subkeys of this key */
741
742                 path = talloc_asprintf(ctx, "%s/%s", key, oldkeyname);
743                 if (!path) {
744                         goto cancel;
745                 }
746                 path = normalize_reg_path(ctx, path);
747                 if (!path) {
748                         goto cancel;
749                 }
750                 status = dbwrap_delete_bystring(regdb, path);
751                 /* Don't fail if the subkey record was not found. */
752                 if (!NT_STATUS_IS_OK(status) &&
753                     !NT_STATUS_EQUAL(status, NT_STATUS_NOT_FOUND))
754                 {
755                         DEBUG(1, ("Deleting %s failed: %s\n", path,
756                                   nt_errstr(status)));
757                         goto cancel;
758                 }
759                 TALLOC_FREE(path);
760         }
761
762         TALLOC_FREE(old_subkeys);
763
764         /* (2) store the subkey list for the parent */
765
766         if (!regdb_store_keys_internal(key, ctr) ) {
767                 DEBUG(0,("regdb_store_keys: Failed to store new subkey list "
768                          "for parent [%s]\n", key));
769                 goto cancel;
770         }
771
772         /* (3) now create records for any subkeys that don't already exist */
773
774         num_subkeys = regsubkey_ctr_numkeys(ctr);
775
776         if (num_subkeys == 0) {
777                 if (!(subkeys = TALLOC_ZERO_P(ctx, REGSUBKEY_CTR)) ) {
778                         DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
779                         goto cancel;
780                 }
781
782                 if (!regdb_store_keys_internal(key, subkeys)) {
783                         DEBUG(0,("regdb_store_keys: Failed to store "
784                                  "new record for key [%s]\n", key));
785                         goto cancel;
786                 }
787                 TALLOC_FREE(subkeys);
788
789         }
790
791         for (i=0; i<num_subkeys; i++) {
792                 path = talloc_asprintf(ctx, "%s/%s",
793                                         key,
794                                         regsubkey_ctr_specific_key(ctr, i));
795                 if (!path) {
796                         goto cancel;
797                 }
798                 if (!(subkeys = TALLOC_ZERO_P(ctx, REGSUBKEY_CTR)) ) {
799                         DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
800                         goto cancel;
801                 }
802
803                 if (regdb_fetch_keys( path, subkeys ) == -1) {
804                         /* create a record with 0 subkeys */
805                         if (!regdb_store_keys_internal(path, subkeys)) {
806                                 DEBUG(0,("regdb_store_keys: Failed to store "
807                                          "new record for key [%s]\n", path));
808                                 goto cancel;
809                         }
810                 }
811
812                 TALLOC_FREE(subkeys);
813                 TALLOC_FREE(path);
814         }
815
816         if (regdb->transaction_commit(regdb) != 0) {
817                 DEBUG(0, ("regdb_store_keys: Could not commit transaction\n"));
818                 goto fail;
819         }
820
821         TALLOC_FREE(ctx);
822         return true;
823
824 cancel:
825         if (regdb->transaction_cancel(regdb) != 0) {
826                 smb_panic("regdb_store_keys: transaction_cancel failed\n");
827         }
828
829 fail:
830         TALLOC_FREE(ctx);
831
832         return false;
833 }
834
835
836 static TDB_DATA regdb_fetch_key_internal(TALLOC_CTX *mem_ctx, const char *key)
837 {
838         char *path = NULL;
839         TDB_DATA data;
840
841         path = normalize_reg_path(mem_ctx, key);
842         if (!path) {
843                 return make_tdb_data(NULL, 0);
844         }
845
846         data = dbwrap_fetch_bystring(regdb, mem_ctx, path);
847
848         TALLOC_FREE(path);
849         return data;
850 }
851
852
853 /**
854  * check whether a given key name represents a base key,
855  * i.e one without a subkey separator ('/' or '\').
856  */
857 static bool regdb_key_is_base_key(const char *key)
858 {
859         TALLOC_CTX *mem_ctx = talloc_stackframe();
860         bool ret = false;
861         char *path;
862
863         if (key == NULL) {
864                 goto done;
865         }
866
867         path = normalize_reg_path(mem_ctx, key);
868         if (path == NULL) {
869                 DEBUG(0, ("out of memory! (talloc failed)\n"));
870                 goto done;
871         }
872
873         if (*path == '\0') {
874                 goto done;
875         }
876
877         ret = (strrchr(path, '/') == NULL);
878
879 done:
880         TALLOC_FREE(mem_ctx);
881         return ret;
882 }
883
884 static int cmp_keynames(const void *p1, const void *p2)
885 {
886         return StrCaseCmp(*((char **)p1), *((char **)p2));
887 }
888
889 static bool create_sorted_subkeys(const char *key, const char *sorted_keyname)
890 {
891         char **sorted_subkeys;
892         REGSUBKEY_CTR *ctr;
893         bool result = false;
894         NTSTATUS status;
895         char *buf;
896         char *p;
897         int i, res;
898         size_t len;
899
900         ctr = talloc(talloc_tos(), REGSUBKEY_CTR);
901         if (ctr == NULL) {
902                 return false;
903         }
904
905         res = regdb_fetch_keys(key, ctr);
906         if (res == -1) {
907                 goto fail;
908         }
909
910         sorted_subkeys = talloc_array(ctr, char *, ctr->num_subkeys);
911         if (sorted_subkeys == NULL) {
912                 goto fail;
913         }
914
915         len = 4 + 4*ctr->num_subkeys;
916
917         for (i = 0; i<ctr->num_subkeys; i++) {
918                 sorted_subkeys[i] = talloc_strdup_upper(sorted_subkeys,
919                                                         ctr->subkeys[i]);
920                 if (sorted_subkeys[i] == NULL) {
921                         goto fail;
922                 }
923                 len += strlen(sorted_subkeys[i])+1;
924         }
925
926         qsort(sorted_subkeys, ctr->num_subkeys, sizeof(char *), cmp_keynames);
927
928         buf = talloc_array(ctr, char, len);
929         if (buf == NULL) {
930                 goto fail;
931         }
932         p = buf + 4 + 4*ctr->num_subkeys;
933
934         SIVAL(buf, 0, ctr->num_subkeys);
935
936         for (i=0; i<ctr->num_subkeys; i++) {
937                 ptrdiff_t offset = p - buf;
938                 SIVAL(buf, 4 + 4*i, offset);
939                 strlcpy(p, sorted_subkeys[i], len-offset);
940                 p += strlen(sorted_subkeys[i]) + 1;
941         }
942
943         status = dbwrap_trans_store_bystring(
944                 regdb, sorted_keyname, make_tdb_data((uint8_t *)buf, len),
945                 TDB_REPLACE);
946         if (!NT_STATUS_IS_OK(status)) {
947                 goto fail;
948         }
949
950         result = true;
951  fail:
952         TALLOC_FREE(ctr);
953         return result;
954 }
955
956 struct scan_subkey_state {
957         char *name;
958         bool scanned;
959         bool found;
960 };
961
962 static int parent_subkey_scanner(TDB_DATA key, TDB_DATA data,
963                                  void *private_data)
964 {
965         struct scan_subkey_state *state =
966                 (struct scan_subkey_state *)private_data;
967         uint32_t num_subkeys;
968         uint32_t l, u;
969
970         if (data.dsize < sizeof(uint32_t)) {
971                 return -1;
972         }
973
974         state->scanned = true;
975         state->found = false;
976
977         tdb_unpack(data.dptr, data.dsize, "d", &num_subkeys);
978
979         l = 0;
980         u = num_subkeys;
981
982         while (l < u) {
983                 uint32_t idx = (l+u)/2;
984                 char *s = (char *)data.dptr + IVAL(data.dptr, 4 + 4*idx);
985                 int comparison = strcmp(state->name, s);
986
987                 if (comparison < 0) {
988                         u = idx;
989                 } else if (comparison > 0) {
990                         l = idx + 1;
991                 } else {
992                         state->found = true;
993                         return 0;
994                 }
995         }
996         return 0;
997 }
998
999 static bool scan_parent_subkeys(const char *parent, const char *name)
1000 {
1001         char *path = NULL;
1002         char *key = NULL;
1003         struct scan_subkey_state state = { 0, };
1004         bool result = false;
1005         int res;
1006
1007         state.name = NULL;
1008
1009         path = normalize_reg_path(talloc_tos(), parent);
1010         if (path == NULL) {
1011                 goto fail;
1012         }
1013
1014         key = talloc_asprintf(talloc_tos(), "%s/%s",
1015                               REG_SORTED_SUBKEYS_PREFIX, path);
1016         if (key == NULL) {
1017                 goto fail;
1018         }
1019
1020         state.name = talloc_strdup_upper(talloc_tos(), name);
1021         if (state.name == NULL) {
1022                 goto fail;
1023         }
1024         state.scanned = false;
1025
1026         res = regdb->parse_record(regdb, string_term_tdb_data(key),
1027                                   parent_subkey_scanner, &state);
1028
1029         if (state.scanned) {
1030                 result = state.found;
1031         } else {
1032                 if (!create_sorted_subkeys(path, key)) {
1033                         goto fail;
1034                 }
1035                 res = regdb->parse_record(regdb, string_term_tdb_data(key),
1036                                           parent_subkey_scanner, &state);
1037                 if ((res == 0) && (state.scanned)) {
1038                         result = state.found;
1039                 }
1040         }
1041
1042  fail:
1043         TALLOC_FREE(path);
1044         TALLOC_FREE(state.name);
1045         return result;
1046 }
1047
1048 /**
1049  * Check for the existence of a key.
1050  *
1051  * Existence of a key is authoritatively defined by its
1052  * existence in the list of subkeys of its parent key.
1053  * The exeption of this are keys without a parent key,
1054  * i.e. the "base" keys (HKLM, HKCU, ...).
1055  */
1056 static bool regdb_key_exists(const char *key)
1057 {
1058         TALLOC_CTX *mem_ctx = talloc_stackframe();
1059         TDB_DATA value;
1060         bool ret = false;
1061         char *path, *p;
1062
1063         if (key == NULL) {
1064                 goto done;
1065         }
1066
1067         path = normalize_reg_path(mem_ctx, key);
1068         if (path == NULL) {
1069                 DEBUG(0, ("out of memory! (talloc failed)\n"));
1070                 goto done;
1071         }
1072
1073         if (*path == '\0') {
1074                 goto done;
1075         }
1076
1077         p = strrchr(path, '/');
1078         if (p == NULL) {
1079                 /* this is a base key */
1080                 value = regdb_fetch_key_internal(mem_ctx, path);
1081                 ret = (value.dptr != NULL);
1082         } else {
1083                 *p = '\0';
1084                 ret = scan_parent_subkeys(path, p+1);
1085         }
1086
1087 done:
1088         TALLOC_FREE(mem_ctx);
1089         return ret;
1090 }
1091
1092
1093 /***********************************************************************
1094  Retrieve an array of strings containing subkeys.  Memory should be
1095  released by the caller.
1096  ***********************************************************************/
1097
1098 int regdb_fetch_keys(const char *key, REGSUBKEY_CTR *ctr)
1099 {
1100         uint32 num_items;
1101         uint8 *buf;
1102         uint32 buflen, len;
1103         int i;
1104         fstring subkeyname;
1105         int ret = -1;
1106         TALLOC_CTX *frame = talloc_stackframe();
1107         TDB_DATA value;
1108
1109         DEBUG(11,("regdb_fetch_keys: Enter key => [%s]\n", key ? key : "NULL"));
1110
1111         if (!regdb_key_exists(key)) {
1112                 goto done;
1113         }
1114
1115         ctr->seqnum = regdb_get_seqnum();
1116
1117         value = regdb_fetch_key_internal(frame, key);
1118
1119         if (value.dptr == NULL) {
1120                 DEBUG(10, ("regdb_fetch_keys: no subkeys found for key [%s]\n",
1121                            key));
1122                 ret = 0;
1123                 goto done;
1124         }
1125
1126         buf = value.dptr;
1127         buflen = value.dsize;
1128         len = tdb_unpack( buf, buflen, "d", &num_items);
1129
1130         /*
1131          * The following code breaks the abstraction that reg_objects.c sets
1132          * up with regsubkey_ctr_addkey(). But if we use that with the current
1133          * data structure of ctr->subkeys being an unsorted array, we end up
1134          * with an O(n^2) algorithm for retrieving keys from the tdb
1135          * file. This is pretty pointless, as we have to trust the data
1136          * structure on disk not to have duplicates anyway. The alternative to
1137          * breaking this abstraction would be to set up a more sophisticated
1138          * data structure in REGSUBKEY_CTR.
1139          *
1140          * This makes "net conf list" for a registry with >1000 shares
1141          * actually usable :-)
1142          */
1143
1144         ctr->subkeys = talloc_array(ctr, char *, num_items);
1145         if (ctr->subkeys == NULL) {
1146                 DEBUG(5, ("regdb_fetch_keys: could not allocate subkeys\n"));
1147                 goto done;
1148         }
1149         ctr->num_subkeys = num_items;
1150
1151         for (i=0; i<num_items; i++) {
1152                 len += tdb_unpack(buf+len, buflen-len, "f", subkeyname);
1153                 ctr->subkeys[i] = talloc_strdup(ctr->subkeys, subkeyname);
1154                 if (ctr->subkeys[i] == NULL) {
1155                         DEBUG(5, ("regdb_fetch_keys: could not allocate "
1156                                   "subkeyname\n"));
1157                         TALLOC_FREE(ctr->subkeys);
1158                         ctr->num_subkeys = 0;
1159                         goto done;
1160                 }
1161         }
1162
1163         DEBUG(11,("regdb_fetch_keys: Exit [%d] items\n", num_items));
1164
1165         ret = num_items;
1166 done:
1167         TALLOC_FREE(frame);
1168         return ret;
1169 }
1170
1171 /****************************************************************************
1172  Unpack a list of registry values frem the TDB
1173  ***************************************************************************/
1174
1175 static int regdb_unpack_values(REGVAL_CTR *values, uint8 *buf, int buflen)
1176 {
1177         int             len = 0;
1178         uint32          type;
1179         fstring valuename;
1180         uint32          size;
1181         uint8           *data_p;
1182         uint32          num_values = 0;
1183         int             i;
1184
1185         /* loop and unpack the rest of the registry values */
1186
1187         len += tdb_unpack(buf+len, buflen-len, "d", &num_values);
1188
1189         for ( i=0; i<num_values; i++ ) {
1190                 /* unpack the next regval */
1191
1192                 type = REG_NONE;
1193                 size = 0;
1194                 data_p = NULL;
1195                 valuename[0] = '\0';
1196                 len += tdb_unpack(buf+len, buflen-len, "fdB",
1197                                   valuename,
1198                                   &type,
1199                                   &size,
1200                                   &data_p);
1201
1202                 /* add the new value. Paranoid protective code -- make sure data_p is valid */
1203
1204                 if (*valuename && size && data_p) {
1205                         regval_ctr_addvalue(values, valuename, type,
1206                                         (const char *)data_p, size);
1207                 }
1208                 SAFE_FREE(data_p); /* 'B' option to tdb_unpack does a malloc() */
1209
1210                 DEBUG(8,("specific: [%s], len: %d\n", valuename, size));
1211         }
1212
1213         return len;
1214 }
1215
1216 /****************************************************************************
1217  Pack all values in all printer keys
1218  ***************************************************************************/
1219
1220 static int regdb_pack_values(REGVAL_CTR *values, uint8 *buf, int buflen)
1221 {
1222         int             len = 0;
1223         int             i;
1224         REGISTRY_VALUE  *val;
1225         int             num_values;
1226
1227         if ( !values )
1228                 return 0;
1229
1230         num_values = regval_ctr_numvals( values );
1231
1232         /* pack the number of values first */
1233
1234         len += tdb_pack( buf+len, buflen-len, "d", num_values );
1235
1236         /* loop over all values */
1237
1238         for ( i=0; i<num_values; i++ ) {
1239                 val = regval_ctr_specific_value( values, i );
1240                 len += tdb_pack(buf+len, buflen-len, "fdB",
1241                                 regval_name(val),
1242                                 regval_type(val),
1243                                 regval_size(val),
1244                                 regval_data_p(val) );
1245         }
1246
1247         return len;
1248 }
1249
1250 /***********************************************************************
1251  Retrieve an array of strings containing subkeys.  Memory should be
1252  released by the caller.
1253  ***********************************************************************/
1254
1255 int regdb_fetch_values( const char* key, REGVAL_CTR *values )
1256 {
1257         char *keystr = NULL;
1258         TALLOC_CTX *ctx = talloc_stackframe();
1259         int ret = 0;
1260         TDB_DATA value;
1261
1262         DEBUG(10,("regdb_fetch_values: Looking for value of key [%s] \n", key));
1263
1264         if (!regdb_key_exists(key)) {
1265                 goto done;
1266         }
1267
1268         keystr = talloc_asprintf(ctx, "%s/%s", REG_VALUE_PREFIX, key);
1269         if (!keystr) {
1270                 goto done;
1271         }
1272
1273         values->seqnum = regdb_get_seqnum();
1274
1275         value = regdb_fetch_key_internal(ctx, keystr);
1276
1277         if (!value.dptr) {
1278                 /* all keys have zero values by default */
1279                 goto done;
1280         }
1281
1282         regdb_unpack_values(values, value.dptr, value.dsize);
1283         ret = regval_ctr_numvals(values);
1284
1285 done:
1286         TALLOC_FREE(ctx);
1287         return ret;
1288 }
1289
1290 bool regdb_store_values( const char *key, REGVAL_CTR *values )
1291 {
1292         TDB_DATA old_data, data;
1293         char *keystr = NULL;
1294         TALLOC_CTX *ctx = talloc_stackframe();
1295         int len;
1296         NTSTATUS status;
1297         bool result = false;
1298
1299         DEBUG(10,("regdb_store_values: Looking for value of key [%s] \n", key));
1300
1301         if (!regdb_key_exists(key)) {
1302                 goto done;
1303         }
1304
1305         ZERO_STRUCT(data);
1306
1307         len = regdb_pack_values(values, data.dptr, data.dsize);
1308         if (len <= 0) {
1309                 DEBUG(0,("regdb_store_values: unable to pack values. len <= 0\n"));
1310                 goto done;
1311         }
1312
1313         data.dptr = TALLOC_ARRAY(ctx, uint8, len);
1314         data.dsize = len;
1315
1316         len = regdb_pack_values(values, data.dptr, data.dsize);
1317
1318         SMB_ASSERT( len == data.dsize );
1319
1320         keystr = talloc_asprintf(ctx, "%s/%s", REG_VALUE_PREFIX, key );
1321         if (!keystr) {
1322                 goto done;
1323         }
1324         keystr = normalize_reg_path(ctx, keystr);
1325         if (!keystr) {
1326                 goto done;
1327         }
1328
1329         old_data = dbwrap_fetch_bystring(regdb, ctx, keystr);
1330
1331         if ((old_data.dptr != NULL)
1332             && (old_data.dsize == data.dsize)
1333             && (memcmp(old_data.dptr, data.dptr, data.dsize) == 0))
1334         {
1335                 result = true;
1336                 goto done;
1337         }
1338
1339         status = dbwrap_trans_store_bystring(regdb, keystr, data, TDB_REPLACE);
1340
1341         result = NT_STATUS_IS_OK(status);
1342
1343 done:
1344         TALLOC_FREE(ctx);
1345         return result;
1346 }
1347
1348 static WERROR regdb_get_secdesc(TALLOC_CTX *mem_ctx, const char *key,
1349                                 struct security_descriptor **psecdesc)
1350 {
1351         char *tdbkey;
1352         TDB_DATA data;
1353         NTSTATUS status;
1354         TALLOC_CTX *tmp_ctx = talloc_stackframe();
1355         WERROR err = WERR_OK;
1356
1357         DEBUG(10, ("regdb_get_secdesc: Getting secdesc of key [%s]\n", key));
1358
1359         if (!regdb_key_exists(key)) {
1360                 err = WERR_BADFILE;
1361                 goto done;
1362         }
1363
1364         tdbkey = talloc_asprintf(tmp_ctx, "%s/%s", REG_SECDESC_PREFIX, key);
1365         if (tdbkey == NULL) {
1366                 err = WERR_NOMEM;
1367                 goto done;
1368         }
1369         normalize_dbkey(tdbkey);
1370
1371         data = dbwrap_fetch_bystring(regdb, tmp_ctx, tdbkey);
1372         if (data.dptr == NULL) {
1373                 err = WERR_BADFILE;
1374                 goto done;
1375         }
1376
1377         status = unmarshall_sec_desc(mem_ctx, (uint8 *)data.dptr, data.dsize,
1378                                      psecdesc);
1379
1380         if (NT_STATUS_EQUAL(status, NT_STATUS_NO_MEMORY)) {
1381                 err = WERR_NOMEM;
1382         } else if (!NT_STATUS_IS_OK(status)) {
1383                 err = WERR_REG_CORRUPT;
1384         }
1385
1386 done:
1387         TALLOC_FREE(tmp_ctx);
1388         return err;
1389 }
1390
1391 static WERROR regdb_set_secdesc(const char *key,
1392                                 struct security_descriptor *secdesc)
1393 {
1394         TALLOC_CTX *mem_ctx = talloc_stackframe();
1395         char *tdbkey;
1396         NTSTATUS status;
1397         WERROR err = WERR_NOMEM;
1398         TDB_DATA tdbdata;
1399
1400         if (!regdb_key_exists(key)) {
1401                 err = WERR_BADFILE;
1402                 goto done;
1403         }
1404
1405         tdbkey = talloc_asprintf(mem_ctx, "%s/%s", REG_SECDESC_PREFIX, key);
1406         if (tdbkey == NULL) {
1407                 goto done;
1408         }
1409         normalize_dbkey(tdbkey);
1410
1411         if (secdesc == NULL) {
1412                 /* assuming a delete */
1413                 status = dbwrap_trans_delete_bystring(regdb, tdbkey);
1414                 if (NT_STATUS_IS_OK(status)) {
1415                         err = WERR_OK;
1416                 } else {
1417                         err = ntstatus_to_werror(status);
1418                 }
1419                 goto done;
1420         }
1421
1422         err = ntstatus_to_werror(marshall_sec_desc(mem_ctx, secdesc,
1423                                                    &tdbdata.dptr,
1424                                                    &tdbdata.dsize));
1425         if (!W_ERROR_IS_OK(err)) {
1426                 goto done;
1427         }
1428
1429         status = dbwrap_trans_store_bystring(regdb, tdbkey, tdbdata, 0);
1430         if (!NT_STATUS_IS_OK(status)) {
1431                 err = ntstatus_to_werror(status);
1432                 goto done;
1433         }
1434
1435  done:
1436         TALLOC_FREE(mem_ctx);
1437         return err;
1438 }
1439
1440 bool regdb_subkeys_need_update(REGSUBKEY_CTR *subkeys)
1441 {
1442         return (regdb_get_seqnum() != subkeys->seqnum);
1443 }
1444
1445 bool regdb_values_need_update(REGVAL_CTR *values)
1446 {
1447         return (regdb_get_seqnum() != values->seqnum);
1448 }
1449
1450 /* 
1451  * Table of function pointers for default access
1452  */
1453  
1454 REGISTRY_OPS regdb_ops = {
1455         .fetch_subkeys = regdb_fetch_keys,
1456         .fetch_values = regdb_fetch_values,
1457         .store_subkeys = regdb_store_keys,
1458         .store_values = regdb_store_values,
1459         .get_secdesc = regdb_get_secdesc,
1460         .set_secdesc = regdb_set_secdesc,
1461         .subkeys_need_update = regdb_subkeys_need_update,
1462         .values_need_update = regdb_values_need_update
1463 };