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.
38 #include "full-read.h"
39 #include "full-write.h"
45 #define STREQ(a,b) (strcmp((a),(b)) == 0)
46 #define STRCASEEQ(a,b) (strcasecmp((a),(b)) == 0)
47 //#define STRNEQ(a,b) (strcmp((a),(b)) != 0)
48 //#define STRCASENEQ(a,b) (strcasecmp((a),(b)) != 0)
49 #define STREQLEN(a,b,n) (strncmp((a),(b),(n)) == 0)
50 //#define STRCASEEQLEN(a,b,n) (strncasecmp((a),(b),(n)) == 0)
51 //#define STRNEQLEN(a,b,n) (strncmp((a),(b),(n)) != 0)
52 //#define STRCASENEQLEN(a,b,n) (strncasecmp((a),(b),(n)) != 0)
53 #define STRPREFIX(a,b) (strncmp((a),(b),strlen((b))) == 0)
56 #include "byte_conversions.h"
58 /* These limits are in place to stop really stupid stuff and/or exploits. */
59 #define HIVEX_MAX_SUBKEYS 15000
60 #define HIVEX_MAX_VALUES 10000
61 #define HIVEX_MAX_VALUE_LEN 1000000
62 #define HIVEX_MAX_ALLOCATION 1000000
64 static char *windows_utf16_to_utf8 (/* const */ char *input, size_t len);
65 static size_t utf16_string_len_in_bytes (const char *str);
66 static size_t utf16_string_len_in_bytes_max (const char *str, size_t len);
75 /* Registry file, memory mapped if read-only, or malloc'd if writing. */
78 struct ntreg_header *hdr;
81 /* Use a bitmap to store which file offsets are valid (point to a
82 * used block). We only need to store 1 bit per 32 bits of the file
83 * (because blocks are 4-byte aligned). We found that the average
84 * block size in a registry file is ~50 bytes. So roughly 1 in 12
85 * bits in the bitmap will be set, making it likely a more efficient
86 * structure than a hash table.
89 #define BITMAP_SET(bitmap,off) (bitmap[(off)>>5] |= 1 << (((off)>>2)&7))
90 #define BITMAP_CLR(bitmap,off) (bitmap[(off)>>5] &= ~ (1 << (((off)>>2)&7)))
91 #define BITMAP_TST(bitmap,off) (bitmap[(off)>>5] & (1 << (((off)>>2)&7)))
92 #define IS_VALID_BLOCK(h,off) \
93 (((off) & 3) == 0 && \
95 (off) < (h)->size && \
96 BITMAP_TST((h)->bitmap,(off)))
98 /* Fields from the header, extracted from little-endianness hell. */
99 size_t rootoffs; /* Root key offset (always an nk-block). */
100 size_t endpages; /* Offset of end of pages. */
103 size_t endblocks; /* Offset to next block allocation (0
104 if not allocated anything yet). */
107 /* NB. All fields are little endian. */
108 struct ntreg_header {
109 char magic[4]; /* "regf" */
112 char last_modified[8];
113 uint32_t major_ver; /* 1 */
114 uint32_t minor_ver; /* 3 */
115 uint32_t unknown5; /* 0 */
116 uint32_t unknown6; /* 1 */
117 uint32_t offset; /* offset of root key record - 4KB */
118 uint32_t blocks; /* pointer AFTER last hbin in file - 4KB */
119 uint32_t unknown7; /* 1 */
121 char name[64]; /* original file name of hive */
122 char unknown_guid1[16];
123 char unknown_guid2[16];
126 char unknown_guid3[16];
131 uint32_t csum; /* checksum: xor of dwords 0-0x1fb. */
133 char unknown11[3528];
135 char unknown_guid4[16];
136 char unknown_guid5[16];
137 char unknown_guid6[16];
141 } __attribute__((__packed__));
143 struct ntreg_hbin_page {
144 char magic[4]; /* "hbin" */
145 uint32_t offset_first; /* offset from 1st block */
146 uint32_t page_size; /* size of this page (multiple of 4KB) */
148 /* Linked list of blocks follows here. */
149 } __attribute__((__packed__));
151 struct ntreg_hbin_block {
152 int32_t seg_len; /* length of this block (-ve for used block) */
153 char id[2]; /* the block type (eg. "nk" for nk record) */
154 /* Block data follows here. */
155 } __attribute__((__packed__));
157 #define BLOCK_ID_EQ(h,offs,eqid) \
158 (STREQLEN (((struct ntreg_hbin_block *)((h)->addr + (offs)))->id, (eqid), 2))
161 block_len (hive_h *h, size_t blkoff, int *used)
163 struct ntreg_hbin_block *block;
164 block = (struct ntreg_hbin_block *) (h->addr + blkoff);
166 int32_t len = le32toh (block->seg_len);
177 struct ntreg_nk_record {
178 int32_t seg_len; /* length (always -ve because used) */
179 char id[2]; /* "nk" */
183 uint32_t parent; /* offset of owner/parent */
184 uint32_t nr_subkeys; /* number of subkeys */
185 uint32_t nr_subkeys_volatile;
186 uint32_t subkey_lf; /* lf record containing list of subkeys */
187 uint32_t subkey_lf_volatile;
188 uint32_t nr_values; /* number of values */
189 uint32_t vallist; /* value-list record */
190 uint32_t sk; /* offset of sk-record */
191 uint32_t classname; /* offset of classname record */
192 uint16_t max_subkey_name_len; /* maximum length of a subkey name in bytes
193 if the subkey was reencoded as UTF-16LE */
196 uint32_t max_vk_name_len; /* maximum length of any vk name in bytes
197 if the name was reencoded as UTF-16LE */
198 uint32_t max_vk_data_len; /* maximum length of any vk data in bytes */
200 uint16_t name_len; /* length of name */
201 uint16_t classname_len; /* length of classname */
202 char name[1]; /* name follows here */
203 } __attribute__((__packed__));
205 struct ntreg_lf_record {
207 char id[2]; /* "lf"|"lh" */
208 uint16_t nr_keys; /* number of keys in this record */
210 uint32_t offset; /* offset of nk-record for this subkey */
211 char hash[4]; /* hash of subkey name */
213 } __attribute__((__packed__));
215 struct ntreg_ri_record {
217 char id[2]; /* "ri" */
218 uint16_t nr_offsets; /* number of pointers to lh records */
219 uint32_t offset[1]; /* list of pointers to lh records */
220 } __attribute__((__packed__));
222 /* This has no ID header. */
223 struct ntreg_value_list {
225 uint32_t offset[1]; /* list of pointers to vk records */
226 } __attribute__((__packed__));
228 struct ntreg_vk_record {
229 int32_t seg_len; /* length (always -ve because used) */
230 char id[2]; /* "vk" */
231 uint16_t name_len; /* length of name */
232 /* length of the data:
233 * If data_len is <= 4, then it's stored inline.
234 * Top bit is set to indicate inline.
237 uint32_t data_offset; /* pointer to the data (or data if inline) */
238 uint32_t data_type; /* type of the data */
239 uint16_t flags; /* bit 0 set => key name ASCII,
240 bit 0 clr => key name UTF-16.
241 Only seen ASCII here in the wild.
242 NB: this is CLEAR for default key. */
244 char name[1]; /* key name follows here */
245 } __attribute__((__packed__));
247 struct ntreg_sk_record {
248 int32_t seg_len; /* length (always -ve because used) */
249 char id[2]; /* "sk" */
251 uint32_t sk_next; /* linked into a circular list */
253 uint32_t refcount; /* reference count */
254 uint32_t sec_len; /* length of security info */
255 char sec_desc[1]; /* security info follows */
256 } __attribute__((__packed__));
259 header_checksum (const hive_h *h)
261 uint32_t *daddr = (uint32_t *) h->addr;
265 for (i = 0; i < 0x1fc / 4; ++i) {
266 sum ^= le32toh (*daddr);
273 #define HIVEX_OPEN_MSGLVL_MASK (HIVEX_OPEN_VERBOSE|HIVEX_OPEN_DEBUG)
276 hivex_open (const char *filename, int flags)
280 assert (sizeof (struct ntreg_header) == 0x1000);
281 assert (offsetof (struct ntreg_header, csum) == 0x1fc);
283 h = calloc (1, sizeof *h);
287 h->msglvl = flags & HIVEX_OPEN_MSGLVL_MASK;
289 const char *debug = getenv ("HIVEX_DEBUG");
290 if (debug && STREQ (debug, "1"))
294 fprintf (stderr, "hivex_open: created handle %p\n", h);
296 h->writable = !!(flags & HIVEX_OPEN_WRITE);
297 h->filename = strdup (filename);
298 if (h->filename == NULL)
301 h->fd = open (filename, O_RDONLY | O_CLOEXEC);
306 if (fstat (h->fd, &statbuf) == -1)
309 h->size = statbuf.st_size;
312 h->addr = mmap (NULL, h->size, PROT_READ, MAP_SHARED, h->fd, 0);
313 if (h->addr == MAP_FAILED)
317 fprintf (stderr, "hivex_open: mapped file at %p\n", h->addr);
319 h->addr = malloc (h->size);
323 if (full_read (h->fd, h->addr, h->size) < h->size)
328 if (h->hdr->magic[0] != 'r' ||
329 h->hdr->magic[1] != 'e' ||
330 h->hdr->magic[2] != 'g' ||
331 h->hdr->magic[3] != 'f') {
332 fprintf (stderr, "hivex: %s: not a Windows NT Registry hive file\n",
338 /* Check major version. */
339 uint32_t major_ver = le32toh (h->hdr->major_ver);
340 if (major_ver != 1) {
342 "hivex: %s: hive file major version %" PRIu32 " (expected 1)\n",
343 filename, major_ver);
348 h->bitmap = calloc (1 + h->size / 32, 1);
349 if (h->bitmap == NULL)
352 /* Header checksum. */
353 uint32_t sum = header_checksum (h);
354 if (sum != le32toh (h->hdr->csum)) {
355 fprintf (stderr, "hivex: %s: bad checksum in hive header\n", filename);
360 if (h->msglvl >= 2) {
361 char *name = windows_utf16_to_utf8 (h->hdr->name, 64);
364 "hivex_open: header fields:\n"
365 " file version %" PRIu32 ".%" PRIu32 "\n"
366 " sequence nos %" PRIu32 " %" PRIu32 "\n"
367 " (sequences nos should match if hive was synched at shutdown)\n"
368 " original file name %s\n"
369 " (only 32 chars are stored, name is probably truncated)\n"
370 " root offset 0x%x + 0x1000\n"
371 " end of last page 0x%x + 0x1000 (total file size 0x%zx)\n"
372 " checksum 0x%x (calculated 0x%x)\n",
373 major_ver, le32toh (h->hdr->minor_ver),
374 le32toh (h->hdr->sequence1), le32toh (h->hdr->sequence2),
375 name ? name : "(conversion failed)",
376 le32toh (h->hdr->offset),
377 le32toh (h->hdr->blocks), h->size,
378 le32toh (h->hdr->csum), sum);
382 h->rootoffs = le32toh (h->hdr->offset) + 0x1000;
383 h->endpages = le32toh (h->hdr->blocks) + 0x1000;
386 fprintf (stderr, "hivex_open: root offset = 0x%zx\n", h->rootoffs);
388 /* We'll set this flag when we see a block with the root offset (ie.
391 int seen_root_block = 0, bad_root_block = 0;
393 /* Collect some stats. */
394 size_t pages = 0; /* Number of hbin pages read. */
395 size_t smallest_page = SIZE_MAX, largest_page = 0;
396 size_t blocks = 0; /* Total number of blocks found. */
397 size_t smallest_block = SIZE_MAX, largest_block = 0, blocks_bytes = 0;
398 size_t used_blocks = 0; /* Total number of used blocks found. */
399 size_t used_size = 0; /* Total size (bytes) of used blocks. */
401 /* Read the pages and blocks. The aim here is to be robust against
402 * corrupt or malicious registries. So we make sure the loops
403 * always make forward progress. We add the address of each block
404 * we read to a hash table so pointers will only reference the start
408 struct ntreg_hbin_page *page;
409 for (off = 0x1000; off < h->size; off += le32toh (page->page_size)) {
410 if (off >= h->endpages)
413 page = (struct ntreg_hbin_page *) (h->addr + off);
414 if (page->magic[0] != 'h' ||
415 page->magic[1] != 'b' ||
416 page->magic[2] != 'i' ||
417 page->magic[3] != 'n') {
418 fprintf (stderr, "hivex: %s: trailing garbage at end of file (at 0x%zx, after %zu pages)\n",
419 filename, off, pages);
424 size_t page_size = le32toh (page->page_size);
426 fprintf (stderr, "hivex_open: page at 0x%zx, size %zu\n", off, page_size);
428 if (page_size < smallest_page) smallest_page = page_size;
429 if (page_size > largest_page) largest_page = page_size;
431 if (page_size <= sizeof (struct ntreg_hbin_page) ||
432 (page_size & 0x0fff) != 0) {
433 fprintf (stderr, "hivex: %s: page size %zu at 0x%zx, bad registry\n",
434 filename, page_size, off);
439 /* Read the blocks in this page. */
441 struct ntreg_hbin_block *block;
443 for (blkoff = off + 0x20;
444 blkoff < off + page_size;
448 int is_root = blkoff == h->rootoffs;
452 block = (struct ntreg_hbin_block *) (h->addr + blkoff);
454 seg_len = block_len (h, blkoff, &used);
455 if (seg_len <= 4 || (seg_len & 3) != 0) {
456 fprintf (stderr, "hivex: %s: block size %" PRIu32 " at 0x%zx, bad registry\n",
457 filename, le32toh (block->seg_len), blkoff);
463 fprintf (stderr, "hivex_open: %s block id %d,%d at 0x%zx size %zu%s\n",
464 used ? "used" : "free", block->id[0], block->id[1], blkoff,
465 seg_len, is_root ? " (root)" : "");
467 blocks_bytes += seg_len;
468 if (seg_len < smallest_block) smallest_block = seg_len;
469 if (seg_len > largest_block) largest_block = seg_len;
471 if (is_root && !used)
476 used_size += seg_len;
478 /* Root block must be an nk-block. */
479 if (is_root && (block->id[0] != 'n' || block->id[1] != 'k'))
482 /* Note this blkoff is a valid address. */
483 BITMAP_SET (h->bitmap, blkoff);
488 if (!seen_root_block) {
489 fprintf (stderr, "hivex: %s: no root block found\n", filename);
494 if (bad_root_block) {
495 fprintf (stderr, "hivex: %s: bad root block (free or not nk)\n", filename);
502 "hivex_open: successfully read Windows Registry hive file:\n"
503 " pages: %zu [sml: %zu, lge: %zu]\n"
504 " blocks: %zu [sml: %zu, avg: %zu, lge: %zu]\n"
505 " blocks used: %zu\n"
506 " bytes used: %zu\n",
507 pages, smallest_page, largest_page,
508 blocks, smallest_block, blocks_bytes / blocks, largest_block,
509 used_blocks, used_size);
517 if (h->addr && h->size && h->addr != MAP_FAILED) {
519 munmap (h->addr, h->size);
533 hivex_close (hive_h *h)
539 munmap (h->addr, h->size);
549 /*----------------------------------------------------------------------
554 hivex_root (hive_h *h)
556 hive_node_h ret = h->rootoffs;
557 if (!IS_VALID_BLOCK (h, ret)) {
565 hivex_node_name (hive_h *h, hive_node_h node)
567 if (!IS_VALID_BLOCK (h, node) || !BLOCK_ID_EQ (h, node, "nk")) {
572 struct ntreg_nk_record *nk = (struct ntreg_nk_record *) (h->addr + node);
574 /* AFAIK the node name is always plain ASCII, so no conversion
575 * to UTF-8 is necessary. However we do need to nul-terminate
579 /* nk->name_len is unsigned, 16 bit, so this is safe ... However
580 * we have to make sure the length doesn't exceed the block length.
582 size_t len = le16toh (nk->name_len);
583 size_t seg_len = block_len (h, node, NULL);
584 if (sizeof (struct ntreg_nk_record) + len - 1 > seg_len) {
586 fprintf (stderr, "hivex_node_name: returning EFAULT because node name is too long (%zu, %zu)\n",
592 char *ret = malloc (len + 1);
595 memcpy (ret, nk->name, len);
601 /* I think the documentation for the sk and classname fields in the nk
602 * record is wrong, or else the offset field is in the wrong place.
603 * Otherwise this makes no sense. Disabled this for now -- it's not
604 * useful for reading the registry anyway.
608 hivex_node_security (hive_h *h, hive_node_h node)
610 if (!IS_VALID_BLOCK (h, node) || !BLOCK_ID_EQ (h, node, "nk")) {
615 struct ntreg_nk_record *nk = (struct ntreg_nk_record *) (h->addr + node);
617 hive_node_h ret = le32toh (nk->sk);
619 if (!IS_VALID_BLOCK (h, ret)) {
627 hivex_node_classname (hive_h *h, hive_node_h node)
629 if (!IS_VALID_BLOCK (h, node) || !BLOCK_ID_EQ (h, node, "nk")) {
634 struct ntreg_nk_record *nk = (struct ntreg_nk_record *) (h->addr + node);
636 hive_node_h ret = le32toh (nk->classname);
638 if (!IS_VALID_BLOCK (h, ret)) {
646 /* Structure for returning 0-terminated lists of offsets (nodes,
656 init_offset_list (struct offset_list *list)
660 list->offsets = NULL;
663 #define INIT_OFFSET_LIST(name) \
664 struct offset_list name; \
665 init_offset_list (&name)
667 /* Preallocates the offset_list, but doesn't make the contents longer. */
669 grow_offset_list (struct offset_list *list, size_t alloc)
671 assert (alloc >= list->len);
672 size_t *p = realloc (list->offsets, alloc * sizeof (size_t));
681 add_to_offset_list (struct offset_list *list, size_t offset)
683 if (list->len >= list->alloc) {
684 if (grow_offset_list (list, list->alloc ? list->alloc * 2 : 4) == -1)
687 list->offsets[list->len] = offset;
693 free_offset_list (struct offset_list *list)
695 free (list->offsets);
699 return_offset_list (struct offset_list *list)
701 if (add_to_offset_list (list, 0) == -1)
703 return list->offsets; /* caller frees */
706 /* Iterate over children, returning child nodes and intermediate blocks. */
707 #define GET_CHILDREN_NO_CHECK_NK 1
710 get_children (hive_h *h, hive_node_h node,
711 hive_node_h **children_ret, size_t **blocks_ret,
714 if (!IS_VALID_BLOCK (h, node) || !BLOCK_ID_EQ (h, node, "nk")) {
719 struct ntreg_nk_record *nk = (struct ntreg_nk_record *) (h->addr + node);
721 size_t nr_subkeys_in_nk = le32toh (nk->nr_subkeys);
723 INIT_OFFSET_LIST (children);
724 INIT_OFFSET_LIST (blocks);
726 /* Deal with the common "no subkeys" case quickly. */
727 if (nr_subkeys_in_nk == 0)
730 /* Arbitrarily limit the number of subkeys we will ever deal with. */
731 if (nr_subkeys_in_nk > HIVEX_MAX_SUBKEYS) {
733 fprintf (stderr, "hivex: get_children: returning ERANGE because nr_subkeys_in_nk > HIVEX_MAX_SUBKEYS (%zu > %d)\n",
734 nr_subkeys_in_nk, HIVEX_MAX_SUBKEYS);
739 /* Preallocate space for the children. */
740 if (grow_offset_list (&children, nr_subkeys_in_nk) == -1)
743 /* The subkey_lf field can point either to an lf-record, which is
744 * the common case, or if there are lots of subkeys, to an
747 size_t subkey_lf = le32toh (nk->subkey_lf);
749 if (!IS_VALID_BLOCK (h, subkey_lf)) {
751 fprintf (stderr, "hivex_node_children: returning EFAULT because subkey_lf is not a valid block (0x%zx)\n",
757 if (add_to_offset_list (&blocks, subkey_lf) == -1)
760 struct ntreg_hbin_block *block =
761 (struct ntreg_hbin_block *) (h->addr + subkey_lf);
763 /* Points to lf-record? (Note, also "lh" but that is basically the
764 * same as "lf" as far as we are concerned here).
766 if (block->id[0] == 'l' && (block->id[1] == 'f' || block->id[1] == 'h')) {
767 struct ntreg_lf_record *lf = (struct ntreg_lf_record *) block;
769 /* Check number of subkeys in the nk-record matches number of subkeys
772 size_t nr_subkeys_in_lf = le16toh (lf->nr_keys);
775 fprintf (stderr, "hivex_node_children: nr_subkeys_in_nk = %zu, nr_subkeys_in_lf = %zu\n",
776 nr_subkeys_in_nk, nr_subkeys_in_lf);
778 if (nr_subkeys_in_nk != nr_subkeys_in_lf) {
783 size_t len = block_len (h, subkey_lf, NULL);
784 if (8 + nr_subkeys_in_lf * 8 > len) {
786 fprintf (stderr, "hivex_node_children: returning EFAULT because too many subkeys (%zu, %zu)\n",
787 nr_subkeys_in_lf, len);
793 for (i = 0; i < nr_subkeys_in_lf; ++i) {
794 hive_node_h subkey = le32toh (lf->keys[i].offset);
796 if (!(flags & GET_CHILDREN_NO_CHECK_NK)) {
797 if (!IS_VALID_BLOCK (h, subkey)) {
799 fprintf (stderr, "hivex_node_children: returning EFAULT because subkey is not a valid block (0x%zx)\n",
805 if (add_to_offset_list (&children, subkey) == -1)
810 /* Points to ri-record? */
811 else if (block->id[0] == 'r' && block->id[1] == 'i') {
812 struct ntreg_ri_record *ri = (struct ntreg_ri_record *) block;
814 size_t nr_offsets = le16toh (ri->nr_offsets);
816 /* Count total number of children. */
818 for (i = 0; i < nr_offsets; ++i) {
819 hive_node_h offset = le32toh (ri->offset[i]);
821 if (!IS_VALID_BLOCK (h, offset)) {
823 fprintf (stderr, "hivex_node_children: returning EFAULT because ri-offset is not a valid block (0x%zx)\n",
828 if (!BLOCK_ID_EQ (h, offset, "lf") && !BLOCK_ID_EQ (h, offset, "lh")) {
830 fprintf (stderr, "get_children: returning ENOTSUP because ri-record offset does not point to lf/lh (0x%zx)\n",
836 if (add_to_offset_list (&blocks, offset) == -1)
839 struct ntreg_lf_record *lf =
840 (struct ntreg_lf_record *) (h->addr + offset);
842 count += le16toh (lf->nr_keys);
846 fprintf (stderr, "hivex_node_children: nr_subkeys_in_nk = %zu, counted = %zu\n",
847 nr_subkeys_in_nk, count);
849 if (nr_subkeys_in_nk != count) {
854 /* Copy list of children. Note nr_subkeys_in_nk is limited to
855 * something reasonable above.
857 for (i = 0; i < nr_offsets; ++i) {
858 hive_node_h offset = le32toh (ri->offset[i]);
860 if (!IS_VALID_BLOCK (h, offset)) {
862 fprintf (stderr, "hivex_node_children: returning EFAULT because ri-offset is not a valid block (0x%zx)\n",
867 if (!BLOCK_ID_EQ (h, offset, "lf") && !BLOCK_ID_EQ (h, offset, "lh")) {
869 fprintf (stderr, "get_children: returning ENOTSUP because ri-record offset does not point to lf/lh (0x%zx)\n",
875 struct ntreg_lf_record *lf =
876 (struct ntreg_lf_record *) (h->addr + offset);
879 for (j = 0; j < le16toh (lf->nr_keys); ++j) {
880 hive_node_h subkey = le32toh (lf->keys[j].offset);
882 if (!(flags & GET_CHILDREN_NO_CHECK_NK)) {
883 if (!IS_VALID_BLOCK (h, subkey)) {
885 fprintf (stderr, "hivex_node_children: returning EFAULT because indirect subkey is not a valid block (0x%zx)\n",
891 if (add_to_offset_list (&children, subkey) == -1)
897 /* else not supported, set errno and fall through */
899 fprintf (stderr, "get_children: returning ENOTSUP because subkey block is not lf/lh/ri (0x%zx, %d, %d)\n",
900 subkey_lf, block->id[0], block->id[1]);
903 free_offset_list (&children);
904 free_offset_list (&blocks);
908 *children_ret = return_offset_list (&children);
909 *blocks_ret = return_offset_list (&blocks);
910 if (!*children_ret || !*blocks_ret)
916 hivex_node_children (hive_h *h, hive_node_h node)
918 hive_node_h *children;
921 if (get_children (h, node, &children, &blocks, 0) == -1)
928 /* Very inefficient, but at least having a separate API call
929 * allows us to make it more efficient in future.
932 hivex_node_get_child (hive_h *h, hive_node_h node, const char *nname)
934 hive_node_h *children = NULL;
938 children = hivex_node_children (h, node);
939 if (!children) goto error;
942 for (i = 0; children[i] != 0; ++i) {
943 name = hivex_node_name (h, children[i]);
944 if (!name) goto error;
945 if (STRCASEEQ (name, nname)) {
949 free (name); name = NULL;
959 hivex_node_parent (hive_h *h, hive_node_h node)
961 if (!IS_VALID_BLOCK (h, node) || !BLOCK_ID_EQ (h, node, "nk")) {
966 struct ntreg_nk_record *nk = (struct ntreg_nk_record *) (h->addr + node);
968 hive_node_h ret = le32toh (nk->parent);
970 if (!IS_VALID_BLOCK (h, ret)) {
972 fprintf (stderr, "hivex_node_parent: returning EFAULT because parent is not a valid block (0x%zx)\n",
981 get_values (hive_h *h, hive_node_h node,
982 hive_value_h **values_ret, size_t **blocks_ret)
984 if (!IS_VALID_BLOCK (h, node) || !BLOCK_ID_EQ (h, node, "nk")) {
989 struct ntreg_nk_record *nk = (struct ntreg_nk_record *) (h->addr + node);
991 size_t nr_values = le32toh (nk->nr_values);
994 fprintf (stderr, "hivex_node_values: nr_values = %zu\n", nr_values);
996 INIT_OFFSET_LIST (values);
997 INIT_OFFSET_LIST (blocks);
999 /* Deal with the common "no values" case quickly. */
1003 /* Arbitrarily limit the number of values we will ever deal with. */
1004 if (nr_values > HIVEX_MAX_VALUES) {
1006 fprintf (stderr, "hivex: get_values: returning ERANGE because nr_values > HIVEX_MAX_VALUES (%zu > %d)\n",
1007 nr_values, HIVEX_MAX_VALUES);
1012 /* Preallocate space for the values. */
1013 if (grow_offset_list (&values, nr_values) == -1)
1016 /* Get the value list and check it looks reasonable. */
1017 size_t vlist_offset = le32toh (nk->vallist);
1018 vlist_offset += 0x1000;
1019 if (!IS_VALID_BLOCK (h, vlist_offset)) {
1021 fprintf (stderr, "hivex_node_values: returning EFAULT because value list is not a valid block (0x%zx)\n",
1027 if (add_to_offset_list (&blocks, vlist_offset) == -1)
1030 struct ntreg_value_list *vlist =
1031 (struct ntreg_value_list *) (h->addr + vlist_offset);
1033 size_t len = block_len (h, vlist_offset, NULL);
1034 if (4 + nr_values * 4 > len) {
1036 fprintf (stderr, "hivex_node_values: returning EFAULT because value list is too long (%zu, %zu)\n",
1043 for (i = 0; i < nr_values; ++i) {
1044 hive_node_h value = vlist->offset[i];
1046 if (!IS_VALID_BLOCK (h, value)) {
1048 fprintf (stderr, "hivex_node_values: returning EFAULT because value is not a valid block (0x%zx)\n",
1053 if (add_to_offset_list (&values, value) == -1)
1058 *values_ret = return_offset_list (&values);
1059 *blocks_ret = return_offset_list (&blocks);
1060 if (!*values_ret || !*blocks_ret)
1065 free_offset_list (&values);
1066 free_offset_list (&blocks);
1071 hivex_node_values (hive_h *h, hive_node_h node)
1073 hive_value_h *values;
1076 if (get_values (h, node, &values, &blocks) == -1)
1083 /* Very inefficient, but at least having a separate API call
1084 * allows us to make it more efficient in future.
1087 hivex_node_get_value (hive_h *h, hive_node_h node, const char *key)
1089 hive_value_h *values = NULL;
1091 hive_value_h ret = 0;
1093 values = hivex_node_values (h, node);
1094 if (!values) goto error;
1097 for (i = 0; values[i] != 0; ++i) {
1098 name = hivex_value_key (h, values[i]);
1099 if (!name) goto error;
1100 if (STRCASEEQ (name, key)) {
1104 free (name); name = NULL;
1114 hivex_value_key (hive_h *h, hive_value_h value)
1116 if (!IS_VALID_BLOCK (h, value) || !BLOCK_ID_EQ (h, value, "vk")) {
1121 struct ntreg_vk_record *vk = (struct ntreg_vk_record *) (h->addr + value);
1123 /* AFAIK the key is always plain ASCII, so no conversion to UTF-8 is
1124 * necessary. However we do need to nul-terminate the string.
1127 /* vk->name_len is unsigned, 16 bit, so this is safe ... However
1128 * we have to make sure the length doesn't exceed the block length.
1130 size_t len = le16toh (vk->name_len);
1131 size_t seg_len = block_len (h, value, NULL);
1132 if (sizeof (struct ntreg_vk_record) + len - 1 > seg_len) {
1134 fprintf (stderr, "hivex_value_key: returning EFAULT because key length is too long (%zu, %zu)\n",
1140 char *ret = malloc (len + 1);
1143 memcpy (ret, vk->name, len);
1149 hivex_value_type (hive_h *h, hive_value_h value, hive_type *t, size_t *len)
1151 if (!IS_VALID_BLOCK (h, value) || !BLOCK_ID_EQ (h, value, "vk")) {
1156 struct ntreg_vk_record *vk = (struct ntreg_vk_record *) (h->addr + value);
1159 *t = le32toh (vk->data_type);
1162 *len = le32toh (vk->data_len);
1163 *len &= 0x7fffffff; /* top bit indicates if data is stored inline */
1170 hivex_value_value (hive_h *h, hive_value_h value,
1171 hive_type *t_rtn, size_t *len_rtn)
1173 if (!IS_VALID_BLOCK (h, value) || !BLOCK_ID_EQ (h, value, "vk")) {
1178 struct ntreg_vk_record *vk = (struct ntreg_vk_record *) (h->addr + value);
1184 t = le32toh (vk->data_type);
1186 len = le32toh (vk->data_len);
1187 is_inline = !!(len & 0x80000000);
1191 fprintf (stderr, "hivex_value_value: value=0x%zx, t=%d, len=%zu, inline=%d\n",
1192 value, t, len, is_inline);
1199 if (is_inline && len > 4) {
1204 /* Arbitrarily limit the length that we will read. */
1205 if (len > HIVEX_MAX_VALUE_LEN) {
1207 fprintf (stderr, "hivex_value_value: returning ERANGE because data length > HIVEX_MAX_VALUE_LEN (%zu > %d)\n",
1208 len, HIVEX_MAX_SUBKEYS);
1213 char *ret = malloc (len);
1218 memcpy (ret, (char *) &vk->data_offset, len);
1222 size_t data_offset = le32toh (vk->data_offset);
1223 data_offset += 0x1000;
1224 if (!IS_VALID_BLOCK (h, data_offset)) {
1226 fprintf (stderr, "hivex_value_value: returning EFAULT because data offset is not a valid block (0x%zx)\n",
1233 /* Check that the declared size isn't larger than the block its in.
1235 * XXX Some apparently valid registries are seen to have this,
1236 * so turn this into a warning and substitute the smaller length
1239 size_t blen = block_len (h, data_offset, NULL);
1240 if (len > blen - 4 /* subtract 4 for block header */) {
1242 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",
1243 data_offset, len, blen);
1247 char *data = h->addr + data_offset + 4;
1248 memcpy (ret, data, len);
1253 windows_utf16_to_utf8 (/* const */ char *input, size_t len)
1255 iconv_t ic = iconv_open ("UTF-8", "UTF-16");
1256 if (ic == (iconv_t) -1)
1259 /* iconv(3) has an insane interface ... */
1261 /* Mostly UTF-8 will be smaller, so this is a good initial guess. */
1262 size_t outalloc = len;
1266 size_t outlen = outalloc;
1267 char *out = malloc (outlen + 1);
1277 size_t r = iconv (ic, &inp, &inlen, &outp, &outlen);
1278 if (r == (size_t) -1) {
1279 if (errno == E2BIG) {
1281 size_t prev = outalloc;
1282 /* Try again with a larger output buffer. */
1285 if (outalloc < prev) {
1293 /* Else some conversion failure, eg. EILSEQ, EINVAL. */
1309 hivex_value_string (hive_h *h, hive_value_h value)
1313 char *data = hivex_value_value (h, value, &t, &len);
1318 if (t != hive_t_string && t != hive_t_expand_string && t != hive_t_link) {
1324 /* Deal with the case where Windows has allocated a large buffer
1325 * full of random junk, and only the first few bytes of the buffer
1326 * contain a genuine UTF-16 string.
1328 * In this case, iconv would try to process the junk bytes as UTF-16
1329 * and inevitably find an illegal sequence (EILSEQ). Instead, stop
1330 * after we find the first \0\0.
1332 * (Found by Hilko Bengen in a fresh Windows XP SOFTWARE hive).
1334 size_t slen = utf16_string_len_in_bytes_max (data, len);
1338 char *ret = windows_utf16_to_utf8 (data, len);
1347 free_strings (char **argv)
1352 for (i = 0; argv[i] != NULL; ++i)
1358 /* Get the length of a UTF-16 format string. Handle the string as
1359 * pairs of bytes, looking for the first \0\0 pair.
1362 utf16_string_len_in_bytes (const char *str)
1366 while (str[0] || str[1]) {
1374 /* As for utf16_string_len_in_bytes but only read up to a maximum length. */
1376 utf16_string_len_in_bytes_max (const char *str, size_t len)
1380 while (len > 0 && (str[0] || str[1])) {
1389 /* http://blogs.msdn.com/oldnewthing/archive/2009/10/08/9904646.aspx */
1391 hivex_value_multiple_strings (hive_h *h, hive_value_h value)
1395 char *data = hivex_value_value (h, value, &t, &len);
1400 if (t != hive_t_multiple_strings) {
1406 size_t nr_strings = 0;
1407 char **ret = malloc ((1 + nr_strings) * sizeof (char *));
1417 while (p < data + len && (plen = utf16_string_len_in_bytes (p)) > 0) {
1419 char **ret2 = realloc (ret, (1 + nr_strings) * sizeof (char *));
1427 ret[nr_strings-1] = windows_utf16_to_utf8 (p, plen);
1428 ret[nr_strings] = NULL;
1429 if (ret[nr_strings-1] == NULL) {
1435 p += plen + 2 /* skip over UTF-16 \0\0 at the end of this string */;
1443 hivex_value_dword (hive_h *h, hive_value_h value)
1447 char *data = hivex_value_value (h, value, &t, &len);
1452 if ((t != hive_t_dword && t != hive_t_dword_be) || len != 4) {
1458 int32_t ret = *(int32_t*)data;
1460 if (t == hive_t_dword) /* little endian */
1461 ret = le32toh (ret);
1463 ret = be32toh (ret);
1469 hivex_value_qword (hive_h *h, hive_value_h value)
1473 char *data = hivex_value_value (h, value, &t, &len);
1478 if (t != hive_t_qword || len != 8) {
1484 int64_t ret = *(int64_t*)data;
1486 ret = le64toh (ret); /* always little endian */
1491 /*----------------------------------------------------------------------
1496 hivex_visit (hive_h *h, const struct hivex_visitor *visitor, size_t len,
1497 void *opaque, int flags)
1499 return hivex_visit_node (h, hivex_root (h), visitor, len, opaque, flags);
1502 static int hivex__visit_node (hive_h *h, hive_node_h node, const struct hivex_visitor *vtor, char *unvisited, void *opaque, int flags);
1505 hivex_visit_node (hive_h *h, hive_node_h node,
1506 const struct hivex_visitor *visitor, size_t len, void *opaque,
1509 struct hivex_visitor vtor;
1510 memset (&vtor, 0, sizeof vtor);
1512 /* Note that len might be larger *or smaller* than the expected size. */
1513 size_t copysize = len <= sizeof vtor ? len : sizeof vtor;
1514 memcpy (&vtor, visitor, copysize);
1516 /* This bitmap records unvisited nodes, so we don't loop if the
1517 * registry contains cycles.
1519 char *unvisited = malloc (1 + h->size / 32);
1520 if (unvisited == NULL)
1522 memcpy (unvisited, h->bitmap, 1 + h->size / 32);
1524 int r = hivex__visit_node (h, node, &vtor, unvisited, opaque, flags);
1530 hivex__visit_node (hive_h *h, hive_node_h node,
1531 const struct hivex_visitor *vtor, char *unvisited,
1532 void *opaque, int flags)
1534 int skip_bad = flags & HIVEX_VISIT_SKIP_BAD;
1536 hive_value_h *values = NULL;
1537 hive_node_h *children = NULL;
1543 /* Return -1 on all callback errors. However on internal errors,
1544 * check if skip_bad is set and suppress those errors if so.
1548 if (!BITMAP_TST (unvisited, node)) {
1550 fprintf (stderr, "hivex__visit_node: contains cycle: visited node 0x%zx already\n",
1554 return skip_bad ? 0 : -1;
1556 BITMAP_CLR (unvisited, node);
1558 name = hivex_node_name (h, node);
1559 if (!name) return skip_bad ? 0 : -1;
1560 if (vtor->node_start && vtor->node_start (h, opaque, node, name) == -1)
1563 values = hivex_node_values (h, node);
1565 ret = skip_bad ? 0 : -1;
1569 for (i = 0; values[i] != 0; ++i) {
1573 if (hivex_value_type (h, values[i], &t, &len) == -1) {
1574 ret = skip_bad ? 0 : -1;
1578 key = hivex_value_key (h, values[i]);
1580 ret = skip_bad ? 0 : -1;
1584 if (vtor->value_any) {
1585 str = hivex_value_value (h, values[i], &t, &len);
1587 ret = skip_bad ? 0 : -1;
1590 if (vtor->value_any (h, opaque, node, values[i], t, len, key, str) == -1)
1592 free (str); str = NULL;
1597 str = hivex_value_value (h, values[i], &t, &len);
1599 ret = skip_bad ? 0 : -1;
1602 if (t != hive_t_none) {
1603 ret = skip_bad ? 0 : -1;
1606 if (vtor->value_none &&
1607 vtor->value_none (h, opaque, node, values[i], t, len, key, str) == -1)
1609 free (str); str = NULL;
1613 case hive_t_expand_string:
1615 str = hivex_value_string (h, values[i]);
1617 if (errno != EILSEQ && errno != EINVAL) {
1618 ret = skip_bad ? 0 : -1;
1621 if (vtor->value_string_invalid_utf16) {
1622 str = hivex_value_value (h, values[i], &t, &len);
1623 if (vtor->value_string_invalid_utf16 (h, opaque, node, values[i], t, len, key, str) == -1)
1625 free (str); str = NULL;
1629 if (vtor->value_string &&
1630 vtor->value_string (h, opaque, node, values[i], t, len, key, str) == -1)
1632 free (str); str = NULL;
1636 case hive_t_dword_be: {
1637 int32_t i32 = hivex_value_dword (h, values[i]);
1638 if (vtor->value_dword &&
1639 vtor->value_dword (h, opaque, node, values[i], t, len, key, i32) == -1)
1644 case hive_t_qword: {
1645 int64_t i64 = hivex_value_qword (h, values[i]);
1646 if (vtor->value_qword &&
1647 vtor->value_qword (h, opaque, node, values[i], t, len, key, i64) == -1)
1653 str = hivex_value_value (h, values[i], &t, &len);
1655 ret = skip_bad ? 0 : -1;
1658 if (t != hive_t_binary) {
1659 ret = skip_bad ? 0 : -1;
1662 if (vtor->value_binary &&
1663 vtor->value_binary (h, opaque, node, values[i], t, len, key, str) == -1)
1665 free (str); str = NULL;
1668 case hive_t_multiple_strings:
1669 strs = hivex_value_multiple_strings (h, values[i]);
1671 if (errno != EILSEQ && errno != EINVAL) {
1672 ret = skip_bad ? 0 : -1;
1675 if (vtor->value_string_invalid_utf16) {
1676 str = hivex_value_value (h, values[i], &t, &len);
1677 if (vtor->value_string_invalid_utf16 (h, opaque, node, values[i], t, len, key, str) == -1)
1679 free (str); str = NULL;
1683 if (vtor->value_multiple_strings &&
1684 vtor->value_multiple_strings (h, opaque, node, values[i], t, len, key, strs) == -1)
1686 free_strings (strs); strs = NULL;
1689 case hive_t_resource_list:
1690 case hive_t_full_resource_description:
1691 case hive_t_resource_requirements_list:
1693 str = hivex_value_value (h, values[i], &t, &len);
1695 ret = skip_bad ? 0 : -1;
1698 if (vtor->value_other &&
1699 vtor->value_other (h, opaque, node, values[i], t, len, key, str) == -1)
1701 free (str); str = NULL;
1706 free (key); key = NULL;
1709 children = hivex_node_children (h, node);
1710 if (children == NULL) {
1711 ret = skip_bad ? 0 : -1;
1715 for (i = 0; children[i] != 0; ++i) {
1717 fprintf (stderr, "hivex__visit_node: %s: visiting subkey %d (0x%zx)\n",
1718 name, i, children[i]);
1720 if (hivex__visit_node (h, children[i], vtor, unvisited, opaque, flags) == -1)
1724 if (vtor->node_end && vtor->node_end (h, opaque, node, name) == -1)
1735 free_strings (strs);
1739 /*----------------------------------------------------------------------
1743 /* Allocate an hbin (page), extending the malloc'd space if necessary,
1744 * and updating the hive handle fields (but NOT the hive disk header
1745 * -- the hive disk header is updated when we commit). This function
1746 * also extends the bitmap if necessary.
1748 * 'allocation_hint' is the size of the block allocation we would like
1749 * to make. Normally registry blocks are very small (avg 50 bytes)
1750 * and are contained in standard-sized pages (4KB), but the registry
1751 * can support blocks which are larger than a standard page, in which
1752 * case it creates a page of 8KB, 12KB etc.
1755 * > 0 : offset of first usable byte of new page (after page header)
1756 * 0 : error (errno set)
1759 allocate_page (hive_h *h, size_t allocation_hint)
1761 /* In almost all cases this will be 1. */
1762 size_t nr_4k_pages =
1763 1 + (allocation_hint + sizeof (struct ntreg_hbin_page) - 1) / 4096;
1764 assert (nr_4k_pages >= 1);
1766 /* 'extend' is the number of bytes to extend the file by. Note that
1767 * hives found in the wild often contain slack between 'endpages'
1768 * and the actual end of the file, so we don't always need to make
1771 ssize_t extend = h->endpages + nr_4k_pages * 4096 - h->size;
1773 if (h->msglvl >= 2) {
1774 fprintf (stderr, "allocate_page: current endpages = 0x%zx, current size = 0x%zx\n",
1775 h->endpages, h->size);
1776 fprintf (stderr, "allocate_page: extending file by %zd bytes (<= 0 if no extension)\n",
1781 size_t oldsize = h->size;
1782 size_t newsize = h->size + extend;
1783 char *newaddr = realloc (h->addr, newsize);
1784 if (newaddr == NULL)
1787 size_t oldbitmapsize = 1 + oldsize / 32;
1788 size_t newbitmapsize = 1 + newsize / 32;
1789 char *newbitmap = realloc (h->bitmap, newbitmapsize);
1790 if (newbitmap == NULL) {
1797 h->bitmap = newbitmap;
1799 memset (h->addr + oldsize, 0, newsize - oldsize);
1800 memset (h->bitmap + oldbitmapsize, 0, newbitmapsize - oldbitmapsize);
1803 size_t offset = h->endpages;
1804 h->endpages += nr_4k_pages * 4096;
1807 fprintf (stderr, "allocate_page: new endpages = 0x%zx, new size = 0x%zx\n",
1808 h->endpages, h->size);
1810 /* Write the hbin header. */
1811 struct ntreg_hbin_page *page =
1812 (struct ntreg_hbin_page *) (h->addr + offset);
1813 page->magic[0] = 'h';
1814 page->magic[1] = 'b';
1815 page->magic[2] = 'i';
1816 page->magic[3] = 'n';
1817 page->offset_first = htole32 (offset - 0x1000);
1818 page->page_size = htole32 (nr_4k_pages * 4096);
1819 memset (page->unknown, 0, sizeof (page->unknown));
1822 fprintf (stderr, "allocate_page: new page at 0x%zx\n", offset);
1824 /* Offset of first usable byte after the header. */
1825 return offset + sizeof (struct ntreg_hbin_page);
1828 /* Allocate a single block, first allocating an hbin (page) at the end
1829 * of the current file if necessary. NB. To keep the implementation
1830 * simple and more likely to be correct, we do not reuse existing free
1833 * seg_len is the size of the block (this INCLUDES the block header).
1834 * The header of the block is initialized to -seg_len (negative to
1835 * indicate used). id[2] is the block ID (type), eg. "nk" for nk-
1836 * record. The block bitmap is updated to show this block as valid.
1837 * The rest of the contents of the block will be zero.
1839 * **NB** Because allocate_block may reallocate the memory, all
1840 * pointers into the memory become potentially invalid. I really
1841 * love writing in C, can't you tell?
1844 * > 0 : offset of new block
1845 * 0 : error (errno set)
1848 allocate_block (hive_h *h, size_t seg_len, const char id[2])
1856 /* The caller probably forgot to include the header. Note that
1857 * value lists have no ID field, so seg_len == 4 would be possible
1858 * for them, albeit unusual.
1861 fprintf (stderr, "allocate_block: refusing too small allocation (%zu), returning ERANGE\n",
1867 /* Refuse really large allocations. */
1868 if (seg_len > HIVEX_MAX_ALLOCATION) {
1870 fprintf (stderr, "allocate_block: refusing large allocation (%zu), returning ERANGE\n",
1876 /* Round up allocation to multiple of 8 bytes. All blocks must be
1877 * on an 8 byte boundary.
1879 seg_len = (seg_len + 7) & ~7;
1881 /* Allocate a new page if necessary. */
1882 if (h->endblocks == 0 || h->endblocks + seg_len > h->endpages) {
1883 size_t newendblocks = allocate_page (h, seg_len);
1884 if (newendblocks == 0)
1886 h->endblocks = newendblocks;
1889 size_t offset = h->endblocks;
1892 fprintf (stderr, "allocate_block: new block at 0x%zx, size %zu\n",
1895 struct ntreg_hbin_block *blockhdr =
1896 (struct ntreg_hbin_block *) (h->addr + offset);
1898 memset (blockhdr, 0, seg_len);
1900 blockhdr->seg_len = htole32 (- (int32_t) seg_len);
1901 if (id[0] && id[1] && seg_len >= sizeof (struct ntreg_hbin_block)) {
1902 blockhdr->id[0] = id[0];
1903 blockhdr->id[1] = id[1];
1906 BITMAP_SET (h->bitmap, offset);
1908 h->endblocks += seg_len;
1910 /* If there is space after the last block in the last page, then we
1911 * have to put a dummy free block header here to mark the rest of
1914 ssize_t rem = h->endpages - h->endblocks;
1917 fprintf (stderr, "allocate_block: marking remainder of page free starting at 0x%zx, size %zd\n",
1922 blockhdr = (struct ntreg_hbin_block *) (h->addr + h->endblocks);
1923 blockhdr->seg_len = htole32 ((int32_t) rem);
1929 /* 'offset' must point to a valid, used block. This function marks
1930 * the block unused (by updating the seg_len field) and invalidates
1931 * the bitmap. It does NOT do this recursively, so to avoid creating
1932 * unreachable used blocks, callers may have to recurse over the hive
1933 * structures. Also callers must ensure there are no references to
1934 * this block from other parts of the hive.
1937 mark_block_unused (hive_h *h, size_t offset)
1939 assert (h->writable);
1940 assert (IS_VALID_BLOCK (h, offset));
1943 fprintf (stderr, "mark_block_unused: marking 0x%zx unused\n", offset);
1945 struct ntreg_hbin_block *blockhdr =
1946 (struct ntreg_hbin_block *) (h->addr + offset);
1948 size_t seg_len = block_len (h, offset, NULL);
1949 blockhdr->seg_len = htole32 (seg_len);
1951 BITMAP_CLR (h->bitmap, offset);
1954 /* Delete all existing values at this node. */
1956 delete_values (hive_h *h, hive_node_h node)
1958 assert (h->writable);
1960 hive_value_h *values;
1962 if (get_values (h, node, &values, &blocks) == -1)
1966 for (i = 0; blocks[i] != 0; ++i)
1967 mark_block_unused (h, blocks[i]);
1971 for (i = 0; values[i] != 0; ++i) {
1972 struct ntreg_vk_record *vk =
1973 (struct ntreg_vk_record *) (h->addr + values[i]);
1977 len = le32toh (vk->data_len);
1978 is_inline = !!(len & 0x80000000); /* top bit indicates is inline */
1981 if (!is_inline) { /* non-inline, so remove data block */
1982 size_t data_offset = le32toh (vk->data_offset);
1983 data_offset += 0x1000;
1984 mark_block_unused (h, data_offset);
1987 /* remove vk record */
1988 mark_block_unused (h, values[i]);
1993 struct ntreg_nk_record *nk = (struct ntreg_nk_record *) (h->addr + node);
1994 nk->nr_values = htole32 (0);
1995 nk->vallist = htole32 (0xffffffff);
2001 hivex_commit (hive_h *h, const char *filename, int flags)
2013 filename = filename ? : h->filename;
2014 int fd = open (filename, O_WRONLY|O_CREAT|O_TRUNC|O_NOCTTY, 0666);
2018 /* Update the header fields. */
2019 uint32_t sequence = le32toh (h->hdr->sequence1);
2021 h->hdr->sequence1 = htole32 (sequence);
2022 h->hdr->sequence2 = htole32 (sequence);
2023 /* XXX Ought to update h->hdr->last_modified. */
2024 h->hdr->blocks = htole32 (h->endpages - 0x1000);
2026 /* Recompute header checksum. */
2027 uint32_t sum = header_checksum (h);
2028 h->hdr->csum = htole32 (sum);
2031 fprintf (stderr, "hivex_commit: new header checksum: 0x%x\n", sum);
2033 if (full_write (fd, h->addr, h->size) != h->size) {
2040 if (close (fd) == -1)
2046 /* Calculate the hash for a lf or lh record offset.
2049 calc_hash (const char *type, const char *name, char *ret)
2051 size_t len = strlen (name);
2053 if (STRPREFIX (type, "lf"))
2054 /* Old-style, not used in current registries. */
2055 memcpy (ret, name, len < 4 ? len : 4);
2057 /* New-style for lh-records. */
2060 for (i = 0; i < len; ++i) {
2061 c = c_toupper (name[i]);
2065 *((uint32_t *) ret) = htole32 (h);
2069 /* Create a completely new lh-record containing just the single node. */
2071 new_lh_record (hive_h *h, const char *name, hive_node_h node)
2073 static const char id[2] = { 'l', 'h' };
2074 size_t seg_len = sizeof (struct ntreg_lf_record);
2075 size_t offset = allocate_block (h, seg_len, id);
2079 struct ntreg_lf_record *lh = (struct ntreg_lf_record *) (h->addr + offset);
2080 lh->nr_keys = htole16 (1);
2081 lh->keys[0].offset = htole32 (node - 0x1000);
2082 calc_hash ("lh", name, lh->keys[0].hash);
2087 /* Insert node into existing lf/lh-record at position.
2088 * This allocates a new record and marks the old one as unused.
2091 insert_lf_record (hive_h *h, size_t old_offs, size_t posn,
2092 const char *name, hive_node_h node)
2094 assert (IS_VALID_BLOCK (h, old_offs));
2096 /* Work around C stupidity.
2097 * http://www.redhat.com/archives/libguestfs/2010-February/msg00056.html
2099 int test = BLOCK_ID_EQ (h, old_offs, "lf") || BLOCK_ID_EQ (h, old_offs, "lh");
2102 struct ntreg_lf_record *old_lf =
2103 (struct ntreg_lf_record *) (h->addr + old_offs);
2104 size_t nr_keys = le16toh (old_lf->nr_keys);
2106 nr_keys++; /* in new record ... */
2108 size_t seg_len = sizeof (struct ntreg_lf_record) + (nr_keys-1) * 8;
2110 /* Copy the old_lf->id in case it moves during allocate_block. */
2112 memcpy (id, old_lf->id, sizeof id);
2114 size_t new_offs = allocate_block (h, seg_len, id);
2118 /* old_lf could have been invalidated by allocate_block. */
2119 old_lf = (struct ntreg_lf_record *) (h->addr + old_offs);
2121 struct ntreg_lf_record *new_lf =
2122 (struct ntreg_lf_record *) (h->addr + new_offs);
2123 new_lf->nr_keys = htole16 (nr_keys);
2125 /* Copy the keys until we reach posn, insert the new key there, then
2126 * copy the remaining keys.
2129 for (i = 0; i < posn; ++i)
2130 new_lf->keys[i] = old_lf->keys[i];
2132 new_lf->keys[i].offset = htole32 (node - 0x1000);
2133 calc_hash (new_lf->id, name, new_lf->keys[i].hash);
2135 for (i = posn+1; i < nr_keys; ++i)
2136 new_lf->keys[i] = old_lf->keys[i-1];
2138 /* Old block is unused, return new block. */
2139 mark_block_unused (h, old_offs);
2143 /* Compare name with name in nk-record. */
2145 compare_name_with_nk_name (hive_h *h, const char *name, hive_node_h nk_offs)
2147 assert (IS_VALID_BLOCK (h, nk_offs));
2148 assert (BLOCK_ID_EQ (h, nk_offs, "nk"));
2150 /* Name in nk is not necessarily nul-terminated. */
2151 char *nname = hivex_node_name (h, nk_offs);
2153 /* Unfortunately we don't have a way to return errors here. */
2155 perror ("compare_name_with_nk_name");
2159 int r = strcasecmp (name, nname);
2166 hivex_node_add_child (hive_h *h, hive_node_h parent, const char *name)
2173 if (!IS_VALID_BLOCK (h, parent) || !BLOCK_ID_EQ (h, parent, "nk")) {
2178 if (name == NULL || strlen (name) == 0) {
2183 if (hivex_node_get_child (h, parent, name) != 0) {
2188 /* Create the new nk-record. */
2189 static const char nk_id[2] = { 'n', 'k' };
2190 size_t seg_len = sizeof (struct ntreg_nk_record) + strlen (name);
2191 hive_node_h node = allocate_block (h, seg_len, nk_id);
2196 fprintf (stderr, "hivex_node_add_child: allocated new nk-record for child at 0x%zx\n", node);
2198 struct ntreg_nk_record *nk = (struct ntreg_nk_record *) (h->addr + node);
2199 nk->flags = htole16 (0x0020); /* key is ASCII. */
2200 nk->parent = htole32 (parent - 0x1000);
2201 nk->subkey_lf = htole32 (0xffffffff);
2202 nk->subkey_lf_volatile = htole32 (0xffffffff);
2203 nk->vallist = htole32 (0xffffffff);
2204 nk->classname = htole32 (0xffffffff);
2205 nk->name_len = htole16 (strlen (name));
2206 strcpy (nk->name, name);
2208 /* Inherit parent sk. */
2209 struct ntreg_nk_record *parent_nk =
2210 (struct ntreg_nk_record *) (h->addr + parent);
2211 size_t parent_sk_offset = le32toh (parent_nk->sk);
2212 parent_sk_offset += 0x1000;
2213 if (!IS_VALID_BLOCK (h, parent_sk_offset) ||
2214 !BLOCK_ID_EQ (h, parent_sk_offset, "sk")) {
2216 fprintf (stderr, "hivex_node_add_child: returning EFAULT because parent sk is not a valid block (%zu)\n",
2221 struct ntreg_sk_record *sk =
2222 (struct ntreg_sk_record *) (h->addr + parent_sk_offset);
2223 sk->refcount = htole32 (le32toh (sk->refcount) + 1);
2224 nk->sk = htole32 (parent_sk_offset - 0x1000);
2226 /* Inherit parent timestamp. */
2227 memcpy (nk->timestamp, parent_nk->timestamp, sizeof (parent_nk->timestamp));
2229 /* What I found out the hard way (not documented anywhere): the
2230 * subkeys in lh-records must be kept sorted. If you just add a
2231 * subkey in a non-sorted position (eg. just add it at the end) then
2232 * Windows won't see the subkey _and_ Windows will corrupt the hive
2233 * itself when it modifies or saves it.
2235 * So use get_children() to get a list of intermediate
2236 * lf/lh-records. get_children() returns these in reading order
2237 * (which is sorted), so we look for the lf/lh-records in sequence
2238 * until we find the key name just after the one we are inserting,
2239 * and we insert the subkey just before it.
2241 * The only other case is the no-subkeys case, where we have to
2242 * create a brand new lh-record.
2244 hive_node_h *unused;
2247 if (get_children (h, parent, &unused, &blocks, 0) == -1)
2252 size_t nr_subkeys_in_parent_nk = le32toh (parent_nk->nr_subkeys);
2253 if (nr_subkeys_in_parent_nk == 0) { /* No subkeys case. */
2254 /* Free up any existing intermediate blocks. */
2255 for (i = 0; blocks[i] != 0; ++i)
2256 mark_block_unused (h, blocks[i]);
2257 size_t lh_offs = new_lh_record (h, name, node);
2263 /* Recalculate pointers that could have been invalidated by
2264 * previous call to allocate_block (via new_lh_record).
2266 nk = (struct ntreg_nk_record *) (h->addr + node);
2267 parent_nk = (struct ntreg_nk_record *) (h->addr + parent);
2270 fprintf (stderr, "hivex_node_add_child: no keys, allocated new lh-record at 0x%zx\n", lh_offs);
2272 parent_nk->subkey_lf = htole32 (lh_offs - 0x1000);
2274 else { /* Insert subkeys case. */
2275 size_t old_offs = 0, new_offs = 0;
2276 struct ntreg_lf_record *old_lf = NULL;
2278 /* Find lf/lh key name just after the one we are inserting. */
2279 for (i = 0; blocks[i] != 0; ++i) {
2280 if (BLOCK_ID_EQ (h, blocks[i], "lf") ||
2281 BLOCK_ID_EQ (h, blocks[i], "lh")) {
2282 old_offs = blocks[i];
2283 old_lf = (struct ntreg_lf_record *) (h->addr + old_offs);
2284 for (j = 0; j < le16toh (old_lf->nr_keys); ++j) {
2285 hive_node_h nk_offs = le32toh (old_lf->keys[j].offset);
2287 if (compare_name_with_nk_name (h, name, nk_offs) < 0)
2293 /* Insert it at the end.
2294 * old_offs points to the last lf record, set j.
2296 assert (old_offs != 0); /* should never happen if nr_subkeys > 0 */
2297 j = le16toh (old_lf->nr_keys);
2302 fprintf (stderr, "hivex_node_add_child: insert key in existing lh-record at 0x%zx, posn %zu\n", old_offs, j);
2304 new_offs = insert_lf_record (h, old_offs, j, name, node);
2305 if (new_offs == 0) {
2310 /* Recalculate pointers that could have been invalidated by
2311 * previous call to allocate_block (via insert_lf_record).
2313 nk = (struct ntreg_nk_record *) (h->addr + node);
2314 parent_nk = (struct ntreg_nk_record *) (h->addr + parent);
2317 fprintf (stderr, "hivex_node_add_child: new lh-record at 0x%zx\n",
2320 /* If the lf/lh-record was directly referenced by the parent nk,
2321 * then update the parent nk.
2323 if (le32toh (parent_nk->subkey_lf) + 0x1000 == old_offs)
2324 parent_nk->subkey_lf = htole32 (new_offs - 0x1000);
2325 /* Else we have to look for the intermediate ri-record and update
2329 for (i = 0; blocks[i] != 0; ++i) {
2330 if (BLOCK_ID_EQ (h, blocks[i], "ri")) {
2331 struct ntreg_ri_record *ri =
2332 (struct ntreg_ri_record *) (h->addr + blocks[i]);
2333 for (j = 0; j < le16toh (ri->nr_offsets); ++j)
2334 if (le32toh (ri->offset[j] + 0x1000) == old_offs) {
2335 ri->offset[j] = htole32 (new_offs - 0x1000);
2341 /* Not found .. This is an internal error. */
2343 fprintf (stderr, "hivex_node_add_child: returning ENOTSUP because could not find ri->lf link\n");
2355 /* Update nr_subkeys in parent nk. */
2356 nr_subkeys_in_parent_nk++;
2357 parent_nk->nr_subkeys = htole32 (nr_subkeys_in_parent_nk);
2359 /* Update max_subkey_name_len in parent nk. */
2360 uint16_t max = le16toh (parent_nk->max_subkey_name_len);
2361 if (max < strlen (name) * 2) /* *2 because "recoded" in UTF16-LE. */
2362 parent_nk->max_subkey_name_len = htole16 (strlen (name) * 2);
2367 /* Decrement the refcount of an sk-record, and if it reaches zero,
2368 * unlink it from the chain and delete it.
2371 delete_sk (hive_h *h, size_t sk_offset)
2373 if (!IS_VALID_BLOCK (h, sk_offset) || !BLOCK_ID_EQ (h, sk_offset, "sk")) {
2375 fprintf (stderr, "delete_sk: not an sk record: 0x%zx\n", sk_offset);
2380 struct ntreg_sk_record *sk = (struct ntreg_sk_record *) (h->addr + sk_offset);
2382 if (sk->refcount == 0) {
2384 fprintf (stderr, "delete_sk: sk record already has refcount 0: 0x%zx\n",
2392 if (sk->refcount == 0) {
2393 size_t sk_prev_offset = sk->sk_prev;
2394 sk_prev_offset += 0x1000;
2396 size_t sk_next_offset = sk->sk_next;
2397 sk_next_offset += 0x1000;
2399 /* Update sk_prev/sk_next SKs, unless they both point back to this
2400 * cell in which case we are deleting the last SK.
2402 if (sk_prev_offset != sk_offset && sk_next_offset != sk_offset) {
2403 struct ntreg_sk_record *sk_prev =
2404 (struct ntreg_sk_record *) (h->addr + sk_prev_offset);
2405 struct ntreg_sk_record *sk_next =
2406 (struct ntreg_sk_record *) (h->addr + sk_next_offset);
2408 sk_prev->sk_next = htole32 (sk_next_offset - 0x1000);
2409 sk_next->sk_prev = htole32 (sk_prev_offset - 0x1000);
2412 /* Refcount is zero so really delete this block. */
2413 mark_block_unused (h, sk_offset);
2419 /* Callback from hivex_node_delete_child which is called to delete a
2420 * node AFTER its subnodes have been visited. The subnodes have been
2421 * deleted but we still have to delete any lf/lh/li/ri records and the
2422 * value list block and values, followed by deleting the node itself.
2425 delete_node (hive_h *h, void *opaque, hive_node_h node, const char *name)
2427 /* Get the intermediate blocks. The subkeys have already been
2428 * deleted by this point, so tell get_children() not to check for
2429 * validity of the nk-records.
2431 hive_node_h *unused;
2433 if (get_children (h, node, &unused, &blocks, GET_CHILDREN_NO_CHECK_NK) == -1)
2437 /* We don't care what's in these intermediate blocks, so we can just
2438 * delete them unconditionally.
2441 for (i = 0; blocks[i] != 0; ++i)
2442 mark_block_unused (h, blocks[i]);
2446 /* Delete the values in the node. */
2447 if (delete_values (h, node) == -1)
2450 struct ntreg_nk_record *nk = (struct ntreg_nk_record *) (h->addr + node);
2452 /* If the NK references an SK, delete it. */
2453 size_t sk_offs = le32toh (nk->sk);
2454 if (sk_offs != 0xffffffff) {
2456 if (delete_sk (h, sk_offs) == -1)
2458 nk->sk = htole32 (0xffffffff);
2461 /* If the NK references a classname, delete it. */
2462 size_t cl_offs = le32toh (nk->classname);
2463 if (cl_offs != 0xffffffff) {
2465 mark_block_unused (h, cl_offs);
2466 nk->classname = htole32 (0xffffffff);
2469 /* Delete the node itself. */
2470 mark_block_unused (h, node);
2476 hivex_node_delete_child (hive_h *h, hive_node_h node)
2483 if (!IS_VALID_BLOCK (h, node) || !BLOCK_ID_EQ (h, node, "nk")) {
2488 if (node == hivex_root (h)) {
2490 fprintf (stderr, "hivex_node_delete_child: cannot delete root node\n");
2495 hive_node_h parent = hivex_node_parent (h, node);
2499 /* Delete node and all its children and values recursively. */
2500 static const struct hivex_visitor visitor = { .node_end = delete_node };
2501 if (hivex_visit_node (h, node, &visitor, sizeof visitor, NULL, 0) == -1)
2504 /* Delete the link from parent to child. We need to find the lf/lh
2505 * record which contains the offset and remove the offset from that
2506 * record, then decrement the element count in that record, and
2507 * decrement the overall number of subkeys stored in the parent
2510 hive_node_h *unused;
2512 if (get_children (h, parent, &unused, &blocks, GET_CHILDREN_NO_CHECK_NK)== -1)
2517 for (i = 0; blocks[i] != 0; ++i) {
2518 struct ntreg_hbin_block *block =
2519 (struct ntreg_hbin_block *) (h->addr + blocks[i]);
2521 if (block->id[0] == 'l' && (block->id[1] == 'f' || block->id[1] == 'h')) {
2522 struct ntreg_lf_record *lf = (struct ntreg_lf_record *) block;
2524 size_t nr_subkeys_in_lf = le16toh (lf->nr_keys);
2526 for (j = 0; j < nr_subkeys_in_lf; ++j)
2527 if (le32toh (lf->keys[j].offset) + 0x1000 == node) {
2528 for (; j < nr_subkeys_in_lf - 1; ++j)
2529 memcpy (&lf->keys[j], &lf->keys[j+1], sizeof (lf->keys[j]));
2530 lf->nr_keys = htole16 (nr_subkeys_in_lf - 1);
2536 fprintf (stderr, "hivex_node_delete_child: could not find parent to child link\n");
2541 struct ntreg_nk_record *nk = (struct ntreg_nk_record *) (h->addr + parent);
2542 size_t nr_subkeys_in_nk = le32toh (nk->nr_subkeys);
2543 nk->nr_subkeys = htole32 (nr_subkeys_in_nk - 1);
2546 fprintf (stderr, "hivex_node_delete_child: updating nr_subkeys in parent 0x%zx to %zu\n",
2547 parent, nr_subkeys_in_nk);
2553 hivex_node_set_values (hive_h *h, hive_node_h node,
2554 size_t nr_values, const hive_set_value *values,
2562 if (!IS_VALID_BLOCK (h, node) || !BLOCK_ID_EQ (h, node, "nk")) {
2567 /* Delete all existing values. */
2568 if (delete_values (h, node) == -1)
2574 /* Allocate value list node. Value lists have no id field. */
2575 static const char nul_id[2] = { 0, 0 };
2577 sizeof (struct ntreg_value_list) + (nr_values - 1) * sizeof (uint32_t);
2578 size_t vallist_offs = allocate_block (h, seg_len, nul_id);
2579 if (vallist_offs == 0)
2582 struct ntreg_nk_record *nk = (struct ntreg_nk_record *) (h->addr + node);
2583 nk->nr_values = htole32 (nr_values);
2584 nk->vallist = htole32 (vallist_offs - 0x1000);
2586 struct ntreg_value_list *vallist =
2587 (struct ntreg_value_list *) (h->addr + vallist_offs);
2590 for (i = 0; i < nr_values; ++i) {
2591 /* Allocate vk record to store this (key, value) pair. */
2592 static const char vk_id[2] = { 'v', 'k' };
2593 seg_len = sizeof (struct ntreg_vk_record) + strlen (values[i].key);
2594 size_t vk_offs = allocate_block (h, seg_len, vk_id);
2598 /* Recalculate pointers that could have been invalidated by
2599 * previous call to allocate_block.
2601 nk = (struct ntreg_nk_record *) (h->addr + node);
2602 vallist = (struct ntreg_value_list *) (h->addr + vallist_offs);
2604 vallist->offset[i] = htole32 (vk_offs - 0x1000);
2606 struct ntreg_vk_record *vk = (struct ntreg_vk_record *) (h->addr + vk_offs);
2607 size_t name_len = strlen (values[i].key);
2608 vk->name_len = htole16 (name_len);
2609 strcpy (vk->name, values[i].key);
2610 vk->data_type = htole32 (values[i].t);
2611 uint32_t len = values[i].len;
2612 if (len <= 4) /* store it inline => set MSB flag */
2614 vk->data_len = htole32 (len);
2615 vk->flags = name_len == 0 ? 0 : 1;
2617 if (values[i].len <= 4) /* store it inline */
2618 memcpy (&vk->data_offset, values[i].value, values[i].len);
2620 size_t offs = allocate_block (h, values[i].len + 4, nul_id);
2624 /* Recalculate pointers that could have been invalidated by
2625 * previous call to allocate_block.
2627 nk = (struct ntreg_nk_record *) (h->addr + node);
2628 vallist = (struct ntreg_value_list *) (h->addr + vallist_offs);
2629 vk = (struct ntreg_vk_record *) (h->addr + vk_offs);
2631 memcpy (h->addr + offs + 4, values[i].value, values[i].len);
2632 vk->data_offset = htole32 (offs - 0x1000);
2635 if (name_len * 2 > le32toh (nk->max_vk_name_len))
2636 /* * 2 for UTF16-LE "reencoding" */
2637 nk->max_vk_name_len = htole32 (name_len * 2);
2638 if (values[i].len > le32toh (nk->max_vk_data_len))
2639 nk->max_vk_data_len = htole32 (values[i].len);
2646 hivex_node_set_value (hive_h *h, hive_node_h node,
2647 const hive_set_value *val, int flags)
2649 hive_value_h *prev_values = hivex_node_values (h, node);
2650 if (prev_values == NULL)
2655 size_t nr_values = 0;
2656 for (hive_value_h *itr = prev_values; *itr != 0; ++itr)
2659 hive_set_value *values = malloc ((nr_values + 1) * (sizeof (hive_set_value)));
2661 goto leave_prev_values;
2664 int idx_of_val = -1;
2665 hive_value_h *prev_val;
2666 for (prev_val = prev_values; *prev_val != 0; ++prev_val) {
2670 hive_set_value *value = &values[prev_val - prev_values];
2672 char *valval = hivex_value_value (h, *prev_val, &t, &len);
2673 if (valval == NULL) goto leave_partial;
2676 value->value = valval;
2680 char *valkey = hivex_value_key (h, *prev_val);
2681 if (valkey == NULL) goto leave_partial;
2684 value->key = valkey;
2686 if (STRCASEEQ (valkey, val->key))
2687 idx_of_val = prev_val - prev_values;
2690 if (idx_of_val > -1) {
2691 free (values[idx_of_val].key);
2692 free (values[idx_of_val].value);
2694 idx_of_val = nr_values;
2698 hive_set_value *value = &values[idx_of_val];
2699 *value = (hive_set_value){
2700 .key = strdup (val->key),
2701 .value = malloc (val->len),
2706 if (value->key == NULL || value->value == NULL) goto leave_partial;
2707 memcpy (value->value, val->value, val->len);
2709 retval = hivex_node_set_values (h, node, nr_values, values, 0);
2712 for (int i = 0; i < alloc_ct; i += 2) {
2713 if (values[i / 2].value != NULL)
2714 free (values[i / 2].value);
2715 if (i + 1 < alloc_ct && values[i / 2].key != NULL)
2716 free (values[i / 2].key);