1 /* hivex - Windows Registry "hive" extraction library.
2 * Copyright (C) 2009-2010 Red Hat Inc.
3 * Derived from code by Petter Nordahl-Hagen under a compatible license:
4 * Copyright (c) 1997-2007 Petter Nordahl-Hagen.
5 * Derived from code by Markus Stephany under a compatible license:
6 * Copyright (c) 2000-2004, Markus Stephany.
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation;
11 * version 2.1 of the License.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * See file LICENSE for the full license.
37 #include "full-read.h"
38 #include "full-write.h"
44 #define STREQ(a,b) (strcmp((a),(b)) == 0)
45 #define STRCASEEQ(a,b) (strcasecmp((a),(b)) == 0)
46 //#define STRNEQ(a,b) (strcmp((a),(b)) != 0)
47 //#define STRCASENEQ(a,b) (strcasecmp((a),(b)) != 0)
48 #define STREQLEN(a,b,n) (strncmp((a),(b),(n)) == 0)
49 //#define STRCASEEQLEN(a,b,n) (strncasecmp((a),(b),(n)) == 0)
50 //#define STRNEQLEN(a,b,n) (strncmp((a),(b),(n)) != 0)
51 //#define STRCASENEQLEN(a,b,n) (strncasecmp((a),(b),(n)) != 0)
52 //#define STRPREFIX(a,b) (strncmp((a),(b),strlen((b))) == 0)
55 #include "byte_conversions.h"
57 static char *windows_utf16_to_utf8 (/* const */ char *input, size_t len);
66 /* Registry file, memory mapped if read-only, or malloc'd if writing. */
69 struct ntreg_header *hdr;
72 /* Use a bitmap to store which file offsets are valid (point to a
73 * used block). We only need to store 1 bit per 32 bits of the file
74 * (because blocks are 4-byte aligned). We found that the average
75 * block size in a registry file is ~50 bytes. So roughly 1 in 12
76 * bits in the bitmap will be set, making it likely a more efficient
77 * structure than a hash table.
80 #define BITMAP_SET(bitmap,off) (bitmap[(off)>>5] |= 1 << (((off)>>2)&7))
81 #define BITMAP_CLR(bitmap,off) (bitmap[(off)>>5] &= ~ (1 << (((off)>>2)&7)))
82 #define BITMAP_TST(bitmap,off) (bitmap[(off)>>5] & (1 << (((off)>>2)&7)))
83 #define IS_VALID_BLOCK(h,off) \
84 (((off) & 3) == 0 && \
86 (off) < (h)->size && \
87 BITMAP_TST((h)->bitmap,(off)))
89 /* Fields from the header, extracted from little-endianness hell. */
90 size_t rootoffs; /* Root key offset (always an nk-block). */
91 size_t endpages; /* Offset of end of pages. */
94 size_t endblocks; /* Offset to next block allocation (0
95 if not allocated anything yet). */
98 /* NB. All fields are little endian. */
100 char magic[4]; /* "regf" */
103 char last_modified[8];
104 uint32_t major_ver; /* 1 */
105 uint32_t minor_ver; /* 3 */
106 uint32_t unknown5; /* 0 */
107 uint32_t unknown6; /* 1 */
108 uint32_t offset; /* offset of root key record - 4KB */
109 uint32_t blocks; /* pointer AFTER last hbin in file - 4KB */
110 uint32_t unknown7; /* 1 */
112 char name[64]; /* original file name of hive */
113 char unknown_guid1[16];
114 char unknown_guid2[16];
117 char unknown_guid3[16];
122 uint32_t csum; /* checksum: xor of dwords 0-0x1fb. */
124 char unknown11[3528];
126 char unknown_guid4[16];
127 char unknown_guid5[16];
128 char unknown_guid6[16];
132 } __attribute__((__packed__));
134 struct ntreg_hbin_page {
135 char magic[4]; /* "hbin" */
136 uint32_t offset_first; /* offset from 1st block */
137 uint32_t page_size; /* size of this page (multiple of 4KB) */
139 /* Linked list of blocks follows here. */
140 } __attribute__((__packed__));
142 struct ntreg_hbin_block {
143 int32_t seg_len; /* length of this block (-ve for used block) */
144 char id[2]; /* the block type (eg. "nk" for nk record) */
145 /* Block data follows here. */
146 } __attribute__((__packed__));
148 #define BLOCK_ID_EQ(h,offs,eqid) \
149 (STREQLEN (((struct ntreg_hbin_block *)((h)->addr + (offs)))->id, (eqid), 2))
152 block_len (hive_h *h, size_t blkoff, int *used)
154 struct ntreg_hbin_block *block;
155 block = (struct ntreg_hbin_block *) (h->addr + blkoff);
157 int32_t len = le32toh (block->seg_len);
168 struct ntreg_nk_record {
169 int32_t seg_len; /* length (always -ve because used) */
170 char id[2]; /* "nk" */
174 uint32_t parent; /* offset of owner/parent */
175 uint32_t nr_subkeys; /* number of subkeys */
176 uint32_t nr_subkeys_volatile;
177 uint32_t subkey_lf; /* lf record containing list of subkeys */
178 uint32_t subkey_lf_volatile;
179 uint32_t nr_values; /* number of values */
180 uint32_t vallist; /* value-list record */
181 uint32_t sk; /* offset of sk-record */
182 uint32_t classname; /* offset of classname record */
183 uint16_t max_subkey_name_len; /* maximum length of a subkey name in bytes
184 if the subkey was reencoded as UTF-16LE */
187 uint32_t max_vk_name_len; /* maximum length of any vk name in bytes
188 if the name was reencoded as UTF-16LE */
189 uint32_t max_vk_data_len; /* maximum length of any vk data in bytes */
191 uint16_t name_len; /* length of name */
192 uint16_t classname_len; /* length of classname */
193 char name[1]; /* name follows here */
194 } __attribute__((__packed__));
196 struct ntreg_lf_record {
198 char id[2]; /* "lf"|"lh" */
199 uint16_t nr_keys; /* number of keys in this record */
201 uint32_t offset; /* offset of nk-record for this subkey */
202 char hash[4]; /* hash of subkey name */
204 } __attribute__((__packed__));
206 struct ntreg_ri_record {
208 char id[2]; /* "ri" */
209 uint16_t nr_offsets; /* number of pointers to lh records */
210 uint32_t offset[1]; /* list of pointers to lh records */
211 } __attribute__((__packed__));
213 /* This has no ID header. */
214 struct ntreg_value_list {
216 uint32_t offset[1]; /* list of pointers to vk records */
217 } __attribute__((__packed__));
219 struct ntreg_vk_record {
220 int32_t seg_len; /* length (always -ve because used) */
221 char id[2]; /* "vk" */
222 uint16_t name_len; /* length of name */
223 /* length of the data:
224 * If data_len is <= 4, then it's stored inline.
225 * If data_len is 0x80000000, then it's an inline dword.
226 * Top bit may be set or not set at random.
229 uint32_t data_offset; /* pointer to the data (or data if inline) */
230 uint32_t data_type; /* type of the data */
231 uint16_t flags; /* bit 0 set => key name ASCII,
232 bit 0 clr => key name UTF-16.
233 Only seen ASCII here in the wild.
234 NB: this is CLEAR for default key. */
236 char name[1]; /* key name follows here */
237 } __attribute__((__packed__));
239 struct ntreg_sk_record {
240 int32_t seg_len; /* length (always -ve because used) */
241 char id[2]; /* "sk" */
243 uint32_t sk_next; /* linked into a circular list */
245 uint32_t refcount; /* reference count */
246 uint32_t sec_len; /* length of security info */
247 char sec_desc[1]; /* security info follows */
248 } __attribute__((__packed__));
251 header_checksum (const hive_h *h)
253 uint32_t *daddr = (uint32_t *) h->addr;
257 for (i = 0; i < 0x1fc / 4; ++i) {
258 sum ^= le32toh (*daddr);
266 hivex_open (const char *filename, int flags)
270 assert (sizeof (struct ntreg_header) == 0x1000);
271 assert (offsetof (struct ntreg_header, csum) == 0x1fc);
273 h = calloc (1, sizeof *h);
277 h->msglvl = flags & HIVEX_OPEN_MSGLVL_MASK;
279 const char *debug = getenv ("HIVEX_DEBUG");
280 if (debug && STREQ (debug, "1"))
284 fprintf (stderr, "hivex_open: created handle %p\n", h);
286 h->writable = !!(flags & HIVEX_OPEN_WRITE);
287 h->filename = strdup (filename);
288 if (h->filename == NULL)
291 h->fd = open (filename, O_RDONLY | O_CLOEXEC);
296 if (fstat (h->fd, &statbuf) == -1)
299 h->size = statbuf.st_size;
302 h->addr = mmap (NULL, h->size, PROT_READ, MAP_SHARED, h->fd, 0);
303 if (h->addr == MAP_FAILED)
307 fprintf (stderr, "hivex_open: mapped file at %p\n", h->addr);
309 h->addr = malloc (h->size);
313 if (full_read (h->fd, h->addr, h->size) < h->size)
318 if (h->hdr->magic[0] != 'r' ||
319 h->hdr->magic[1] != 'e' ||
320 h->hdr->magic[2] != 'g' ||
321 h->hdr->magic[3] != 'f') {
322 fprintf (stderr, "hivex: %s: not a Windows NT Registry hive file\n",
328 /* Check major version. */
329 uint32_t major_ver = le32toh (h->hdr->major_ver);
330 if (major_ver != 1) {
332 "hivex: %s: hive file major version %" PRIu32 " (expected 1)\n",
333 filename, major_ver);
338 h->bitmap = calloc (1 + h->size / 32, 1);
339 if (h->bitmap == NULL)
342 /* Header checksum. */
343 uint32_t sum = header_checksum (h);
344 if (sum != le32toh (h->hdr->csum)) {
345 fprintf (stderr, "hivex: %s: bad checksum in hive header\n", filename);
350 if (h->msglvl >= 2) {
351 char *name = windows_utf16_to_utf8 (h->hdr->name, 64);
354 "hivex_open: header fields:\n"
355 " file version %" PRIu32 ".%" PRIu32 "\n"
356 " sequence nos %" PRIu32 " %" PRIu32 "\n"
357 " (sequences nos should match if hive was synched at shutdown)\n"
358 " original file name %s\n"
359 " (only 32 chars are stored, name is probably truncated)\n"
360 " root offset 0x%x + 0x1000\n"
361 " end of last page 0x%x + 0x1000 (total file size 0x%zx)\n"
362 " checksum 0x%x (calculated 0x%x)\n",
363 major_ver, le32toh (h->hdr->minor_ver),
364 le32toh (h->hdr->sequence1), le32toh (h->hdr->sequence2),
365 name ? name : "(conversion failed)",
366 le32toh (h->hdr->offset),
367 le32toh (h->hdr->blocks), h->size,
368 le32toh (h->hdr->csum), sum);
372 h->rootoffs = le32toh (h->hdr->offset) + 0x1000;
373 h->endpages = le32toh (h->hdr->blocks) + 0x1000;
376 fprintf (stderr, "hivex_open: root offset = 0x%zx\n", h->rootoffs);
378 /* We'll set this flag when we see a block with the root offset (ie.
381 int seen_root_block = 0, bad_root_block = 0;
383 /* Collect some stats. */
384 size_t pages = 0; /* Number of hbin pages read. */
385 size_t smallest_page = SIZE_MAX, largest_page = 0;
386 size_t blocks = 0; /* Total number of blocks found. */
387 size_t smallest_block = SIZE_MAX, largest_block = 0, blocks_bytes = 0;
388 size_t used_blocks = 0; /* Total number of used blocks found. */
389 size_t used_size = 0; /* Total size (bytes) of used blocks. */
391 /* Read the pages and blocks. The aim here is to be robust against
392 * corrupt or malicious registries. So we make sure the loops
393 * always make forward progress. We add the address of each block
394 * we read to a hash table so pointers will only reference the start
398 struct ntreg_hbin_page *page;
399 for (off = 0x1000; off < h->size; off += le32toh (page->page_size)) {
400 if (off >= h->endpages)
403 page = (struct ntreg_hbin_page *) (h->addr + off);
404 if (page->magic[0] != 'h' ||
405 page->magic[1] != 'b' ||
406 page->magic[2] != 'i' ||
407 page->magic[3] != 'n') {
408 fprintf (stderr, "hivex: %s: trailing garbage at end of file (at 0x%zx, after %zu pages)\n",
409 filename, off, pages);
414 size_t page_size = le32toh (page->page_size);
416 fprintf (stderr, "hivex_open: page at 0x%zx, size %zu\n", off, page_size);
418 if (page_size < smallest_page) smallest_page = page_size;
419 if (page_size > largest_page) largest_page = page_size;
421 if (page_size <= sizeof (struct ntreg_hbin_page) ||
422 (page_size & 0x0fff) != 0) {
423 fprintf (stderr, "hivex: %s: page size %zu at 0x%zx, bad registry\n",
424 filename, page_size, off);
429 /* Read the blocks in this page. */
431 struct ntreg_hbin_block *block;
433 for (blkoff = off + 0x20;
434 blkoff < off + page_size;
438 int is_root = blkoff == h->rootoffs;
442 block = (struct ntreg_hbin_block *) (h->addr + blkoff);
444 seg_len = block_len (h, blkoff, &used);
445 if (seg_len <= 4 || (seg_len & 3) != 0) {
446 fprintf (stderr, "hivex: %s: block size %" PRIu32 " at 0x%zx, bad registry\n",
447 filename, le32toh (block->seg_len), blkoff);
453 fprintf (stderr, "hivex_open: %s block id %d,%d at 0x%zx size %zu%s\n",
454 used ? "used" : "free", block->id[0], block->id[1], blkoff,
455 seg_len, is_root ? " (root)" : "");
457 blocks_bytes += seg_len;
458 if (seg_len < smallest_block) smallest_block = seg_len;
459 if (seg_len > largest_block) largest_block = seg_len;
461 if (is_root && !used)
466 used_size += seg_len;
468 /* Root block must be an nk-block. */
469 if (is_root && (block->id[0] != 'n' || block->id[1] != 'k'))
472 /* Note this blkoff is a valid address. */
473 BITMAP_SET (h->bitmap, blkoff);
478 if (!seen_root_block) {
479 fprintf (stderr, "hivex: %s: no root block found\n", filename);
484 if (bad_root_block) {
485 fprintf (stderr, "hivex: %s: bad root block (free or not nk)\n", filename);
492 "hivex_open: successfully read Windows Registry hive file:\n"
493 " pages: %zu [sml: %zu, lge: %zu]\n"
494 " blocks: %zu [sml: %zu, avg: %zu, lge: %zu]\n"
495 " blocks used: %zu\n"
496 " bytes used: %zu\n",
497 pages, smallest_page, largest_page,
498 blocks, smallest_block, blocks_bytes / blocks, largest_block,
499 used_blocks, used_size);
507 if (h->addr && h->size && h->addr != MAP_FAILED) {
509 munmap (h->addr, h->size);
523 hivex_close (hive_h *h)
529 munmap (h->addr, h->size);
539 /*----------------------------------------------------------------------
544 hivex_root (hive_h *h)
546 hive_node_h ret = h->rootoffs;
547 if (!IS_VALID_BLOCK (h, ret)) {
555 hivex_node_name (hive_h *h, hive_node_h node)
557 if (!IS_VALID_BLOCK (h, node) || !BLOCK_ID_EQ (h, node, "nk")) {
562 struct ntreg_nk_record *nk = (struct ntreg_nk_record *) (h->addr + node);
564 /* AFAIK the node name is always plain ASCII, so no conversion
565 * to UTF-8 is necessary. However we do need to nul-terminate
569 /* nk->name_len is unsigned, 16 bit, so this is safe ... However
570 * we have to make sure the length doesn't exceed the block length.
572 size_t len = le16toh (nk->name_len);
573 size_t seg_len = block_len (h, node, NULL);
574 if (sizeof (struct ntreg_nk_record) + len - 1 > seg_len) {
576 fprintf (stderr, "hivex_node_name: returning EFAULT because node name is too long (%zu, %zu)\n",
582 char *ret = malloc (len + 1);
585 memcpy (ret, nk->name, len);
591 /* I think the documentation for the sk and classname fields in the nk
592 * record is wrong, or else the offset field is in the wrong place.
593 * Otherwise this makes no sense. Disabled this for now -- it's not
594 * useful for reading the registry anyway.
598 hivex_node_security (hive_h *h, hive_node_h node)
600 if (!IS_VALID_BLOCK (h, node) || !BLOCK_ID_EQ (h, node, "nk")) {
605 struct ntreg_nk_record *nk = (struct ntreg_nk_record *) (h->addr + node);
607 hive_node_h ret = le32toh (nk->sk);
609 if (!IS_VALID_BLOCK (h, ret)) {
617 hivex_node_classname (hive_h *h, hive_node_h node)
619 if (!IS_VALID_BLOCK (h, node) || !BLOCK_ID_EQ (h, node, "nk")) {
624 struct ntreg_nk_record *nk = (struct ntreg_nk_record *) (h->addr + node);
626 hive_node_h ret = le32toh (nk->classname);
628 if (!IS_VALID_BLOCK (h, ret)) {
636 /* Structure for returning 0-terminated lists of offsets (nodes,
646 init_offset_list (struct offset_list *list)
650 list->offsets = NULL;
653 #define INIT_OFFSET_LIST(name) \
654 struct offset_list name; \
655 init_offset_list (&name)
657 /* Preallocates the offset_list, but doesn't make the contents longer. */
659 grow_offset_list (struct offset_list *list, size_t alloc)
661 assert (alloc >= list->len);
662 size_t *p = realloc (list->offsets, alloc * sizeof (size_t));
671 add_to_offset_list (struct offset_list *list, size_t offset)
673 if (list->len >= list->alloc) {
674 if (grow_offset_list (list, list->alloc ? list->alloc * 2 : 4) == -1)
677 list->offsets[list->len] = offset;
683 free_offset_list (struct offset_list *list)
685 free (list->offsets);
689 return_offset_list (struct offset_list *list)
691 if (add_to_offset_list (list, 0) == -1)
693 return list->offsets; /* caller frees */
696 /* Iterate over children, returning child nodes and intermediate blocks. */
697 #define GET_CHILDREN_NO_CHECK_NK 1
700 get_children (hive_h *h, hive_node_h node,
701 hive_node_h **children_ret, size_t **blocks_ret,
704 if (!IS_VALID_BLOCK (h, node) || !BLOCK_ID_EQ (h, node, "nk")) {
709 struct ntreg_nk_record *nk = (struct ntreg_nk_record *) (h->addr + node);
711 size_t nr_subkeys_in_nk = le32toh (nk->nr_subkeys);
713 INIT_OFFSET_LIST (children);
714 INIT_OFFSET_LIST (blocks);
716 /* Deal with the common "no subkeys" case quickly. */
717 if (nr_subkeys_in_nk == 0)
720 /* Arbitrarily limit the number of subkeys we will ever deal with. */
721 if (nr_subkeys_in_nk > 1000000) {
726 /* Preallocate space for the children. */
727 if (grow_offset_list (&children, nr_subkeys_in_nk) == -1)
730 /* The subkey_lf field can point either to an lf-record, which is
731 * the common case, or if there are lots of subkeys, to an
734 size_t subkey_lf = le32toh (nk->subkey_lf);
736 if (!IS_VALID_BLOCK (h, subkey_lf)) {
738 fprintf (stderr, "hivex_node_children: returning EFAULT because subkey_lf is not a valid block (%zu)\n",
744 if (add_to_offset_list (&blocks, subkey_lf) == -1)
747 struct ntreg_hbin_block *block =
748 (struct ntreg_hbin_block *) (h->addr + subkey_lf);
750 /* Points to lf-record? (Note, also "lh" but that is basically the
751 * same as "lf" as far as we are concerned here).
753 if (block->id[0] == 'l' && (block->id[1] == 'f' || block->id[1] == 'h')) {
754 struct ntreg_lf_record *lf = (struct ntreg_lf_record *) block;
756 /* Check number of subkeys in the nk-record matches number of subkeys
759 size_t nr_subkeys_in_lf = le16toh (lf->nr_keys);
762 fprintf (stderr, "hivex_node_children: nr_subkeys_in_nk = %zu, nr_subkeys_in_lf = %zu\n",
763 nr_subkeys_in_nk, nr_subkeys_in_lf);
765 if (nr_subkeys_in_nk != nr_subkeys_in_lf) {
770 size_t len = block_len (h, subkey_lf, NULL);
771 if (8 + nr_subkeys_in_lf * 8 > len) {
773 fprintf (stderr, "hivex_node_children: returning EFAULT because too many subkeys (%zu, %zu)\n",
774 nr_subkeys_in_lf, len);
780 for (i = 0; i < nr_subkeys_in_lf; ++i) {
781 hive_node_h subkey = le32toh (lf->keys[i].offset);
783 if (!(flags & GET_CHILDREN_NO_CHECK_NK)) {
784 if (!IS_VALID_BLOCK (h, subkey)) {
786 fprintf (stderr, "hivex_node_children: returning EFAULT because subkey is not a valid block (0x%zx)\n",
792 if (add_to_offset_list (&children, subkey) == -1)
797 /* Points to ri-record? */
798 else if (block->id[0] == 'r' && block->id[1] == 'i') {
799 struct ntreg_ri_record *ri = (struct ntreg_ri_record *) block;
801 size_t nr_offsets = le16toh (ri->nr_offsets);
803 /* Count total number of children. */
805 for (i = 0; i < nr_offsets; ++i) {
806 hive_node_h offset = le32toh (ri->offset[i]);
808 if (!IS_VALID_BLOCK (h, offset)) {
810 fprintf (stderr, "hivex_node_children: returning EFAULT because ri-offset is not a valid block (0x%zx)\n",
815 if (!BLOCK_ID_EQ (h, offset, "lf") && !BLOCK_ID_EQ (h, offset, "lh")) {
820 if (add_to_offset_list (&blocks, offset) == -1)
823 struct ntreg_lf_record *lf =
824 (struct ntreg_lf_record *) (h->addr + offset);
826 count += le16toh (lf->nr_keys);
830 fprintf (stderr, "hivex_node_children: nr_subkeys_in_nk = %zu, counted = %zu\n",
831 nr_subkeys_in_nk, count);
833 if (nr_subkeys_in_nk != count) {
838 /* Copy list of children. Note nr_subkeys_in_nk is limited to
839 * something reasonable above.
841 for (i = 0; i < nr_offsets; ++i) {
842 hive_node_h offset = le32toh (ri->offset[i]);
844 if (!IS_VALID_BLOCK (h, offset)) {
846 fprintf (stderr, "hivex_node_children: returning EFAULT because ri-offset is not a valid block (0x%zx)\n",
851 if (!BLOCK_ID_EQ (h, offset, "lf") && !BLOCK_ID_EQ (h, offset, "lh")) {
856 struct ntreg_lf_record *lf =
857 (struct ntreg_lf_record *) (h->addr + offset);
860 for (j = 0; j < le16toh (lf->nr_keys); ++j) {
861 hive_node_h subkey = le32toh (lf->keys[j].offset);
863 if (!(flags & GET_CHILDREN_NO_CHECK_NK)) {
864 if (!IS_VALID_BLOCK (h, subkey)) {
866 fprintf (stderr, "hivex_node_children: returning EFAULT because indirect subkey is not a valid block (0x%zx)\n",
872 if (add_to_offset_list (&children, subkey) == -1)
878 /* else not supported, set errno and fall through */
881 free_offset_list (&children);
882 free_offset_list (&blocks);
886 *children_ret = return_offset_list (&children);
887 *blocks_ret = return_offset_list (&blocks);
888 if (!*children_ret || !*blocks_ret)
894 hivex_node_children (hive_h *h, hive_node_h node)
896 hive_node_h *children;
899 if (get_children (h, node, &children, &blocks, 0) == -1)
906 /* Very inefficient, but at least having a separate API call
907 * allows us to make it more efficient in future.
910 hivex_node_get_child (hive_h *h, hive_node_h node, const char *nname)
912 hive_node_h *children = NULL;
916 children = hivex_node_children (h, node);
917 if (!children) goto error;
920 for (i = 0; children[i] != 0; ++i) {
921 name = hivex_node_name (h, children[i]);
922 if (!name) goto error;
923 if (STRCASEEQ (name, nname)) {
927 free (name); name = NULL;
937 hivex_node_parent (hive_h *h, hive_node_h node)
939 if (!IS_VALID_BLOCK (h, node) || !BLOCK_ID_EQ (h, node, "nk")) {
944 struct ntreg_nk_record *nk = (struct ntreg_nk_record *) (h->addr + node);
946 hive_node_h ret = le32toh (nk->parent);
948 if (!IS_VALID_BLOCK (h, ret)) {
950 fprintf (stderr, "hivex_node_parent: returning EFAULT because parent is not a valid block (0x%zx)\n",
959 get_values (hive_h *h, hive_node_h node,
960 hive_value_h **values_ret, size_t **blocks_ret)
962 if (!IS_VALID_BLOCK (h, node) || !BLOCK_ID_EQ (h, node, "nk")) {
967 struct ntreg_nk_record *nk = (struct ntreg_nk_record *) (h->addr + node);
969 size_t nr_values = le32toh (nk->nr_values);
972 fprintf (stderr, "hivex_node_values: nr_values = %zu\n", nr_values);
974 INIT_OFFSET_LIST (values);
975 INIT_OFFSET_LIST (blocks);
977 /* Deal with the common "no values" case quickly. */
981 /* Arbitrarily limit the number of values we will ever deal with. */
982 if (nr_values > 100000) {
987 /* Preallocate space for the values. */
988 if (grow_offset_list (&values, nr_values) == -1)
991 /* Get the value list and check it looks reasonable. */
992 size_t vlist_offset = le32toh (nk->vallist);
993 vlist_offset += 0x1000;
994 if (!IS_VALID_BLOCK (h, vlist_offset)) {
996 fprintf (stderr, "hivex_node_values: returning EFAULT because value list is not a valid block (0x%zx)\n",
1002 if (add_to_offset_list (&blocks, vlist_offset) == -1)
1005 struct ntreg_value_list *vlist =
1006 (struct ntreg_value_list *) (h->addr + vlist_offset);
1008 size_t len = block_len (h, vlist_offset, NULL);
1009 if (4 + nr_values * 4 > len) {
1011 fprintf (stderr, "hivex_node_values: returning EFAULT because value list is too long (%zu, %zu)\n",
1018 for (i = 0; i < nr_values; ++i) {
1019 hive_node_h value = vlist->offset[i];
1021 if (!IS_VALID_BLOCK (h, value)) {
1023 fprintf (stderr, "hivex_node_values: returning EFAULT because value is not a valid block (0x%zx)\n",
1028 if (add_to_offset_list (&values, value) == -1)
1033 *values_ret = return_offset_list (&values);
1034 *blocks_ret = return_offset_list (&blocks);
1035 if (!*values_ret || !*blocks_ret)
1040 free_offset_list (&values);
1041 free_offset_list (&blocks);
1046 hivex_node_values (hive_h *h, hive_node_h node)
1048 hive_value_h *values;
1051 if (get_values (h, node, &values, &blocks) == -1)
1058 /* Very inefficient, but at least having a separate API call
1059 * allows us to make it more efficient in future.
1062 hivex_node_get_value (hive_h *h, hive_node_h node, const char *key)
1064 hive_value_h *values = NULL;
1066 hive_value_h ret = 0;
1068 values = hivex_node_values (h, node);
1069 if (!values) goto error;
1072 for (i = 0; values[i] != 0; ++i) {
1073 name = hivex_value_key (h, values[i]);
1074 if (!name) goto error;
1075 if (STRCASEEQ (name, key)) {
1079 free (name); name = NULL;
1089 hivex_value_key (hive_h *h, hive_value_h value)
1091 if (!IS_VALID_BLOCK (h, value) || !BLOCK_ID_EQ (h, value, "vk")) {
1096 struct ntreg_vk_record *vk = (struct ntreg_vk_record *) (h->addr + value);
1098 /* AFAIK the key is always plain ASCII, so no conversion to UTF-8 is
1099 * necessary. However we do need to nul-terminate the string.
1102 /* vk->name_len is unsigned, 16 bit, so this is safe ... However
1103 * we have to make sure the length doesn't exceed the block length.
1105 size_t len = le16toh (vk->name_len);
1106 size_t seg_len = block_len (h, value, NULL);
1107 if (sizeof (struct ntreg_vk_record) + len - 1 > seg_len) {
1109 fprintf (stderr, "hivex_value_key: returning EFAULT because key length is too long (%zu, %zu)\n",
1115 char *ret = malloc (len + 1);
1118 memcpy (ret, vk->name, len);
1124 hivex_value_type (hive_h *h, hive_value_h value, hive_type *t, size_t *len)
1126 if (!IS_VALID_BLOCK (h, value) || !BLOCK_ID_EQ (h, value, "vk")) {
1131 struct ntreg_vk_record *vk = (struct ntreg_vk_record *) (h->addr + value);
1134 *t = le32toh (vk->data_type);
1137 *len = le32toh (vk->data_len);
1138 if (*len == 0x80000000) { /* special case */
1140 if (t) *t = hive_t_dword;
1149 hivex_value_value (hive_h *h, hive_value_h value,
1150 hive_type *t_rtn, size_t *len_rtn)
1152 if (!IS_VALID_BLOCK (h, value) || !BLOCK_ID_EQ (h, value, "vk")) {
1157 struct ntreg_vk_record *vk = (struct ntreg_vk_record *) (h->addr + value);
1162 t = le32toh (vk->data_type);
1164 len = le32toh (vk->data_len);
1165 if (len == 0x80000000) { /* special case */
1172 fprintf (stderr, "hivex_value_value: value=0x%zx, t=%d, len=%zu\n",
1180 /* Arbitrarily limit the length that we will read. */
1181 if (len > 1000000) {
1186 char *ret = malloc (len);
1190 /* If length is <= 4 it's always stored inline. */
1192 memcpy (ret, (char *) &vk->data_offset, len);
1196 size_t data_offset = le32toh (vk->data_offset);
1197 data_offset += 0x1000;
1198 if (!IS_VALID_BLOCK (h, data_offset)) {
1200 fprintf (stderr, "hivex_value_value: returning EFAULT because data offset is not a valid block (0x%zx)\n",
1207 /* Check that the declared size isn't larger than the block its in.
1209 * XXX Some apparently valid registries are seen to have this,
1210 * so turn this into a warning and substitute the smaller length
1213 size_t blen = block_len (h, data_offset, NULL);
1214 if (len > blen - 4 /* subtract 4 for block header */) {
1216 fprintf (stderr, "hivex_value_value: warning: declared data length is longer than the block it is in (data 0x%zx, data len %zu, block len %zu)\n",
1217 data_offset, len, blen);
1221 char *data = h->addr + data_offset + 4;
1222 memcpy (ret, data, len);
1227 windows_utf16_to_utf8 (/* const */ char *input, size_t len)
1229 iconv_t ic = iconv_open ("UTF-8", "UTF-16");
1230 if (ic == (iconv_t) -1)
1233 /* iconv(3) has an insane interface ... */
1235 /* Mostly UTF-8 will be smaller, so this is a good initial guess. */
1236 size_t outalloc = len;
1240 size_t outlen = outalloc;
1241 char *out = malloc (outlen + 1);
1251 size_t r = iconv (ic, &inp, &inlen, &outp, &outlen);
1252 if (r == (size_t) -1) {
1253 if (errno == E2BIG) {
1254 size_t prev = outalloc;
1255 /* Try again with a larger output buffer. */
1258 if (outalloc < prev)
1263 /* Else some conversion failure, eg. EILSEQ, EINVAL. */
1279 hivex_value_string (hive_h *h, hive_value_h value)
1283 char *data = hivex_value_value (h, value, &t, &len);
1288 if (t != hive_t_string && t != hive_t_expand_string && t != hive_t_link) {
1294 char *ret = windows_utf16_to_utf8 (data, len);
1303 free_strings (char **argv)
1308 for (i = 0; argv[i] != NULL; ++i)
1314 /* Get the length of a UTF-16 format string. Handle the string as
1315 * pairs of bytes, looking for the first \0\0 pair.
1318 utf16_string_len_in_bytes (const char *str)
1322 while (str[0] || str[1]) {
1330 /* http://blogs.msdn.com/oldnewthing/archive/2009/10/08/9904646.aspx */
1332 hivex_value_multiple_strings (hive_h *h, hive_value_h value)
1336 char *data = hivex_value_value (h, value, &t, &len);
1341 if (t != hive_t_multiple_strings) {
1347 size_t nr_strings = 0;
1348 char **ret = malloc ((1 + nr_strings) * sizeof (char *));
1358 while (p < data + len && (plen = utf16_string_len_in_bytes (p)) > 0) {
1360 char **ret2 = realloc (ret, (1 + nr_strings) * sizeof (char *));
1368 ret[nr_strings-1] = windows_utf16_to_utf8 (p, plen);
1369 ret[nr_strings] = NULL;
1370 if (ret[nr_strings-1] == NULL) {
1376 p += plen + 2 /* skip over UTF-16 \0\0 at the end of this string */;
1384 hivex_value_dword (hive_h *h, hive_value_h value)
1388 char *data = hivex_value_value (h, value, &t, &len);
1393 if ((t != hive_t_dword && t != hive_t_dword_be) || len != 4) {
1399 int32_t ret = *(int32_t*)data;
1401 if (t == hive_t_dword) /* little endian */
1402 ret = le32toh (ret);
1404 ret = be32toh (ret);
1410 hivex_value_qword (hive_h *h, hive_value_h value)
1414 char *data = hivex_value_value (h, value, &t, &len);
1419 if (t != hive_t_qword || len != 8) {
1425 int64_t ret = *(int64_t*)data;
1427 ret = le64toh (ret); /* always little endian */
1432 /*----------------------------------------------------------------------
1437 hivex_visit (hive_h *h, const struct hivex_visitor *visitor, size_t len,
1438 void *opaque, int flags)
1440 return hivex_visit_node (h, hivex_root (h), visitor, len, opaque, flags);
1443 static int hivex__visit_node (hive_h *h, hive_node_h node, const struct hivex_visitor *vtor, char *unvisited, void *opaque, int flags);
1446 hivex_visit_node (hive_h *h, hive_node_h node,
1447 const struct hivex_visitor *visitor, size_t len, void *opaque,
1450 struct hivex_visitor vtor;
1451 memset (&vtor, 0, sizeof vtor);
1453 /* Note that len might be larger *or smaller* than the expected size. */
1454 size_t copysize = len <= sizeof vtor ? len : sizeof vtor;
1455 memcpy (&vtor, visitor, copysize);
1457 /* This bitmap records unvisited nodes, so we don't loop if the
1458 * registry contains cycles.
1460 char *unvisited = malloc (1 + h->size / 32);
1461 if (unvisited == NULL)
1463 memcpy (unvisited, h->bitmap, 1 + h->size / 32);
1465 int r = hivex__visit_node (h, node, &vtor, unvisited, opaque, flags);
1471 hivex__visit_node (hive_h *h, hive_node_h node,
1472 const struct hivex_visitor *vtor, char *unvisited,
1473 void *opaque, int flags)
1475 int skip_bad = flags & HIVEX_VISIT_SKIP_BAD;
1477 hive_value_h *values = NULL;
1478 hive_node_h *children = NULL;
1484 /* Return -1 on all callback errors. However on internal errors,
1485 * check if skip_bad is set and suppress those errors if so.
1489 if (!BITMAP_TST (unvisited, node)) {
1491 fprintf (stderr, "hivex__visit_node: contains cycle: visited node 0x%zx already\n",
1495 return skip_bad ? 0 : -1;
1497 BITMAP_CLR (unvisited, node);
1499 name = hivex_node_name (h, node);
1500 if (!name) return skip_bad ? 0 : -1;
1501 if (vtor->node_start && vtor->node_start (h, opaque, node, name) == -1)
1504 values = hivex_node_values (h, node);
1506 ret = skip_bad ? 0 : -1;
1510 for (i = 0; values[i] != 0; ++i) {
1514 if (hivex_value_type (h, values[i], &t, &len) == -1) {
1515 ret = skip_bad ? 0 : -1;
1519 key = hivex_value_key (h, values[i]);
1521 ret = skip_bad ? 0 : -1;
1525 if (vtor->value_any) {
1526 str = hivex_value_value (h, values[i], &t, &len);
1528 ret = skip_bad ? 0 : -1;
1531 if (vtor->value_any (h, opaque, node, values[i], t, len, key, str) == -1)
1533 free (str); str = NULL;
1538 str = hivex_value_value (h, values[i], &t, &len);
1540 ret = skip_bad ? 0 : -1;
1543 if (t != hive_t_none) {
1544 ret = skip_bad ? 0 : -1;
1547 if (vtor->value_none &&
1548 vtor->value_none (h, opaque, node, values[i], t, len, key, str) == -1)
1550 free (str); str = NULL;
1554 case hive_t_expand_string:
1556 str = hivex_value_string (h, values[i]);
1558 if (errno != EILSEQ && errno != EINVAL) {
1559 ret = skip_bad ? 0 : -1;
1562 if (vtor->value_string_invalid_utf16) {
1563 str = hivex_value_value (h, values[i], &t, &len);
1564 if (vtor->value_string_invalid_utf16 (h, opaque, node, values[i], t, len, key, str) == -1)
1566 free (str); str = NULL;
1570 if (vtor->value_string &&
1571 vtor->value_string (h, opaque, node, values[i], t, len, key, str) == -1)
1573 free (str); str = NULL;
1577 case hive_t_dword_be: {
1578 int32_t i32 = hivex_value_dword (h, values[i]);
1579 if (vtor->value_dword &&
1580 vtor->value_dword (h, opaque, node, values[i], t, len, key, i32) == -1)
1585 case hive_t_qword: {
1586 int64_t i64 = hivex_value_qword (h, values[i]);
1587 if (vtor->value_qword &&
1588 vtor->value_qword (h, opaque, node, values[i], t, len, key, i64) == -1)
1594 str = hivex_value_value (h, values[i], &t, &len);
1596 ret = skip_bad ? 0 : -1;
1599 if (t != hive_t_binary) {
1600 ret = skip_bad ? 0 : -1;
1603 if (vtor->value_binary &&
1604 vtor->value_binary (h, opaque, node, values[i], t, len, key, str) == -1)
1606 free (str); str = NULL;
1609 case hive_t_multiple_strings:
1610 strs = hivex_value_multiple_strings (h, values[i]);
1612 if (errno != EILSEQ && errno != EINVAL) {
1613 ret = skip_bad ? 0 : -1;
1616 if (vtor->value_string_invalid_utf16) {
1617 str = hivex_value_value (h, values[i], &t, &len);
1618 if (vtor->value_string_invalid_utf16 (h, opaque, node, values[i], t, len, key, str) == -1)
1620 free (str); str = NULL;
1624 if (vtor->value_multiple_strings &&
1625 vtor->value_multiple_strings (h, opaque, node, values[i], t, len, key, strs) == -1)
1627 free_strings (strs); strs = NULL;
1630 case hive_t_resource_list:
1631 case hive_t_full_resource_description:
1632 case hive_t_resource_requirements_list:
1634 str = hivex_value_value (h, values[i], &t, &len);
1636 ret = skip_bad ? 0 : -1;
1639 if (vtor->value_other &&
1640 vtor->value_other (h, opaque, node, values[i], t, len, key, str) == -1)
1642 free (str); str = NULL;
1647 free (key); key = NULL;
1650 children = hivex_node_children (h, node);
1651 if (children == NULL) {
1652 ret = skip_bad ? 0 : -1;
1656 for (i = 0; children[i] != 0; ++i) {
1658 fprintf (stderr, "hivex__visit_node: %s: visiting subkey %d (0x%zx)\n",
1659 name, i, children[i]);
1661 if (hivex__visit_node (h, children[i], vtor, unvisited, opaque, flags) == -1)
1665 if (vtor->node_end && vtor->node_end (h, opaque, node, name) == -1)
1676 free_strings (strs);
1680 /*----------------------------------------------------------------------
1684 /* Allocate an hbin (page), extending the malloc'd space if necessary,
1685 * and updating the hive handle fields (but NOT the hive disk header
1686 * -- the hive disk header is updated when we commit). This function
1687 * also extends the bitmap if necessary.
1689 * 'allocation_hint' is the size of the block allocation we would like
1690 * to make. Normally registry blocks are very small (avg 50 bytes)
1691 * and are contained in standard-sized pages (4KB), but the registry
1692 * can support blocks which are larger than a standard page, in which
1693 * case it creates a page of 8KB, 12KB etc.
1696 * > 0 : offset of first usable byte of new page (after page header)
1697 * 0 : error (errno set)
1700 allocate_page (hive_h *h, size_t allocation_hint)
1702 /* In almost all cases this will be 1. */
1703 size_t nr_4k_pages =
1704 1 + (allocation_hint + sizeof (struct ntreg_hbin_page) - 1) / 4096;
1705 assert (nr_4k_pages >= 1);
1707 /* 'extend' is the number of bytes to extend the file by. Note that
1708 * hives found in the wild often contain slack between 'endpages'
1709 * and the actual end of the file, so we don't always need to make
1712 ssize_t extend = h->endpages + nr_4k_pages * 4096 - h->size;
1714 if (h->msglvl >= 2) {
1715 fprintf (stderr, "allocate_page: current endpages = 0x%zx, current size = 0x%zx\n",
1716 h->endpages, h->size);
1717 fprintf (stderr, "allocate_page: extending file by %zd bytes (<= 0 if no extension)\n",
1722 size_t oldsize = h->size;
1723 size_t newsize = h->size + extend;
1724 char *newaddr = realloc (h->addr, newsize);
1725 if (newaddr == NULL)
1728 size_t oldbitmapsize = 1 + oldsize / 32;
1729 size_t newbitmapsize = 1 + newsize / 32;
1730 char *newbitmap = realloc (h->bitmap, newbitmapsize);
1731 if (newbitmap == NULL) {
1738 h->bitmap = newbitmap;
1740 memset (h->addr + oldsize, 0, newsize - oldsize);
1741 memset (h->bitmap + oldbitmapsize, 0, newbitmapsize - oldbitmapsize);
1744 size_t offset = h->endpages;
1745 h->endpages += nr_4k_pages * 4096;
1748 fprintf (stderr, "allocate_page: new endpages = 0x%zx, new size = 0x%zx\n",
1749 h->endpages, h->size);
1751 /* Write the hbin header. */
1752 struct ntreg_hbin_page *page =
1753 (struct ntreg_hbin_page *) (h->addr + offset);
1754 page->magic[0] = 'h';
1755 page->magic[1] = 'b';
1756 page->magic[2] = 'i';
1757 page->magic[3] = 'n';
1758 page->offset_first = htole32 (offset - 0x1000);
1759 page->page_size = htole32 (nr_4k_pages * 4096);
1760 memset (page->unknown, 0, sizeof (page->unknown));
1763 fprintf (stderr, "allocate_page: new page at 0x%zx\n", offset);
1765 /* Offset of first usable byte after the header. */
1766 return offset + sizeof (struct ntreg_hbin_page);
1769 /* Allocate a single block, first allocating an hbin (page) at the end
1770 * of the current file if necessary. NB. To keep the implementation
1771 * simple and more likely to be correct, we do not reuse existing free
1774 * seg_len is the size of the block (this INCLUDES the block header).
1775 * The header of the block is initialized to -seg_len (negative to
1776 * indicate used). id[2] is the block ID (type), eg. "nk" for nk-
1777 * record. The block bitmap is updated to show this block as valid.
1778 * The rest of the contents of the block will be zero.
1781 * > 0 : offset of new block
1782 * 0 : error (errno set)
1785 allocate_block (hive_h *h, size_t seg_len, const char id[2])
1793 /* The caller probably forgot to include the header. Note that
1794 * value lists have no ID field, so seg_len == 4 would be possible
1795 * for them, albeit unusual.
1798 fprintf (stderr, "allocate_block: refusing too small allocation (%zu), returning ERANGE\n",
1804 /* Refuse really large allocations. */
1805 if (seg_len > 1000000) {
1807 fprintf (stderr, "allocate_block: refusing large allocation (%zu), returning ERANGE\n",
1813 /* Round up allocation to multiple of 8 bytes. All blocks must be
1814 * on an 8 byte boundary.
1816 seg_len = (seg_len + 7) & ~7;
1818 /* Allocate a new page if necessary. */
1819 if (h->endblocks == 0 || h->endblocks + seg_len > h->endpages) {
1820 size_t newendblocks = allocate_page (h, seg_len);
1821 if (newendblocks == 0)
1823 h->endblocks = newendblocks;
1826 size_t offset = h->endblocks;
1829 fprintf (stderr, "allocate_block: new block at 0x%zx, size %zu\n",
1832 struct ntreg_hbin_block *blockhdr =
1833 (struct ntreg_hbin_block *) (h->addr + offset);
1835 blockhdr->seg_len = htole32 (- (int32_t) seg_len);
1836 if (id[0] && id[1] && seg_len >= 6) {
1837 blockhdr->id[0] = id[0];
1838 blockhdr->id[1] = id[1];
1841 h->endblocks += seg_len;
1843 /* If there is space after the last block in the last page, then we
1844 * have to put a dummy free block header here to mark the rest of
1847 ssize_t rem = h->endpages - h->endblocks;
1850 fprintf (stderr, "allocate_block: marking remainder of page free starting at 0x%zx, size %zd\n",
1855 blockhdr = (struct ntreg_hbin_block *) (h->addr + h->endblocks);
1856 blockhdr->seg_len = htole32 ((int32_t) rem);
1862 /* 'offset' must point to a valid, used block. This function marks
1863 * the block unused (by updating the seg_len field) and invalidates
1864 * the bitmap. It does NOT do this recursively, so to avoid creating
1865 * unreachable used blocks, callers may have to recurse over the hive
1866 * structures. Also callers must ensure there are no references to
1867 * this block from other parts of the hive.
1870 mark_block_unused (hive_h *h, size_t offset)
1872 assert (h->writable);
1873 assert (IS_VALID_BLOCK (h, offset));
1876 fprintf (stderr, "mark_block_unused: marking 0x%zx unused\n", offset);
1878 struct ntreg_hbin_block *blockhdr =
1879 (struct ntreg_hbin_block *) (h->addr + offset);
1881 size_t seg_len = block_len (h, offset, NULL);
1882 blockhdr->seg_len = htole32 (seg_len);
1884 BITMAP_CLR (h->bitmap, offset);
1887 /* Delete all existing values at this node. */
1889 delete_values (hive_h *h, hive_node_h node)
1891 assert (h->writable);
1893 hive_value_h *values;
1895 if (get_values (h, node, &values, &blocks) == -1)
1899 for (i = 0; blocks[i] != 0; ++i)
1900 mark_block_unused (h, blocks[i]);
1904 for (i = 0; values[i] != 0; ++i) {
1905 struct ntreg_vk_record *vk =
1906 (struct ntreg_vk_record *) (h->addr + values[i]);
1909 len = le32toh (vk->data_len);
1910 if (len == 0x80000000) /* special case */
1914 if (len > 4) { /* non-inline, so remove data block */
1915 size_t data_offset = le32toh (vk->data_offset);
1916 data_offset += 0x1000;
1917 mark_block_unused (h, data_offset);
1920 /* remove vk record */
1921 mark_block_unused (h, values[i]);
1926 struct ntreg_nk_record *nk = (struct ntreg_nk_record *) (h->addr + node);
1927 nk->nr_values = htole32 (0);
1928 nk->vallist = htole32 (0xffffffff);
1934 hivex_commit (hive_h *h, const char *filename, int flags)
1946 filename = filename ? : h->filename;
1947 int fd = open (filename, O_WRONLY|O_CREAT|O_TRUNC|O_NOCTTY, 0666);
1951 /* Update the header fields. */
1952 uint32_t sequence = le32toh (h->hdr->sequence1);
1954 h->hdr->sequence1 = htole32 (sequence);
1955 h->hdr->sequence2 = htole32 (sequence);
1956 /* XXX Ought to update h->hdr->last_modified. */
1957 h->hdr->blocks = htole32 (h->endpages - 0x1000);
1959 /* Recompute header checksum. */
1960 uint32_t sum = header_checksum (h);
1961 h->hdr->csum = htole32 (sum);
1964 fprintf (stderr, "hivex_commit: new header checksum: 0x%x\n", sum);
1966 if (full_write (fd, h->addr, h->size) != h->size) {
1973 if (close (fd) == -1)
1981 hivex_node_add_child (hive_h *h, hive_node_h parent, const char *name)
1988 if (!IS_VALID_BLOCK (h, parent) || !BLOCK_ID_EQ (h, parent, "nk")) {
2006 /* Decrement the refcount of an sk-record, and if it reaches zero,
2007 * unlink it from the chain and delete it.
2010 delete_sk (hive_h *h, size_t sk_offset)
2012 if (!IS_VALID_BLOCK (h, sk_offset) || !BLOCK_ID_EQ (h, sk_offset, "sk")) {
2014 fprintf (stderr, "delete_sk: not an sk record: 0x%zx\n", sk_offset);
2019 struct ntreg_sk_record *sk = (struct ntreg_sk_record *) (h->addr + sk_offset);
2021 if (sk->refcount == 0) {
2023 fprintf (stderr, "delete_sk: sk record already has refcount 0: 0x%zx\n",
2031 if (sk->refcount == 0) {
2032 size_t sk_prev_offset = sk->sk_prev;
2033 sk_prev_offset += 0x1000;
2035 size_t sk_next_offset = sk->sk_next;
2036 sk_next_offset += 0x1000;
2038 /* Update sk_prev/sk_next SKs, unless they both point back to this
2039 * cell in which case we are deleting the last SK.
2041 if (sk_prev_offset != sk_offset && sk_next_offset != sk_offset) {
2042 struct ntreg_sk_record *sk_prev =
2043 (struct ntreg_sk_record *) (h->addr + sk_prev_offset);
2044 struct ntreg_sk_record *sk_next =
2045 (struct ntreg_sk_record *) (h->addr + sk_next_offset);
2047 sk_prev->sk_next = htole32 (sk_next_offset - 0x1000);
2048 sk_next->sk_prev = htole32 (sk_prev_offset - 0x1000);
2051 /* Refcount is zero so really delete this block. */
2052 mark_block_unused (h, sk_offset);
2058 /* Callback from hivex_node_delete_child which is called to delete a
2059 * node AFTER its subnodes have been visited. The subnodes have been
2060 * deleted but we still have to delete any lf/lh/li/ri records and the
2061 * value list block and values, followed by deleting the node itself.
2064 delete_node (hive_h *h, void *opaque, hive_node_h node, const char *name)
2066 /* Get the intermediate blocks. The subkeys have already been
2067 * deleted by this point, so tell get_children() not to check for
2068 * validity of the nk-records.
2070 hive_node_h *unused;
2072 if (get_children (h, node, &unused, &blocks, GET_CHILDREN_NO_CHECK_NK) == -1)
2076 /* We don't care what's in these intermediate blocks, so we can just
2077 * delete them unconditionally.
2080 for (i = 0; blocks[i] != 0; ++i)
2081 mark_block_unused (h, blocks[i]);
2085 /* Delete the values in the node. */
2086 if (delete_values (h, node) == -1)
2089 struct ntreg_nk_record *nk = (struct ntreg_nk_record *) (h->addr + node);
2091 /* If the NK references an SK, delete it. */
2092 size_t sk_offs = le32toh (nk->sk);
2093 if (sk_offs != 0xffffffff) {
2095 if (delete_sk (h, sk_offs) == -1)
2097 nk->sk = htole32 (0xffffffff);
2100 /* If the NK references a classname, delete it. */
2101 size_t cl_offs = le32toh (nk->classname);
2102 if (cl_offs != 0xffffffff) {
2104 mark_block_unused (h, cl_offs);
2105 nk->classname = htole32 (0xffffffff);
2108 /* Delete the node itself. */
2109 mark_block_unused (h, node);
2115 hivex_node_delete_child (hive_h *h, hive_node_h node)
2122 if (!IS_VALID_BLOCK (h, node) || !BLOCK_ID_EQ (h, node, "nk")) {
2127 if (node == hivex_root (h)) {
2129 fprintf (stderr, "hivex_node_delete_child: cannot delete root node\n");
2134 hive_node_h parent = hivex_node_parent (h, node);
2138 /* Delete node and all its children and values recursively. */
2139 static const struct hivex_visitor visitor = { .node_end = delete_node };
2140 if (hivex_visit_node (h, node, &visitor, sizeof visitor, NULL, 0) == -1)
2143 /* Delete the link from parent to child. We need to find the lf/lh
2144 * record which contains the offset and remove the offset from that
2145 * record, then decrement the element count in that record, and
2146 * decrement the overall number of subkeys stored in the parent
2149 hive_node_h *unused;
2151 if (get_children (h, parent, &unused, &blocks, GET_CHILDREN_NO_CHECK_NK)== -1)
2156 for (i = 0; blocks[i] != 0; ++i) {
2157 struct ntreg_hbin_block *block =
2158 (struct ntreg_hbin_block *) (h->addr + blocks[i]);
2160 if (block->id[0] == 'l' && (block->id[1] == 'f' || block->id[1] == 'h')) {
2161 struct ntreg_lf_record *lf = (struct ntreg_lf_record *) block;
2163 size_t nr_subkeys_in_lf = le16toh (lf->nr_keys);
2165 for (j = 0; j < nr_subkeys_in_lf; ++j)
2166 if (le32toh (lf->keys[j].offset) + 0x1000 == node) {
2167 for (; j < nr_subkeys_in_lf - 1; ++j)
2168 memcpy (&lf->keys[j], &lf->keys[j+1], sizeof (lf->keys[j]));
2169 lf->nr_keys = htole16 (nr_subkeys_in_lf - 1);
2175 fprintf (stderr, "hivex_node_delete_child: could not find parent to child link\n");
2180 struct ntreg_nk_record *nk = (struct ntreg_nk_record *) (h->addr + parent);
2181 size_t nr_subkeys_in_nk = le32toh (nk->nr_subkeys);
2182 nk->nr_subkeys = htole32 (nr_subkeys_in_nk - 1);
2185 fprintf (stderr, "hivex_node_delete_child: updating nr_subkeys in parent 0x%zx to %zu\n",
2186 parent, nr_subkeys_in_nk);
2192 hivex_node_set_values (hive_h *h, hive_node_h node,
2193 size_t nr_values, const hive_set_value *values,
2201 if (!IS_VALID_BLOCK (h, node) || !BLOCK_ID_EQ (h, node, "nk")) {
2206 /* Delete all existing values. */
2207 if (delete_values (h, node) == -1)
2213 /* Allocate value list node. Value lists have no id field. */
2214 static const char nul_id[2] = { 0, 0 };
2216 sizeof (struct ntreg_value_list) + (nr_values - 1) * sizeof (uint32_t);
2217 size_t vallist_offs = allocate_block (h, seg_len, nul_id);
2218 if (vallist_offs == 0)
2221 struct ntreg_nk_record *nk = (struct ntreg_nk_record *) (h->addr + node);
2222 nk->nr_values = htole32 (nr_values);
2223 nk->vallist = htole32 (vallist_offs - 0x1000);
2225 struct ntreg_value_list *vallist =
2226 (struct ntreg_value_list *) (h->addr + vallist_offs);
2229 for (i = 0; i < nr_values; ++i) {
2230 /* Allocate vk record to store this (key, value) pair. */
2231 static const char vk_id[2] = { 'v', 'k' };
2232 seg_len = sizeof (struct ntreg_vk_record) + strlen (values[i].key);
2233 size_t vk_offs = allocate_block (h, seg_len, vk_id);
2237 vallist->offset[i] = htole32 (vk_offs - 0x1000);
2239 struct ntreg_vk_record *vk = (struct ntreg_vk_record *) (h->addr + vk_offs);
2240 size_t name_len = strlen (values[i].key);
2241 vk->name_len = htole16 (name_len);
2242 strcpy (vk->name, values[i].key);
2243 vk->data_type = htole32 (values[i].t);
2244 vk->data_len = htole16 (values[i].len);
2245 vk->flags = name_len == 0 ? 0 : 1;
2247 if (values[i].len <= 4) /* Store data inline. */
2248 memcpy (&vk->data_offset, values[i].value, values[i].len);
2250 size_t offs = allocate_block (h, values[i].len + 4, nul_id);
2253 memcpy (h->addr + offs + 4, values[i].value, values[i].len);
2254 vk->data_offset = htole32 (offs - 0x1000);
2257 if (name_len * 2 > le32toh (nk->max_vk_name_len))
2258 nk->max_vk_name_len = htole32 (name_len * 2);
2259 if (values[i].len > le32toh (nk->max_vk_data_len))
2260 nk->max_vk_data_len = htole32 (values[i].len);