registry: bump debug level to 1 in regdb_init() if opening the registry fails.
[amitay/samba.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_trans(NULL, state_path("registry.tdb"), 0,
394                               REG_TDB_FLAGS, O_RDWR, 0600);
395         if (!regdb) {
396                 regdb = db_open_trans(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(0, ("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_trans(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                 len += tdb_pack(buffer+len, buflen-len, "f",
540                                 regsubkey_ctr_specific_key(ctr, i));
541                 if (len > buflen) {
542                         /* allocate some extra space */
543                         buffer = (uint8 *)SMB_REALLOC(buffer, len*2);
544                         if(buffer == NULL) {
545                                 DEBUG(0, ("regdb_store_keys: Failed to realloc "
546                                           "memory of size [%d]\n", len*2));
547                                 ret = false;
548                                 goto done;
549                         }
550                         buflen = len*2;
551                         len = tdb_pack(buffer+len, buflen-len, "f",
552                                        regsubkey_ctr_specific_key(ctr, i));
553                 }
554         }
555
556         /* finally write out the data */
557
558         dbuf.dptr = buffer;
559         dbuf.dsize = len;
560         status = dbwrap_store_bystring(regdb, keyname, dbuf, TDB_REPLACE);
561         if (!NT_STATUS_IS_OK(status)) {
562                 ret = false;
563                 goto done;
564         }
565
566 done:
567         TALLOC_FREE(ctx);
568         SAFE_FREE(buffer);
569         return ret;
570 }
571
572 /***********************************************************************
573  Store the new subkey record and create any child key records that
574  do not currently exist
575  ***********************************************************************/
576
577 bool regdb_store_keys(const char *key, REGSUBKEY_CTR *ctr)
578 {
579         int num_subkeys, i;
580         char *path = NULL;
581         REGSUBKEY_CTR *subkeys = NULL, *old_subkeys = NULL;
582         char *oldkeyname = NULL;
583         TALLOC_CTX *ctx = talloc_stackframe();
584         NTSTATUS status;
585
586         if (!regdb_key_is_base_key(key) && !regdb_key_exists(key)) {
587                 goto fail;
588         }
589
590         /*
591          * fetch a list of the old subkeys so we can determine if anything has
592          * changed
593          */
594
595         if (!(old_subkeys = TALLOC_ZERO_P(ctx, REGSUBKEY_CTR))) {
596                 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
597                 return false;
598         }
599
600         regdb_fetch_keys(key, old_subkeys);
601
602         if ((ctr->num_subkeys && old_subkeys->num_subkeys) &&
603             (ctr->num_subkeys == old_subkeys->num_subkeys)) {
604
605                 for (i = 0; i<ctr->num_subkeys; i++) {
606                         if (strcmp(ctr->subkeys[i],
607                                    old_subkeys->subkeys[i]) != 0) {
608                                 break;
609                         }
610                 }
611                 if (i == ctr->num_subkeys) {
612                         /*
613                          * Nothing changed, no point to even start a tdb
614                          * transaction
615                          */
616                         TALLOC_FREE(old_subkeys);
617                         return true;
618                 }
619         }
620
621         TALLOC_FREE(old_subkeys);
622
623         if (regdb->transaction_start(regdb) != 0) {
624                 DEBUG(0, ("regdb_store_keys: transaction_start failed\n"));
625                 goto fail;
626         }
627
628         /*
629          * Re-fetch the old keys inside the transaction
630          */
631
632         if (!(old_subkeys = TALLOC_ZERO_P(ctx, REGSUBKEY_CTR))) {
633                 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
634                 goto cancel;
635         }
636
637         regdb_fetch_keys(key, old_subkeys);
638
639         /*
640          * Make the store operation as safe as possible without transactions:
641          *
642          * (1) For each subkey removed from ctr compared with old_subkeys:
643          *
644          *     (a) First delete the value db entry.
645          *
646          *     (b) Next delete the secdesc db record.
647          *
648          *     (c) Then delete the subkey list entry.
649          *
650          * (2) Now write the list of subkeys of the parent key,
651          *     deleting removed entries and adding new ones.
652          *
653          * (3) Finally create the subkey list entries for the added keys.
654          *
655          * This way if we crash half-way in between deleting the subkeys
656          * and storing the parent's list of subkeys, no old data can pop up
657          * out of the blue when re-adding keys later on.
658          */
659
660         /* (1) delete removed keys' lists (values/secdesc/subkeys) */
661
662         num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
663         for (i=0; i<num_subkeys; i++) {
664                 oldkeyname = regsubkey_ctr_specific_key(old_subkeys, i);
665
666                 if (regsubkey_ctr_key_exists(ctr, oldkeyname)) {
667                         /*
668                          * It's still around, don't delete
669                          */
670
671                         continue;
672                 }
673
674                 /* (a) Delete the value list for this key */
675
676                 path = talloc_asprintf(ctx, "%s/%s/%s",
677                                 REG_VALUE_PREFIX,
678                                 key,
679                                 oldkeyname );
680                 if (!path) {
681                         goto cancel;
682                 }
683                 path = normalize_reg_path(ctx, path);
684                 if (!path) {
685                         goto cancel;
686                 }
687                 /* Ignore errors here, we might have no values around */
688                 dbwrap_delete_bystring(regdb, path);
689                 TALLOC_FREE(path);
690
691                 /* (b) Delete the secdesc for this key */
692
693                 path = talloc_asprintf(ctx, "%s/%s/%s",
694                                 REG_SECDESC_PREFIX,
695                                 key,
696                                 oldkeyname );
697                 if (!path) {
698                         goto cancel;
699                 }
700                 path = normalize_reg_path(ctx, path);
701                 if (!path) {
702                         goto cancel;
703                 }
704                 status = dbwrap_delete_bystring(regdb, path);
705                 /* Don't fail if there are no values around. */
706                 if (!NT_STATUS_IS_OK(status) &&
707                     !NT_STATUS_EQUAL(status, NT_STATUS_NOT_FOUND))
708                 {
709                         DEBUG(1, ("Deleting %s failed: %s\n", path,
710                                   nt_errstr(status)));
711                         goto cancel;
712                 }
713                 TALLOC_FREE(path);
714
715                 /* (c) Delete the list of subkeys of this key */
716
717                 path = talloc_asprintf(ctx, "%s/%s", key, oldkeyname);
718                 if (!path) {
719                         goto cancel;
720                 }
721                 path = normalize_reg_path(ctx, path);
722                 if (!path) {
723                         goto cancel;
724                 }
725                 status = dbwrap_delete_bystring(regdb, path);
726                 /* Don't fail if the subkey record was not found. */
727                 if (!NT_STATUS_IS_OK(status) &&
728                     !NT_STATUS_EQUAL(status, NT_STATUS_NOT_FOUND))
729                 {
730                         DEBUG(1, ("Deleting %s failed: %s\n", path,
731                                   nt_errstr(status)));
732                         goto cancel;
733                 }
734                 TALLOC_FREE(path);
735         }
736
737         TALLOC_FREE(old_subkeys);
738
739         /* (2) store the subkey list for the parent */
740
741         if (!regdb_store_keys_internal(key, ctr) ) {
742                 DEBUG(0,("regdb_store_keys: Failed to store new subkey list "
743                          "for parent [%s]\n", key));
744                 goto cancel;
745         }
746
747         /* (3) now create records for any subkeys that don't already exist */
748
749         num_subkeys = regsubkey_ctr_numkeys(ctr);
750
751         if (num_subkeys == 0) {
752                 if (!(subkeys = TALLOC_ZERO_P(ctx, REGSUBKEY_CTR)) ) {
753                         DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
754                         goto cancel;
755                 }
756
757                 if (!regdb_store_keys_internal(key, subkeys)) {
758                         DEBUG(0,("regdb_store_keys: Failed to store "
759                                  "new record for key [%s]\n", key));
760                         goto cancel;
761                 }
762                 TALLOC_FREE(subkeys);
763
764         }
765
766         for (i=0; i<num_subkeys; i++) {
767                 path = talloc_asprintf(ctx, "%s/%s",
768                                         key,
769                                         regsubkey_ctr_specific_key(ctr, i));
770                 if (!path) {
771                         goto cancel;
772                 }
773                 if (!(subkeys = TALLOC_ZERO_P(ctx, REGSUBKEY_CTR)) ) {
774                         DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
775                         goto cancel;
776                 }
777
778                 if (regdb_fetch_keys( path, subkeys ) == -1) {
779                         /* create a record with 0 subkeys */
780                         if (!regdb_store_keys_internal(path, subkeys)) {
781                                 DEBUG(0,("regdb_store_keys: Failed to store "
782                                          "new record for key [%s]\n", path));
783                                 goto cancel;
784                         }
785                 }
786
787                 TALLOC_FREE(subkeys);
788                 TALLOC_FREE(path);
789         }
790
791         if (regdb->transaction_commit(regdb) != 0) {
792                 DEBUG(0, ("regdb_store_keys: Could not commit transaction\n"));
793                 goto fail;
794         }
795
796         TALLOC_FREE(ctx);
797         return true;
798
799 cancel:
800         if (regdb->transaction_cancel(regdb) != 0) {
801                 smb_panic("regdb_store_keys: transaction_cancel failed\n");
802         }
803
804 fail:
805         TALLOC_FREE(ctx);
806
807         return false;
808 }
809
810
811 static TDB_DATA regdb_fetch_key_internal(TALLOC_CTX *mem_ctx, const char *key)
812 {
813         char *path = NULL;
814         TDB_DATA data;
815
816         path = normalize_reg_path(mem_ctx, key);
817         if (!path) {
818                 return make_tdb_data(NULL, 0);
819         }
820
821         data = dbwrap_fetch_bystring(regdb, mem_ctx, path);
822
823         TALLOC_FREE(path);
824         return data;
825 }
826
827
828 /**
829  * check whether a given key name represents a base key,
830  * i.e one without a subkey separator ('/' or '\').
831  */
832 static bool regdb_key_is_base_key(const char *key)
833 {
834         TALLOC_CTX *mem_ctx = talloc_stackframe();
835         bool ret = false;
836         char *path;
837
838         if (key == NULL) {
839                 goto done;
840         }
841
842         path = normalize_reg_path(mem_ctx, key);
843         if (path == NULL) {
844                 DEBUG(0, ("out of memory! (talloc failed)\n"));
845                 goto done;
846         }
847
848         if (*path == '\0') {
849                 goto done;
850         }
851
852         ret = (strrchr(path, '/') == NULL);
853
854 done:
855         TALLOC_FREE(mem_ctx);
856         return ret;
857 }
858
859
860 /**
861  * Check for the existence of a key.
862  *
863  * Existence of a key is authoritatively defined by its
864  * existence in the list of subkeys of its parent key.
865  * The exeption of this are keys without a parent key,
866  * i.e. the "base" keys (HKLM, HKCU, ...).
867  */
868 static bool regdb_key_exists(const char *key)
869 {
870         TALLOC_CTX *mem_ctx = talloc_stackframe();
871         TDB_DATA value;
872         bool ret = false;
873         char *path, *p;
874
875         if (key == NULL) {
876                 goto done;
877         }
878
879         path = normalize_reg_path(mem_ctx, key);
880         if (path == NULL) {
881                 DEBUG(0, ("out of memory! (talloc failed)\n"));
882                 goto done;
883         }
884
885         if (*path == '\0') {
886                 goto done;
887         }
888
889         p = strrchr(path, '/');
890         if (p == NULL) {
891                 /* this is a base key */
892                 value = regdb_fetch_key_internal(mem_ctx, path);
893                 ret = (value.dptr != NULL);
894         } else {
895                 /* get the list of subkeys of the parent key */
896                 uint32 num_items, len, i;
897                 fstring subkeyname;
898
899                 *p = '\0';
900                 p++;
901                 value = regdb_fetch_key_internal(mem_ctx, path);
902                 if (value.dptr == NULL) {
903                         goto done;
904                 }
905
906                 len = tdb_unpack(value.dptr, value.dsize, "d", &num_items);
907                 for (i = 0; i < num_items; i++) {
908                         len += tdb_unpack(value.dptr +len, value.dsize -len,
909                                           "f", &subkeyname);
910                         if (strequal(subkeyname, p)) {
911                                 ret = true;
912                                 goto done;
913                         }
914                 }
915         }
916
917 done:
918         TALLOC_FREE(mem_ctx);
919         return ret;
920 }
921
922
923 /***********************************************************************
924  Retrieve an array of strings containing subkeys.  Memory should be
925  released by the caller.
926  ***********************************************************************/
927
928 int regdb_fetch_keys(const char *key, REGSUBKEY_CTR *ctr)
929 {
930         WERROR werr;
931         uint32 num_items;
932         uint8 *buf;
933         uint32 buflen, len;
934         int i;
935         fstring subkeyname;
936         int ret = -1;
937         TALLOC_CTX *frame = talloc_stackframe();
938         TDB_DATA value;
939
940         DEBUG(11,("regdb_fetch_keys: Enter key => [%s]\n", key ? key : "NULL"));
941
942         if (!regdb_key_exists(key)) {
943                 goto done;
944         }
945
946         ctr->seqnum = regdb_get_seqnum();
947
948         value = regdb_fetch_key_internal(frame, key);
949
950         if (value.dptr == NULL) {
951                 DEBUG(10, ("regdb_fetch_keys: no subkeys found for key [%s]\n",
952                            key));
953                 ret = 0;
954                 goto done;
955         }
956
957         buf = value.dptr;
958         buflen = value.dsize;
959         len = tdb_unpack( buf, buflen, "d", &num_items);
960
961         for (i=0; i<num_items; i++) {
962                 len += tdb_unpack(buf+len, buflen-len, "f", subkeyname);
963                 werr = regsubkey_ctr_addkey(ctr, subkeyname);
964                 if (!W_ERROR_IS_OK(werr)) {
965                         DEBUG(5, ("regdb_fetch_keys: regsubkey_ctr_addkey "
966                                   "failed: %s\n", dos_errstr(werr)));
967                         goto done;
968                 }
969         }
970
971         DEBUG(11,("regdb_fetch_keys: Exit [%d] items\n", num_items));
972
973         ret = num_items;
974 done:
975         TALLOC_FREE(frame);
976         return ret;
977 }
978
979 /****************************************************************************
980  Unpack a list of registry values frem the TDB
981  ***************************************************************************/
982
983 static int regdb_unpack_values(REGVAL_CTR *values, uint8 *buf, int buflen)
984 {
985         int             len = 0;
986         uint32          type;
987         fstring valuename;
988         uint32          size;
989         uint8           *data_p;
990         uint32          num_values = 0;
991         int             i;
992
993         /* loop and unpack the rest of the registry values */
994
995         len += tdb_unpack(buf+len, buflen-len, "d", &num_values);
996
997         for ( i=0; i<num_values; i++ ) {
998                 /* unpack the next regval */
999
1000                 type = REG_NONE;
1001                 size = 0;
1002                 data_p = NULL;
1003                 valuename[0] = '\0';
1004                 len += tdb_unpack(buf+len, buflen-len, "fdB",
1005                                   valuename,
1006                                   &type,
1007                                   &size,
1008                                   &data_p);
1009
1010                 /* add the new value. Paranoid protective code -- make sure data_p is valid */
1011
1012                 if (*valuename && size && data_p) {
1013                         regval_ctr_addvalue(values, valuename, type,
1014                                         (const char *)data_p, size);
1015                 }
1016                 SAFE_FREE(data_p); /* 'B' option to tdb_unpack does a malloc() */
1017
1018                 DEBUG(8,("specific: [%s], len: %d\n", valuename, size));
1019         }
1020
1021         return len;
1022 }
1023
1024 /****************************************************************************
1025  Pack all values in all printer keys
1026  ***************************************************************************/
1027
1028 static int regdb_pack_values(REGVAL_CTR *values, uint8 *buf, int buflen)
1029 {
1030         int             len = 0;
1031         int             i;
1032         REGISTRY_VALUE  *val;
1033         int             num_values;
1034
1035         if ( !values )
1036                 return 0;
1037
1038         num_values = regval_ctr_numvals( values );
1039
1040         /* pack the number of values first */
1041
1042         len += tdb_pack( buf+len, buflen-len, "d", num_values );
1043
1044         /* loop over all values */
1045
1046         for ( i=0; i<num_values; i++ ) {
1047                 val = regval_ctr_specific_value( values, i );
1048                 len += tdb_pack(buf+len, buflen-len, "fdB",
1049                                 regval_name(val),
1050                                 regval_type(val),
1051                                 regval_size(val),
1052                                 regval_data_p(val) );
1053         }
1054
1055         return len;
1056 }
1057
1058 /***********************************************************************
1059  Retrieve an array of strings containing subkeys.  Memory should be
1060  released by the caller.
1061  ***********************************************************************/
1062
1063 int regdb_fetch_values( const char* key, REGVAL_CTR *values )
1064 {
1065         char *keystr = NULL;
1066         TALLOC_CTX *ctx = talloc_stackframe();
1067         int ret = 0;
1068         TDB_DATA value;
1069
1070         DEBUG(10,("regdb_fetch_values: Looking for value of key [%s] \n", key));
1071
1072         if (!regdb_key_exists(key)) {
1073                 goto done;
1074         }
1075
1076         keystr = talloc_asprintf(ctx, "%s/%s", REG_VALUE_PREFIX, key);
1077         if (!keystr) {
1078                 goto done;
1079         }
1080
1081         values->seqnum = regdb_get_seqnum();
1082
1083         value = regdb_fetch_key_internal(ctx, keystr);
1084
1085         if (!value.dptr) {
1086                 /* all keys have zero values by default */
1087                 goto done;
1088         }
1089
1090         regdb_unpack_values(values, value.dptr, value.dsize);
1091         ret = regval_ctr_numvals(values);
1092
1093 done:
1094         TALLOC_FREE(ctx);
1095         return ret;
1096 }
1097
1098 bool regdb_store_values( const char *key, REGVAL_CTR *values )
1099 {
1100         TDB_DATA old_data, data;
1101         char *keystr = NULL;
1102         TALLOC_CTX *ctx = talloc_stackframe();
1103         int len;
1104         NTSTATUS status;
1105         bool result = false;
1106
1107         DEBUG(10,("regdb_store_values: Looking for value of key [%s] \n", key));
1108
1109         if (!regdb_key_exists(key)) {
1110                 goto done;
1111         }
1112
1113         ZERO_STRUCT(data);
1114
1115         len = regdb_pack_values(values, data.dptr, data.dsize);
1116         if (len <= 0) {
1117                 DEBUG(0,("regdb_store_values: unable to pack values. len <= 0\n"));
1118                 goto done;
1119         }
1120
1121         data.dptr = TALLOC_ARRAY(ctx, uint8, len);
1122         data.dsize = len;
1123
1124         len = regdb_pack_values(values, data.dptr, data.dsize);
1125
1126         SMB_ASSERT( len == data.dsize );
1127
1128         keystr = talloc_asprintf(ctx, "%s/%s", REG_VALUE_PREFIX, key );
1129         if (!keystr) {
1130                 goto done;
1131         }
1132         keystr = normalize_reg_path(ctx, keystr);
1133         if (!keystr) {
1134                 goto done;
1135         }
1136
1137         old_data = dbwrap_fetch_bystring(regdb, ctx, keystr);
1138
1139         if ((old_data.dptr != NULL)
1140             && (old_data.dsize == data.dsize)
1141             && (memcmp(old_data.dptr, data.dptr, data.dsize) == 0))
1142         {
1143                 result = true;
1144                 goto done;
1145         }
1146
1147         status = dbwrap_trans_store(regdb, string_term_tdb_data(keystr), data,
1148                                     TDB_REPLACE);
1149
1150         result = NT_STATUS_IS_OK(status);
1151
1152 done:
1153         TALLOC_FREE(ctx);
1154         return result;
1155 }
1156
1157 static WERROR regdb_get_secdesc(TALLOC_CTX *mem_ctx, const char *key,
1158                                 struct security_descriptor **psecdesc)
1159 {
1160         char *tdbkey;
1161         TDB_DATA data;
1162         NTSTATUS status;
1163         TALLOC_CTX *tmp_ctx = talloc_stackframe();
1164         WERROR err = WERR_OK;
1165
1166         DEBUG(10, ("regdb_get_secdesc: Getting secdesc of key [%s]\n", key));
1167
1168         if (!regdb_key_exists(key)) {
1169                 err = WERR_BADFILE;
1170                 goto done;
1171         }
1172
1173         tdbkey = talloc_asprintf(tmp_ctx, "%s/%s", REG_SECDESC_PREFIX, key);
1174         if (tdbkey == NULL) {
1175                 err = WERR_NOMEM;
1176                 goto done;
1177         }
1178         normalize_dbkey(tdbkey);
1179
1180         data = dbwrap_fetch_bystring(regdb, tmp_ctx, tdbkey);
1181         if (data.dptr == NULL) {
1182                 err = WERR_BADFILE;
1183                 goto done;
1184         }
1185
1186         status = unmarshall_sec_desc(mem_ctx, (uint8 *)data.dptr, data.dsize,
1187                                      psecdesc);
1188
1189         if (NT_STATUS_EQUAL(status, NT_STATUS_NO_MEMORY)) {
1190                 err = WERR_NOMEM;
1191         } else if (!NT_STATUS_IS_OK(status)) {
1192                 err = WERR_REG_CORRUPT;
1193         }
1194
1195 done:
1196         TALLOC_FREE(tmp_ctx);
1197         return err;
1198 }
1199
1200 static WERROR regdb_set_secdesc(const char *key,
1201                                 struct security_descriptor *secdesc)
1202 {
1203         TALLOC_CTX *mem_ctx = talloc_stackframe();
1204         char *tdbkey;
1205         NTSTATUS status;
1206         WERROR err = WERR_NOMEM;
1207         TDB_DATA tdbdata;
1208
1209         if (!regdb_key_exists(key)) {
1210                 err = WERR_BADFILE;
1211                 goto done;
1212         }
1213
1214         tdbkey = talloc_asprintf(mem_ctx, "%s/%s", REG_SECDESC_PREFIX, key);
1215         if (tdbkey == NULL) {
1216                 goto done;
1217         }
1218         normalize_dbkey(tdbkey);
1219
1220         if (secdesc == NULL) {
1221                 /* assuming a delete */
1222                 status = dbwrap_trans_delete(regdb,
1223                                              string_term_tdb_data(tdbkey));
1224                 if (NT_STATUS_IS_OK(status)) {
1225                         err = WERR_OK;
1226                 } else {
1227                         err = ntstatus_to_werror(status);
1228                 }
1229                 goto done;
1230         }
1231
1232         err = ntstatus_to_werror(marshall_sec_desc(mem_ctx, secdesc,
1233                                                    &tdbdata.dptr,
1234                                                    &tdbdata.dsize));
1235         if (!W_ERROR_IS_OK(err)) {
1236                 goto done;
1237         }
1238
1239         status = dbwrap_trans_store(regdb, string_term_tdb_data(tdbkey),
1240                                     tdbdata, 0);
1241         if (!NT_STATUS_IS_OK(status)) {
1242                 err = ntstatus_to_werror(status);
1243                 goto done;
1244         }
1245
1246  done:
1247         TALLOC_FREE(mem_ctx);
1248         return err;
1249 }
1250
1251 bool regdb_subkeys_need_update(REGSUBKEY_CTR *subkeys)
1252 {
1253         return (regdb_get_seqnum() != subkeys->seqnum);
1254 }
1255
1256 bool regdb_values_need_update(REGVAL_CTR *values)
1257 {
1258         return (regdb_get_seqnum() != values->seqnum);
1259 }
1260
1261 /* 
1262  * Table of function pointers for default access
1263  */
1264  
1265 REGISTRY_OPS regdb_ops = {
1266         .fetch_subkeys = regdb_fetch_keys,
1267         .fetch_values = regdb_fetch_values,
1268         .store_subkeys = regdb_store_keys,
1269         .store_values = regdb_store_values,
1270         .get_secdesc = regdb_get_secdesc,
1271         .set_secdesc = regdb_set_secdesc,
1272         .subkeys_need_update = regdb_subkeys_need_update,
1273         .values_need_update = regdb_values_need_update
1274 };