2
* Unix SMB/CIFS implementation.
3
* Virtual Windows Registry Layer
4
* Copyright (C) Gerald Carter 2002-2005
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.
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.
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/>.
20
/* Implementation of internal registry database functions. */
25
#define DBGC_CLASS DBGC_REGISTRY
27
static struct db_context *regdb = NULL;
28
static int regdb_refcount;
30
static bool regdb_key_exists(const char *key);
31
static bool regdb_key_is_base_key(const char *key);
33
/* List the deepest path into the registry. All part components will be created.*/
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 */
43
static const char *builtin_registry_paths[] = {
53
KEY_SAMBA_GROUP_POLICY,
54
KEY_GP_MACHINE_POLICY,
55
KEY_GP_MACHINE_WIN_POLICY,
58
KEY_GP_USER_WIN_POLICY,
59
KEY_WINLOGON_GPEXT_PATH,
60
"HKLM\\SYSTEM\\CurrentControlSet\\Control\\Print\\Monitors",
62
"HKLM\\SYSTEM\\CurrentControlSet\\Control\\Terminal Server\\DefaultUserConfiguration",
71
struct builtin_regkey_value {
73
const char *valuename;
81
static struct builtin_regkey_value builtin_registry_values[] = {
83
SAMBA_PRINTER_PORT_NAME, REG_SZ, { "" } },
85
"DefaultSpoolDirectory", REG_SZ, { "C:\\Windows\\System32\\Spool\\Printers" } },
87
"DisplayName", REG_SZ, { "Event Log" } },
89
"ErrorControl", REG_DWORD, { (char*)0x00000001 } },
90
{ NULL, NULL, 0, { NULL } }
94
* Initialize a key in the registry:
95
* create each component key of the specified path.
97
static WERROR init_registry_key_internal(const char *add_path)
100
TALLOC_CTX *frame = talloc_stackframe();
103
char *remaining = NULL;
106
struct regsubkey_ctr *subkeys;
109
DEBUG(6, ("init_registry_key: Adding [%s]\n", add_path));
111
path = talloc_strdup(frame, add_path);
112
base = talloc_strdup(frame, "");
113
if (!path || !base) {
119
while (next_token_talloc(frame, &p, &keyname, "\\")) {
121
/* build up the registry path from the components */
124
base = talloc_asprintf(frame, "%s\\", base);
130
base = talloc_asprintf_append(base, "%s", keyname);
136
/* get the immediate subkeyname (if we have one ) */
138
subkeyname = talloc_strdup(frame, "");
144
remaining = talloc_strdup(frame, p);
151
if (!next_token_talloc(frame, &p2,
154
subkeyname = talloc_strdup(frame,p2);
162
DEBUG(10,("init_registry_key: Storing key [%s] with "
163
"subkey [%s]\n", base,
164
*subkeyname ? subkeyname : "NULL"));
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 */
170
werr = regsubkey_ctr_init(frame, &subkeys);
171
if (!W_ERROR_IS_OK(werr)) {
172
DEBUG(0,("talloc() failure!\n"));
176
regdb_fetch_keys(base, subkeys);
178
werr = regsubkey_ctr_addkey(subkeys, subkeyname);
179
if (!W_ERROR_IS_OK(werr)) {
183
if (!regdb_store_keys( base, subkeys)) {
184
werr = WERR_CAN_NOT_COMPLETE;
197
* Initialize a key in the registry:
198
* create each component key of the specified path,
199
* wrapped in one db transaction.
201
WERROR init_registry_key(const char *add_path)
205
if (regdb_key_exists(add_path)) {
209
if (regdb->transaction_start(regdb) != 0) {
210
DEBUG(0, ("init_registry_key: transaction_start failed\n"));
211
return WERR_REG_IO_FAILURE;
214
werr = init_registry_key_internal(add_path);
215
if (!W_ERROR_IS_OK(werr)) {
219
if (regdb->transaction_commit(regdb) != 0) {
220
DEBUG(0, ("init_registry_key: Could not commit transaction\n"));
221
return WERR_REG_IO_FAILURE;
227
if (regdb->transaction_cancel(regdb) != 0) {
228
smb_panic("init_registry_key: transaction_cancel failed\n");
234
/***********************************************************************
235
Open the registry data in the tdb
236
***********************************************************************/
238
WERROR init_registry_data(void)
241
TALLOC_CTX *frame = talloc_stackframe();
247
* First, check for the existence of the needed keys and values.
248
* If all do already exist, we can save the writes.
250
for (i=0; builtin_registry_paths[i] != NULL; i++) {
251
if (!regdb_key_exists(builtin_registry_paths[i])) {
256
for (i=0; builtin_registry_values[i].path != NULL; i++) {
257
values = TALLOC_ZERO_P(frame, REGVAL_CTR);
258
if (values == NULL) {
263
regdb_fetch_values(builtin_registry_values[i].path, values);
264
if (!regval_ctr_key_exists(values,
265
builtin_registry_values[i].valuename))
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.
287
if (regdb->transaction_start(regdb) != 0) {
288
DEBUG(0, ("init_registry_data: tdb_transaction_start "
290
werr = WERR_REG_IO_FAILURE;
294
/* loop over all of the predefined paths and add each component */
296
for (i=0; builtin_registry_paths[i] != NULL; i++) {
297
if (regdb_key_exists(builtin_registry_paths[i])) {
300
werr = init_registry_key_internal(builtin_registry_paths[i]);
301
if (!W_ERROR_IS_OK(werr)) {
306
/* loop over all of the predefined values and add each component */
308
for (i=0; builtin_registry_values[i].path != NULL; i++) {
310
values = TALLOC_ZERO_P(frame, REGVAL_CTR);
311
if (values == NULL) {
316
regdb_fetch_values(builtin_registry_values[i].path, values);
318
/* preserve existing values across restarts. Only add new ones */
320
if (!regval_ctr_key_exists(values,
321
builtin_registry_values[i].valuename))
323
switch(builtin_registry_values[i].type) {
325
regval_ctr_addvalue(values,
326
builtin_registry_values[i].valuename,
328
(char*)&builtin_registry_values[i].data.dw_value,
334
builtin_registry_values[i].data.string,
336
regval_ctr_addvalue(values,
337
builtin_registry_values[i].valuename,
340
data.uni_str_len*sizeof(uint16));
344
DEBUG(0, ("init_registry_data: invalid value "
345
"type in builtin_registry_values "
347
builtin_registry_values[i].type));
349
regdb_store_values(builtin_registry_values[i].path,
355
if (regdb->transaction_commit(regdb) != 0) {
356
DEBUG(0, ("init_registry_data: Could not commit "
358
werr = WERR_REG_IO_FAILURE;
366
if (regdb->transaction_cancel(regdb) != 0) {
367
smb_panic("init_registry_data: tdb_transaction_cancel "
376
/***********************************************************************
377
Open the registry database
378
***********************************************************************/
380
WERROR regdb_init(void)
382
const char *vstring = "INFO/version";
387
DEBUG(10, ("regdb_init: incrementing refcount (%d)\n",
393
regdb = db_open(NULL, state_path("registry.tdb"), 0,
394
REG_TDB_FLAGS, O_RDWR, 0600);
396
regdb = db_open(NULL, state_path("registry.tdb"), 0,
397
REG_TDB_FLAGS, O_RDWR|O_CREAT, 0600);
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) ));
405
DEBUG(10,("regdb_init: Successfully created registry tdb\n"));
410
vers_id = dbwrap_fetch_int32(regdb, vstring);
412
if ( vers_id != REGVER_V1 ) {
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);
423
DEBUG(10, ("regdb_init: stored %s = %d\n",
424
vstring, REGVER_V1));
431
/***********************************************************************
432
Open the registry. Must already have been initialized by regdb_init()
433
***********************************************************************/
435
WERROR regdb_open( void )
437
WERROR result = WERR_OK;
440
DEBUG(10,("regdb_open: incrementing refcount (%d)\n", regdb_refcount));
447
regdb = db_open(NULL, state_path("registry.tdb"), 0,
448
REG_TDB_FLAGS, O_RDWR, 0600);
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) ));
458
DEBUG(10,("regdb_open: refcount reset (%d)\n", regdb_refcount));
463
/***********************************************************************
464
***********************************************************************/
466
int regdb_close( void )
468
if (regdb_refcount == 0) {
474
DEBUG(10,("regdb_close: decrementing refcount (%d)\n", regdb_refcount));
476
if ( regdb_refcount > 0 )
479
SMB_ASSERT( regdb_refcount >= 0 );
485
WERROR regdb_transaction_start(void)
487
return (regdb->transaction_start(regdb) == 0) ?
488
WERR_OK : WERR_REG_IO_FAILURE;
491
WERROR regdb_transaction_commit(void)
493
return (regdb->transaction_commit(regdb) == 0) ?
494
WERR_OK : WERR_REG_IO_FAILURE;
497
WERROR regdb_transaction_cancel(void)
499
return (regdb->transaction_cancel(regdb) == 0) ?
500
WERR_OK : WERR_REG_IO_FAILURE;
503
/***********************************************************************
504
return the tdb sequence number of the registry tdb.
505
this is an indicator for the content of the registry
506
having changed. it will change upon regdb_init, too, though.
507
***********************************************************************/
508
int regdb_get_seqnum(void)
510
return regdb->get_seqnum(regdb);
514
static WERROR regdb_delete_key_with_prefix(const char *keyname,
518
WERROR werr = WERR_NOMEM;
519
TALLOC_CTX *mem_ctx = talloc_stackframe();
521
if (keyname == NULL) {
522
werr = WERR_INVALID_PARAM;
526
if (prefix == NULL) {
527
path = discard_const_p(char, keyname);
529
path = talloc_asprintf(mem_ctx, "%s/%s", prefix, keyname);
535
path = normalize_reg_path(mem_ctx, path);
540
werr = ntstatus_to_werror(dbwrap_delete_bystring(regdb, path));
542
/* treat "not" found" as ok */
543
if (W_ERROR_EQUAL(werr, WERR_NOT_FOUND)) {
548
talloc_free(mem_ctx);
553
static WERROR regdb_delete_values(const char *keyname)
555
return regdb_delete_key_with_prefix(keyname, REG_VALUE_PREFIX);
558
static WERROR regdb_delete_secdesc(const char *keyname)
560
return regdb_delete_key_with_prefix(keyname, REG_SECDESC_PREFIX);
563
static WERROR regdb_delete_subkeylist(const char *keyname)
565
return regdb_delete_key_with_prefix(keyname, NULL);
568
static WERROR regdb_delete_key_lists(const char *keyname)
572
werr = regdb_delete_values(keyname);
573
if (!W_ERROR_IS_OK(werr)) {
574
DEBUG(1, (__location__ " Deleting %s/%s failed: %s\n",
575
REG_VALUE_PREFIX, keyname, win_errstr(werr)));
579
werr = regdb_delete_secdesc(keyname);
580
if (!W_ERROR_IS_OK(werr)) {
581
DEBUG(1, (__location__ " Deleting %s/%s failed: %s\n",
582
REG_SECDESC_PREFIX, keyname, win_errstr(werr)));
586
werr = regdb_delete_subkeylist(keyname);
587
if (!W_ERROR_IS_OK(werr)) {
588
DEBUG(1, (__location__ " Deleting %s failed: %s\n",
589
keyname, win_errstr(werr)));
597
/***********************************************************************
598
Add subkey strings to the registry tdb under a defined key
599
fmt is the same format as tdb_pack except this function only supports
601
***********************************************************************/
603
static bool regdb_store_keys_internal(const char *key, struct regsubkey_ctr *ctr)
606
uint8 *buffer = NULL;
610
uint32 num_subkeys = regsubkey_ctr_numkeys(ctr);
611
char *keyname = NULL;
612
TALLOC_CTX *ctx = talloc_stackframe();
619
keyname = talloc_strdup(ctx, key);
623
keyname = normalize_reg_path(ctx, keyname);
625
/* allocate some initial memory */
627
buffer = (uint8 *)SMB_MALLOC(1024);
628
if (buffer == NULL) {
634
/* store the number of subkeys */
636
len += tdb_pack(buffer+len, buflen-len, "d", num_subkeys);
638
/* pack all the strings */
640
for (i=0; i<num_subkeys; i++) {
643
thistime = tdb_pack(buffer+len, buflen-len, "f",
644
regsubkey_ctr_specific_key(ctr, i));
645
if (len+thistime > buflen) {
648
* tdb_pack hasn't done anything because of the short
649
* buffer, allocate extra space.
651
buffer = SMB_REALLOC_ARRAY(buffer, uint8_t,
654
DEBUG(0, ("regdb_store_keys: Failed to realloc "
655
"memory of size [%u]\n",
656
(unsigned int)(len+thistime)*2));
660
buflen = (len+thistime)*2;
661
thistime2 = tdb_pack(
662
buffer+len, buflen-len, "f",
663
regsubkey_ctr_specific_key(ctr, i));
664
if (thistime2 != thistime) {
665
DEBUG(0, ("tdb_pack failed\n"));
673
/* finally write out the data */
677
status = dbwrap_store_bystring(regdb, keyname, dbuf, TDB_REPLACE);
678
if (!NT_STATUS_IS_OK(status)) {
684
* Delete a sorted subkey cache for regdb_key_exists, will be
685
* recreated automatically
687
keyname = talloc_asprintf(ctx, "%s/%s", REG_SORTED_SUBKEYS_PREFIX,
689
if (keyname != NULL) {
690
dbwrap_delete_bystring(regdb, keyname);
699
/***********************************************************************
700
Store the new subkey record and create any child key records that
701
do not currently exist
702
***********************************************************************/
704
bool regdb_store_keys(const char *key, struct regsubkey_ctr *ctr)
706
int num_subkeys, old_num_subkeys, i;
708
struct regsubkey_ctr *subkeys = NULL, *old_subkeys = NULL;
709
char *oldkeyname = NULL;
710
TALLOC_CTX *ctx = talloc_stackframe();
713
if (!regdb_key_is_base_key(key) && !regdb_key_exists(key)) {
718
* fetch a list of the old subkeys so we can determine if anything has
722
werr = regsubkey_ctr_init(ctx, &old_subkeys);
723
if (!W_ERROR_IS_OK(werr)) {
724
DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
728
regdb_fetch_keys(key, old_subkeys);
730
num_subkeys = regsubkey_ctr_numkeys(ctr);
731
old_num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
732
if ((num_subkeys && old_num_subkeys) &&
733
(num_subkeys == old_num_subkeys)) {
735
for (i = 0; i < num_subkeys; i++) {
736
if (strcmp(regsubkey_ctr_specific_key(ctr, i),
737
regsubkey_ctr_specific_key(old_subkeys, i))
743
if (i == num_subkeys) {
745
* Nothing changed, no point to even start a tdb
748
TALLOC_FREE(old_subkeys);
753
TALLOC_FREE(old_subkeys);
755
if (regdb->transaction_start(regdb) != 0) {
756
DEBUG(0, ("regdb_store_keys: transaction_start failed\n"));
761
* Re-fetch the old keys inside the transaction
764
werr = regsubkey_ctr_init(ctx, &old_subkeys);
765
if (!W_ERROR_IS_OK(werr)) {
766
DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
770
regdb_fetch_keys(key, old_subkeys);
773
* Make the store operation as safe as possible without transactions:
775
* (1) For each subkey removed from ctr compared with old_subkeys:
777
* (a) First delete the value db entry.
779
* (b) Next delete the secdesc db record.
781
* (c) Then delete the subkey list entry.
783
* (2) Now write the list of subkeys of the parent key,
784
* deleting removed entries and adding new ones.
786
* (3) Finally create the subkey list entries for the added keys.
788
* This way if we crash half-way in between deleting the subkeys
789
* and storing the parent's list of subkeys, no old data can pop up
790
* out of the blue when re-adding keys later on.
793
/* (1) delete removed keys' lists (values/secdesc/subkeys) */
795
num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
796
for (i=0; i<num_subkeys; i++) {
797
oldkeyname = regsubkey_ctr_specific_key(old_subkeys, i);
799
if (regsubkey_ctr_key_exists(ctr, oldkeyname)) {
801
* It's still around, don't delete
807
path = talloc_asprintf(ctx, "%s/%s", key, oldkeyname);
812
werr = regdb_delete_key_lists(path);
813
W_ERROR_NOT_OK_GOTO(werr, cancel);
818
TALLOC_FREE(old_subkeys);
820
/* (2) store the subkey list for the parent */
822
if (!regdb_store_keys_internal(key, ctr) ) {
823
DEBUG(0,("regdb_store_keys: Failed to store new subkey list "
824
"for parent [%s]\n", key));
828
/* (3) now create records for any subkeys that don't already exist */
830
num_subkeys = regsubkey_ctr_numkeys(ctr);
832
if (num_subkeys == 0) {
833
werr = regsubkey_ctr_init(ctx, &subkeys);
834
if (!W_ERROR_IS_OK(werr)) {
835
DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
839
if (!regdb_store_keys_internal(key, subkeys)) {
840
DEBUG(0,("regdb_store_keys: Failed to store "
841
"new record for key [%s]\n", key));
844
TALLOC_FREE(subkeys);
848
for (i=0; i<num_subkeys; i++) {
849
path = talloc_asprintf(ctx, "%s/%s",
851
regsubkey_ctr_specific_key(ctr, i));
855
werr = regsubkey_ctr_init(ctx, &subkeys);
856
if (!W_ERROR_IS_OK(werr)) {
857
DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
861
if (regdb_fetch_keys( path, subkeys ) == -1) {
862
/* create a record with 0 subkeys */
863
if (!regdb_store_keys_internal(path, subkeys)) {
864
DEBUG(0,("regdb_store_keys: Failed to store "
865
"new record for key [%s]\n", path));
870
TALLOC_FREE(subkeys);
874
if (regdb->transaction_commit(regdb) != 0) {
875
DEBUG(0, ("regdb_store_keys: Could not commit transaction\n"));
883
if (regdb->transaction_cancel(regdb) != 0) {
884
smb_panic("regdb_store_keys: transaction_cancel failed\n");
893
static WERROR regdb_create_subkey(const char *key, const char *subkey)
896
struct regsubkey_ctr *subkeys;
897
TALLOC_CTX *mem_ctx = talloc_stackframe();
899
if (!regdb_key_is_base_key(key) && !regdb_key_exists(key)) {
900
werr = WERR_NOT_FOUND;
904
werr = regsubkey_ctr_init(mem_ctx, &subkeys);
905
W_ERROR_NOT_OK_GOTO_DONE(werr);
907
if (regdb_fetch_keys(key, subkeys) < 0) {
908
werr = WERR_REG_IO_FAILURE;
912
if (regsubkey_ctr_key_exists(subkeys, subkey)) {
917
talloc_free(subkeys);
919
werr = regdb_transaction_start();
920
W_ERROR_NOT_OK_GOTO_DONE(werr);
922
werr = regsubkey_ctr_init(mem_ctx, &subkeys);
923
W_ERROR_NOT_OK_GOTO(werr, cancel);
925
if (regdb_fetch_keys(key, subkeys) < 0) {
926
werr = WERR_REG_IO_FAILURE;
930
werr = regsubkey_ctr_addkey(subkeys, subkey);
931
W_ERROR_NOT_OK_GOTO(werr, cancel);
933
if (!regdb_store_keys_internal(key, subkeys)) {
934
DEBUG(0, (__location__ " failed to store new subkey list for "
935
"parent key %s\n", key));
936
werr = WERR_REG_IO_FAILURE;
940
werr = regdb_transaction_commit();
941
if (!W_ERROR_IS_OK(werr)) {
942
DEBUG(0, (__location__ " failed to commit transaction: %s\n",
949
werr = regdb_transaction_cancel();
950
if (!W_ERROR_IS_OK(werr)) {
951
DEBUG(0, (__location__ " failed to cancel transaction: %s\n",
956
talloc_free(mem_ctx);
960
static WERROR regdb_delete_subkey(const char *key, const char *subkey)
963
struct regsubkey_ctr *subkeys;
965
TALLOC_CTX *mem_ctx = talloc_stackframe();
967
if (!regdb_key_is_base_key(key) && !regdb_key_exists(key)) {
968
werr = WERR_NOT_FOUND;
972
path = talloc_asprintf(mem_ctx, "%s/%s", key, subkey);
978
if (!regdb_key_exists(path)) {
983
werr = regdb_transaction_start();
984
W_ERROR_NOT_OK_GOTO_DONE(werr);
986
werr = regdb_delete_key_lists(path);
987
W_ERROR_NOT_OK_GOTO(werr, cancel);
989
werr = regsubkey_ctr_init(mem_ctx, &subkeys);
990
W_ERROR_NOT_OK_GOTO(werr, cancel);
992
if (regdb_fetch_keys(key, subkeys) < 0) {
993
werr = WERR_REG_IO_FAILURE;
997
werr = regsubkey_ctr_delkey(subkeys, subkey);
998
W_ERROR_NOT_OK_GOTO(werr, cancel);
1000
if (!regdb_store_keys_internal(key, subkeys)) {
1001
DEBUG(0, (__location__ " failed to store new subkey_list for "
1002
"parent key %s\n", key));
1003
werr = WERR_REG_IO_FAILURE;
1007
werr = regdb_transaction_commit();
1008
if (!W_ERROR_IS_OK(werr)) {
1009
DEBUG(0, (__location__ " failed to commit transaction: %s\n",
1016
werr2 = regdb_transaction_cancel();
1017
if (!W_ERROR_IS_OK(werr2)) {
1018
DEBUG(0, (__location__ " failed to cancel transaction: %s\n",
1019
win_errstr(werr2)));
1023
talloc_free(mem_ctx);
1027
static TDB_DATA regdb_fetch_key_internal(TALLOC_CTX *mem_ctx, const char *key)
1032
path = normalize_reg_path(mem_ctx, key);
1034
return make_tdb_data(NULL, 0);
1037
data = dbwrap_fetch_bystring(regdb, mem_ctx, path);
1045
* check whether a given key name represents a base key,
1046
* i.e one without a subkey separator ('/' or '\').
1048
static bool regdb_key_is_base_key(const char *key)
1050
TALLOC_CTX *mem_ctx = talloc_stackframe();
1058
path = normalize_reg_path(mem_ctx, key);
1060
DEBUG(0, ("out of memory! (talloc failed)\n"));
1064
if (*path == '\0') {
1068
ret = (strrchr(path, '/') == NULL);
1071
TALLOC_FREE(mem_ctx);
1076
* regdb_key_exists() is a very frequent operation. It can be quite
1077
* time-consuming to fully fetch the parent's subkey list, talloc_strdup all
1078
* subkeys and then compare the keyname linearly to all the parent's subkeys.
1080
* The following code tries to make this operation as efficient as possible:
1081
* Per registry key we create a list of subkeys that is very efficient to
1082
* search for existence of a subkey. Its format is:
1084
* 4 bytes num_subkeys
1085
* 4*num_subkey bytes offset into the string array
1086
* then follows a sorted list of subkeys in uppercase
1088
* This record is created by create_sorted_subkeys() on demand if it does not
1089
* exist. scan_parent_subkeys() uses regdb->parse_record to search the sorted
1090
* list, the parsing code and the binary search can be found in
1091
* parent_subkey_scanner. The code uses parse_record() to avoid a memcpy of
1092
* the potentially large subkey record.
1094
* The sorted subkey record is deleted in regdb_store_keys_internal and
1095
* recreated on demand.
1098
static int cmp_keynames(const void *p1, const void *p2)
1100
return StrCaseCmp(*((char **)p1), *((char **)p2));
1103
static bool create_sorted_subkeys(const char *key, const char *sorted_keyname)
1105
char **sorted_subkeys;
1106
struct regsubkey_ctr *ctr;
1107
bool result = false;
1116
if (regdb->transaction_start(regdb) != 0) {
1117
DEBUG(0, ("create_sorted_subkeys: transaction_start "
1122
werr = regsubkey_ctr_init(talloc_tos(), &ctr);
1123
if (!W_ERROR_IS_OK(werr)) {
1127
res = regdb_fetch_keys(key, ctr);
1132
num_subkeys = regsubkey_ctr_numkeys(ctr);
1133
sorted_subkeys = talloc_array(ctr, char *, num_subkeys);
1134
if (sorted_subkeys == NULL) {
1138
len = 4 + 4*num_subkeys;
1140
for (i = 0; i < num_subkeys; i++) {
1141
sorted_subkeys[i] = talloc_strdup_upper(sorted_subkeys,
1142
regsubkey_ctr_specific_key(ctr, i));
1143
if (sorted_subkeys[i] == NULL) {
1146
len += strlen(sorted_subkeys[i])+1;
1149
qsort(sorted_subkeys, num_subkeys, sizeof(char *), cmp_keynames);
1151
buf = talloc_array(ctr, char, len);
1155
p = buf + 4 + 4*num_subkeys;
1157
SIVAL(buf, 0, num_subkeys);
1159
for (i=0; i < num_subkeys; i++) {
1160
ptrdiff_t offset = p - buf;
1161
SIVAL(buf, 4 + 4*i, offset);
1162
strlcpy(p, sorted_subkeys[i], len-offset);
1163
p += strlen(sorted_subkeys[i]) + 1;
1166
status = dbwrap_store_bystring(
1167
regdb, sorted_keyname, make_tdb_data((uint8_t *)buf, len),
1169
if (!NT_STATUS_IS_OK(status)) {
1171
* Don't use a "goto fail;" here, this would commit the broken
1172
* transaction. See below for an explanation.
1174
if (regdb->transaction_cancel(regdb) == -1) {
1175
DEBUG(0, ("create_sorted_subkeys: transaction_cancel "
1185
* We only get here via the "goto fail" when we did not write anything
1186
* yet. Using transaction_commit even in a failure case is necessary
1187
* because this (disposable) call might be nested in other
1188
* transactions. Doing a cancel here would destroy the possibility of
1189
* a transaction_commit for transactions that we might be wrapped in.
1191
if (regdb->transaction_commit(regdb) == -1) {
1192
DEBUG(0, ("create_sorted_subkeys: transaction_start "
1201
struct scan_subkey_state {
1207
static int parent_subkey_scanner(TDB_DATA key, TDB_DATA data,
1210
struct scan_subkey_state *state =
1211
(struct scan_subkey_state *)private_data;
1212
uint32_t num_subkeys;
1215
if (data.dsize < sizeof(uint32_t)) {
1219
state->scanned = true;
1220
state->found = false;
1222
tdb_unpack(data.dptr, data.dsize, "d", &num_subkeys);
1228
uint32_t idx = (l+u)/2;
1229
char *s = (char *)data.dptr + IVAL(data.dptr, 4 + 4*idx);
1230
int comparison = strcmp(state->name, s);
1232
if (comparison < 0) {
1234
} else if (comparison > 0) {
1237
state->found = true;
1244
static bool scan_parent_subkeys(const char *parent, const char *name)
1248
struct scan_subkey_state state = { 0, };
1249
bool result = false;
1254
path = normalize_reg_path(talloc_tos(), parent);
1259
key = talloc_asprintf(talloc_tos(), "%s/%s",
1260
REG_SORTED_SUBKEYS_PREFIX, path);
1265
state.name = talloc_strdup_upper(talloc_tos(), name);
1266
if (state.name == NULL) {
1269
state.scanned = false;
1271
res = regdb->parse_record(regdb, string_term_tdb_data(key),
1272
parent_subkey_scanner, &state);
1274
if (state.scanned) {
1275
result = state.found;
1277
if (!create_sorted_subkeys(path, key)) {
1280
res = regdb->parse_record(regdb, string_term_tdb_data(key),
1281
parent_subkey_scanner, &state);
1282
if ((res == 0) && (state.scanned)) {
1283
result = state.found;
1289
TALLOC_FREE(state.name);
1294
* Check for the existence of a key.
1296
* Existence of a key is authoritatively defined by its
1297
* existence in the list of subkeys of its parent key.
1298
* The exeption of this are keys without a parent key,
1299
* i.e. the "base" keys (HKLM, HKCU, ...).
1301
static bool regdb_key_exists(const char *key)
1303
TALLOC_CTX *mem_ctx = talloc_stackframe();
1312
path = normalize_reg_path(mem_ctx, key);
1314
DEBUG(0, ("out of memory! (talloc failed)\n"));
1318
if (*path == '\0') {
1322
p = strrchr(path, '/');
1324
/* this is a base key */
1325
value = regdb_fetch_key_internal(mem_ctx, path);
1326
ret = (value.dptr != NULL);
1329
ret = scan_parent_subkeys(path, p+1);
1333
TALLOC_FREE(mem_ctx);
1338
/***********************************************************************
1339
Retrieve an array of strings containing subkeys. Memory should be
1340
released by the caller.
1341
***********************************************************************/
1343
int regdb_fetch_keys(const char *key, struct regsubkey_ctr *ctr)
1352
TALLOC_CTX *frame = talloc_stackframe();
1355
DEBUG(11,("regdb_fetch_keys: Enter key => [%s]\n", key ? key : "NULL"));
1357
if (!regdb_key_exists(key)) {
1361
werr = regsubkey_ctr_set_seqnum(ctr, regdb_get_seqnum());
1362
if (!W_ERROR_IS_OK(werr)) {
1366
value = regdb_fetch_key_internal(frame, key);
1368
if (value.dptr == NULL) {
1369
DEBUG(10, ("regdb_fetch_keys: no subkeys found for key [%s]\n",
1376
buflen = value.dsize;
1377
len = tdb_unpack( buf, buflen, "d", &num_items);
1379
for (i=0; i<num_items; i++) {
1380
len += tdb_unpack(buf+len, buflen-len, "f", subkeyname);
1381
werr = regsubkey_ctr_addkey(ctr, subkeyname);
1382
if (!W_ERROR_IS_OK(werr)) {
1383
DEBUG(5, ("regdb_fetch_keys: regsubkey_ctr_addkey "
1384
"failed: %s\n", win_errstr(werr)));
1389
DEBUG(11,("regdb_fetch_keys: Exit [%d] items\n", num_items));
1397
/****************************************************************************
1398
Unpack a list of registry values frem the TDB
1399
***************************************************************************/
1401
static int regdb_unpack_values(REGVAL_CTR *values, uint8 *buf, int buflen)
1408
uint32 num_values = 0;
1411
/* loop and unpack the rest of the registry values */
1413
len += tdb_unpack(buf+len, buflen-len, "d", &num_values);
1415
for ( i=0; i<num_values; i++ ) {
1416
/* unpack the next regval */
1421
valuename[0] = '\0';
1422
len += tdb_unpack(buf+len, buflen-len, "fdB",
1428
/* add the new value. Paranoid protective code -- make sure data_p is valid */
1430
if (*valuename && size && data_p) {
1431
regval_ctr_addvalue(values, valuename, type,
1432
(const char *)data_p, size);
1434
SAFE_FREE(data_p); /* 'B' option to tdb_unpack does a malloc() */
1436
DEBUG(8,("specific: [%s], len: %d\n", valuename, size));
1442
/****************************************************************************
1443
Pack all values in all printer keys
1444
***************************************************************************/
1446
static int regdb_pack_values(REGVAL_CTR *values, uint8 *buf, int buflen)
1450
REGISTRY_VALUE *val;
1456
num_values = regval_ctr_numvals( values );
1458
/* pack the number of values first */
1460
len += tdb_pack( buf+len, buflen-len, "d", num_values );
1462
/* loop over all values */
1464
for ( i=0; i<num_values; i++ ) {
1465
val = regval_ctr_specific_value( values, i );
1466
len += tdb_pack(buf+len, buflen-len, "fdB",
1470
regval_data_p(val) );
1476
/***********************************************************************
1477
Retrieve an array of strings containing subkeys. Memory should be
1478
released by the caller.
1479
***********************************************************************/
1481
int regdb_fetch_values( const char* key, REGVAL_CTR *values )
1483
char *keystr = NULL;
1484
TALLOC_CTX *ctx = talloc_stackframe();
1488
DEBUG(10,("regdb_fetch_values: Looking for value of key [%s] \n", key));
1490
if (!regdb_key_exists(key)) {
1494
keystr = talloc_asprintf(ctx, "%s/%s", REG_VALUE_PREFIX, key);
1499
values->seqnum = regdb_get_seqnum();
1501
value = regdb_fetch_key_internal(ctx, keystr);
1504
/* all keys have zero values by default */
1508
regdb_unpack_values(values, value.dptr, value.dsize);
1509
ret = regval_ctr_numvals(values);
1516
bool regdb_store_values( const char *key, REGVAL_CTR *values )
1518
TDB_DATA old_data, data;
1519
char *keystr = NULL;
1520
TALLOC_CTX *ctx = talloc_stackframe();
1523
bool result = false;
1525
DEBUG(10,("regdb_store_values: Looking for value of key [%s] \n", key));
1527
if (!regdb_key_exists(key)) {
1533
len = regdb_pack_values(values, data.dptr, data.dsize);
1535
DEBUG(0,("regdb_store_values: unable to pack values. len <= 0\n"));
1539
data.dptr = TALLOC_ARRAY(ctx, uint8, len);
1542
len = regdb_pack_values(values, data.dptr, data.dsize);
1544
SMB_ASSERT( len == data.dsize );
1546
keystr = talloc_asprintf(ctx, "%s/%s", REG_VALUE_PREFIX, key );
1550
keystr = normalize_reg_path(ctx, keystr);
1555
old_data = dbwrap_fetch_bystring(regdb, ctx, keystr);
1557
if ((old_data.dptr != NULL)
1558
&& (old_data.dsize == data.dsize)
1559
&& (memcmp(old_data.dptr, data.dptr, data.dsize) == 0))
1565
status = dbwrap_trans_store_bystring(regdb, keystr, data, TDB_REPLACE);
1567
result = NT_STATUS_IS_OK(status);
1574
static WERROR regdb_get_secdesc(TALLOC_CTX *mem_ctx, const char *key,
1575
struct security_descriptor **psecdesc)
1580
TALLOC_CTX *tmp_ctx = talloc_stackframe();
1581
WERROR err = WERR_OK;
1583
DEBUG(10, ("regdb_get_secdesc: Getting secdesc of key [%s]\n", key));
1585
if (!regdb_key_exists(key)) {
1590
tdbkey = talloc_asprintf(tmp_ctx, "%s/%s", REG_SECDESC_PREFIX, key);
1591
if (tdbkey == NULL) {
1595
normalize_dbkey(tdbkey);
1597
data = dbwrap_fetch_bystring(regdb, tmp_ctx, tdbkey);
1598
if (data.dptr == NULL) {
1603
status = unmarshall_sec_desc(mem_ctx, (uint8 *)data.dptr, data.dsize,
1606
if (NT_STATUS_EQUAL(status, NT_STATUS_NO_MEMORY)) {
1608
} else if (!NT_STATUS_IS_OK(status)) {
1609
err = WERR_REG_CORRUPT;
1613
TALLOC_FREE(tmp_ctx);
1617
static WERROR regdb_set_secdesc(const char *key,
1618
struct security_descriptor *secdesc)
1620
TALLOC_CTX *mem_ctx = talloc_stackframe();
1622
WERROR err = WERR_NOMEM;
1625
if (!regdb_key_exists(key)) {
1630
tdbkey = talloc_asprintf(mem_ctx, "%s/%s", REG_SECDESC_PREFIX, key);
1631
if (tdbkey == NULL) {
1634
normalize_dbkey(tdbkey);
1636
if (secdesc == NULL) {
1637
/* assuming a delete */
1638
err = ntstatus_to_werror(dbwrap_trans_delete_bystring(regdb,
1643
err = ntstatus_to_werror(marshall_sec_desc(mem_ctx, secdesc,
1646
W_ERROR_NOT_OK_GOTO_DONE(err);
1648
err = ntstatus_to_werror(dbwrap_trans_store_bystring(regdb, tdbkey,
1652
TALLOC_FREE(mem_ctx);
1656
bool regdb_subkeys_need_update(struct regsubkey_ctr *subkeys)
1658
return (regdb_get_seqnum() != regsubkey_ctr_get_seqnum(subkeys));
1661
bool regdb_values_need_update(REGVAL_CTR *values)
1663
return (regdb_get_seqnum() != values->seqnum);
1667
* Table of function pointers for default access
1670
REGISTRY_OPS regdb_ops = {
1671
.fetch_subkeys = regdb_fetch_keys,
1672
.fetch_values = regdb_fetch_values,
1673
.store_subkeys = regdb_store_keys,
1674
.store_values = regdb_store_values,
1675
.create_subkey = regdb_create_subkey,
1676
.delete_subkey = regdb_delete_subkey,
1677
.get_secdesc = regdb_get_secdesc,
1678
.set_secdesc = regdb_set_secdesc,
1679
.subkeys_need_update = regdb_subkeys_need_update,
1680
.values_need_update = regdb_values_need_update