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