s3:registry: extract the reg_backend_db prototypes into their own header.
[Samba/ekacnet.git] / source3 / registry / reg_backend_db.c
blob472cef022b12a67f3e40689eb679ce80139b2d26
1 /*
2 * Unix SMB/CIFS implementation.
3 * Virtual Windows Registry Layer
4 * Copyright (C) Gerald Carter 2002-2005
5 * Copyright (C) Michael Adam 2007-2009
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 /* Implementation of internal registry database functions. */
23 #include "includes.h"
24 #include "registry.h"
25 #include "reg_db.h"
26 #include "reg_util.h"
27 #include "reg_backend_db.h"
29 #undef DBGC_CLASS
30 #define DBGC_CLASS DBGC_REGISTRY
32 static struct db_context *regdb = NULL;
33 static int regdb_refcount;
35 static bool regdb_key_exists(struct db_context *db, const char *key);
36 static bool regdb_key_is_base_key(const char *key);
37 static WERROR regdb_fetch_keys_internal(struct db_context *db, const char *key,
38 struct regsubkey_ctr *ctr);
39 static bool regdb_store_keys_internal(struct db_context *db, const char *key,
40 struct regsubkey_ctr *ctr);
41 static int regdb_fetch_values_internal(struct db_context *db, const char* key,
42 struct regval_ctr *values);
43 static bool regdb_store_values_internal(struct db_context *db, const char *key,
44 struct regval_ctr *values);
46 /* List the deepest path into the registry. All part components will be created.*/
48 /* If you want to have a part of the path controlled by the tdb and part by
49 a virtual registry db (e.g. printing), then you have to list the deepest path.
50 For example,"HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion/Print"
51 allows the reg_db backend to handle everything up to
52 "HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion" and then we'll hook
53 the reg_printing backend onto the last component of the path (see
54 KEY_PRINTING_2K in include/rpc_reg.h) --jerry */
56 static const char *builtin_registry_paths[] = {
57 KEY_PRINTING_2K,
58 KEY_PRINTING_PORTS,
59 KEY_PRINTING,
60 KEY_SHARES,
61 KEY_EVENTLOG,
62 KEY_SMBCONF,
63 KEY_PERFLIB,
64 KEY_PERFLIB_009,
65 KEY_GROUP_POLICY,
66 KEY_SAMBA_GROUP_POLICY,
67 KEY_GP_MACHINE_POLICY,
68 KEY_GP_MACHINE_WIN_POLICY,
69 KEY_HKCU,
70 KEY_GP_USER_POLICY,
71 KEY_GP_USER_WIN_POLICY,
72 "HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion\\Winlogon\\GPExtensions",
73 "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Print\\Monitors",
74 KEY_PROD_OPTIONS,
75 "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Terminal Server\\DefaultUserConfiguration",
76 KEY_TCPIP_PARAMS,
77 KEY_NETLOGON_PARAMS,
78 KEY_HKU,
79 KEY_HKCR,
80 KEY_HKPD,
81 KEY_HKPT,
82 NULL };
84 struct builtin_regkey_value {
85 const char *path;
86 const char *valuename;
87 uint32 type;
88 union {
89 const char *string;
90 uint32 dw_value;
91 } data;
94 static struct builtin_regkey_value builtin_registry_values[] = {
95 { KEY_PRINTING_PORTS,
96 SAMBA_PRINTER_PORT_NAME, REG_SZ, { "" } },
97 { KEY_PRINTING_2K,
98 "DefaultSpoolDirectory", REG_SZ, { "C:\\Windows\\System32\\Spool\\Printers" } },
99 { KEY_EVENTLOG,
100 "DisplayName", REG_SZ, { "Event Log" } },
101 { KEY_EVENTLOG,
102 "ErrorControl", REG_DWORD, { (char*)0x00000001 } },
103 { NULL, NULL, 0, { NULL } }
107 * Initialize a key in the registry:
108 * create each component key of the specified path.
110 static WERROR init_registry_key_internal(struct db_context *db,
111 const char *add_path)
113 WERROR werr;
114 TALLOC_CTX *frame = talloc_stackframe();
115 char *path = NULL;
116 char *base = NULL;
117 char *remaining = NULL;
118 char *keyname;
119 char *subkeyname;
120 struct regsubkey_ctr *subkeys;
121 const char *p, *p2;
123 DEBUG(6, ("init_registry_key: Adding [%s]\n", add_path));
125 path = talloc_strdup(frame, add_path);
126 base = talloc_strdup(frame, "");
127 if (!path || !base) {
128 werr = WERR_NOMEM;
129 goto fail;
131 p = path;
133 while (next_token_talloc(frame, &p, &keyname, "\\")) {
135 /* build up the registry path from the components */
137 if (*base) {
138 base = talloc_asprintf(frame, "%s\\", base);
139 if (!base) {
140 werr = WERR_NOMEM;
141 goto fail;
144 base = talloc_asprintf_append(base, "%s", keyname);
145 if (!base) {
146 werr = WERR_NOMEM;
147 goto fail;
150 /* get the immediate subkeyname (if we have one ) */
152 subkeyname = talloc_strdup(frame, "");
153 if (!subkeyname) {
154 werr = WERR_NOMEM;
155 goto fail;
157 if (*p) {
158 remaining = talloc_strdup(frame, p);
159 if (!remaining) {
160 werr = WERR_NOMEM;
161 goto fail;
163 p2 = remaining;
165 if (!next_token_talloc(frame, &p2,
166 &subkeyname, "\\"))
168 subkeyname = talloc_strdup(frame,p2);
169 if (!subkeyname) {
170 werr = WERR_NOMEM;
171 goto fail;
176 DEBUG(10,("init_registry_key: Storing key [%s] with "
177 "subkey [%s]\n", base,
178 *subkeyname ? subkeyname : "NULL"));
180 /* we don't really care if the lookup succeeds or not
181 * since we are about to update the record.
182 * We just want any subkeys already present */
184 werr = regsubkey_ctr_init(frame, &subkeys);
185 if (!W_ERROR_IS_OK(werr)) {
186 DEBUG(0,("talloc() failure!\n"));
187 goto fail;
190 werr = regdb_fetch_keys_internal(db, base, subkeys);
191 if (!W_ERROR_IS_OK(werr) &&
192 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
194 goto fail;
197 if (*subkeyname) {
198 werr = regsubkey_ctr_addkey(subkeys, subkeyname);
199 if (!W_ERROR_IS_OK(werr)) {
200 goto fail;
203 if (!regdb_store_keys_internal(db, base, subkeys)) {
204 werr = WERR_CAN_NOT_COMPLETE;
205 goto fail;
209 werr = WERR_OK;
211 fail:
212 TALLOC_FREE(frame);
213 return werr;
216 struct init_registry_key_context {
217 const char *add_path;
220 static NTSTATUS init_registry_key_action(struct db_context *db,
221 void *private_data)
223 struct init_registry_key_context *init_ctx =
224 (struct init_registry_key_context *)private_data;
226 return werror_to_ntstatus(init_registry_key_internal(
227 db, init_ctx->add_path));
231 * Initialize a key in the registry:
232 * create each component key of the specified path,
233 * wrapped in one db transaction.
235 WERROR init_registry_key(const char *add_path)
237 struct init_registry_key_context init_ctx;
239 if (regdb_key_exists(regdb, add_path)) {
240 return WERR_OK;
243 init_ctx.add_path = add_path;
245 return ntstatus_to_werror(dbwrap_trans_do(regdb,
246 init_registry_key_action,
247 &init_ctx));
250 /***********************************************************************
251 Open the registry data in the tdb
252 ***********************************************************************/
254 static void regdb_ctr_add_value(struct regval_ctr *ctr,
255 struct builtin_regkey_value *value)
257 switch(value->type) {
258 case REG_DWORD:
259 regval_ctr_addvalue(ctr, value->valuename, REG_DWORD,
260 (uint8_t *)&value->data.dw_value,
261 sizeof(uint32));
262 break;
264 case REG_SZ:
265 regval_ctr_addvalue_sz(ctr, value->valuename,
266 value->data.string);
267 break;
269 default:
270 DEBUG(0, ("regdb_ctr_add_value: invalid value type in "
271 "registry values [%d]\n", value->type));
275 static NTSTATUS init_registry_data_action(struct db_context *db,
276 void *private_data)
278 NTSTATUS status;
279 TALLOC_CTX *frame = talloc_stackframe();
280 struct regval_ctr *values;
281 int i;
283 /* loop over all of the predefined paths and add each component */
285 for (i=0; builtin_registry_paths[i] != NULL; i++) {
286 if (regdb_key_exists(db, builtin_registry_paths[i])) {
287 continue;
289 status = werror_to_ntstatus(init_registry_key_internal(db,
290 builtin_registry_paths[i]));
291 if (!NT_STATUS_IS_OK(status)) {
292 goto done;
296 /* loop over all of the predefined values and add each component */
298 for (i=0; builtin_registry_values[i].path != NULL; i++) {
300 values = TALLOC_ZERO_P(frame, struct regval_ctr);
301 if (values == NULL) {
302 status = NT_STATUS_NO_MEMORY;
303 goto done;
306 regdb_fetch_values_internal(db,
307 builtin_registry_values[i].path,
308 values);
310 /* preserve existing values across restarts. Only add new ones */
312 if (!regval_ctr_key_exists(values,
313 builtin_registry_values[i].valuename))
315 regdb_ctr_add_value(values,
316 &builtin_registry_values[i]);
317 regdb_store_values_internal(db,
318 builtin_registry_values[i].path,
319 values);
321 TALLOC_FREE(values);
324 status = NT_STATUS_OK;
326 done:
328 TALLOC_FREE(frame);
329 return status;
332 WERROR init_registry_data(void)
334 WERROR werr;
335 TALLOC_CTX *frame = talloc_stackframe();
336 struct regval_ctr *values;
337 int i;
340 * First, check for the existence of the needed keys and values.
341 * If all do already exist, we can save the writes.
343 for (i=0; builtin_registry_paths[i] != NULL; i++) {
344 if (!regdb_key_exists(regdb, builtin_registry_paths[i])) {
345 goto do_init;
349 for (i=0; builtin_registry_values[i].path != NULL; i++) {
350 values = TALLOC_ZERO_P(frame, struct regval_ctr);
351 if (values == NULL) {
352 werr = WERR_NOMEM;
353 goto done;
356 regdb_fetch_values_internal(regdb,
357 builtin_registry_values[i].path,
358 values);
359 if (!regval_ctr_key_exists(values,
360 builtin_registry_values[i].valuename))
362 TALLOC_FREE(values);
363 goto do_init;
366 TALLOC_FREE(values);
369 werr = WERR_OK;
370 goto done;
372 do_init:
375 * There are potentially quite a few store operations which are all
376 * indiviually wrapped in tdb transactions. Wrapping them in a single
377 * transaction gives just a single transaction_commit() to actually do
378 * its fsync()s. See tdb/common/transaction.c for info about nested
379 * transaction behaviour.
382 werr = ntstatus_to_werror(dbwrap_trans_do(regdb,
383 init_registry_data_action,
384 NULL));
386 done:
387 TALLOC_FREE(frame);
388 return werr;
391 /***********************************************************************
392 Open the registry database
393 ***********************************************************************/
395 WERROR regdb_init(void)
397 const char *vstring = "INFO/version";
398 uint32 vers_id;
399 WERROR werr;
401 if (regdb) {
402 DEBUG(10, ("regdb_init: incrementing refcount (%d)\n",
403 regdb_refcount));
404 regdb_refcount++;
405 return WERR_OK;
408 regdb = db_open(NULL, state_path("registry.tdb"), 0,
409 REG_TDB_FLAGS, O_RDWR, 0600);
410 if (!regdb) {
411 regdb = db_open(NULL, state_path("registry.tdb"), 0,
412 REG_TDB_FLAGS, O_RDWR|O_CREAT, 0600);
413 if (!regdb) {
414 werr = ntstatus_to_werror(map_nt_error_from_unix(errno));
415 DEBUG(1,("regdb_init: Failed to open registry %s (%s)\n",
416 state_path("registry.tdb"), strerror(errno) ));
417 return werr;
420 DEBUG(10,("regdb_init: Successfully created registry tdb\n"));
423 regdb_refcount = 1;
425 vers_id = dbwrap_fetch_int32(regdb, vstring);
427 if ( vers_id != REGVER_V1 ) {
428 NTSTATUS status;
429 /* any upgrade code here if needed */
430 DEBUG(10, ("regdb_init: got %s = %d != %d\n", vstring,
431 vers_id, REGVER_V1));
432 status = dbwrap_trans_store_int32(regdb, vstring, REGVER_V1);
433 if (!NT_STATUS_IS_OK(status)) {
434 DEBUG(1, ("regdb_init: error storing %s = %d: %s\n",
435 vstring, REGVER_V1, nt_errstr(status)));
436 return ntstatus_to_werror(status);
437 } else {
438 DEBUG(10, ("regdb_init: stored %s = %d\n",
439 vstring, REGVER_V1));
443 return WERR_OK;
446 /***********************************************************************
447 Open the registry. Must already have been initialized by regdb_init()
448 ***********************************************************************/
450 WERROR regdb_open( void )
452 WERROR result = WERR_OK;
454 if ( regdb ) {
455 DEBUG(10,("regdb_open: incrementing refcount (%d)\n", regdb_refcount));
456 regdb_refcount++;
457 return WERR_OK;
460 become_root();
462 regdb = db_open(NULL, state_path("registry.tdb"), 0,
463 REG_TDB_FLAGS, O_RDWR, 0600);
464 if ( !regdb ) {
465 result = ntstatus_to_werror( map_nt_error_from_unix( errno ) );
466 DEBUG(0,("regdb_open: Failed to open %s! (%s)\n",
467 state_path("registry.tdb"), strerror(errno) ));
470 unbecome_root();
472 regdb_refcount = 1;
473 DEBUG(10,("regdb_open: refcount reset (%d)\n", regdb_refcount));
475 return result;
478 /***********************************************************************
479 ***********************************************************************/
481 int regdb_close( void )
483 if (regdb_refcount == 0) {
484 return 0;
487 regdb_refcount--;
489 DEBUG(10,("regdb_close: decrementing refcount (%d)\n", regdb_refcount));
491 if ( regdb_refcount > 0 )
492 return 0;
494 SMB_ASSERT( regdb_refcount >= 0 );
496 TALLOC_FREE(regdb);
497 return 0;
500 WERROR regdb_transaction_start(void)
502 return (regdb->transaction_start(regdb) == 0) ?
503 WERR_OK : WERR_REG_IO_FAILURE;
506 WERROR regdb_transaction_commit(void)
508 return (regdb->transaction_commit(regdb) == 0) ?
509 WERR_OK : WERR_REG_IO_FAILURE;
512 WERROR regdb_transaction_cancel(void)
514 return (regdb->transaction_cancel(regdb) == 0) ?
515 WERR_OK : WERR_REG_IO_FAILURE;
518 /***********************************************************************
519 return the tdb sequence number of the registry tdb.
520 this is an indicator for the content of the registry
521 having changed. it will change upon regdb_init, too, though.
522 ***********************************************************************/
523 int regdb_get_seqnum(void)
525 return regdb->get_seqnum(regdb);
529 static WERROR regdb_delete_key_with_prefix(struct db_context *db,
530 const char *keyname,
531 const char *prefix)
533 char *path;
534 WERROR werr = WERR_NOMEM;
535 TALLOC_CTX *mem_ctx = talloc_stackframe();
537 if (keyname == NULL) {
538 werr = WERR_INVALID_PARAM;
539 goto done;
542 if (prefix == NULL) {
543 path = discard_const_p(char, keyname);
544 } else {
545 path = talloc_asprintf(mem_ctx, "%s/%s", prefix, keyname);
546 if (path == NULL) {
547 goto done;
551 path = normalize_reg_path(mem_ctx, path);
552 if (path == NULL) {
553 goto done;
556 werr = ntstatus_to_werror(dbwrap_delete_bystring(db, path));
558 /* treat "not" found" as ok */
559 if (W_ERROR_EQUAL(werr, WERR_NOT_FOUND)) {
560 werr = WERR_OK;
563 done:
564 talloc_free(mem_ctx);
565 return werr;
569 static WERROR regdb_delete_values(struct db_context *db, const char *keyname)
571 return regdb_delete_key_with_prefix(db, keyname, REG_VALUE_PREFIX);
574 static WERROR regdb_delete_secdesc(struct db_context *db, const char *keyname)
576 return regdb_delete_key_with_prefix(db, keyname, REG_SECDESC_PREFIX);
579 static WERROR regdb_delete_subkeylist(struct db_context *db, const char *keyname)
581 return regdb_delete_key_with_prefix(db, keyname, NULL);
584 static WERROR regdb_delete_key_lists(struct db_context *db, const char *keyname)
586 WERROR werr;
588 werr = regdb_delete_values(db, keyname);
589 if (!W_ERROR_IS_OK(werr)) {
590 DEBUG(1, (__location__ " Deleting %s/%s failed: %s\n",
591 REG_VALUE_PREFIX, keyname, win_errstr(werr)));
592 goto done;
595 werr = regdb_delete_secdesc(db, keyname);
596 if (!W_ERROR_IS_OK(werr)) {
597 DEBUG(1, (__location__ " Deleting %s/%s failed: %s\n",
598 REG_SECDESC_PREFIX, keyname, win_errstr(werr)));
599 goto done;
602 werr = regdb_delete_subkeylist(db, keyname);
603 if (!W_ERROR_IS_OK(werr)) {
604 DEBUG(1, (__location__ " Deleting %s failed: %s\n",
605 keyname, win_errstr(werr)));
606 goto done;
609 done:
610 return werr;
613 /***********************************************************************
614 Add subkey strings to the registry tdb under a defined key
615 fmt is the same format as tdb_pack except this function only supports
616 fstrings
617 ***********************************************************************/
619 static WERROR regdb_store_keys_internal2(struct db_context *db,
620 const char *key,
621 struct regsubkey_ctr *ctr)
623 TDB_DATA dbuf;
624 uint8 *buffer = NULL;
625 int i = 0;
626 uint32 len, buflen;
627 uint32 num_subkeys = regsubkey_ctr_numkeys(ctr);
628 char *keyname = NULL;
629 TALLOC_CTX *ctx = talloc_stackframe();
630 WERROR werr;
632 if (!key) {
633 werr = WERR_INVALID_PARAM;
634 goto done;
637 keyname = talloc_strdup(ctx, key);
638 if (!keyname) {
639 werr = WERR_NOMEM;
640 goto done;
643 keyname = normalize_reg_path(ctx, keyname);
644 if (!keyname) {
645 werr = WERR_NOMEM;
646 goto done;
649 /* allocate some initial memory */
651 buffer = (uint8 *)SMB_MALLOC(1024);
652 if (buffer == NULL) {
653 werr = WERR_NOMEM;
654 goto done;
656 buflen = 1024;
657 len = 0;
659 /* store the number of subkeys */
661 len += tdb_pack(buffer+len, buflen-len, "d", num_subkeys);
663 /* pack all the strings */
665 for (i=0; i<num_subkeys; i++) {
666 size_t thistime;
668 thistime = tdb_pack(buffer+len, buflen-len, "f",
669 regsubkey_ctr_specific_key(ctr, i));
670 if (len+thistime > buflen) {
671 size_t thistime2;
673 * tdb_pack hasn't done anything because of the short
674 * buffer, allocate extra space.
676 buffer = SMB_REALLOC_ARRAY(buffer, uint8_t,
677 (len+thistime)*2);
678 if(buffer == NULL) {
679 DEBUG(0, ("regdb_store_keys: Failed to realloc "
680 "memory of size [%u]\n",
681 (unsigned int)(len+thistime)*2));
682 werr = WERR_NOMEM;
683 goto done;
685 buflen = (len+thistime)*2;
686 thistime2 = tdb_pack(
687 buffer+len, buflen-len, "f",
688 regsubkey_ctr_specific_key(ctr, i));
689 if (thistime2 != thistime) {
690 DEBUG(0, ("tdb_pack failed\n"));
691 werr = WERR_CAN_NOT_COMPLETE;
692 goto done;
695 len += thistime;
698 /* finally write out the data */
700 dbuf.dptr = buffer;
701 dbuf.dsize = len;
702 werr = ntstatus_to_werror(dbwrap_store_bystring(db, keyname, dbuf,
703 TDB_REPLACE));
704 W_ERROR_NOT_OK_GOTO_DONE(werr);
707 * Delete a sorted subkey cache for regdb_key_exists, will be
708 * recreated automatically
710 keyname = talloc_asprintf(ctx, "%s/%s", REG_SORTED_SUBKEYS_PREFIX,
711 keyname);
712 if (keyname == NULL) {
713 werr = WERR_NOMEM;
714 goto done;
717 werr = ntstatus_to_werror(dbwrap_delete_bystring(db, keyname));
719 /* don't treat WERR_NOT_FOUND as an error here */
720 if (W_ERROR_EQUAL(werr, WERR_NOT_FOUND)) {
721 werr = WERR_OK;
724 done:
725 TALLOC_FREE(ctx);
726 SAFE_FREE(buffer);
727 return werr;
730 /***********************************************************************
731 Store the new subkey record and create any child key records that
732 do not currently exist
733 ***********************************************************************/
735 struct regdb_store_keys_context {
736 const char *key;
737 struct regsubkey_ctr *ctr;
740 static NTSTATUS regdb_store_keys_action(struct db_context *db,
741 void *private_data)
743 struct regdb_store_keys_context *store_ctx;
744 WERROR werr;
745 int num_subkeys, i;
746 char *path = NULL;
747 struct regsubkey_ctr *subkeys = NULL, *old_subkeys = NULL;
748 char *oldkeyname = NULL;
749 TALLOC_CTX *mem_ctx = talloc_stackframe();
751 store_ctx = (struct regdb_store_keys_context *)private_data;
754 * Re-fetch the old keys inside the transaction
757 werr = regsubkey_ctr_init(mem_ctx, &old_subkeys);
758 W_ERROR_NOT_OK_GOTO_DONE(werr);
760 werr = regdb_fetch_keys_internal(db, store_ctx->key, old_subkeys);
761 if (!W_ERROR_IS_OK(werr) &&
762 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
764 goto done;
768 * Make the store operation as safe as possible without transactions:
770 * (1) For each subkey removed from ctr compared with old_subkeys:
772 * (a) First delete the value db entry.
774 * (b) Next delete the secdesc db record.
776 * (c) Then delete the subkey list entry.
778 * (2) Now write the list of subkeys of the parent key,
779 * deleting removed entries and adding new ones.
781 * (3) Finally create the subkey list entries for the added keys.
783 * This way if we crash half-way in between deleting the subkeys
784 * and storing the parent's list of subkeys, no old data can pop up
785 * out of the blue when re-adding keys later on.
788 /* (1) delete removed keys' lists (values/secdesc/subkeys) */
790 num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
791 for (i=0; i<num_subkeys; i++) {
792 oldkeyname = regsubkey_ctr_specific_key(old_subkeys, i);
794 if (regsubkey_ctr_key_exists(store_ctx->ctr, oldkeyname)) {
796 * It's still around, don't delete
798 continue;
801 path = talloc_asprintf(mem_ctx, "%s/%s", store_ctx->key,
802 oldkeyname);
803 if (!path) {
804 werr = WERR_NOMEM;
805 goto done;
808 werr = regdb_delete_key_lists(db, path);
809 W_ERROR_NOT_OK_GOTO_DONE(werr);
811 TALLOC_FREE(path);
814 TALLOC_FREE(old_subkeys);
816 /* (2) store the subkey list for the parent */
818 werr = regdb_store_keys_internal2(db, store_ctx->key, store_ctx->ctr);
819 if (!W_ERROR_IS_OK(werr)) {
820 DEBUG(0,("regdb_store_keys: Failed to store new subkey list "
821 "for parent [%s]: %s\n", store_ctx->key,
822 win_errstr(werr)));
823 goto done;
826 /* (3) now create records for any subkeys that don't already exist */
828 num_subkeys = regsubkey_ctr_numkeys(store_ctx->ctr);
830 if (num_subkeys == 0) {
831 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
832 W_ERROR_NOT_OK_GOTO_DONE(werr);
834 werr = regdb_store_keys_internal2(db, store_ctx->key, subkeys);
835 if (!W_ERROR_IS_OK(werr)) {
836 DEBUG(0,("regdb_store_keys: Failed to store "
837 "new record for key [%s]: %s\n",
838 store_ctx->key, win_errstr(werr)));
839 goto done;
841 TALLOC_FREE(subkeys);
844 for (i=0; i<num_subkeys; i++) {
845 path = talloc_asprintf(mem_ctx, "%s/%s", store_ctx->key,
846 regsubkey_ctr_specific_key(store_ctx->ctr, i));
847 if (!path) {
848 werr = WERR_NOMEM;
849 goto done;
851 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
852 W_ERROR_NOT_OK_GOTO_DONE(werr);
854 werr = regdb_fetch_keys_internal(db, path, subkeys);
855 if (!W_ERROR_IS_OK(werr)) {
856 /* create a record with 0 subkeys */
857 werr = regdb_store_keys_internal2(db, path, subkeys);
858 if (!W_ERROR_IS_OK(werr)) {
859 DEBUG(0,("regdb_store_keys: Failed to store "
860 "new record for key [%s]: %s\n", path,
861 win_errstr(werr)));
862 goto done;
866 TALLOC_FREE(subkeys);
867 TALLOC_FREE(path);
870 werr = WERR_OK;
872 done:
873 talloc_free(mem_ctx);
874 return werror_to_ntstatus(werr);
877 static bool regdb_store_keys_internal(struct db_context *db, const char *key,
878 struct regsubkey_ctr *ctr)
880 int num_subkeys, old_num_subkeys, i;
881 struct regsubkey_ctr *old_subkeys = NULL;
882 TALLOC_CTX *ctx = talloc_stackframe();
883 WERROR werr;
884 bool ret = false;
885 struct regdb_store_keys_context store_ctx;
887 if (!regdb_key_is_base_key(key) && !regdb_key_exists(db, key)) {
888 goto done;
892 * fetch a list of the old subkeys so we can determine if anything has
893 * changed
896 werr = regsubkey_ctr_init(ctx, &old_subkeys);
897 if (!W_ERROR_IS_OK(werr)) {
898 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
899 goto done;
902 werr = regdb_fetch_keys_internal(db, key, old_subkeys);
903 if (!W_ERROR_IS_OK(werr) &&
904 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
906 goto done;
909 num_subkeys = regsubkey_ctr_numkeys(ctr);
910 old_num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
911 if ((num_subkeys && old_num_subkeys) &&
912 (num_subkeys == old_num_subkeys)) {
914 for (i = 0; i < num_subkeys; i++) {
915 if (strcmp(regsubkey_ctr_specific_key(ctr, i),
916 regsubkey_ctr_specific_key(old_subkeys, i))
917 != 0)
919 break;
922 if (i == num_subkeys) {
924 * Nothing changed, no point to even start a tdb
925 * transaction
928 ret = true;
929 goto done;
933 TALLOC_FREE(old_subkeys);
935 store_ctx.key = key;
936 store_ctx.ctr = ctr;
938 werr = ntstatus_to_werror(dbwrap_trans_do(db,
939 regdb_store_keys_action,
940 &store_ctx));
942 ret = W_ERROR_IS_OK(werr);
944 done:
945 TALLOC_FREE(ctx);
947 return ret;
950 bool regdb_store_keys(const char *key, struct regsubkey_ctr *ctr)
952 return regdb_store_keys_internal(regdb, key, ctr);
956 * create a subkey of a given key
959 struct regdb_create_subkey_context {
960 const char *key;
961 const char *subkey;
964 static NTSTATUS regdb_create_subkey_action(struct db_context *db,
965 void *private_data)
967 WERROR werr;
968 struct regdb_create_subkey_context *create_ctx;
969 struct regsubkey_ctr *subkeys;
970 TALLOC_CTX *mem_ctx = talloc_stackframe();
972 create_ctx = (struct regdb_create_subkey_context *)private_data;
974 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
975 W_ERROR_NOT_OK_GOTO_DONE(werr);
977 werr = regdb_fetch_keys_internal(db, create_ctx->key, subkeys);
978 W_ERROR_NOT_OK_GOTO_DONE(werr);
980 werr = regsubkey_ctr_addkey(subkeys, create_ctx->subkey);
981 W_ERROR_NOT_OK_GOTO_DONE(werr);
983 werr = regdb_store_keys_internal2(db, create_ctx->key, subkeys);
984 if (!W_ERROR_IS_OK(werr)) {
985 DEBUG(0, (__location__ " failed to store new subkey list for "
986 "parent key %s: %s\n", create_ctx->key,
987 win_errstr(werr)));
990 done:
991 talloc_free(mem_ctx);
992 return werror_to_ntstatus(werr);
995 static WERROR regdb_create_subkey(const char *key, const char *subkey)
997 WERROR werr;
998 struct regsubkey_ctr *subkeys;
999 TALLOC_CTX *mem_ctx = talloc_stackframe();
1000 struct regdb_create_subkey_context create_ctx;
1002 if (!regdb_key_is_base_key(key) && !regdb_key_exists(regdb, key)) {
1003 werr = WERR_NOT_FOUND;
1004 goto done;
1007 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1008 W_ERROR_NOT_OK_GOTO_DONE(werr);
1010 werr = regdb_fetch_keys_internal(regdb, key, subkeys);
1011 W_ERROR_NOT_OK_GOTO_DONE(werr);
1013 if (regsubkey_ctr_key_exists(subkeys, subkey)) {
1014 werr = WERR_OK;
1015 goto done;
1018 talloc_free(subkeys);
1020 create_ctx.key = key;
1021 create_ctx.subkey = subkey;
1023 werr = ntstatus_to_werror(dbwrap_trans_do(regdb,
1024 regdb_create_subkey_action,
1025 &create_ctx));
1027 done:
1028 talloc_free(mem_ctx);
1029 return werr;
1033 * create a subkey of a given key
1036 struct regdb_delete_subkey_context {
1037 const char *key;
1038 const char *subkey;
1039 const char *path;
1042 static NTSTATUS regdb_delete_subkey_action(struct db_context *db,
1043 void *private_data)
1045 WERROR werr;
1046 struct regdb_delete_subkey_context *delete_ctx;
1047 struct regsubkey_ctr *subkeys;
1048 TALLOC_CTX *mem_ctx = talloc_stackframe();
1050 delete_ctx = (struct regdb_delete_subkey_context *)private_data;
1052 werr = regdb_delete_key_lists(db, delete_ctx->path);
1053 W_ERROR_NOT_OK_GOTO_DONE(werr);
1055 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1056 W_ERROR_NOT_OK_GOTO_DONE(werr);
1058 werr = regdb_fetch_keys_internal(db, delete_ctx->key, subkeys);
1059 W_ERROR_NOT_OK_GOTO_DONE(werr);
1061 werr = regsubkey_ctr_delkey(subkeys, delete_ctx->subkey);
1062 W_ERROR_NOT_OK_GOTO_DONE(werr);
1064 werr = regdb_store_keys_internal2(db, delete_ctx->key, subkeys);
1065 if (!W_ERROR_IS_OK(werr)) {
1066 DEBUG(0, (__location__ " failed to store new subkey_list for "
1067 "parent key %s: %s\n", delete_ctx->key,
1068 win_errstr(werr)));
1071 done:
1072 talloc_free(mem_ctx);
1073 return werror_to_ntstatus(werr);
1076 static WERROR regdb_delete_subkey(const char *key, const char *subkey)
1078 WERROR werr;
1079 char *path;
1080 struct regdb_delete_subkey_context delete_ctx;
1081 TALLOC_CTX *mem_ctx = talloc_stackframe();
1083 if (!regdb_key_is_base_key(key) && !regdb_key_exists(regdb, key)) {
1084 werr = WERR_NOT_FOUND;
1085 goto done;
1088 path = talloc_asprintf(mem_ctx, "%s/%s", key, subkey);
1089 if (path == NULL) {
1090 werr = WERR_NOMEM;
1091 goto done;
1094 if (!regdb_key_exists(regdb, path)) {
1095 werr = WERR_OK;
1096 goto done;
1099 delete_ctx.key = key;
1100 delete_ctx.subkey = subkey;
1101 delete_ctx.path = path;
1103 werr = ntstatus_to_werror(dbwrap_trans_do(regdb,
1104 regdb_delete_subkey_action,
1105 &delete_ctx));
1107 done:
1108 talloc_free(mem_ctx);
1109 return werr;
1112 static TDB_DATA regdb_fetch_key_internal(struct db_context *db,
1113 TALLOC_CTX *mem_ctx, const char *key)
1115 char *path = NULL;
1116 TDB_DATA data;
1118 path = normalize_reg_path(mem_ctx, key);
1119 if (!path) {
1120 return make_tdb_data(NULL, 0);
1123 data = dbwrap_fetch_bystring(db, mem_ctx, path);
1125 TALLOC_FREE(path);
1126 return data;
1131 * check whether a given key name represents a base key,
1132 * i.e one without a subkey separator ('/' or '\').
1134 static bool regdb_key_is_base_key(const char *key)
1136 TALLOC_CTX *mem_ctx = talloc_stackframe();
1137 bool ret = false;
1138 char *path;
1140 if (key == NULL) {
1141 goto done;
1144 path = normalize_reg_path(mem_ctx, key);
1145 if (path == NULL) {
1146 DEBUG(0, ("out of memory! (talloc failed)\n"));
1147 goto done;
1150 if (*path == '\0') {
1151 goto done;
1154 ret = (strrchr(path, '/') == NULL);
1156 done:
1157 TALLOC_FREE(mem_ctx);
1158 return ret;
1162 * regdb_key_exists() is a very frequent operation. It can be quite
1163 * time-consuming to fully fetch the parent's subkey list, talloc_strdup all
1164 * subkeys and then compare the keyname linearly to all the parent's subkeys.
1166 * The following code tries to make this operation as efficient as possible:
1167 * Per registry key we create a list of subkeys that is very efficient to
1168 * search for existence of a subkey. Its format is:
1170 * 4 bytes num_subkeys
1171 * 4*num_subkey bytes offset into the string array
1172 * then follows a sorted list of subkeys in uppercase
1174 * This record is created by create_sorted_subkeys() on demand if it does not
1175 * exist. scan_parent_subkeys() uses regdb->parse_record to search the sorted
1176 * list, the parsing code and the binary search can be found in
1177 * parent_subkey_scanner. The code uses parse_record() to avoid a memcpy of
1178 * the potentially large subkey record.
1180 * The sorted subkey record is deleted in regdb_store_keys_internal2 and
1181 * recreated on demand.
1184 static int cmp_keynames(char **p1, char **p2)
1186 return StrCaseCmp(*p1, *p2);
1189 struct create_sorted_subkeys_context {
1190 const char *key;
1191 const char *sorted_keyname;
1194 static NTSTATUS create_sorted_subkeys_action(struct db_context *db,
1195 void *private_data)
1197 char **sorted_subkeys;
1198 struct regsubkey_ctr *ctr;
1199 NTSTATUS status;
1200 char *buf;
1201 char *p;
1202 int i;
1203 size_t len;
1204 int num_subkeys;
1205 struct create_sorted_subkeys_context *sorted_ctx;
1207 sorted_ctx = (struct create_sorted_subkeys_context *)private_data;
1210 * In this function, we only treat failing of the actual write to
1211 * the db as a real error. All preliminary errors, at a stage when
1212 * nothing has been written to the DB yet are treated as success
1213 * to be committed (as an empty transaction).
1215 * The reason is that this (disposable) call might be nested in other
1216 * transactions. Doing a cancel here would destroy the possibility of
1217 * a transaction_commit for transactions that we might be wrapped in.
1220 status = werror_to_ntstatus(regsubkey_ctr_init(talloc_tos(), &ctr));
1221 if (!NT_STATUS_IS_OK(status)) {
1222 /* don't treat this as an error */
1223 status = NT_STATUS_OK;
1224 goto done;
1227 status = werror_to_ntstatus(regdb_fetch_keys_internal(db,
1228 sorted_ctx->key,
1229 ctr));
1230 if (!NT_STATUS_IS_OK(status)) {
1231 /* don't treat this as an error */
1232 status = NT_STATUS_OK;
1233 goto done;
1236 num_subkeys = regsubkey_ctr_numkeys(ctr);
1237 sorted_subkeys = talloc_array(ctr, char *, num_subkeys);
1238 if (sorted_subkeys == NULL) {
1239 /* don't treat this as an error */
1240 goto done;
1243 len = 4 + 4*num_subkeys;
1245 for (i = 0; i < num_subkeys; i++) {
1246 sorted_subkeys[i] = talloc_strdup_upper(sorted_subkeys,
1247 regsubkey_ctr_specific_key(ctr, i));
1248 if (sorted_subkeys[i] == NULL) {
1249 /* don't treat this as an error */
1250 goto done;
1252 len += strlen(sorted_subkeys[i])+1;
1255 TYPESAFE_QSORT(sorted_subkeys, num_subkeys, cmp_keynames);
1257 buf = talloc_array(ctr, char, len);
1258 if (buf == NULL) {
1259 /* don't treat this as an error */
1260 goto done;
1262 p = buf + 4 + 4*num_subkeys;
1264 SIVAL(buf, 0, num_subkeys);
1266 for (i=0; i < num_subkeys; i++) {
1267 ptrdiff_t offset = p - buf;
1268 SIVAL(buf, 4 + 4*i, offset);
1269 strlcpy(p, sorted_subkeys[i], len-offset);
1270 p += strlen(sorted_subkeys[i]) + 1;
1273 status = dbwrap_store_bystring(
1274 db, sorted_ctx->sorted_keyname, make_tdb_data((uint8_t *)buf,
1275 len),
1276 TDB_REPLACE);
1278 done:
1279 talloc_free(ctr);
1280 return status;
1283 static bool create_sorted_subkeys(const char *key, const char *sorted_keyname)
1285 NTSTATUS status;
1286 struct create_sorted_subkeys_context sorted_ctx;
1288 sorted_ctx.key = key;
1289 sorted_ctx.sorted_keyname = sorted_keyname;
1291 status = dbwrap_trans_do(regdb,
1292 create_sorted_subkeys_action,
1293 &sorted_ctx);
1295 return NT_STATUS_IS_OK(status);
1298 struct scan_subkey_state {
1299 char *name;
1300 bool scanned;
1301 bool found;
1304 static int parent_subkey_scanner(TDB_DATA key, TDB_DATA data,
1305 void *private_data)
1307 struct scan_subkey_state *state =
1308 (struct scan_subkey_state *)private_data;
1309 uint32_t num_subkeys;
1310 uint32_t l, u;
1312 if (data.dsize < sizeof(uint32_t)) {
1313 return -1;
1316 state->scanned = true;
1317 state->found = false;
1319 tdb_unpack(data.dptr, data.dsize, "d", &num_subkeys);
1321 l = 0;
1322 u = num_subkeys;
1324 while (l < u) {
1325 uint32_t idx = (l+u)/2;
1326 char *s = (char *)data.dptr + IVAL(data.dptr, 4 + 4*idx);
1327 int comparison = strcmp(state->name, s);
1329 if (comparison < 0) {
1330 u = idx;
1331 } else if (comparison > 0) {
1332 l = idx + 1;
1333 } else {
1334 state->found = true;
1335 return 0;
1338 return 0;
1341 static bool scan_parent_subkeys(struct db_context *db, const char *parent,
1342 const char *name)
1344 char *path = NULL;
1345 char *key = NULL;
1346 struct scan_subkey_state state = { 0, };
1347 bool result = false;
1348 int res;
1350 state.name = NULL;
1352 path = normalize_reg_path(talloc_tos(), parent);
1353 if (path == NULL) {
1354 goto fail;
1357 key = talloc_asprintf(talloc_tos(), "%s/%s",
1358 REG_SORTED_SUBKEYS_PREFIX, path);
1359 if (key == NULL) {
1360 goto fail;
1363 state.name = talloc_strdup_upper(talloc_tos(), name);
1364 if (state.name == NULL) {
1365 goto fail;
1367 state.scanned = false;
1369 res = db->parse_record(db, string_term_tdb_data(key),
1370 parent_subkey_scanner, &state);
1372 if (state.scanned) {
1373 result = state.found;
1374 } else {
1375 res = db->transaction_start(db);
1376 if (res != 0) {
1377 DEBUG(0, ("error starting transacion\n"));
1378 goto fail;
1381 if (!create_sorted_subkeys(path, key)) {
1382 res = db->transaction_cancel(db);
1383 if (res != 0) {
1384 smb_panic("Failed to cancel transaction.");
1386 goto fail;
1389 res = db->parse_record(db, string_term_tdb_data(key),
1390 parent_subkey_scanner, &state);
1391 if ((res == 0) && (state.scanned)) {
1392 result = state.found;
1395 res = db->transaction_commit(db);
1396 if (res != 0) {
1397 DEBUG(0, ("error committing transaction\n"));
1398 result = false;
1402 fail:
1403 TALLOC_FREE(path);
1404 TALLOC_FREE(state.name);
1405 return result;
1409 * Check for the existence of a key.
1411 * Existence of a key is authoritatively defined by its
1412 * existence in the list of subkeys of its parent key.
1413 * The exeption of this are keys without a parent key,
1414 * i.e. the "base" keys (HKLM, HKCU, ...).
1416 static bool regdb_key_exists(struct db_context *db, const char *key)
1418 TALLOC_CTX *mem_ctx = talloc_stackframe();
1419 TDB_DATA value;
1420 bool ret = false;
1421 char *path, *p;
1423 if (key == NULL) {
1424 goto done;
1427 path = normalize_reg_path(mem_ctx, key);
1428 if (path == NULL) {
1429 DEBUG(0, ("out of memory! (talloc failed)\n"));
1430 goto done;
1433 if (*path == '\0') {
1434 goto done;
1437 p = strrchr(path, '/');
1438 if (p == NULL) {
1439 /* this is a base key */
1440 value = regdb_fetch_key_internal(db, mem_ctx, path);
1441 ret = (value.dptr != NULL);
1442 } else {
1443 *p = '\0';
1444 ret = scan_parent_subkeys(db, path, p+1);
1447 done:
1448 TALLOC_FREE(mem_ctx);
1449 return ret;
1453 /***********************************************************************
1454 Retrieve an array of strings containing subkeys. Memory should be
1455 released by the caller.
1456 ***********************************************************************/
1458 static WERROR regdb_fetch_keys_internal(struct db_context *db, const char *key,
1459 struct regsubkey_ctr *ctr)
1461 WERROR werr;
1462 uint32_t num_items;
1463 uint8 *buf;
1464 uint32 buflen, len;
1465 int i;
1466 fstring subkeyname;
1467 TALLOC_CTX *frame = talloc_stackframe();
1468 TDB_DATA value;
1470 DEBUG(11,("regdb_fetch_keys: Enter key => [%s]\n", key ? key : "NULL"));
1472 frame = talloc_stackframe();
1474 if (!regdb_key_exists(db, key)) {
1475 DEBUG(10, ("key [%s] not found\n", key));
1476 werr = WERR_NOT_FOUND;
1477 goto done;
1480 werr = regsubkey_ctr_set_seqnum(ctr, db->get_seqnum(db));
1481 W_ERROR_NOT_OK_GOTO_DONE(werr);
1483 value = regdb_fetch_key_internal(db, frame, key);
1485 if (value.dsize == 0 || value.dptr == NULL) {
1486 DEBUG(10, ("regdb_fetch_keys: no subkeys found for key [%s]\n",
1487 key));
1488 goto done;
1491 buf = value.dptr;
1492 buflen = value.dsize;
1493 len = tdb_unpack( buf, buflen, "d", &num_items);
1494 if (len == (uint32_t)-1) {
1495 werr = WERR_NOT_FOUND;
1496 goto done;
1499 werr = regsubkey_ctr_reinit(ctr);
1500 W_ERROR_NOT_OK_GOTO_DONE(werr);
1502 for (i=0; i<num_items; i++) {
1503 len += tdb_unpack(buf+len, buflen-len, "f", subkeyname);
1504 werr = regsubkey_ctr_addkey(ctr, subkeyname);
1505 if (!W_ERROR_IS_OK(werr)) {
1506 DEBUG(5, ("regdb_fetch_keys: regsubkey_ctr_addkey "
1507 "failed: %s\n", win_errstr(werr)));
1508 num_items = 0;
1509 goto done;
1513 DEBUG(11,("regdb_fetch_keys: Exit [%d] items\n", num_items));
1515 done:
1516 TALLOC_FREE(frame);
1517 return werr;
1520 int regdb_fetch_keys(const char *key, struct regsubkey_ctr *ctr)
1522 WERROR werr;
1524 werr = regdb_fetch_keys_internal(regdb, key, ctr);
1525 if (!W_ERROR_IS_OK(werr)) {
1526 return -1;
1529 return regsubkey_ctr_numkeys(ctr);
1532 /****************************************************************************
1533 Unpack a list of registry values frem the TDB
1534 ***************************************************************************/
1536 static int regdb_unpack_values(struct regval_ctr *values, uint8 *buf, int buflen)
1538 int len = 0;
1539 uint32 type;
1540 fstring valuename;
1541 uint32 size;
1542 uint8 *data_p;
1543 uint32 num_values = 0;
1544 int i;
1546 /* loop and unpack the rest of the registry values */
1548 len += tdb_unpack(buf+len, buflen-len, "d", &num_values);
1550 for ( i=0; i<num_values; i++ ) {
1551 /* unpack the next regval */
1553 type = REG_NONE;
1554 size = 0;
1555 data_p = NULL;
1556 valuename[0] = '\0';
1557 len += tdb_unpack(buf+len, buflen-len, "fdB",
1558 valuename,
1559 &type,
1560 &size,
1561 &data_p);
1563 /* add the new value. Paranoid protective code -- make sure data_p is valid */
1565 if (size && data_p) {
1566 regval_ctr_addvalue(values, valuename, type,
1567 (uint8_t *)data_p, size);
1569 SAFE_FREE(data_p); /* 'B' option to tdb_unpack does a malloc() */
1571 DEBUG(8,("specific: [%s], len: %d\n", valuename, size));
1574 return len;
1577 /****************************************************************************
1578 Pack all values in all printer keys
1579 ***************************************************************************/
1581 static int regdb_pack_values(struct regval_ctr *values, uint8 *buf, int buflen)
1583 int len = 0;
1584 int i;
1585 struct regval_blob *val;
1586 int num_values;
1588 if ( !values )
1589 return 0;
1591 num_values = regval_ctr_numvals( values );
1593 /* pack the number of values first */
1595 len += tdb_pack( buf+len, buflen-len, "d", num_values );
1597 /* loop over all values */
1599 for ( i=0; i<num_values; i++ ) {
1600 val = regval_ctr_specific_value( values, i );
1601 len += tdb_pack(buf+len, buflen-len, "fdB",
1602 regval_name(val),
1603 regval_type(val),
1604 regval_size(val),
1605 regval_data_p(val) );
1608 return len;
1611 /***********************************************************************
1612 Retrieve an array of strings containing subkeys. Memory should be
1613 released by the caller.
1614 ***********************************************************************/
1616 static int regdb_fetch_values_internal(struct db_context *db, const char* key,
1617 struct regval_ctr *values)
1619 char *keystr = NULL;
1620 TALLOC_CTX *ctx = talloc_stackframe();
1621 int ret = 0;
1622 TDB_DATA value;
1624 DEBUG(10,("regdb_fetch_values: Looking for value of key [%s] \n", key));
1626 if (!regdb_key_exists(db, key)) {
1627 goto done;
1630 keystr = talloc_asprintf(ctx, "%s/%s", REG_VALUE_PREFIX, key);
1631 if (!keystr) {
1632 goto done;
1635 values->seqnum = db->get_seqnum(db);
1637 value = regdb_fetch_key_internal(db, ctx, keystr);
1639 if (!value.dptr) {
1640 /* all keys have zero values by default */
1641 goto done;
1644 regdb_unpack_values(values, value.dptr, value.dsize);
1645 ret = regval_ctr_numvals(values);
1647 done:
1648 TALLOC_FREE(ctx);
1649 return ret;
1652 int regdb_fetch_values(const char* key, struct regval_ctr *values)
1654 return regdb_fetch_values_internal(regdb, key, values);
1657 static bool regdb_store_values_internal(struct db_context *db, const char *key,
1658 struct regval_ctr *values)
1660 TDB_DATA old_data, data;
1661 char *keystr = NULL;
1662 TALLOC_CTX *ctx = talloc_stackframe();
1663 int len;
1664 NTSTATUS status;
1665 bool result = false;
1667 DEBUG(10,("regdb_store_values: Looking for value of key [%s] \n", key));
1669 if (!regdb_key_exists(db, key)) {
1670 goto done;
1673 ZERO_STRUCT(data);
1675 len = regdb_pack_values(values, data.dptr, data.dsize);
1676 if (len <= 0) {
1677 DEBUG(0,("regdb_store_values: unable to pack values. len <= 0\n"));
1678 goto done;
1681 data.dptr = TALLOC_ARRAY(ctx, uint8, len);
1682 data.dsize = len;
1684 len = regdb_pack_values(values, data.dptr, data.dsize);
1686 SMB_ASSERT( len == data.dsize );
1688 keystr = talloc_asprintf(ctx, "%s/%s", REG_VALUE_PREFIX, key );
1689 if (!keystr) {
1690 goto done;
1692 keystr = normalize_reg_path(ctx, keystr);
1693 if (!keystr) {
1694 goto done;
1697 old_data = dbwrap_fetch_bystring(db, ctx, keystr);
1699 if ((old_data.dptr != NULL)
1700 && (old_data.dsize == data.dsize)
1701 && (memcmp(old_data.dptr, data.dptr, data.dsize) == 0))
1703 result = true;
1704 goto done;
1707 status = dbwrap_trans_store_bystring(db, keystr, data, TDB_REPLACE);
1709 result = NT_STATUS_IS_OK(status);
1711 done:
1712 TALLOC_FREE(ctx);
1713 return result;
1716 bool regdb_store_values(const char *key, struct regval_ctr *values)
1718 return regdb_store_values_internal(regdb, key, values);
1721 static WERROR regdb_get_secdesc(TALLOC_CTX *mem_ctx, const char *key,
1722 struct security_descriptor **psecdesc)
1724 char *tdbkey;
1725 TDB_DATA data;
1726 NTSTATUS status;
1727 TALLOC_CTX *tmp_ctx = talloc_stackframe();
1728 WERROR err = WERR_OK;
1730 DEBUG(10, ("regdb_get_secdesc: Getting secdesc of key [%s]\n", key));
1732 if (!regdb_key_exists(regdb, key)) {
1733 err = WERR_BADFILE;
1734 goto done;
1737 tdbkey = talloc_asprintf(tmp_ctx, "%s/%s", REG_SECDESC_PREFIX, key);
1738 if (tdbkey == NULL) {
1739 err = WERR_NOMEM;
1740 goto done;
1742 normalize_dbkey(tdbkey);
1744 data = dbwrap_fetch_bystring(regdb, tmp_ctx, tdbkey);
1745 if (data.dptr == NULL) {
1746 err = WERR_BADFILE;
1747 goto done;
1750 status = unmarshall_sec_desc(mem_ctx, (uint8 *)data.dptr, data.dsize,
1751 psecdesc);
1753 if (NT_STATUS_EQUAL(status, NT_STATUS_NO_MEMORY)) {
1754 err = WERR_NOMEM;
1755 } else if (!NT_STATUS_IS_OK(status)) {
1756 err = WERR_REG_CORRUPT;
1759 done:
1760 TALLOC_FREE(tmp_ctx);
1761 return err;
1764 static WERROR regdb_set_secdesc(const char *key,
1765 struct security_descriptor *secdesc)
1767 TALLOC_CTX *mem_ctx = talloc_stackframe();
1768 char *tdbkey;
1769 WERROR err = WERR_NOMEM;
1770 TDB_DATA tdbdata;
1772 if (!regdb_key_exists(regdb, key)) {
1773 err = WERR_BADFILE;
1774 goto done;
1777 tdbkey = talloc_asprintf(mem_ctx, "%s/%s", REG_SECDESC_PREFIX, key);
1778 if (tdbkey == NULL) {
1779 goto done;
1781 normalize_dbkey(tdbkey);
1783 if (secdesc == NULL) {
1784 /* assuming a delete */
1785 err = ntstatus_to_werror(dbwrap_trans_delete_bystring(regdb,
1786 tdbkey));
1787 goto done;
1790 err = ntstatus_to_werror(marshall_sec_desc(mem_ctx, secdesc,
1791 &tdbdata.dptr,
1792 &tdbdata.dsize));
1793 W_ERROR_NOT_OK_GOTO_DONE(err);
1795 err = ntstatus_to_werror(dbwrap_trans_store_bystring(regdb, tdbkey,
1796 tdbdata, 0));
1798 done:
1799 TALLOC_FREE(mem_ctx);
1800 return err;
1803 bool regdb_subkeys_need_update(struct regsubkey_ctr *subkeys)
1805 return (regdb_get_seqnum() != regsubkey_ctr_get_seqnum(subkeys));
1808 bool regdb_values_need_update(struct regval_ctr *values)
1810 return (regdb_get_seqnum() != values->seqnum);
1814 * Table of function pointers for default access
1817 struct registry_ops regdb_ops = {
1818 .fetch_subkeys = regdb_fetch_keys,
1819 .fetch_values = regdb_fetch_values,
1820 .store_subkeys = regdb_store_keys,
1821 .store_values = regdb_store_values,
1822 .create_subkey = regdb_create_subkey,
1823 .delete_subkey = regdb_delete_subkey,
1824 .get_secdesc = regdb_get_secdesc,
1825 .set_secdesc = regdb_set_secdesc,
1826 .subkeys_need_update = regdb_subkeys_need_update,
1827 .values_need_update = regdb_values_need_update