s3:net registry check: adapt to new semantic of dbwrap_fetch
[Samba/gebeck_regimport.git] / source3 / utils / net_registry_check.c
blobc51a2f02b96b1410a79b90d0e06b36bedf730575
1 /*
2 * Samba Unix/Linux SMB client library
4 * Copyright (C) Gregor Beck 2011
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 /**
21 * @brief Check the registry database.
22 * @author Gregor Beck <gb@sernet.de>
23 * @date Mar 2011
26 #include "net_registry_check.h"
28 #include "includes.h"
29 #include "system/filesys.h"
30 #include "lib/dbwrap/dbwrap.h"
31 #include "lib/dbwrap/dbwrap_open.h"
32 #include "lib/dbwrap/dbwrap_rbt.h"
33 #include "net.h"
34 #include "libcli/security/dom_sid.h"
35 #include "libcli/security/secdesc.h"
36 #include "cbuf.h"
37 #include "srprs.h"
38 #include <termios.h>
39 #include "util_tdb.h"
40 #include "registry/reg_db.h"
41 #include "libcli/registry/util_reg.h"
42 #include "registry/reg_parse_internal.h"
43 #include "interact.h"
46 check tree:
47 + every key has a subkeylist
48 + every key is referenced by the subkeylist of its parent
49 check path:
50 + starts with valid hive
51 + UTF-8 (option to convert ???)
52 + only uppercase
53 + separator ???
54 check value:
55 + REG_DWORD has size 4
56 + REG_QWORD has size 8
57 + STRINGS are zero terminated UTF-16
60 struct regval {
61 char *name;
62 uint32_t type;
63 DATA_BLOB data;
66 struct regkey {
67 char *name;
68 char *path;
69 bool has_subkeylist;
70 bool needs_update;
71 struct regkey *parent;
72 size_t nsubkeys;
73 struct regkey **subkeys;
74 size_t nvalues;
75 struct regval **values;
76 struct security_descriptor *sd;
79 struct check_ctx {
80 char *fname;
81 struct check_options opt;
83 uint32_t version;
84 char sep;
85 struct db_context *idb;
86 struct db_context *odb;
88 struct regkey *root; /*dummy key to hold all basekeys*/
89 struct db_context *reg;
90 struct db_context *del;
92 bool transaction;
93 char auto_action;
94 char default_action;
97 static void* talloc_array_append(void *mem_ctx, void* array[], void *ptr)
99 size_t size = array ? talloc_array_length(array) : 1;
100 void **tmp = talloc_realloc(mem_ctx, array, void*, size + 1);
101 if (tmp == NULL) {
102 talloc_free(array);
103 return NULL;
105 tmp[size-1] = ptr;
106 tmp[size] = NULL;
107 return tmp;
110 static void regkey_add_subkey(struct regkey *key, struct regkey *subkey)
112 key->subkeys = (struct regkey**)
113 talloc_array_append(key, (void**)key->subkeys, subkey);
114 if (key->subkeys != NULL) {
115 key->nsubkeys++;
119 static struct regval* regval_copy(TALLOC_CTX *mem_ctx, const struct regval *val)
121 struct regval *ret = talloc_zero(mem_ctx, struct regval);
122 if (ret == NULL) {
123 goto fail;
126 ret->name = talloc_strdup(ret, val->name);
127 if (ret->name == NULL) {
128 goto fail;
131 ret->data = data_blob_dup_talloc(ret, val->data);
132 if (ret->data.data == NULL) {
133 goto fail;
136 ret->type = val->type;
138 return ret;
139 fail:
140 talloc_free(ret);
141 return NULL;
144 static void regkey_add_regval(struct regkey *key, struct regval *val)
146 key->values = (struct regval**)
147 talloc_array_append(key, (void**)key->values, val);
148 if (key->values != NULL) {
149 key->nvalues++;
153 static bool tdb_data_read_uint32(TDB_DATA *buf, uint32_t *result)
155 const size_t len = sizeof(uint32_t);
156 if (buf->dsize >= len) {
157 *result = IVAL(buf->dptr, 0);
158 buf->dptr += len;
159 buf->dsize -= len;
160 return true;
162 return false;
165 static bool tdb_data_read_cstr(TDB_DATA *buf, char **result)
167 const size_t len = strnlen((char*)buf->dptr, buf->dsize) + 1;
168 if (buf->dsize >= len) {
169 *result = (char*)buf->dptr;
170 buf->dptr += len;
171 buf->dsize -= len;
172 return true;
174 return false;
177 static bool tdb_data_read_blob(TDB_DATA *buf, DATA_BLOB *result)
179 TDB_DATA tmp = *buf;
180 uint32_t len;
181 if (!tdb_data_read_uint32(&tmp, &len)) {
182 return false;
184 if (tmp.dsize >= len) {
185 *buf = tmp;
186 result->data = tmp.dptr;
187 result->length = len;
188 buf->dptr += len;
189 buf->dsize -= len;
190 return true;
192 return false;
195 static bool tdb_data_read_regval(TDB_DATA *buf, struct regval *result)
197 TDB_DATA tmp = *buf;
198 struct regval value;
199 if (!tdb_data_read_cstr(&tmp, &value.name)
200 || !tdb_data_read_uint32(&tmp, &value.type)
201 || !tdb_data_read_blob(&tmp, &value.data))
203 return false;
205 *buf = tmp;
206 *result = value;
207 return true;
210 static bool tdb_data_is_empty(TDB_DATA d) {
211 return (d.dptr == NULL) || (d.dsize == 0);
214 static bool tdb_data_is_cstr(TDB_DATA d) {
215 if (tdb_data_is_empty(d)) {
216 return false;
218 return (d.dptr[d.dsize-1] == '\0');
221 static char* tdb_data_print(TALLOC_CTX *mem_ctx, TDB_DATA d)
223 if (!tdb_data_is_empty(d)) {
224 char *ret = NULL;
225 cbuf *ost = cbuf_new(mem_ctx);
226 int len = cbuf_print_quoted(ost, (const char*)d.dptr, d.dsize);
227 if (len != -1) {
228 cbuf_swapptr(ost, &ret, 0);
229 talloc_steal(mem_ctx, ret);
231 talloc_free(ost);
232 return ret;
234 return talloc_strdup(mem_ctx, "<NULL>");
238 static TDB_DATA cbuf_make_tdb_data(cbuf *b)
240 return make_tdb_data((void*)cbuf_gets(b, 0), cbuf_getpos(b));
243 static void remove_all(char *str, char c)
245 char *out=str;
246 while (*str) {
247 if (*str != c) {
248 *out = *str;
249 out++;
251 str++;
253 *out = '\0';
256 static char* parent_path(const char *path, char sep)
258 const char *p = strrchr(path, sep);
259 return p ? talloc_strndup(talloc_tos(), path, p-path) : NULL;
262 /* return the regkey corresponding to path, create if not yet existing */
263 static struct regkey*
264 check_ctx_lookup_key(struct check_ctx *ctx, const char *path) {
265 struct regkey *ret = NULL;
266 NTSTATUS status;
267 TDB_DATA val;
269 if ( path == NULL) {
270 return ctx->root;
273 status = dbwrap_fetch(ctx->reg, ctx, string_term_tdb_data(path), &val);
274 if (!NT_STATUS_IS_OK(status)) {
275 return NULL;
277 if (val.dptr != NULL) {
278 if (ctx->opt.verbose) {
279 printf("Open: %s\n", path);
281 ret = *(struct regkey**)val.dptr;
282 } else {
283 /* not yet existing, create */
284 char *pp;
285 if (ctx->opt.verbose) {
286 printf("New: %s\n", path);
288 ret = talloc_zero(ctx, struct regkey);
289 if (ret == NULL) {
290 DEBUG(0, ("Out of memory!\n"));
291 goto done;
293 ret->path = talloc_strdup(ret, path);
295 pp = parent_path(path, ctx->sep);
296 ret->parent = check_ctx_lookup_key(ctx, pp);
297 regkey_add_subkey(ret->parent, ret);
298 TALLOC_FREE(pp);
300 /* the dummy root key has no subkeylist so set the name */
301 if (ret->parent == ctx->root) {
302 ret->name = talloc_strdup(ret, path);
305 dbwrap_store(ctx->reg, string_term_tdb_data(path),
306 make_tdb_data((void*)&ret, sizeof(ret)), 0);
308 done:
309 talloc_free(val.dptr);
310 return ret;
313 static struct check_ctx* check_ctx_create(TALLOC_CTX *mem_ctx, const char *db,
314 const struct check_options *opt)
316 struct check_ctx *ctx = talloc_zero(mem_ctx, struct check_ctx);
318 ctx->opt = *opt;
319 ctx->reg = db_open_rbt(ctx);
320 ctx->del = db_open_rbt(ctx);
321 ctx->root = talloc_zero(ctx, struct regkey);
322 ctx->fname = talloc_strdup(ctx, db);
324 if (opt->automatic && (opt->output == NULL)) {
325 ctx->opt.repair = true;
326 ctx->opt.output = ctx->fname;
329 if (opt->repair) {
330 if (opt->output) {
331 d_fprintf(stderr, "You can not specify --output "
332 "with --repair\n");
333 goto fail;
334 } else {
335 ctx->opt.output = ctx->fname;
339 ctx->default_action = 'r';
340 return ctx;
341 fail:
342 talloc_free(ctx);
343 return NULL;
346 static bool check_ctx_open_output(struct check_ctx *ctx)
348 int oflags = O_RDWR | O_CREAT ;
350 if (ctx->opt.output == NULL) {
351 return true;
354 if (!ctx->opt.repair) {
355 if (!ctx->opt.wipe) {
356 oflags |= O_EXCL;
358 ctx->opt.wipe = true;
361 ctx->odb = db_open(ctx, ctx->opt.output, 0, TDB_DEFAULT, oflags, 0644);
362 if (ctx->odb == NULL) {
363 d_fprintf(stderr,
364 _("Could not open db (%s) for writing: %s\n"),
365 ctx->opt.output, strerror(errno));
366 return false;
368 return true;
372 static bool check_ctx_open_input(struct check_ctx *ctx) {
373 ctx->idb = db_open(ctx, ctx->fname, 0, TDB_DEFAULT, O_RDONLY, 0);
374 if (ctx->idb == NULL) {
375 d_fprintf(stderr,
376 _("Could not open db (%s) for reading: %s\n"),
377 ctx->fname, strerror(errno));
378 return false;
380 return true;
383 static bool check_ctx_transaction_start(struct check_ctx *ctx) {
384 if (ctx->odb == NULL) {
385 return true;
387 if (dbwrap_transaction_start(ctx->odb) != 0) {
388 DEBUG(0, ("transaction_start failed\n"));
389 return false;
391 ctx->transaction = true;
392 return true;
395 static void check_ctx_transaction_stop(struct check_ctx *ctx, bool ok) {
396 if (!ctx->transaction) {
397 return;
399 if (!ctx->opt.test && ok) {
400 d_printf("Commiting changes\n");
401 if (dbwrap_transaction_commit(ctx->odb) != 0) {
402 DEBUG(0, ("transaction_commit failed\n"));
404 } else {
405 d_printf("Discarding changes\n");
406 dbwrap_transaction_cancel(ctx->odb);
410 static bool read_info(struct check_ctx *ctx, const char *key, TDB_DATA val)
412 if (val.dsize==sizeof(uint32_t) && strcmp(key, "version")==0) {
413 uint32_t v = IVAL(val.dptr, 0);
414 printf("INFO: %s = %d\n", key, v);
415 return true;
417 printf("INFO: %s = <invalid>\n", key);
418 return false;
421 static bool is_all_upper(const char *str) {
422 bool ret;
423 char *tmp = talloc_strdup(talloc_tos(), str);
424 strupper_m(tmp);
425 ret = (strcmp(tmp, str) == 0);
426 talloc_free(tmp);
427 return ret;
430 static void move_to_back(struct regkey *key, struct regkey *subkey)
432 struct regkey **ptr;
433 size_t nidx;
435 DEBUG(5, ("Move to back subkey \"%s\" of \"%s\"\n",
436 subkey->path, key->path));
438 for (ptr=key->subkeys; *ptr != subkey; ptr++)
441 nidx = ptr + 1 - key->subkeys;
442 memmove(ptr, ptr+1, (key->nsubkeys - nidx) * sizeof(*ptr));
444 key->subkeys[key->nsubkeys-1] = subkey;
447 static void set_subkey_name(struct check_ctx *ctx, struct regkey *key,
448 const char *name, int nlen)
450 char *path = key->path;
451 TALLOC_CTX *mem_ctx = talloc_new(talloc_tos());
452 char *p;
453 struct regkey *subkey;
454 char *nname = talloc_strndup(mem_ctx, name, nlen);
455 remove_all(nname, ctx->sep);
457 if (strncmp(name, nname, nlen) != 0) {
458 /* XXX interaction: delete/edit */
459 printf("Warning: invalid name: \"%s\" replace with \"%s\"\n",
460 name, nname);
461 key->needs_update = true;
463 p = talloc_asprintf_strupper_m(mem_ctx, "%s%c%s",
464 path, ctx->sep, nname);
465 subkey = check_ctx_lookup_key(ctx, p);
466 if (subkey->name) {
467 bool do_replace = false;
469 if (strcmp(subkey->name, nname) != 0) {
470 int action;
471 char default_action;
473 if (is_all_upper(nname)) {
474 default_action = 'o';
475 } else {
476 default_action = 'n';
479 printf("Conflicting subkey names of [%s]: "
480 "old: \"%s\", new: \"%s\"\n",
481 key->path, subkey->name, nname);
483 if (ctx->opt.output == NULL || ctx->opt.automatic) {
484 action = default_action;
485 } else {
486 do {
487 action = interact_prompt(
488 "choose spelling [o]ld, [n]ew,"
489 "or [e]dit", "one",
490 default_action);
491 if (action == 'e') {
492 printf("Sorry, edit is not yet "
493 "implemented here...\n");
495 } while (action == 'e');
498 if (action == 'n') {
499 do_replace = true;
503 if (do_replace) {
504 if (ctx->opt.verbose) {
505 printf("Replacing name: %s: \"%s\""
506 " -> \"%s\"\n", path,
507 subkey->name, nname);
509 TALLOC_FREE(subkey->name);
510 subkey->name = talloc_steal(subkey, nname);
511 key->needs_update = true;
513 } else {
514 if (ctx->opt.verbose) {
515 printf("Set name: %s: \"%s\"\n", path, nname);
517 subkey->name = talloc_steal(subkey, nname);
520 move_to_back(key, subkey);
521 TALLOC_FREE(mem_ctx);
524 static void
525 read_subkeys(struct check_ctx *ctx, const char *path, TDB_DATA val, bool update)
527 uint32_t num_items, found_items = 0;
528 char *subkey;
529 struct regkey *key = check_ctx_lookup_key(ctx, path);
531 key->needs_update |= update;
533 /* printf("SUBKEYS: %s\n", path); */
534 if (key->has_subkeylist) {
535 printf("Duplicate subkeylist \"%s\"\n",
536 path);
537 found_items = key->nsubkeys;
540 /* exists as defined by regdb_key_exists() */
541 key->has_subkeylist = true;
543 /* name is set if a key is referenced by the */
544 /* subkeylist of its parent. */
546 if (!tdb_data_read_uint32(&val, &num_items) ) {
547 printf("Invalid subkeylist: \"%s\"\n", path);
548 return;
551 while (tdb_data_read_cstr(&val, &subkey)) {
552 /* printf(" SUBKEY: %s\n", subkey); */
553 set_subkey_name(ctx, key, subkey, strlen(subkey));
554 found_items++;
557 if (val.dsize != 0) {
558 printf("Subkeylist of \"%s\": trailing: \"%.*s\"\n",
559 path, (int)val.dsize, val.dptr);
560 /* ask: best effort, delete or edit?*/
561 set_subkey_name(ctx, key, (char*)val.dptr, val.dsize);
562 found_items++;
563 key->needs_update = true;
566 if (num_items != found_items) {
567 printf("Subkeylist of \"%s\": invalid number of subkeys, "
568 "expected: %d got: %d\n", path, num_items, found_items);
569 key->needs_update = true;
574 static void read_values(struct check_ctx *ctx, const char *path, TDB_DATA val)
576 struct regkey *key = check_ctx_lookup_key(ctx, path);
577 uint32_t num_items, found_items;
578 struct regval value;
580 /* printf("VALUES: %s\n", path); */
582 if (!tdb_data_read_uint32(&val, &num_items) ) {
583 printf("Invalid valuelist: \"%s\"\n", path);
584 return;
587 found_items=0;
588 while (tdb_data_read_regval(&val, &value)) {
589 /* printf(" VAL: %s type: %s(%d) length: %d\n", value.name, */
590 /* str_regtype(value.type), value.type, */
591 /* (int)value.data.length); */
592 regkey_add_regval(key, regval_copy(key, &value));
593 found_items++;
596 if (num_items != found_items) {
597 printf("Valuelist of \"%s\": invalid number of values, "
598 "expected: %d got: %d\n", path, num_items, found_items);
599 key->needs_update = true;
602 if (val.dsize != 0) {
603 printf("Valuelist of \"%s\": trailing: \"%*s\"\n", path,
604 (int)val.dsize, val.dptr);
605 key->needs_update = true;
606 /* XXX best effort ??? */
607 /* ZERO_STRUCT(value); */
608 /* if (tdb_data_read_cstr(&val, &value.name) */
609 /* && tdb_data_read_uint32(&val, &value.type)) */
610 /* { */
611 /* uint32_t len = -1; */
612 /* tdb_data_read_uint32(&val, &len); */
613 /* ... */
614 /* found_items ++; */
615 /* regkey_add_regval(key, regval_copy(key, value)); */
616 /* } */
618 if (found_items == 0) {
619 printf("Valuelist of \"%s\" empty\n", path);
620 key->needs_update = true;
624 static bool read_sorted(struct check_ctx *ctx, const char *path, TDB_DATA val)
626 if (ctx->version >= 3) {
627 return false;
630 if ((val.dptr == NULL) || (val.dsize<4)) {
631 return false;
634 /* ToDo: check */
635 /* struct regkey *key = check_ctx_lookup_key(ctx, path); */
636 /* printf("SORTED: %s\n", path); */
637 return true;
640 static bool read_sd(struct check_ctx *ctx, const char *path, TDB_DATA val)
642 NTSTATUS status;
643 struct regkey *key = check_ctx_lookup_key(ctx, path);
644 /* printf("SD: %s\n", path); */
646 status = unmarshall_sec_desc(key, val.dptr, val.dsize, &key->sd);
647 if (!NT_STATUS_IS_OK(status)) {
648 DEBUG(0, ("Failed to read SD of %s: %s\n",
649 path, nt_errstr(status)));
651 return true;
654 static bool srprs_path(const char **ptr, const char* prefix, char sep,
655 const char **ppath)
657 const char *path, *pos = *ptr;
658 if (prefix != NULL) {
659 if (!srprs_str(&pos, prefix, -1) || !srprs_char(&pos, sep) ) {
660 return false;
663 path = pos;
664 if ( !srprs_hive(&pos, NULL) ) {
665 return false;
667 if ( !srprs_eos(&pos) && !srprs_char(&pos, sep) ) {
668 return false;
670 *ppath = path;
671 /* We know pos ends in '\0'. */
672 *ptr = &pos[strlen(pos)];
673 return true;
676 /* Fixme: this dosn't work in the general multibyte char case.
677 see string_replace()
679 static bool normalize_path_internal(char* path, char sep) {
680 size_t len = strlen(path);
681 const char *orig = talloc_strndup(talloc_tos(), path, len);
682 char *optr = path, *iptr = path;
683 bool changed;
685 while (*iptr == sep ) {
686 iptr++;
688 while (*iptr) {
689 *optr = *iptr;
690 if (*iptr == sep) {
691 while (*iptr == sep) {
692 iptr++;
694 if (*iptr) {
695 optr++;
697 } else {
698 iptr++;
699 optr++;
702 *optr = '\0';
704 strupper_m(path);
705 changed = (strcmp(orig, path) != 0);
706 talloc_free(discard_const(orig));
707 return changed;
710 static bool normalize_path(char* path, char sep) {
711 static const char* SEPS = "\\/";
712 char* firstsep = strpbrk(path, SEPS);
713 bool wrong_sep = (firstsep && (*firstsep != sep));
715 assert (strchr(SEPS, sep));
717 if (wrong_sep) {
718 string_replace(path, *firstsep, sep);
720 return normalize_path_internal(path, sep) || wrong_sep;
723 static int check_tdb_action(struct db_record *rec, void *check_ctx)
725 struct check_ctx *ctx = (struct check_ctx*)check_ctx;
726 TALLOC_CTX *frame = talloc_stackframe();
727 TDB_DATA val = dbwrap_record_get_value(rec);
728 TDB_DATA rec_key = dbwrap_record_get_key(rec);
729 char *key;
730 bool invalid_path = false;
731 bool once_more;
732 bool first_iter = true;
734 if (!tdb_data_is_cstr(rec_key)) {
735 printf("Key is not zero terminated: \"%.*s\"\ntry to go on.\n",
736 (int)rec_key.dsize, rec_key.dptr);
737 invalid_path = true;
739 key = talloc_strndup(frame, (char*)rec_key.dptr, rec_key.dsize);
741 do {
742 const char *path, *pos = key;
743 once_more = false;
745 if (srprs_str(&pos, "INFO/", -1)) {
746 if ( read_info(ctx, pos, val) ) {
747 break;
749 invalid_path = true;
750 /* ask: mark invalid */
751 } else if (srprs_str(&pos, "__db_sequence_number__", -1)) {
752 printf("Skip key: \"%.*s\"\n",
753 (int)rec_key.dsize, rec_key.dptr);
754 /* skip: do nothing + break */
755 break;
757 } else if (normalize_path(key, ctx->sep)) {
758 printf("Unnormal key: \"%.*s\"\n",
759 (int)rec_key.dsize, rec_key.dptr);
760 printf("Normalize to: \"%s\"\n", key);
761 invalid_path = true;
762 } else if (srprs_path(&pos, NULL,
763 ctx->sep, &path))
765 read_subkeys(ctx, path, val, invalid_path);
766 break;
767 } else if (srprs_path(&pos, REG_VALUE_PREFIX,
768 ctx->sep, &path))
770 read_values(ctx, path, val);
771 break;
772 } else if (srprs_path(&pos, REG_SECDESC_PREFIX,
773 ctx->sep, &path))
775 read_sd(ctx, path, val);
776 break;
777 } else if (srprs_path(&pos, REG_SORTED_SUBKEYS_PREFIX,
778 ctx->sep, &path))
780 if (!read_sorted(ctx, path, val)) {
781 /* delete: mark invalid + break */
782 printf("Invalid sorted subkeys for: \"%s\"\n", path);
783 invalid_path = true;
784 key = NULL;
786 break;
787 } else {
788 printf("Unrecognized key: \"%.*s\"\n",
789 (int)rec_key.dsize, rec_key.dptr);
790 invalid_path = true;
793 if (invalid_path) {
794 int action;
795 if (ctx->opt.output == NULL) {
796 action = first_iter ? 'r' : 's';
797 } else if (ctx->opt.automatic) {
798 action = first_iter ? 'r' : 'd';
799 } else if (ctx->auto_action != '\0') {
800 action = ctx->auto_action;
801 } else {
802 action = interact_prompt("[s]kip,[S]kip all,"
803 "[d]elete,[D]elete all"
804 ",[e]dit,[r]etry"
805 , "sder",
806 ctx->default_action);
808 if (isupper(action)) {
809 action = tolower(action);
810 ctx->auto_action = action;
812 ctx->default_action = action;
813 switch (action) {
814 case 's': /* skip */
815 invalid_path = false;
816 break;
817 case 'd': /* delete */
818 invalid_path = true;
819 key = NULL;
820 break;
821 case 'e': /* edit */ {
822 char *p = interact_edit(frame, key);
823 if (p) {
824 talloc_free(key);
825 key = p;
827 } /* fall through */
828 case 'r': /* retry */
829 once_more = true;
830 break;
833 first_iter = false;
834 } while (once_more);
836 if (invalid_path) {
837 dbwrap_store(ctx->del, rec_key, string_term_tdb_data(key), 0);
840 talloc_free(frame);
841 return 0;
844 static bool get_version(struct check_ctx *ctx) {
845 static const uint32_t curr_version = REGDB_CODE_VERSION;
846 uint32_t version = ctx->opt.version ? ctx->opt.version : curr_version;
847 uint32_t info_version = 0;
848 NTSTATUS status;
850 status = dbwrap_fetch_uint32(ctx->idb, "INFO/version", &info_version);
851 if (!NT_STATUS_IS_OK(status)) {
852 printf("Warning: no INFO/version found!\n");
853 /* info_version = guess_version(ctx); */
856 if (ctx->opt.version) {
857 version = ctx->opt.version;
858 } else if (ctx->opt.implicit_db) {
859 version = curr_version;
860 } else {
861 version = info_version;
864 if (!version) {
865 printf("Couldn't determine registry format version, "
866 "specify with --reg-version\n");
867 return false;
871 if ( version != info_version ) {
872 if (ctx->opt.force || !ctx->opt.repair) {
873 printf("Warning: overwrite registry format "
874 "version %d with %d\n", info_version, version);
875 } else {
876 printf("Warning: found registry format version %d but "
877 "expected %d, use --force to proceed.\n", info_version, version);
878 return false;
882 ctx->version = version;
883 ctx->sep = (version > 1) ? '\\' : '/';
885 return true;
888 static bool
889 dbwrap_store_verbose(struct db_context *db, const char *key, TDB_DATA nval)
891 TALLOC_CTX *mem_ctx = talloc_new(talloc_tos());
892 TDB_DATA oval;
893 NTSTATUS status;
895 status = dbwrap_fetch_bystring(db, mem_ctx, key, &oval);
896 if (NT_STATUS_IS_OK(status)) {
897 if (tdb_data_equal(nval, oval)) {
898 goto done;
900 printf("store %s:\n overwrite: %s\n with: %s\n", key,
901 tdb_data_print(mem_ctx, oval),
902 tdb_data_print(mem_ctx, nval));
904 } else if (NT_STATUS_EQUAL(status, NT_STATUS_NOT_FOUND)) {
905 printf("store %s:\n write: %s\n", key,
906 tdb_data_print(mem_ctx, nval));
907 } else {
908 printf ("store %s:\n failed to fetch old value: %s\n", key,
909 nt_errstr(status));
910 goto done;
913 status = dbwrap_store_bystring(db, key, nval, 0);
914 if (!NT_STATUS_IS_OK(status)) {
915 printf ("store %s failed: %s\n", key, nt_errstr(status));
918 done:
919 talloc_free(mem_ctx);
920 return NT_STATUS_IS_OK(status);
923 static bool
924 dbwrap_store_uint32_verbose(struct db_context *db, const char *key, uint32_t nval)
926 uint32_t oval;
927 NTSTATUS status;
929 status = dbwrap_fetch_uint32(db, key, &oval);
930 if (NT_STATUS_IS_OK(status)) {
931 if (nval == oval) {
932 goto done;
934 printf("store %s:\n overwrite: %d\n with: %d\n", key,
935 (int)oval, (int)nval);
937 } else if (NT_STATUS_EQUAL(status, NT_STATUS_NOT_FOUND)) {
938 printf("store %s:\n write: %d\n", key, (int)nval);
939 } else {
940 printf ("store %s:\n failed to fetch old value: %s\n", key,
941 nt_errstr(status));
942 goto done;
945 status = dbwrap_store_uint32(db, key, nval);
946 if (!NT_STATUS_IS_OK(status)) {
947 printf ("store %s failed: %s\n", key, nt_errstr(status));
950 done:
951 return NT_STATUS_IS_OK(status);
954 static int cmp_keynames(char **p1, char **p2)
956 return strcasecmp_m(*p1, *p2);
959 static bool
960 write_subkeylist(struct db_context *db, struct regkey *key, char sep)
962 cbuf *buf = cbuf_new(talloc_tos());
963 int i;
964 bool ret;
966 cbuf_putdw(buf, key->nsubkeys);
968 for (i=0; i < key->nsubkeys; i++) {
969 struct regkey *subkey = key->subkeys[i];
970 const char *name = subkey->name;
971 if (name == NULL) {
972 printf("Warning: no explicite name for key %s\n",
973 subkey->path);
974 name = strrchr_m(subkey->path, sep);
975 assert(name);
976 name ++;
978 cbuf_puts(buf, name, -1);
979 cbuf_putc(buf, '\0');
982 ret = dbwrap_store_verbose(db, key->path, cbuf_make_tdb_data(buf));
984 talloc_free(buf);
985 return ret;
988 static bool write_sorted(struct db_context *db, struct regkey *key, char sep)
990 cbuf *buf = cbuf_new(talloc_tos());
991 char *path;
992 int i;
993 bool ret = false;
994 char **sorted = talloc_zero_array(buf, char*, key->nsubkeys);
995 int offset = (1 + key->nsubkeys) * sizeof(uint32_t);
997 for (i=0; i < key->nsubkeys; i++) {
998 sorted[i] = talloc_strdup_upper(sorted, key->subkeys[i]->name);
1000 TYPESAFE_QSORT(sorted, key->nsubkeys, cmp_keynames);
1002 cbuf_putdw(buf, key->nsubkeys);
1003 for (i=0; i < key->nsubkeys; i++) {
1004 cbuf_putdw(buf, offset);
1005 offset += strlen(sorted[i]) + 1;
1007 for (i=0; i < key->nsubkeys; i++) {
1008 cbuf_puts(buf, sorted[i], -1);
1009 cbuf_putc(buf, '\0');
1012 path = talloc_asprintf(buf, "%s%c%s", REG_SORTED_SUBKEYS_PREFIX, sep,
1013 key->path);
1014 if (path == NULL) {
1015 DEBUG(0, ("Out of memory!\n"));
1016 goto done;
1019 ret = dbwrap_store_verbose(db, path, cbuf_make_tdb_data(buf));
1020 done:
1021 talloc_free(buf);
1022 return ret;
1025 static bool write_values(struct db_context *db, struct regkey *key, char sep)
1027 cbuf *buf = cbuf_new(talloc_tos());
1028 char *path;
1029 int i;
1030 bool ret = false;
1032 cbuf_putdw(buf, key->nvalues);
1033 for (i=0; i < key->nvalues; i++) {
1034 struct regval *val = key->values[i];
1035 cbuf_puts(buf, val->name, -1);
1036 cbuf_putc(buf, '\0');
1037 cbuf_putdw(buf, val->type);
1038 cbuf_putdw(buf, val->data.length);
1039 cbuf_puts(buf, (void*)val->data.data, val->data.length);
1042 path = talloc_asprintf(buf, "%s%c%s", REG_VALUE_PREFIX, sep, key->path);
1043 if (path == NULL) {
1044 DEBUG(0, ("Out of memory!\n"));
1045 goto done;
1048 ret = dbwrap_store_verbose(db, path, cbuf_make_tdb_data(buf));
1049 done:
1050 talloc_free(buf);
1051 return ret;
1054 static bool write_sd(struct db_context *db, struct regkey *key, char sep)
1056 TDB_DATA sd;
1057 NTSTATUS status;
1058 char *path;
1059 bool ret = false;
1060 TALLOC_CTX *mem_ctx = talloc_new(talloc_tos());
1062 status = marshall_sec_desc(mem_ctx, key->sd, &sd.dptr, &sd.dsize);
1063 if (!NT_STATUS_IS_OK(status)) {
1064 printf("marshall sec desc %s failed: %s\n",
1065 key->path, nt_errstr(status));
1066 goto done;
1068 path = talloc_asprintf(mem_ctx, "%s%c%s", REG_SECDESC_PREFIX,
1069 sep, key->path);
1070 if (path == NULL) {
1071 DEBUG(0, ("Out of memory!\n"));
1072 goto done;
1075 ret = dbwrap_store_verbose(db, path, sd);
1076 done:
1077 talloc_free(mem_ctx);
1078 return ret;
1082 static int check_write_db_action(struct db_record *rec, void *check_ctx)
1084 struct check_ctx *ctx = (struct check_ctx*)check_ctx;
1085 TDB_DATA rec_val = dbwrap_record_get_value(rec);
1086 struct regkey *key = *(struct regkey**)rec_val.dptr;
1087 TALLOC_CTX *frame = talloc_stackframe();
1089 /* write subkeylist */
1090 if ((ctx->version > 2) || (key->nsubkeys > 0) || (key->has_subkeylist)) {
1091 write_subkeylist(ctx->odb, key, ctx->sep);
1094 /* write sorted subkeys */
1095 if ((ctx->version < 3) && (key->nsubkeys > 0)) {
1096 write_sorted(ctx->odb, key, ctx->sep);
1099 /* write value list */
1100 if (key->nvalues > 0) {
1101 write_values(ctx->odb, key, ctx->sep);
1104 /* write sd */
1105 if (key->sd) {
1106 write_sd(ctx->odb, key, ctx->sep);
1109 talloc_free(frame);
1110 return 0;
1113 static int fix_tree_action(struct db_record *rec, void *check_ctx)
1115 struct check_ctx *ctx = (struct check_ctx*)check_ctx;
1116 TDB_DATA rec_key = dbwrap_record_get_key(rec);
1117 TDB_DATA rec_val = dbwrap_record_get_value(rec);
1118 struct regkey* key = *(struct regkey**)rec_val.dptr;
1119 if (ctx->opt.verbose) {
1120 printf("Check Tree: %s\n", key->path);
1123 assert (strncmp(key->path, (char*)rec_key.dptr, rec_key.dsize) == 0);
1125 /* assert(dbwrap_exists(ctx->db, string_term_tdb_data(key->path)) */
1126 /* == key->exists); */
1128 if (key->needs_update) {
1129 printf("Update key: \"%s\"\n", key->path);
1130 if ((ctx->version > 2) || (key->nsubkeys > 0)) {
1131 write_subkeylist(ctx->odb, key, ctx->sep);
1133 if ((ctx->version <= 2) && (key->nsubkeys > 0)) {
1134 write_sorted(ctx->odb, key, ctx->sep);
1136 if (key->nvalues > 0) {
1137 write_values(ctx->odb, key, ctx->sep);
1139 if (key->sd) {
1140 write_sd(ctx->odb, key, ctx->sep);
1142 } else if (!key->has_subkeylist) {
1143 if ((ctx->version > 2) || (key->nsubkeys > 0)) {
1144 printf("Missing subkeylist: %s\n", key->path);
1145 write_subkeylist(ctx->odb, key, ctx->sep);
1149 if (key->name == NULL && key->parent->has_subkeylist) {
1150 printf("Key not referenced by the its parents subkeylist: %s\n",
1151 key->path);
1152 write_subkeylist(ctx->odb, key->parent, ctx->sep);
1155 /* XXX check that upcase(name) matches last part of path ??? */
1157 return 0;
1161 /* give the same warnings as fix_tree_action */
1162 static int check_tree_action(struct db_record *rec, void *check_ctx)
1164 struct check_ctx *ctx = (struct check_ctx*)check_ctx;
1165 TDB_DATA rec_key = dbwrap_record_get_key(rec);
1166 TDB_DATA rec_val = dbwrap_record_get_value(rec);
1167 struct regkey* key = *(struct regkey**)rec_val.dptr;
1168 if (ctx->opt.verbose) {
1169 printf("Check Tree: %s\n", key->path);
1172 assert (strncmp(key->path, (char*)rec_key.dptr, rec_key.dsize) == 0);
1174 if (!key->has_subkeylist) {
1175 if ((ctx->version > 2) || (key->nsubkeys > 0)) {
1176 printf("Missing subkeylist: %s\n", key->path);
1180 if (key->name == NULL && key->parent->has_subkeylist) {
1181 printf("Key not referenced by the its parents subkeylist: %s\n",
1182 key->path);
1185 return 0;
1188 static int delete_invalid_action(struct db_record *rec, void* check_ctx)
1190 NTSTATUS status;
1191 struct check_ctx *ctx = (struct check_ctx*)check_ctx;
1192 TDB_DATA rec_key = dbwrap_record_get_key(rec);
1193 TDB_DATA rec_val = dbwrap_record_get_value(rec);
1196 printf("Delete key: \"%.*s\"",(int)rec_key.dsize, rec_key.dptr);
1197 if (rec_val.dsize > 0) {
1198 printf(" in favour of \"%s\"\n", rec_val.dptr);
1199 } else {
1200 putc('\n', stdout);
1203 status = dbwrap_delete(ctx->odb, rec_key);
1204 if (!NT_STATUS_IS_OK(status)) {
1205 d_printf("delete key \"%.*s\" failed!\n",
1206 (int)rec_key.dsize, rec_key.dptr);
1207 return -1;
1209 return 0;
1212 static bool check_ctx_check_tree(struct check_ctx *ctx) {
1213 NTSTATUS status;
1215 status = dbwrap_traverse(ctx->reg, check_tree_action, ctx, NULL);
1216 if (!NT_STATUS_IS_OK(status)) {
1217 DEBUG(0, ("check traverse failed: %s\n",
1218 nt_errstr(status)));
1219 return false;
1221 return true;
1223 static bool check_ctx_fix_inplace(struct check_ctx *ctx) {
1224 NTSTATUS status;
1225 status = dbwrap_traverse(ctx->reg, fix_tree_action, ctx, NULL);
1226 if (!NT_STATUS_IS_OK(status)) {
1227 DEBUG(0, ("fix traverse failed: %s\n", nt_errstr(status)));
1228 return false;
1231 status = dbwrap_traverse(ctx->del, delete_invalid_action, ctx, NULL);
1232 if (!NT_STATUS_IS_OK(status)) {
1233 DEBUG(0, ("delete traverse failed: %s\n", nt_errstr(status)));
1234 return false;
1237 if (!dbwrap_store_uint32_verbose(ctx->odb, "INFO/version", ctx->version)) {
1238 DEBUG(0, ("storing version failed: %s\n", nt_errstr(status)));
1239 return false;
1242 return true;
1245 static bool check_ctx_write_new_db(struct check_ctx *ctx) {
1246 NTSTATUS status;
1248 assert(ctx->odb);
1250 if (ctx->opt.wipe) {
1251 int ret = dbwrap_wipe(ctx->odb);
1252 if (ret != 0) {
1253 DEBUG(0, ("wiping %s failed\n", ctx->opt.output));
1254 return false;
1258 status = dbwrap_traverse(ctx->reg, check_write_db_action, ctx, NULL);
1259 if (!NT_STATUS_IS_OK(status)) {
1260 DEBUG(0, ("traverse2 failed: %s\n", nt_errstr(status)));
1261 return false;
1264 status = dbwrap_store_uint32(ctx->odb,
1265 "INFO/version", ctx->version);
1266 if (!NT_STATUS_IS_OK(status)) {
1267 DEBUG(0, ("write version failed: %s\n", nt_errstr(status)));
1268 return false;
1270 return true;
1273 int net_registry_check_db(const char *name, const struct check_options *opt)
1275 NTSTATUS status;
1276 int ret = -1;
1277 struct check_ctx *ctx = check_ctx_create(talloc_tos(), name, opt);
1278 if (ctx==NULL) {
1279 goto done;
1282 d_printf("Check database: %s\n", name);
1284 /* 1. open output RW */
1285 if (!check_ctx_open_output(ctx)) {
1286 goto done;
1289 /* 2. open input RO */
1290 if (!check_ctx_open_input(ctx)) {
1291 goto done;
1294 if (opt->lock && !check_ctx_transaction_start(ctx)) {
1295 goto done;
1298 if (!get_version(ctx)) {
1299 goto done;
1302 status = dbwrap_traverse_read(ctx->idb, check_tdb_action, ctx, NULL);
1303 if (!NT_STATUS_IS_OK(status)) {
1304 DEBUG(0, ("check traverse failed: %s\n", nt_errstr(status)));
1305 goto done;
1308 if (!opt->lock && !check_ctx_transaction_start(ctx)) {
1309 goto done;
1312 if (ctx->opt.repair && !ctx->opt.wipe) {
1313 if (!check_ctx_fix_inplace(ctx)) {
1314 goto done;
1316 } else {
1317 if (!check_ctx_check_tree(ctx)) {
1318 goto done;
1320 if (ctx->odb) {
1321 if (!check_ctx_write_new_db(ctx)) {
1322 goto done;
1326 ret = 0;
1327 done:
1328 check_ctx_transaction_stop(ctx, ret == 0);
1330 talloc_free(ctx);
1331 return ret;
1334 /*Local Variables:*/
1335 /*mode: c*/
1336 /*End:*/