?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
s3:registry: replace typedef "REGSUBKEY_CTR" by "struct regsubkey_ctr"
[Samba/ekacnet.git] / source / registry / reg_backend_db.c
blob453ff46d5a306e12ce5f50ba11ad693f65f58153
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 struct 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, struct regsubkey_ctr))) {
171 DEBUG(0,("talloc() failure!\n"));
172 werr = WERR_NOMEM;
173 goto fail;
174 }
175
176 regdb_fetch_keys(base, subkeys);
177 if (*subkeyname) {
178 werr = regsubkey_ctr_addkey(subkeys, subkeyname);
179 if (!W_ERROR_IS_OK(werr)) {
180 goto fail;
181 }
182 }
183 if (!regdb_store_keys( base, subkeys)) {
184 werr = WERR_CAN_NOT_COMPLETE;
185 goto fail;
186 }
187 }
188
189 werr = WERR_OK;
190
191 fail:
192 TALLOC_FREE(frame);
193 return werr;
194 }
195
196 /**
197 * Initialize a key in the registry:
198 * create each component key of the specified path,
199 * wrapped in one db transaction.
200 */
201 WERROR init_registry_key(const char *add_path)
202 {
203 WERROR werr;
204
205 if (regdb_key_exists(add_path)) {
206 return WERR_OK;
207 }
208
209 if (regdb->transaction_start(regdb) != 0) {
210 DEBUG(0, ("init_registry_key: transaction_start failed\n"));
211 return WERR_REG_IO_FAILURE;
212 }
213
214 werr = init_registry_key_internal(add_path);
215 if (!W_ERROR_IS_OK(werr)) {
216 goto fail;
217 }
218
219 if (regdb->transaction_commit(regdb) != 0) {
220 DEBUG(0, ("init_registry_key: Could not commit transaction\n"));
221 return WERR_REG_IO_FAILURE;
222 }
223
224 return WERR_OK;
225
226 fail:
227 if (regdb->transaction_cancel(regdb) != 0) {
228 smb_panic("init_registry_key: transaction_cancel failed\n");
229 }
230
231 return werr;
232 }
233
234 /***********************************************************************
235 Open the registry data in the tdb
236 ***********************************************************************/
237
238 WERROR init_registry_data(void)
239 {
240 WERROR werr;
241 TALLOC_CTX *frame = talloc_stackframe();
242 REGVAL_CTR *values;
243 int i;
244 UNISTR2 data;
245
246 /*
247 * First, check for the existence of the needed keys and values.
248 * If all do already exist, we can save the writes.
249 */
250 for (i=0; builtin_registry_paths[i] != NULL; i++) {
251 if (!regdb_key_exists(builtin_registry_paths[i])) {
252 goto do_init;
253 }
254 }
255
256 for (i=0; builtin_registry_values[i].path != NULL; i++) {
257 values = TALLOC_ZERO_P(frame, REGVAL_CTR);
258 if (values == NULL) {
259 werr = WERR_NOMEM;
260 goto done;
261 }
262
263 regdb_fetch_values(builtin_registry_values[i].path, values);
264 if (!regval_ctr_key_exists(values,
265 builtin_registry_values[i].valuename))
266 {
267 TALLOC_FREE(values);
268 goto do_init;
269 }
270
271 TALLOC_FREE(values);
272 }
273
274 werr = WERR_OK;
275 goto done;
276
277 do_init:
278
279 /*
280 * There are potentially quite a few store operations which are all
281 * indiviually wrapped in tdb transactions. Wrapping them in a single
282 * transaction gives just a single transaction_commit() to actually do
283 * its fsync()s. See tdb/common/transaction.c for info about nested
284 * transaction behaviour.
285 */
286
287 if (regdb->transaction_start(regdb) != 0) {
288 DEBUG(0, ("init_registry_data: tdb_transaction_start "
289 "failed\n"));
290 werr = WERR_REG_IO_FAILURE;
291 goto done;
292 }
293
294 /* loop over all of the predefined paths and add each component */
295
296 for (i=0; builtin_registry_paths[i] != NULL; i++) {
297 if (regdb_key_exists(builtin_registry_paths[i])) {
298 continue;
299 }
300 werr = init_registry_key_internal(builtin_registry_paths[i]);
301 if (!W_ERROR_IS_OK(werr)) {
302 goto fail;
303 }
304 }
305
306 /* loop over all of the predefined values and add each component */
307
308 for (i=0; builtin_registry_values[i].path != NULL; i++) {
309
310 values = TALLOC_ZERO_P(frame, REGVAL_CTR);
311 if (values == NULL) {
312 werr = WERR_NOMEM;
313 goto fail;
314 }
315
316 regdb_fetch_values(builtin_registry_values[i].path, values);
317
318 /* preserve existing values across restarts. Only add new ones */
319
320 if (!regval_ctr_key_exists(values,
321 builtin_registry_values[i].valuename))
322 {
323 switch(builtin_registry_values[i].type) {
324 case REG_DWORD:
325 regval_ctr_addvalue(values,
326 builtin_registry_values[i].valuename,
327 REG_DWORD,
328 (char*)&builtin_registry_values[i].data.dw_value,
329 sizeof(uint32));
330 break;
331
332 case REG_SZ:
333 init_unistr2(&data,
334 builtin_registry_values[i].data.string,
335 UNI_STR_TERMINATE);
336 regval_ctr_addvalue(values,
337 builtin_registry_values[i].valuename,
338 REG_SZ,
339 (char*)data.buffer,
340 data.uni_str_len*sizeof(uint16));
341 break;
342
343 default:
344 DEBUG(0, ("init_registry_data: invalid value "
345 "type in builtin_registry_values "
346 "[%d]\n",
347 builtin_registry_values[i].type));
348 }
349 regdb_store_values(builtin_registry_values[i].path,
350 values);
351 }
352 TALLOC_FREE(values);
353 }
354
355 if (regdb->transaction_commit(regdb) != 0) {
356 DEBUG(0, ("init_registry_data: Could not commit "
357 "transaction\n"));
358 werr = WERR_REG_IO_FAILURE;
359 } else {
360 werr = WERR_OK;
361 }
362
363 goto done;
364
365 fail:
366 if (regdb->transaction_cancel(regdb) != 0) {
367 smb_panic("init_registry_data: tdb_transaction_cancel "
368 "failed\n");
369 }
370
371 done:
372 TALLOC_FREE(frame);
373 return werr;
374 }
375
376 /***********************************************************************
377 Open the registry database
378 ***********************************************************************/
379
380 WERROR regdb_init(void)
381 {
382 const char *vstring = "INFO/version";
383 uint32 vers_id;
384 WERROR werr;
385
386 if (regdb) {
387 DEBUG(10, ("regdb_init: incrementing refcount (%d)\n",
388 regdb_refcount));
389 regdb_refcount++;
390 return WERR_OK;
391 }
392
393 regdb = db_open(NULL, state_path("registry.tdb"), 0,
394 REG_TDB_FLAGS, O_RDWR, 0600);
395 if (!regdb) {
396 regdb = db_open(NULL, state_path("registry.tdb"), 0,
397 REG_TDB_FLAGS, O_RDWR|O_CREAT, 0600);
398 if (!regdb) {
399 werr = ntstatus_to_werror(map_nt_error_from_unix(errno));
400 DEBUG(1,("regdb_init: Failed to open registry %s (%s)\n",
401 state_path("registry.tdb"), strerror(errno) ));
402 return werr;
403 }
404
405 DEBUG(10,("regdb_init: Successfully created registry tdb\n"));
406 }
407
408 regdb_refcount = 1;
409
410 vers_id = dbwrap_fetch_int32(regdb, vstring);
411
412 if ( vers_id != REGVER_V1 ) {
413 NTSTATUS status;
414 /* any upgrade code here if needed */
415 DEBUG(10, ("regdb_init: got %s = %d != %d\n", vstring,
416 vers_id, REGVER_V1));
417 status = dbwrap_trans_store_int32(regdb, vstring, REGVER_V1);
418 if (!NT_STATUS_IS_OK(status)) {
419 DEBUG(1, ("regdb_init: error storing %s = %d: %s\n",
420 vstring, REGVER_V1, nt_errstr(status)));
421 return ntstatus_to_werror(status);
422 } else {
423 DEBUG(10, ("regdb_init: stored %s = %d\n",
424 vstring, REGVER_V1));
425 }
426 }
427
428 return WERR_OK;
429 }
430
431 /***********************************************************************
432 Open the registry. Must already have been initialized by regdb_init()
433 ***********************************************************************/
434
435 WERROR regdb_open( void )
436 {
437 WERROR result = WERR_OK;
438
439 if ( regdb ) {
440 DEBUG(10,("regdb_open: incrementing refcount (%d)\n", regdb_refcount));
441 regdb_refcount++;
442 return WERR_OK;
443 }
444
445 become_root();
446
447 regdb = db_open(NULL, state_path("registry.tdb"), 0,
448 REG_TDB_FLAGS, O_RDWR, 0600);
449 if ( !regdb ) {
450 result = ntstatus_to_werror( map_nt_error_from_unix( errno ) );
451 DEBUG(0,("regdb_open: Failed to open %s! (%s)\n",
452 state_path("registry.tdb"), strerror(errno) ));
453 }
454
455 unbecome_root();
456
457 regdb_refcount = 1;
458 DEBUG(10,("regdb_open: refcount reset (%d)\n", regdb_refcount));
459
460 return result;
461 }
462
463 /***********************************************************************
464 ***********************************************************************/
465
466 int regdb_close( void )
467 {
468 if (regdb_refcount == 0) {
469 return 0;
470 }
471
472 regdb_refcount--;
473
474 DEBUG(10,("regdb_close: decrementing refcount (%d)\n", regdb_refcount));
475
476 if ( regdb_refcount > 0 )
477 return 0;
478
479 SMB_ASSERT( regdb_refcount >= 0 );
480
481 TALLOC_FREE(regdb);
482 return 0;
483 }
484
485 WERROR regdb_transaction_start(void)
486 {
487 return (regdb->transaction_start(regdb) == 0) ?
488 WERR_OK : WERR_REG_IO_FAILURE;
489 }
490
491 WERROR regdb_transaction_commit(void)
492 {
493 return (regdb->transaction_commit(regdb) == 0) ?
494 WERR_OK : WERR_REG_IO_FAILURE;
495 }
496
497 WERROR regdb_transaction_cancel(void)
498 {
499 return (regdb->transaction_cancel(regdb) == 0) ?
500 WERR_OK : WERR_REG_IO_FAILURE;
501 }
502
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)
509 {
510 return regdb->get_seqnum(regdb);
511 }
512
513 /***********************************************************************
514 Add subkey strings to the registry tdb under a defined key
515 fmt is the same format as tdb_pack except this function only supports
516 fstrings
517 ***********************************************************************/
518
519 static bool regdb_store_keys_internal(const char *key, struct regsubkey_ctr *ctr)
520 {
521 TDB_DATA dbuf;
522 uint8 *buffer = NULL;
523 int i = 0;
524 uint32 len, buflen;
525 bool ret = true;
526 uint32 num_subkeys = regsubkey_ctr_numkeys(ctr);
527 char *keyname = NULL;
528 TALLOC_CTX *ctx = talloc_stackframe();
529 NTSTATUS status;
530
531 if (!key) {
532 return false;
533 }
534
535 keyname = talloc_strdup(ctx, key);
536 if (!keyname) {
537 return false;
538 }
539 keyname = normalize_reg_path(ctx, keyname);
540
541 /* allocate some initial memory */
542
543 buffer = (uint8 *)SMB_MALLOC(1024);
544 if (buffer == NULL) {
545 return false;
546 }
547 buflen = 1024;
548 len = 0;
549
550 /* store the number of subkeys */
551
552 len += tdb_pack(buffer+len, buflen-len, "d", num_subkeys);
553
554 /* pack all the strings */
555
556 for (i=0; i<num_subkeys; i++) {
557 size_t thistime;
558
559 thistime = tdb_pack(buffer+len, buflen-len, "f",
560 regsubkey_ctr_specific_key(ctr, i));
561 if (len+thistime > buflen) {
562 size_t thistime2;
563 /*
564 * tdb_pack hasn't done anything because of the short
565 * buffer, allocate extra space.
566 */
567 buffer = SMB_REALLOC_ARRAY(buffer, uint8_t,
568 (len+thistime)*2);
569 if(buffer == NULL) {
570 DEBUG(0, ("regdb_store_keys: Failed to realloc "
571 "memory of size [%u]\n",
572 (unsigned int)(len+thistime)*2));
573 ret = false;
574 goto done;
575 }
576 buflen = (len+thistime)*2;
577 thistime2 = tdb_pack(
578 buffer+len, buflen-len, "f",
579 regsubkey_ctr_specific_key(ctr, i));
580 if (thistime2 != thistime) {
581 DEBUG(0, ("tdb_pack failed\n"));
582 ret = false;
583 goto done;
584 }
585 }
586 len += thistime;
587 }
588
589 /* finally write out the data */
590
591 dbuf.dptr = buffer;
592 dbuf.dsize = len;
593 status = dbwrap_store_bystring(regdb, keyname, dbuf, TDB_REPLACE);
594 if (!NT_STATUS_IS_OK(status)) {
595 ret = false;
596 goto done;
597 }
598
599 /*
600 * Delete a sorted subkey cache for regdb_key_exists, will be
601 * recreated automatically
602 */
603 keyname = talloc_asprintf(ctx, "%s/%s", REG_SORTED_SUBKEYS_PREFIX,
604 keyname);
605 if (keyname != NULL) {
606 dbwrap_delete_bystring(regdb, keyname);
607 }
608
609 done:
610 TALLOC_FREE(ctx);
611 SAFE_FREE(buffer);
612 return ret;
613 }
614
615 /***********************************************************************
616 Store the new subkey record and create any child key records that
617 do not currently exist
618 ***********************************************************************/
619
620 bool regdb_store_keys(const char *key, struct regsubkey_ctr *ctr)
621 {
622 int num_subkeys, i;
623 char *path = NULL;
624 struct regsubkey_ctr *subkeys = NULL, *old_subkeys = NULL;
625 char *oldkeyname = NULL;
626 TALLOC_CTX *ctx = talloc_stackframe();
627 NTSTATUS status;
628
629 if (!regdb_key_is_base_key(key) && !regdb_key_exists(key)) {
630 goto fail;
631 }
632
633 /*
634 * fetch a list of the old subkeys so we can determine if anything has
635 * changed
636 */
637
638 if (!(old_subkeys = TALLOC_ZERO_P(ctx, struct regsubkey_ctr))) {
639 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
640 return false;
641 }
642
643 regdb_fetch_keys(key, old_subkeys);
644
645 if ((ctr->num_subkeys && old_subkeys->num_subkeys) &&
646 (ctr->num_subkeys == old_subkeys->num_subkeys)) {
647
648 for (i = 0; i<ctr->num_subkeys; i++) {
649 if (strcmp(ctr->subkeys[i],
650 old_subkeys->subkeys[i]) != 0) {
651 break;
652 }
653 }
654 if (i == ctr->num_subkeys) {
655 /*
656 * Nothing changed, no point to even start a tdb
657 * transaction
658 */
659 TALLOC_FREE(old_subkeys);
660 return true;
661 }
662 }
663
664 TALLOC_FREE(old_subkeys);
665
666 if (regdb->transaction_start(regdb) != 0) {
667 DEBUG(0, ("regdb_store_keys: transaction_start failed\n"));
668 goto fail;
669 }
670
671 /*
672 * Re-fetch the old keys inside the transaction
673 */
674
675 if (!(old_subkeys = TALLOC_ZERO_P(ctx, struct regsubkey_ctr))) {
676 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
677 goto cancel;
678 }
679
680 regdb_fetch_keys(key, old_subkeys);
681
682 /*
683 * Make the store operation as safe as possible without transactions:
684 *
685 * (1) For each subkey removed from ctr compared with old_subkeys:
686 *
687 * (a) First delete the value db entry.
688 *
689 * (b) Next delete the secdesc db record.
690 *
691 * (c) Then delete the subkey list entry.
692 *
693 * (2) Now write the list of subkeys of the parent key,
694 * deleting removed entries and adding new ones.
695 *
696 * (3) Finally create the subkey list entries for the added keys.
697 *
698 * This way if we crash half-way in between deleting the subkeys
699 * and storing the parent's list of subkeys, no old data can pop up
700 * out of the blue when re-adding keys later on.
701 */
702
703 /* (1) delete removed keys' lists (values/secdesc/subkeys) */
704
705 num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
706 for (i=0; i<num_subkeys; i++) {
707 oldkeyname = regsubkey_ctr_specific_key(old_subkeys, i);
708
709 if (regsubkey_ctr_key_exists(ctr, oldkeyname)) {
710 /*
711 * It's still around, don't delete
712 */
713
714 continue;
715 }
716
717 /* (a) Delete the value list for this key */
718
719 path = talloc_asprintf(ctx, "%s/%s/%s",
720 REG_VALUE_PREFIX,
721 key,
722 oldkeyname );
723 if (!path) {
724 goto cancel;
725 }
726 path = normalize_reg_path(ctx, path);
727 if (!path) {
728 goto cancel;
729 }
730 /* Ignore errors here, we might have no values around */
731 dbwrap_delete_bystring(regdb, path);
732 TALLOC_FREE(path);
733
734 /* (b) Delete the secdesc for this key */
735
736 path = talloc_asprintf(ctx, "%s/%s/%s",
737 REG_SECDESC_PREFIX,
738 key,
739 oldkeyname );
740 if (!path) {
741 goto cancel;
742 }
743 path = normalize_reg_path(ctx, path);
744 if (!path) {
745 goto cancel;
746 }
747 status = dbwrap_delete_bystring(regdb, path);
748 /* Don't fail if there are no values around. */
749 if (!NT_STATUS_IS_OK(status) &&
750 !NT_STATUS_EQUAL(status, NT_STATUS_NOT_FOUND))
751 {
752 DEBUG(1, ("Deleting %s failed: %s\n", path,
753 nt_errstr(status)));
754 goto cancel;
755 }
756 TALLOC_FREE(path);
757
758 /* (c) Delete the list of subkeys of this key */
759
760 path = talloc_asprintf(ctx, "%s/%s", key, oldkeyname);
761 if (!path) {
762 goto cancel;
763 }
764 path = normalize_reg_path(ctx, path);
765 if (!path) {
766 goto cancel;
767 }
768 status = dbwrap_delete_bystring(regdb, path);
769 /* Don't fail if the subkey record was not found. */
770 if (!NT_STATUS_IS_OK(status) &&
771 !NT_STATUS_EQUAL(status, NT_STATUS_NOT_FOUND))
772 {
773 DEBUG(1, ("Deleting %s failed: %s\n", path,
774 nt_errstr(status)));
775 goto cancel;
776 }
777 TALLOC_FREE(path);
778 }
779
780 TALLOC_FREE(old_subkeys);
781
782 /* (2) store the subkey list for the parent */
783
784 if (!regdb_store_keys_internal(key, ctr) ) {
785 DEBUG(0,("regdb_store_keys: Failed to store new subkey list "
786 "for parent [%s]\n", key));
787 goto cancel;
788 }
789
790 /* (3) now create records for any subkeys that don't already exist */
791
792 num_subkeys = regsubkey_ctr_numkeys(ctr);
793
794 if (num_subkeys == 0) {
795 if (!(subkeys = TALLOC_ZERO_P(ctx, struct regsubkey_ctr)) ) {
796 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
797 goto cancel;
798 }
799
800 if (!regdb_store_keys_internal(key, subkeys)) {
801 DEBUG(0,("regdb_store_keys: Failed to store "
802 "new record for key [%s]\n", key));
803 goto cancel;
804 }
805 TALLOC_FREE(subkeys);
806
807 }
808
809 for (i=0; i<num_subkeys; i++) {
810 path = talloc_asprintf(ctx, "%s/%s",
811 key,
812 regsubkey_ctr_specific_key(ctr, i));
813 if (!path) {
814 goto cancel;
815 }
816 if (!(subkeys = TALLOC_ZERO_P(ctx, struct regsubkey_ctr)) ) {
817 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
818 goto cancel;
819 }
820
821 if (regdb_fetch_keys( path, subkeys ) == -1) {
822 /* create a record with 0 subkeys */
823 if (!regdb_store_keys_internal(path, subkeys)) {
824 DEBUG(0,("regdb_store_keys: Failed to store "
825 "new record for key [%s]\n", path));
826 goto cancel;
827 }
828 }
829
830 TALLOC_FREE(subkeys);
831 TALLOC_FREE(path);
832 }
833
834 if (regdb->transaction_commit(regdb) != 0) {
835 DEBUG(0, ("regdb_store_keys: Could not commit transaction\n"));
836 goto fail;
837 }
838
839 TALLOC_FREE(ctx);
840 return true;
841
842 cancel:
843 if (regdb->transaction_cancel(regdb) != 0) {
844 smb_panic("regdb_store_keys: transaction_cancel failed\n");
845 }
846
847 fail:
848 TALLOC_FREE(ctx);
849
850 return false;
851 }
852
853
854 static TDB_DATA regdb_fetch_key_internal(TALLOC_CTX *mem_ctx, const char *key)
855 {
856 char *path = NULL;
857 TDB_DATA data;
858
859 path = normalize_reg_path(mem_ctx, key);
860 if (!path) {
861 return make_tdb_data(NULL, 0);
862 }
863
864 data = dbwrap_fetch_bystring(regdb, mem_ctx, path);
865
866 TALLOC_FREE(path);
867 return data;
868 }
869
870
871 /**
872 * check whether a given key name represents a base key,
873 * i.e one without a subkey separator ('/' or '\').
874 */
875 static bool regdb_key_is_base_key(const char *key)
876 {
877 TALLOC_CTX *mem_ctx = talloc_stackframe();
878 bool ret = false;
879 char *path;
880
881 if (key == NULL) {
882 goto done;
883 }
884
885 path = normalize_reg_path(mem_ctx, key);
886 if (path == NULL) {
887 DEBUG(0, ("out of memory! (talloc failed)\n"));
888 goto done;
889 }
890
891 if (*path == '\0') {
892 goto done;
893 }
894
895 ret = (strrchr(path, '/') == NULL);
896
897 done:
898 TALLOC_FREE(mem_ctx);
899 return ret;
900 }
901
902 /*
903 * regdb_key_exists() is a very frequent operation. It can be quite
904 * time-consuming to fully fetch the parent's subkey list, talloc_strdup all
905 * subkeys and then compare the keyname linearly to all the parent's subkeys.
906 *
907 * The following code tries to make this operation as efficient as possible:
908 * Per registry key we create a list of subkeys that is very efficient to
909 * search for existence of a subkey. Its format is:
910 *
911 * 4 bytes num_subkeys
912 * 4*num_subkey bytes offset into the string array
913 * then follows a sorted list of subkeys in uppercase
914 *
915 * This record is created by create_sorted_subkeys() on demand if it does not
916 * exist. scan_parent_subkeys() uses regdb->parse_record to search the sorted
917 * list, the parsing code and the binary search can be found in
918 * parent_subkey_scanner. The code uses parse_record() to avoid a memcpy of
919 * the potentially large subkey record.
920 *
921 * The sorted subkey record is deleted in regdb_store_keys_internal and
922 * recreated on demand.
923 */
924
925 static int cmp_keynames(const void *p1, const void *p2)
926 {
927 return StrCaseCmp(*((char **)p1), *((char **)p2));
928 }
929
930 static bool create_sorted_subkeys(const char *key, const char *sorted_keyname)
931 {
932 char **sorted_subkeys;
933 struct regsubkey_ctr *ctr;
934 bool result = false;
935 NTSTATUS status;
936 char *buf;
937 char *p;
938 int i, res;
939 size_t len;
940
941 if (regdb->transaction_start(regdb) != 0) {
942 DEBUG(0, ("create_sorted_subkeys: transaction_start "
943 "failed\n"));
944 return false;
945 }
946
947 ctr = talloc(talloc_tos(), struct regsubkey_ctr);
948 if (ctr == NULL) {
949 goto fail;
950 }
951
952 res = regdb_fetch_keys(key, ctr);
953 if (res == -1) {
954 goto fail;
955 }
956
957 sorted_subkeys = talloc_array(ctr, char *, ctr->num_subkeys);
958 if (sorted_subkeys == NULL) {
959 goto fail;
960 }
961
962 len = 4 + 4*ctr->num_subkeys;
963
964 for (i = 0; i<ctr->num_subkeys; i++) {
965 sorted_subkeys[i] = talloc_strdup_upper(sorted_subkeys,
966 ctr->subkeys[i]);
967 if (sorted_subkeys[i] == NULL) {
968 goto fail;
969 }
970 len += strlen(sorted_subkeys[i])+1;
971 }
972
973 qsort(sorted_subkeys, ctr->num_subkeys, sizeof(char *), cmp_keynames);
974
975 buf = talloc_array(ctr, char, len);
976 if (buf == NULL) {
977 goto fail;
978 }
979 p = buf + 4 + 4*ctr->num_subkeys;
980
981 SIVAL(buf, 0, ctr->num_subkeys);
982
983 for (i=0; i<ctr->num_subkeys; i++) {
984 ptrdiff_t offset = p - buf;
985 SIVAL(buf, 4 + 4*i, offset);
986 strlcpy(p, sorted_subkeys[i], len-offset);
987 p += strlen(sorted_subkeys[i]) + 1;
988 }
989
990 status = dbwrap_store_bystring(
991 regdb, sorted_keyname, make_tdb_data((uint8_t *)buf, len),
992 TDB_REPLACE);
993 if (!NT_STATUS_IS_OK(status)) {
994 /*
995 * Don't use a "goto fail;" here, this would commit the broken
996 * transaction. See below for an explanation.
997 */
998 if (regdb->transaction_cancel(regdb) == -1) {
999 DEBUG(0, ("create_sorted_subkeys: transaction_cancel "
1000 "failed\n"));
1001 }
1002 TALLOC_FREE(ctr);
1003 return false;
1004 }
1005
1006 result = true;
1007 fail:
1008 /*
1009 * We only get here via the "goto fail" when we did not write anything
1010 * yet. Using transaction_commit even in a failure case is necessary
1011 * because this (disposable) call might be nested in other
1012 * transactions. Doing a cancel here would destroy the possibility of
1013 * a transaction_commit for transactions that we might be wrapped in.
1014 */
1015 if (regdb->transaction_commit(regdb) == -1) {
1016 DEBUG(0, ("create_sorted_subkeys: transaction_start "
1017 "failed\n"));
1018 goto fail;
1019 }
1020
1021 TALLOC_FREE(ctr);
1022 return result;
1023 }
1024
1025 struct scan_subkey_state {
1026 char *name;
1027 bool scanned;
1028 bool found;
1029 };
1030
1031 static int parent_subkey_scanner(TDB_DATA key, TDB_DATA data,
1032 void *private_data)
1033 {
1034 struct scan_subkey_state *state =
1035 (struct scan_subkey_state *)private_data;
1036 uint32_t num_subkeys;
1037 uint32_t l, u;
1038
1039 if (data.dsize < sizeof(uint32_t)) {
1040 return -1;
1041 }
1042
1043 state->scanned = true;
1044 state->found = false;
1045
1046 tdb_unpack(data.dptr, data.dsize, "d", &num_subkeys);
1047
1048 l = 0;
1049 u = num_subkeys;
1050
1051 while (l < u) {
1052 uint32_t idx = (l+u)/2;
1053 char *s = (char *)data.dptr + IVAL(data.dptr, 4 + 4*idx);
1054 int comparison = strcmp(state->name, s);
1055
1056 if (comparison < 0) {
1057 u = idx;
1058 } else if (comparison > 0) {
1059 l = idx + 1;
1060 } else {
1061 state->found = true;
1062 return 0;
1063 }
1064 }
1065 return 0;
1066 }
1067
1068 static bool scan_parent_subkeys(const char *parent, const char *name)
1069 {
1070 char *path = NULL;
1071 char *key = NULL;
1072 struct scan_subkey_state state = { 0, };
1073 bool result = false;
1074 int res;
1075
1076 state.name = NULL;
1077
1078 path = normalize_reg_path(talloc_tos(), parent);
1079 if (path == NULL) {
1080 goto fail;
1081 }
1082
1083 key = talloc_asprintf(talloc_tos(), "%s/%s",
1084 REG_SORTED_SUBKEYS_PREFIX, path);
1085 if (key == NULL) {
1086 goto fail;
1087 }
1088
1089 state.name = talloc_strdup_upper(talloc_tos(), name);
1090 if (state.name == NULL) {
1091 goto fail;
1092 }
1093 state.scanned = false;
1094
1095 res = regdb->parse_record(regdb, string_term_tdb_data(key),
1096 parent_subkey_scanner, &state);
1097
1098 if (state.scanned) {
1099 result = state.found;
1100 } else {
1101 if (!create_sorted_subkeys(path, key)) {
1102 goto fail;
1103 }
1104 res = regdb->parse_record(regdb, string_term_tdb_data(key),
1105 parent_subkey_scanner, &state);
1106 if ((res == 0) && (state.scanned)) {
1107 result = state.found;
1108 }
1109 }
1110
1111 fail:
1112 TALLOC_FREE(path);
1113 TALLOC_FREE(state.name);
1114 return result;
1115 }
1116
1117 /**
1118 * Check for the existence of a key.
1119 *
1120 * Existence of a key is authoritatively defined by its
1121 * existence in the list of subkeys of its parent key.
1122 * The exeption of this are keys without a parent key,
1123 * i.e. the "base" keys (HKLM, HKCU, ...).
1124 */
1125 static bool regdb_key_exists(const char *key)
1126 {
1127 TALLOC_CTX *mem_ctx = talloc_stackframe();
1128 TDB_DATA value;
1129 bool ret = false;
1130 char *path, *p;
1131
1132 if (key == NULL) {
1133 goto done;
1134 }
1135
1136 path = normalize_reg_path(mem_ctx, key);
1137 if (path == NULL) {
1138 DEBUG(0, ("out of memory! (talloc failed)\n"));
1139 goto done;
1140 }
1141
1142 if (*path == '\0') {
1143 goto done;
1144 }
1145
1146 p = strrchr(path, '/');
1147 if (p == NULL) {
1148 /* this is a base key */
1149 value = regdb_fetch_key_internal(mem_ctx, path);
1150 ret = (value.dptr != NULL);
1151 } else {
1152 *p = '\0';
1153 ret = scan_parent_subkeys(path, p+1);
1154 }
1155
1156 done:
1157 TALLOC_FREE(mem_ctx);
1158 return ret;
1159 }
1160
1161
1162 /***********************************************************************
1163 Retrieve an array of strings containing subkeys. Memory should be
1164 released by the caller.
1165 ***********************************************************************/
1166
1167 int regdb_fetch_keys(const char *key, struct regsubkey_ctr *ctr)
1168 {
1169 WERROR werr;
1170 uint32 num_items;
1171 uint8 *buf;
1172 uint32 buflen, len;
1173 int i;
1174 fstring subkeyname;
1175 int ret = -1;
1176 TALLOC_CTX *frame = talloc_stackframe();
1177 TDB_DATA value;
1178
1179 DEBUG(11,("regdb_fetch_keys: Enter key => [%s]\n", key ? key : "NULL"));
1180
1181 if (!regdb_key_exists(key)) {
1182 goto done;
1183 }
1184
1185 ctr->seqnum = regdb_get_seqnum();
1186
1187 value = regdb_fetch_key_internal(frame, key);
1188
1189 if (value.dptr == NULL) {
1190 DEBUG(10, ("regdb_fetch_keys: no subkeys found for key [%s]\n",
1191 key));
1192 ret = 0;
1193 goto done;
1194 }
1195
1196 buf = value.dptr;
1197 buflen = value.dsize;
1198 len = tdb_unpack( buf, buflen, "d", &num_items);
1199
1200 for (i=0; i<num_items; i++) {
1201 len += tdb_unpack(buf+len, buflen-len, "f", subkeyname);
1202 werr = regsubkey_ctr_addkey(ctr, subkeyname);
1203 if (!W_ERROR_IS_OK(werr)) {
1204 DEBUG(5, ("regdb_fetch_keys: regsubkey_ctr_addkey "
1205 "failed: %s\n", dos_errstr(werr)));
1206 goto done;
1207 }
1208 }
1209
1210 DEBUG(11,("regdb_fetch_keys: Exit [%d] items\n", num_items));
1211
1212 ret = num_items;
1213 done:
1214 TALLOC_FREE(frame);
1215 return ret;
1216 }
1217
1218 /****************************************************************************
1219 Unpack a list of registry values frem the TDB
1220 ***************************************************************************/
1221
1222 static int regdb_unpack_values(REGVAL_CTR *values, uint8 *buf, int buflen)
1223 {
1224 int len = 0;
1225 uint32 type;
1226 fstring valuename;
1227 uint32 size;
1228 uint8 *data_p;
1229 uint32 num_values = 0;
1230 int i;
1231
1232 /* loop and unpack the rest of the registry values */
1233
1234 len += tdb_unpack(buf+len, buflen-len, "d", &num_values);
1235
1236 for ( i=0; i<num_values; i++ ) {
1237 /* unpack the next regval */
1238
1239 type = REG_NONE;
1240 size = 0;
1241 data_p = NULL;
1242 valuename[0] = '\0';
1243 len += tdb_unpack(buf+len, buflen-len, "fdB",
1244 valuename,
1245 &type,
1246 &size,
1247 &data_p);
1248
1249 /* add the new value. Paranoid protective code -- make sure data_p is valid */
1250
1251 if (*valuename && size && data_p) {
1252 regval_ctr_addvalue(values, valuename, type,
1253 (const char *)data_p, size);
1254 }
1255 SAFE_FREE(data_p); /* 'B' option to tdb_unpack does a malloc() */
1256
1257 DEBUG(8,("specific: [%s], len: %d\n", valuename, size));
1258 }
1259
1260 return len;
1261 }
1262
1263 /****************************************************************************
1264 Pack all values in all printer keys
1265 ***************************************************************************/
1266
1267 static int regdb_pack_values(REGVAL_CTR *values, uint8 *buf, int buflen)
1268 {
1269 int len = 0;
1270 int i;
1271 REGISTRY_VALUE *val;
1272 int num_values;
1273
1274 if ( !values )
1275 return 0;
1276
1277 num_values = regval_ctr_numvals( values );
1278
1279 /* pack the number of values first */
1280
1281 len += tdb_pack( buf+len, buflen-len, "d", num_values );
1282
1283 /* loop over all values */
1284
1285 for ( i=0; i<num_values; i++ ) {
1286 val = regval_ctr_specific_value( values, i );
1287 len += tdb_pack(buf+len, buflen-len, "fdB",
1288 regval_name(val),
1289 regval_type(val),
1290 regval_size(val),
1291 regval_data_p(val) );
1292 }
1293
1294 return len;
1295 }
1296
1297 /***********************************************************************
1298 Retrieve an array of strings containing subkeys. Memory should be
1299 released by the caller.
1300 ***********************************************************************/
1301
1302 int regdb_fetch_values( const char* key, REGVAL_CTR *values )
1303 {
1304 char *keystr = NULL;
1305 TALLOC_CTX *ctx = talloc_stackframe();
1306 int ret = 0;
1307 TDB_DATA value;
1308
1309 DEBUG(10,("regdb_fetch_values: Looking for value of key [%s] \n", key));
1310
1311 if (!regdb_key_exists(key)) {
1312 goto done;
1313 }
1314
1315 keystr = talloc_asprintf(ctx, "%s/%s", REG_VALUE_PREFIX, key);
1316 if (!keystr) {
1317 goto done;
1318 }
1319
1320 values->seqnum = regdb_get_seqnum();
1321
1322 value = regdb_fetch_key_internal(ctx, keystr);
1323
1324 if (!value.dptr) {
1325 /* all keys have zero values by default */
1326 goto done;
1327 }
1328
1329 regdb_unpack_values(values, value.dptr, value.dsize);
1330 ret = regval_ctr_numvals(values);
1331
1332 done:
1333 TALLOC_FREE(ctx);
1334 return ret;
1335 }
1336
1337 bool regdb_store_values( const char *key, REGVAL_CTR *values )
1338 {
1339 TDB_DATA old_data, data;
1340 char *keystr = NULL;
1341 TALLOC_CTX *ctx = talloc_stackframe();
1342 int len;
1343 NTSTATUS status;
1344 bool result = false;
1345
1346 DEBUG(10,("regdb_store_values: Looking for value of key [%s] \n", key));
1347
1348 if (!regdb_key_exists(key)) {
1349 goto done;
1350 }
1351
1352 ZERO_STRUCT(data);
1353
1354 len = regdb_pack_values(values, data.dptr, data.dsize);
1355 if (len <= 0) {
1356 DEBUG(0,("regdb_store_values: unable to pack values. len <= 0\n"));
1357 goto done;
1358 }
1359
1360 data.dptr = TALLOC_ARRAY(ctx, uint8, len);
1361 data.dsize = len;
1362
1363 len = regdb_pack_values(values, data.dptr, data.dsize);
1364
1365 SMB_ASSERT( len == data.dsize );
1366
1367 keystr = talloc_asprintf(ctx, "%s/%s", REG_VALUE_PREFIX, key );
1368 if (!keystr) {
1369 goto done;
1370 }
1371 keystr = normalize_reg_path(ctx, keystr);
1372 if (!keystr) {
1373 goto done;
1374 }
1375
1376 old_data = dbwrap_fetch_bystring(regdb, ctx, keystr);
1377
1378 if ((old_data.dptr != NULL)
1379 && (old_data.dsize == data.dsize)
1380 && (memcmp(old_data.dptr, data.dptr, data.dsize) == 0))
1381 {
1382 result = true;
1383 goto done;
1384 }
1385
1386 status = dbwrap_trans_store_bystring(regdb, keystr, data, TDB_REPLACE);
1387
1388 result = NT_STATUS_IS_OK(status);
1389
1390 done:
1391 TALLOC_FREE(ctx);
1392 return result;
1393 }
1394
1395 static WERROR regdb_get_secdesc(TALLOC_CTX *mem_ctx, const char *key,
1396 struct security_descriptor **psecdesc)
1397 {
1398 char *tdbkey;
1399 TDB_DATA data;
1400 NTSTATUS status;
1401 TALLOC_CTX *tmp_ctx = talloc_stackframe();
1402 WERROR err = WERR_OK;
1403
1404 DEBUG(10, ("regdb_get_secdesc: Getting secdesc of key [%s]\n", key));
1405
1406 if (!regdb_key_exists(key)) {
1407 err = WERR_BADFILE;
1408 goto done;
1409 }
1410
1411 tdbkey = talloc_asprintf(tmp_ctx, "%s/%s", REG_SECDESC_PREFIX, key);
1412 if (tdbkey == NULL) {
1413 err = WERR_NOMEM;
1414 goto done;
1415 }
1416 normalize_dbkey(tdbkey);
1417
1418 data = dbwrap_fetch_bystring(regdb, tmp_ctx, tdbkey);
1419 if (data.dptr == NULL) {
1420 err = WERR_BADFILE;
1421 goto done;
1422 }
1423
1424 status = unmarshall_sec_desc(mem_ctx, (uint8 *)data.dptr, data.dsize,
1425 psecdesc);
1426
1427 if (NT_STATUS_EQUAL(status, NT_STATUS_NO_MEMORY)) {
1428 err = WERR_NOMEM;
1429 } else if (!NT_STATUS_IS_OK(status)) {
1430 err = WERR_REG_CORRUPT;
1431 }
1432
1433 done:
1434 TALLOC_FREE(tmp_ctx);
1435 return err;
1436 }
1437
1438 static WERROR regdb_set_secdesc(const char *key,
1439 struct security_descriptor *secdesc)
1440 {
1441 TALLOC_CTX *mem_ctx = talloc_stackframe();
1442 char *tdbkey;
1443 NTSTATUS status;
1444 WERROR err = WERR_NOMEM;
1445 TDB_DATA tdbdata;
1446
1447 if (!regdb_key_exists(key)) {
1448 err = WERR_BADFILE;
1449 goto done;
1450 }
1451
1452 tdbkey = talloc_asprintf(mem_ctx, "%s/%s", REG_SECDESC_PREFIX, key);
1453 if (tdbkey == NULL) {
1454 goto done;
1455 }
1456 normalize_dbkey(tdbkey);
1457
1458 if (secdesc == NULL) {
1459 /* assuming a delete */
1460 status = dbwrap_trans_delete_bystring(regdb, tdbkey);
1461 if (NT_STATUS_IS_OK(status)) {
1462 err = WERR_OK;
1463 } else {
1464 err = ntstatus_to_werror(status);
1465 }
1466 goto done;
1467 }
1468
1469 err = ntstatus_to_werror(marshall_sec_desc(mem_ctx, secdesc,
1470 &tdbdata.dptr,
1471 &tdbdata.dsize));
1472 if (!W_ERROR_IS_OK(err)) {
1473 goto done;
1474 }
1475
1476 status = dbwrap_trans_store_bystring(regdb, tdbkey, tdbdata, 0);
1477 if (!NT_STATUS_IS_OK(status)) {
1478 err = ntstatus_to_werror(status);
1479 goto done;
1480 }
1481
1482 done:
1483 TALLOC_FREE(mem_ctx);
1484 return err;
1485 }
1486
1487 bool regdb_subkeys_need_update(struct regsubkey_ctr *subkeys)
1488 {
1489 return (regdb_get_seqnum() != subkeys->seqnum);
1490 }
1491
1492 bool regdb_values_need_update(REGVAL_CTR *values)
1493 {
1494 return (regdb_get_seqnum() != values->seqnum);
1495 }
1496
1497 /*
1498 * Table of function pointers for default access
1499 */
1500
1501 REGISTRY_OPS regdb_ops = {
1502 .fetch_subkeys = regdb_fetch_keys,
1503 .fetch_values = regdb_fetch_values,
1504 .store_subkeys = regdb_store_keys,
1505 .store_values = regdb_store_values,
1506 .get_secdesc = regdb_get_secdesc,
1507 .set_secdesc = regdb_set_secdesc,
1508 .subkeys_need_update = regdb_subkeys_need_update,
1509 .values_need_update = regdb_values_need_update
1510 };