d4a339e1b39b17beff4499a2351ce64c43821176
[libguestfs.git] / hivex / tools / visualizer.ml
1 (* Windows Registry reverse-engineering tool.
2  * Copyright (C) 2010 Red Hat Inc.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License along
15  * with this program; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17  *
18  * For existing information on the registry format, please refer
19  * to the following documents.  Note they are both incomplete
20  * and inaccurate in some respects.
21  *
22  * http://www.sentinelchicken.com/data/TheWindowsNTRegistryFileFormat.pdf
23  * http://pogostick.net/~pnh/ntpasswd/WinReg.txt
24  *)
25
26 open Bitstring
27 open ExtString
28 open Printf
29 open Visualizer_utils
30 open Visualizer_NT_time
31
32 let () =
33   if Array.length Sys.argv <> 2 then (
34     eprintf "Error: missing argument.
35 Usage: %s hivefile > out
36 where
37   'hivefile' is the input hive file from a Windows machine
38   'out' is an output file where we will write all the keys,
39     values etc for extended debugging purposes.
40 Errors, inconsistencies and unexpected fields in the hive file
41 are written to stderr.
42 " Sys.executable_name;
43     exit 1
44   )
45
46 let filename = Sys.argv.(1)
47 let basename = Filename.basename filename
48
49 (* Load the file. *)
50 let bits = bitstring_of_file filename
51
52 (* Split into header + data at the 4KB boundary. *)
53 let header, data = takebits (4096 * 8) bits, dropbits (4096 * 8) bits
54
55 (* Define a persistent pattern which matches the header fields.  By
56  * using persistent patterns, we can reuse them later in the
57  * program.
58  *)
59 let bitmatch header_fields =
60   { "regf" : 4*8 : string;
61     seq1 : 4*8 : littleendian;
62     seq2 : 4*8 : littleendian;
63     last_modified : 64
64       : littleendian, bind (nt_to_time_t last_modified);
65     major : 4*8 : littleendian;
66     minor : 4*8 : littleendian;
67
68     (* "Type".  Contains 0. *)
69     unknown1 : 4*8 : littleendian;
70
71     (* "Format".  Contains 1. *)
72     unknown2 : 4*8 : littleendian;
73
74     root_key : 4*8
75       : littleendian, bind (get_offset root_key);
76     end_pages : 4*8
77       : littleendian, bind (get_offset end_pages);
78
79     (* "Cluster".  Contains 1. *)
80     unknown3 : 4*8 : littleendian;
81
82     filename : 64*8 : string;
83
84     (* All three GUIDs here confirmed in Windows 7 registries.  In
85      * Windows <= 2003 these GUID fields seem to contain junk.
86      * 
87      * If you write zeroes to the GUID fields, load and unload in Win7
88      * REGEDIT, then Windows 7 writes some random GUIDs.
89      * 
90      * Also (on Win7) unknownguid1 == unknownguid2.  unknownguid3 is
91      * different.
92      *)
93     unknownguid1 : 16*8 : bitstring;
94     unknownguid2 : 16*8 : bitstring;
95
96     (* Wrote zero to unknown4, loaded and unloaded it in Win7 REGEDIT,
97      * and it still contained zero.  In existing registries it seems to
98      * contain random junk.
99      *)
100     unknown4 : 4*8 : littleendian;
101     unknownguid3 : 16*8 : bitstring;
102
103     (* If you write zero to unknown5, load and unload it in REGEDIT,
104      * Windows 7 puts the string "rmtm" here.  Existing registries also
105      * seen containing this string.  However on older Windows it can
106      * be all zeroes.
107      *)
108     unknown5 : 4*8 : string;
109
110     (* This seems to contain junk from other parts of the registry.  I
111      * wrote zeroes here, loaded and unloaded it in Win7 REGEDIT, and
112      * it still contained zeroes.
113      *)
114     unknown6 : 340*8 : bitstring;
115     csum : 4*8
116       : littleendian, save_offset_to (crc_offset),
117     check (assert (crc_offset = 0x1fc * 8); true);
118     unknown7 : (0x1000-0x200)*8 : bitstring }
119
120 let fprintf_header chan bits =
121   bitmatch bits with
122   | { :header_fields } ->
123       fprintf chan
124         "HD %6ld %6ld %s %ld.%ld %08lx %08lx %s %s %08lx %s %s %s %08lx %s %s %s %08lx %s\n"
125         seq1 seq2 (print_time last_modified) major minor
126         unknown1 unknown2
127         (print_offset root_key) (print_offset end_pages)
128         unknown3 (print_utf16 filename)
129         (print_guid unknownguid1) (print_guid unknownguid2)
130         unknown4 (print_guid unknownguid3) unknown5
131         (print_bitstring unknown6)
132         csum (print_bitstring unknown7)
133
134 (* Parse the header and check it. *)
135 let root_key, end_pages =
136   bitmatch header with
137   |  { :header_fields } ->
138        fprintf_header stdout header;
139
140        if major <> 1_l then
141          eprintf "HD hive file major <> 1 (major.minor = %ld.%ld)\n"
142            major minor;
143        if seq1 <> seq2 then
144          eprintf "HD hive file sequence numbers should match (%ld <> %ld)\n"
145            seq1 seq2;
146        if unknown1 <> 0_l then
147          eprintf "HD unknown1 field <> 0 (%08lx)\n" unknown1;
148        if unknown2 <> 1_l then
149          eprintf "HD unknown2 field <> 1 (%08lx)\n" unknown2;
150        if unknown3 <> 1_l then
151          eprintf "HD unknown3 field <> 1 (%08lx)\n" unknown3;
152        if not (equals unknownguid1 unknownguid2) then
153          eprintf "HD unknownguid1 <> unknownguid2 (%s, %s)\n"
154            (print_guid unknownguid1) (print_guid unknownguid2);
155        (* We think this is junk.
156        if unknown4 <> 0_l then
157          eprintf "HD unknown4 field <> 0 (%08lx)\n" unknown4;
158        *)
159        if unknown5 <> "rmtm" && unknown5 <> "\000\000\000\000" then
160          eprintf "HD unknown5 field <> \"rmtm\" & <> zeroes (%s)\n" unknown5;
161        (* We think this is junk.
162        if not (is_zero_bitstring unknown6) then
163          eprintf "HD unknown6 area is not zero (%s)\n"
164            (print_bitstring unknown6);
165        *)
166        if not (is_zero_bitstring unknown7) then
167          eprintf "HD unknown7 area is not zero (%s)\n"
168            (print_bitstring unknown7);
169
170        root_key, end_pages
171   | {_} ->
172       failwithf "%s: this doesn't look like a registry hive file\n" basename
173
174 (* Define persistent patterns to match page and block fields. *)
175 let bitmatch page_fields =
176   { "hbin" : 4*8 : string;
177     page_offset : 4*8
178       : littleendian, bind (get_offset page_offset);
179     page_size : 4*8
180       : littleendian, check (Int32.rem page_size 4096_l = 0_l),
181         bind (Int32.to_int page_size);
182
183     (* In the first hbin in the file these fields contain something.
184      * In subsequent hbins these fields are all zero.
185      *
186      * From existing hives (first hbin only):
187      *
188      * unknown1     unknown2                               unknown5
189      * 00 00 00 00  00 00 00 00  9C 77 3B 02  6A 7D CA 01  00 00 00 00
190      * 00 00 00 00  00 00 00 00  50 3A 15 07  B5 9B CA 01  00 00 00 00
191      * 00 00 00 00  00 00 00 00  57 86 90 D4  9A 58 CA 01  00 00 00 00
192      * 00 00 00 00  00 00 00 00  52 3F 90 9D  CF 7C CA 01  00 00 00 00
193      * 00 00 00 00  00 00 00 00  E8 86 C1 17  BD 06 CA 01  00 00 00 00
194      * 00 00 00 00  00 00 00 00  4A 77 CE 7A  CF 7C CA 01  00 00 00 00
195      * 00 00 00 00  00 00 00 00  E4 EA 23 FF  69 7D CA 01  00 00 00 00
196      * 00 00 00 00  00 00 00 00  50 13 BA 8D  A2 9A CA 01  00 00 00 00
197      * 00 00 00 00  00 00 00 00  0E 07 93 13  BD 06 CA 01  00 00 00 00
198      * 00 00 00 00  00 00 00 00  9D 55 D0 B3  99 58 CA 01  00 00 00 00
199      * 00 00 00 00  00 00 00 00  46 AC FF 8B  CF 7C CA 01  00 00 00 00
200      * 00 00 00 00  00 00 00 00  80 29 2D 02  6A 7D CA 01  00 00 00 00
201      * 00 00 00 00  00 00 00 00  90 8D 36 07  B5 9B CA 01  00 00 00 00
202      * 00 00 00 00  00 00 00 00  5C 9B 8B B8  6A 06 CA 01  00 00 00 00
203      * 00 00 00 00  00 00 00 00  85 9F BB 99  9A 58 CA 01  00 00 00 00
204      * 00 00 00 00  00 00 00 00  BE 3D 21 02  6A 7D CA 01  00 00 00 00
205      * 00 00 00 00  00 00 00 00  70 53 09 07  B5 9B CA 01  00 00 00 00
206      * 00 00 00 00  00 00 00 00  5B 62 42 B6  9A 58 CA 01  00 00 00 00
207      * 01 00 00 00  00 00 00 00  B2 46 9B 9E  CF 7C CA 01  00 00 00 00
208      * 01 00 00 00  00 00 00 00  CA 88 EE 1A  BD 06 CA 01  00 00 00 00
209      *
210      * From the above we worked out that fields 3 and 4 are an NT
211      * timestamp, which seems to be "last modified" (when REGEDIT
212      * unloads a hive it updates this timestamp even if nothing
213      * has been changed).
214      *)
215     unknown1 : 4*8 : littleendian;  (* usually zero, occasionally 1 *)
216     unknown2 : 4*8 : littleendian;  (* always zero? *)
217     last_modified : 64
218       : littleendian,
219         bind (if page_offset = 0 then nt_to_time_t last_modified
220               else (
221                 assert (last_modified = 0_L);
222                 0.
223               )
224              );
225     (* The "B.D." document said this field contains the page size, but
226      * this is not true.  This misinformation has been copied to the
227      * sentinelchicken documentation too.
228      *)
229     unknown5 : 4*8 : littleendian;  (* always zero? *)
230
231     (* Now the blocks in this page follow. *)
232     blocks : (page_size - 32) * 8 : bitstring;
233
234     rest : -1 : bitstring }
235
236 let fprintf_page chan bits =
237   bitmatch bits with
238   | { :page_fields } ->
239       fprintf chan "HB %s %08x %08lx %08lx %s %08lx\n"
240         (print_offset page_offset)
241         page_size unknown1 unknown2
242         (if page_offset = 0 then print_time last_modified
243          else string_of_float last_modified) unknown5
244
245 let bitmatch block_fields =
246   { seg_len : 4*8
247       : littleendian, bind (Int32.to_int seg_len);
248     block_data : (abs seg_len - 4) * 8 : bitstring;
249     rest : -1 : bitstring }
250
251 let fprintf_block chan block_offset bits =
252   bitmatch bits with
253   | { :block_fields } ->
254       fprintf chan "BL %s %s %d\n"
255         (print_offset block_offset)
256         (if seg_len < 0 then "used" else "free")
257         (if seg_len < 0 then -seg_len else seg_len)
258
259 (* Iterate over the pages and blocks.  In the process we will examine
260  * each page (hbin) header.  Also we will build block_list which is a
261  * list of (block offset, length, used flag, data).
262  *)
263 let block_list = ref []
264 let () =
265   let rec loop_over_pages data data_offset =
266     if data_offset < end_pages then (
267       bitmatch data with
268       | { rest : -1 : bitstring } when bitstring_length rest = 0 -> ()
269
270       | { :page_fields } ->
271           fprintf_page stdout data;
272
273           assert (page_offset = data_offset);
274
275           if data_offset = 0 then (     (* first hbin only *)
276             if unknown1 <> 0_l then
277               eprintf "HB %s unknown1 field <> 0 (%08lx)\n"
278                 (print_offset page_offset) unknown1;
279             if unknown2 <> 0_l then
280               eprintf "HB %s unknown2 field <> 0 (%08lx)\n"
281                 (print_offset page_offset) unknown2;
282             if unknown5 <> 0_l then
283               eprintf "HB %s unknown5 field <> 0 (%08lx)\n"
284                 (print_offset page_offset) unknown5
285           ) else (                      (* subsequent hbins *)
286             if unknown1 <> 0_l || unknown2 <> 0_l || unknown5 <> 0_l then
287                 eprintf "HB %s unknown fields <> 0 (%08lx %08lx %08lx)\n"
288                   (print_offset page_offset)
289                   unknown1 unknown2 unknown5;
290             if last_modified <> 0. then
291                 eprintf "HB %s last_modified <> 0. (%g)\n"
292                   (print_offset page_offset) last_modified
293           );
294
295           (* Loop over the blocks in this page. *)
296           loop_over_blocks blocks (data_offset + 32);
297
298           (* Loop over rest of the pages. *)
299           loop_over_pages rest (data_offset + page_size)
300
301       | {_} ->
302           failwithf "%s: invalid hbin at offset %s\n"
303             basename (print_offset data_offset)
304     ) else (
305       (* Reached the end of the official hbins in this file, BUT the
306        * file can be larger than this and might contain stuff.  What
307        * does it contain after the hbins?  We think just junk, but
308        * we're not sure.
309        *)
310       if not (is_zero_bitstring data) then (
311         eprintf "Junk in file after end of pages:\n";
312         let rec loop data data_offset =
313           bitmatch data with
314           | { rest : -1 : bitstring } when bitstring_length rest = 0 -> ()
315           | { :page_fields } ->
316               eprintf "\tjunk hbin %s 0x%08x\n"
317                 (print_offset data_offset) page_size;
318               loop rest (data_offset + page_size);
319           | { _ } ->
320               eprintf "\tother junk %s %s\n"
321                 (print_offset data_offset) (print_bitstring data)
322         in
323         loop data data_offset
324       )
325     )
326   and loop_over_blocks blocks block_offset =
327     bitmatch blocks with
328     | { rest : -1 : bitstring } when bitstring_length rest = 0 -> ()
329
330     | { :block_fields } ->
331         assert (block_offset mod 8 = 0);
332
333         fprintf_block stdout block_offset blocks;
334
335         let used, seg_len =
336           if seg_len < 0 then true, -seg_len else false, seg_len in
337
338         let block = block_offset, (seg_len, used, block_data) in
339         block_list := block :: !block_list;
340
341         (* Loop over the rest of the blocks in this page. *)
342         loop_over_blocks rest (block_offset + seg_len)
343
344     | {_} ->
345         failwithf "%s: invalid block near offset %s\n"
346           basename (print_offset block_offset)
347   in
348   loop_over_pages data 0
349
350 (* Turn the block_list into a map so we can quickly look up a block
351  * from its offset.
352  *)
353 let block_list = !block_list
354 let block_map =
355   List.fold_left (
356     fun map (block_offset, block) -> IntMap.add block_offset block map
357   ) IntMap.empty block_list
358 let lookup fn offset =
359   try
360     let (_, used, _) as block = IntMap.find offset block_map in
361     if not used then
362       failwithf "%s: %s: lookup: free block %s referenced from hive tree"
363         basename fn (print_offset offset);
364     block
365   with Not_found ->
366     failwithf "%s: %s: lookup: unknown block %s referenced from hive tree"
367       basename fn (print_offset offset)
368
369 (* Use this to mark blocks that we've visited.  If the hive contains
370  * no unreferenced blocks, then by the end this should just contain
371  * free blocks.
372  *)
373 let mark_visited, is_not_visited, unvisited_blocks =
374   let v = ref block_map in
375   let mark_visited offset = v := IntMap.remove offset !v
376   and is_not_visited offset = IntMap.mem offset !v
377   and unvisited_blocks () = !v in
378   mark_visited, is_not_visited, unvisited_blocks
379
380 (* Define persistent patterns to match nk-records, vk-records and
381  * sk-records, which are the record types that we especially want to
382  * analyze later.  Other blocks types (eg. value lists, lf-records)
383  * have no "spare space" so everything is known about them and we don't
384  * store these.
385  *)
386 let bitmatch nk_fields =
387   { "nk" : 2*8 : string;
388     (* Flags stored in the file as a little endian word, hence the
389      * unusual ordering:
390      *)
391     virtmirrored : 1;
392     predefinedhandle : 1; keynameascii : 1; symlinkkey : 1;
393     cannotbedeleted : 1; isroot : 1; ismountpoint : 1; isvolatile : 1;
394     unknownflag8000 : 1; unknownflag4000 : 1;
395     unknownflag2000 : 1; unknownflag1000 : 1;
396     unknownflag0800 : 1; unknownflag0400 : 1;
397     virtualstore : 1; virttarget : 1;
398     timestamp : 64 : littleendian, bind (nt_to_time_t timestamp);
399     unknown1 : 4*8 : littleendian;
400     parent : 4*8 : littleendian, bind (get_offset parent);
401     nr_subkeys : 4*8 : littleendian, bind (Int32.to_int nr_subkeys);
402     nr_subkeys_vol : 4*8;
403     subkeys : 4*8 : littleendian, bind (get_offset subkeys);
404     subkeys_vol : 4*8;
405     nr_values : 4*8 : littleendian, bind (Int32.to_int nr_values);
406     vallist : 4*8 : littleendian, bind (get_offset vallist);
407     sk : 4*8 : littleendian, bind (get_offset sk);
408     classname : 4*8 : littleendian, bind (get_offset classname);
409     (* sentinelchicken.com says this is a single 32 bit field
410      * containing maximum number of bytes in a subkey name, however
411      * that does not seem to be correct.  We think it is several
412      * fields, the first being the maximum number of bytes in the
413      * UTF16-LE encoded version of the subkey names, (since subkey
414      * names are usually ASCII, that would be max length of names * 2).
415      * This is a historical maximum, so it can be greater than the
416      * current maximum name field.
417      * 
418      * The remaining fields are often non-zero, but the purpose is
419      * unknown.
420      * 
421      * In the hives we examined the other fields had values as
422      * follows:
423      *   userflags: 0, 2, 0xa, 0xe
424      *   virtcontrolflags: 0, 1
425      *   debug: always 0
426      *)
427     max_subkey_name_len : 2*8 : littleendian;
428     unknown2_userflags : 4;
429     unknown2_virtcontrolflags : 4;
430     unknown2_debug : 8;
431
432     (* sentinelchicken.com says: maximum subkey CLASSNAME length,
433      * however that does not seem to be correct.  In hives I looked
434      * at, it has value 0, 0xc, 0x10, 0x18, 0x1a, 0x28.
435      *)
436     unknown3 : 4*8 : littleendian;
437     (* sentinelchicken.com says: maximum number of bytes in a value
438      * name, however that does not seem to be correct.  We think it is
439      * the maximum number of bytes in the UTF16-LE encoded version of
440      * the value names (since value names are usually ASCII, that would
441      * be max length of names * 2).  This is a historical maximum, so
442      * it can be greater than the current maximum name field.
443      *)
444     max_vk_name_len : 4*8 : littleendian, bind (Int32.to_int max_vk_name_len);
445     (* sentinelchicken.com says: maximum value data size, and this
446      * agrees with my observations.  It is the largest data size (not
447      * seg_len, but vk.data_len) for any value in this key.  We think
448      * that this field is a historical max, so eg if a maximally sized
449      * value is deleted then this field is not reduced.  Certainly
450      * max_vk_data_len >= the measured maximum in all the hives that we
451      * have observed.
452      *)
453     max_vk_data_len : 4*8 : littleendian, bind (Int32.to_int max_vk_data_len);
454     unknown6 : 4*8 : littleendian;
455     name_len : 2*8 : littleendian;
456     classname_len : 2*8 : littleendian;
457     name : name_len * 8 : string }
458
459 let fprintf_nk chan nk =
460   let (_, _, bits) = lookup "fprintf_nk" nk in
461   bitmatch bits with
462   | { :nk_fields } ->
463       fprintf chan
464         "NK %s %s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s %s %08lx %s %d %ld %s %08lx %d %s %s %s %d %x %x %x %08lx %d %d %08lx %d %d %s\n"
465         (print_offset nk)
466         (if unknownflag8000 then "8" else ".")
467         (if unknownflag4000 then "4" else ".")
468         (if unknownflag2000 then "2" else ".")
469         (if unknownflag1000 then "1" else ".")
470         (if unknownflag0800 then "8" else ".")
471         (if unknownflag0400 then "4" else ".")
472         (if virtualstore then "s" else ".")
473         (if virttarget then "t" else ".")
474         (if virtmirrored then "m" else ".")
475         (if predefinedhandle then "P" else ".")
476         (if keynameascii then "A" else ".")
477         (if symlinkkey then "S" else ".")
478         (if cannotbedeleted then "N" else ".")
479         (if isroot then "R" else ".")
480         (if ismountpoint then "M" else ".")
481         (if isvolatile then "V" else ".")
482         (print_time timestamp)
483         unknown1 (print_offset parent) nr_subkeys nr_subkeys_vol
484         (print_offset subkeys) subkeys_vol
485         nr_values (print_offset vallist)
486         (print_offset sk) (print_offset classname)
487         max_subkey_name_len
488         unknown2_userflags unknown2_virtcontrolflags unknown2_debug
489         unknown3 max_vk_name_len max_vk_data_len unknown6
490         name_len classname_len name
491
492 type data_t = Inline of bitstring | Offset of int
493 let bitmatch vk_fields =
494   { "vk" : 2*8 : string;
495     name_len : 2*8 : littleendian;
496     (* No one documents the important fact that data_len can have the
497      * top bit set (randomly or is it meaningful?).  The length can
498      * also be 0 (or 0x80000000) if the data type is NONE.
499      *)
500     data_len : 4*8
501       : littleendian, bind (
502         let data_len = Int32.logand data_len 0x7fff_ffff_l in
503         Int32.to_int data_len
504       );
505     (* Inline data if len <= 4, offset otherwise.
506      *
507      * The data itself depends on the type field.
508      *
509      * For REG_SZ type, the data always seems to be NUL-terminated, which
510      * means because these strings are often UTF-16LE, that the string will
511      * end with \0\0 bytes.  The termination bytes are included in data_len.
512      *
513      * For REG_MULTI_SZ, see
514      * http://blogs.msdn.com/oldnewthing/archive/2009/10/08/9904646.aspx
515      *)
516     data : 4*8
517       : bitstring, bind (
518         if data_len <= 4 then
519           Inline (takebits (data_len*8) data)
520         else (
521           let offset =
522             bitmatch data with { offset : 4*8 : littleendian } -> offset in
523           let offset = get_offset offset in
524           Offset offset
525         )
526       );
527     t : 4*8 : littleendian, bind (Int32.to_int t);
528     (* Flags, stored as a little-endian word: *)
529     unknown1 : 7;
530     nameisascii : 1;  (* Clear for default [zero-length] name, always set
531                        * otherwise in registries that we found.  Perhaps this
532                        * is really "nameisdefault" flag?
533                        *)
534     unknown2 : 8;
535     (* Unknown field, usually contains something. *)
536     unknown3 : 2*8 : littleendian;
537     name : name_len * 8 : string }
538
539 let fprintf_vk chan vk =
540   let (_, _, bits) = lookup "fprintf_vk" vk in
541   bitmatch bits with
542   | { :vk_fields } ->
543       let real_data =
544         match data with
545         | Inline data -> data
546         | Offset offset ->
547             let (_, _, bits) = lookup "fprintf_vk (data)" offset in
548             bits in
549       fprintf chan "VK %s %s %d %s%s %s %08x %s %08x %08x\n"
550         (print_offset vk)
551         name data_len
552         (match data with
553          | Inline _ -> ""
554          | Offset offset -> "["^print_offset offset^"]")
555         (print_bitstring real_data)
556         (print_vk_type t)
557         unknown1 (if nameisascii then "A" else "L")
558         unknown2 unknown3
559
560 let bitmatch sk_fields =
561   { "sk" : 2*8 : string;
562     unknown1 : 2*8 : littleendian;
563     sk_next : 4*8 : littleendian, bind (get_offset sk_next);
564     sk_prev : 4*8 : littleendian, bind (get_offset sk_prev);
565     refcount : 4*8 : littleendian, bind (Int32.to_int refcount);
566     sec_len : 4*8 : littleendian, bind (Int32.to_int sec_len);
567     sec_desc : sec_len * 8 : bitstring }
568
569 let fprintf_sk chan sk =
570   let (_, _, bits) = lookup "fprintf_sk" sk in
571   bitmatch bits with
572   | { :sk_fields } ->
573       fprintf chan "SK %s %04x %s %s %d %d\n"
574         (print_offset sk) unknown1
575         (print_offset sk_next) (print_offset sk_prev)
576         refcount sec_len
577         (* print_bitstring sec_desc -- suppress this *)
578
579 (* Store lists of records we encounter (lists of offsets). *)
580 let nk_records = ref []
581 and vk_records = ref []
582 and sk_records = ref []
583
584 (* Functions to visit each block, starting at the root.  Each block
585  * that we visit is printed.
586  *)
587 let rec visit_nk ?(nk_is_root = false) nk =
588   let (_, _, bits) = lookup "visit_nk" nk in
589   mark_visited nk;
590   (bitmatch bits with
591    | { :nk_fields } ->
592        fprintf_nk stdout nk;
593
594        nk_records := nk :: !nk_records;
595
596        (* Check the isroot flag is only set on the root node. *)
597        assert (isroot = nk_is_root);
598
599        if unknownflag8000 then
600          eprintf "NK %s unknownflag8000 is set\n" (print_offset nk);
601        if unknownflag4000 then
602          eprintf "NK %s unknownflag4000 is set\n" (print_offset nk);
603        if unknownflag2000 then
604          eprintf "NK %s unknownflag2000 is set\n" (print_offset nk);
605        if unknownflag1000 then
606          eprintf "NK %s unknownflag1000 is set\n" (print_offset nk);
607        if unknownflag0800 then
608          eprintf "NK %s unknownflag0800 is set\n" (print_offset nk);
609        if unknownflag0400 then
610          eprintf "NK %s unknownflag0400 is set\n" (print_offset nk);
611        if unknown1 <> 0_l then
612          eprintf "NK %s unknown1 <> 0 (%08lx)\n" (print_offset nk) unknown1;
613        if unknown2_userflags <> 0 then
614          eprintf "NK %s unknown2_userflags <> 0 (%x)\n"
615            (print_offset nk) unknown2_userflags;
616        if unknown2_virtcontrolflags <> 0 then
617          eprintf "NK %s unknown2_virtcontrolflags <> 0 (%x)\n"
618            (print_offset nk) unknown2_virtcontrolflags;
619        if unknown2_debug <> 0 then
620          eprintf "NK %s unknown2_debug <> 0 (%x)\n"
621            (print_offset nk) unknown2_debug;
622        if unknown3 <> 0_l then
623          eprintf "NK %s unknown3 <> 0 (%08lx)\n" (print_offset nk) unknown3;
624        if unknown6 <> 0_l then
625          eprintf "NK %s unknown6 <> 0 (%08lx)\n" (print_offset nk) unknown6;
626
627        (* -- common, assume it's not an error
628        if classname = -1 then
629          eprintf "NK %s has no classname\n" (print_offset nk);
630        if classname_len = 0 then
631          eprintf "NK %s has zero-length classname\n" (print_offset nk);
632        *)
633        if sk = -1 then
634          eprintf "NK %s has no sk-record\n" (print_offset nk);
635        if name_len = 0 then
636          eprintf "NK %s has zero-length name\n" (print_offset nk);
637
638        (* Visit the values first at this node. *)
639        let max_data_len, max_name_len =
640          if vallist <> -1 then
641            visit_vallist nr_values vallist
642          else
643            0, 0 in
644
645        if max_vk_data_len < max_data_len then
646          eprintf "NK %s nk.max_vk_data_len (%d) < actual max data_len (%d)\n"
647            (print_offset nk) max_vk_data_len max_data_len;
648
649        if max_vk_name_len < max_name_len * 2 then
650          eprintf "NK %s nk.max_vk_name_len (%d) < actual max name_len * 2 (%d)\n"
651            (print_offset nk) max_vk_name_len (max_name_len * 2);
652
653        (* Visit the subkeys of this node. *)
654        if subkeys <> -1 then (
655          let counted, max_name_len, _ = visit_subkeys subkeys in
656
657          if counted <> nr_subkeys then
658            failwithf "%s: incorrect count of subkeys (%d, counted %d) in subkey list at %s\n"
659              basename nr_subkeys counted (print_offset subkeys);
660
661          if max_subkey_name_len < max_name_len * 2 then
662            eprintf "NK %s nk.max_subkey_name_len (%d) < actual max name_len * 2 (%d)\n"
663              (print_offset nk) max_subkey_name_len (max_name_len * 2);
664        );
665
666        (* Visit the sk-record and classname. *)
667        if sk <> -1 then
668          visit_sk sk;
669        if classname <> -1 then
670          visit_classname classname classname_len;
671
672    | {_} ->
673        failwithf "%s: invalid nk block at offset %s\n"
674          basename (print_offset nk)
675   )
676
677 and visit_vallist nr_values vallist =
678   let (seg_len, _, bits) = lookup "visit_vallist" vallist in
679   mark_visited vallist;
680   printf "VL %s %d %d\n" (print_offset vallist) nr_values seg_len;
681   visit_values_in_vallist nr_values vallist bits
682
683 and visit_values_in_vallist nr_values vallist bits =
684   if nr_values > 0 then (
685     bitmatch bits with
686     | { rest : -1 : bitstring } when bitstring_length rest = 0 ->
687         assert (nr_values = 0);
688         0, 0
689
690     | { value : 4*8 : littleendian, bind (get_offset value);
691         rest : -1 : bitstring } ->
692         let data_len, name_len = visit_vk value in
693         let max_data_len, max_name_len =
694           visit_values_in_vallist (nr_values-1) vallist rest in
695         max max_data_len data_len, max max_name_len name_len
696
697     | {_} ->
698         failwithf "%s: invalid offset in value list at %s\n"
699           basename (print_offset vallist)
700   ) else 0, 0
701
702 and visit_vk vk =
703   let (_, _, bits) = lookup "visit_vk" vk in
704   mark_visited vk;
705
706   (bitmatch bits with
707    | { :vk_fields } ->
708        fprintf_vk stdout vk;
709
710        if unknown1 <> 0 then
711          eprintf "VK %s unknown1 flags set (%02x)\n"
712            (print_offset vk) unknown1;
713        if unknown2 <> 0 then
714          eprintf "VK %s unknown2 flags set (%02x)\n"
715            (print_offset vk) unknown2;
716        if unknown3 <> 0 then
717          eprintf "VK %s unknown3 flags set (%04x)\n"
718            (print_offset vk) unknown3;
719
720        (* Note this is common for default [ie. zero-length] key names. *)
721        if not nameisascii && name_len > 0 then
722          eprintf "VK %s has non-ASCII name flag set (name is %s)\n"
723            (print_offset vk) (print_binary_string name);
724
725        vk_records := vk :: !vk_records;
726        (match data with
727         | Inline data -> ()
728         | Offset offset ->
729             let _ = lookup "visit_vk (data)" offset in
730             mark_visited offset
731        );
732
733        data_len, name_len
734
735    | {_} ->
736        failwithf "%s: invalid vk block at offset %s\n"
737          basename (print_offset vk)
738   )
739
740 (* Visits subkeys, recursing through intermediate lf/lh/ri structures,
741  * and returns the number of subkeys actually seen.
742  *)
743 and visit_subkeys subkeys =
744   let (_, _, bits) = lookup "visit_subkeys" subkeys in
745   mark_visited subkeys;
746   (bitmatch bits with
747    | { "lf" : 2*8 : string;
748        len : 2*8 : littleendian; (* number of subkeys of this node *)
749        rest : len*8*8 : bitstring } ->
750        printf "LF %s %d\n" (print_offset subkeys) len;
751        visit_subkeys_in_lf_list false subkeys len rest
752
753    | { "lh" : 2*8 : string;
754        len : 2*8 : littleendian; (* number of subkeys of this node *)
755        rest : len*8*8 : bitstring } ->
756        printf "LF %s %d\n" (print_offset subkeys) len;
757        visit_subkeys_in_lf_list true subkeys len rest
758
759    | { "ri" : 2*8 : string;
760        len : 2*8 : littleendian;
761        rest : len*4*8 : bitstring } ->
762        printf "RI %s %d\n" (print_offset subkeys) len;
763        visit_subkeys_in_ri_list subkeys len rest
764
765    (* In theory you can have an li-record here, but we've never
766     * seen one.
767     *)
768
769    | { "nk" : 2*8 : string } ->
770        visit_nk subkeys;
771        let name, name_len = name_of_nk subkeys in
772        1, name_len, name
773
774    | {_} ->
775        failwithf "%s: invalid subkey node found at %s\n"
776          basename (print_offset subkeys)
777   )
778
779 and visit_subkeys_in_lf_list newstyle_hash subkeys_top len bits =
780   if len > 0 then (
781     bitmatch bits with
782     | { rest : -1 : bitstring } when bitstring_length rest = 0 ->
783         assert (len = 0);
784         0, 0, ""
785
786     | { offset : 4*8 : littleendian, bind (get_offset offset);
787         hash : 4*8 : bitstring;
788         rest : -1 : bitstring } ->
789         let c1, name_len1, name = visit_subkeys offset in
790
791         check_hash offset newstyle_hash hash name;
792
793         let c2, name_len2, _ =
794           visit_subkeys_in_lf_list newstyle_hash subkeys_top (len-1) rest in
795         c1 + c2, max name_len1 name_len2, ""
796
797     | {_} ->
798         failwithf "%s: invalid subkey in lf/lh list at %s\n"
799           basename (print_offset subkeys_top)
800   ) else 0, 0, ""
801
802 and visit_subkeys_in_ri_list subkeys_top len bits =
803   if len > 0 then (
804     bitmatch bits with
805     | { rest : -1 : bitstring } when bitstring_length rest = 0 ->
806         assert (len = 0);
807         0, 0, ""
808
809     | { offset : 4*8 : littleendian, bind (get_offset offset);
810         rest : -1 : bitstring } ->
811         let c1, name_len1, _ = visit_subkeys offset in
812         let c2, name_len2, _ =
813           visit_subkeys_in_ri_list subkeys_top (len-1) rest in
814         c1 + c2, max name_len1 name_len2, ""
815
816     | {_} ->
817         failwithf "%s: invalid subkey in ri list at %s\n"
818           basename (print_offset subkeys_top)
819   ) else 0, 0, ""
820
821 and check_hash offset newstyle_hash hash name =
822   if not newstyle_hash then (
823     (* Old-style lf record hash the first four bytes of the name
824      * as the has.
825      *)
826     let len = String.length name in
827     let name_bits =
828       if len >= 4 then
829         bitstring_of_string (String.sub name 0 4)
830       else (
831         let zeroes = zeroes_bitstring ((4-len)*8) in
832         concat [bitstring_of_string name; zeroes]
833       ) in
834     if not (equals hash name_bits) then
835       eprintf "LF incorrect hash for name %s, expected %s, actual %s\n"
836         name (print_bitstring name_bits) (print_bitstring hash)
837   ) else (
838     (* New-style lh record has a proper hash. *)
839     let actual = bitmatch hash with { hash : 4*8 : littleendian } -> hash in
840     let h = ref 0_l in
841     String.iter (
842       fun c ->
843         h := Int32.mul !h 37_l;
844         h := Int32.add !h (Int32.of_int (Char.code (Char.uppercase c)))
845     ) name;
846     if actual <> !h then
847       eprintf "LH incorrect hash for name %s, expected 0x%08lx, actual 0x%08lx\n"
848         name !h actual
849   )
850
851 and name_of_nk nk =
852   let (_, _, bits) = lookup "name_of_nk" nk in
853   bitmatch bits with
854   | { :nk_fields } -> name, name_len
855
856 and visit_sk sk =
857   let (_, _, bits) = lookup "visit_sk" sk in
858   if is_not_visited sk then (
859     mark_visited sk;
860     (bitmatch bits with
861      | { :sk_fields } ->
862          fprintf_sk stdout sk;
863
864          if unknown1 <> 0 then
865            eprintf "SK %s unknown1 <> 0 (%04x)\n" (print_offset sk) unknown1;
866
867          sk_records := sk :: !sk_records
868
869      | {_} ->
870          failwithf "%s: invalid sk-record at %s\n"
871            basename (print_offset sk)
872     )
873   )
874
875 and visit_classname classname classname_len =
876   let (seg_len, _, bits) = lookup "visit_classname" classname in
877   mark_visited classname;
878   assert (seg_len >= classname_len);
879   printf "CL %s %s\n" (print_offset classname) (print_bitstring bits)
880
881 let () =
882   visit_nk ~nk_is_root:true root_key
883
884 (* These are immutable now. *)
885 let nk_records = !nk_records
886 let vk_records = !vk_records
887 let sk_records = !sk_records
888
889 (* So we can rapidly tell what is an nk/vk/sk offset. *)
890 let nk_set =
891   List.fold_left (fun set offs -> IntSet.add offs set) IntSet.empty nk_records
892 let vk_set =
893   List.fold_left (fun set offs -> IntSet.add offs set) IntSet.empty vk_records
894 let sk_set =
895   List.fold_left (fun set offs -> IntSet.add offs set) IntSet.empty sk_records
896
897 (* Now after visiting all the blocks, are there any used blocks which
898  * are unvisited?  If there are any then that would indicate either (a)
899  * that the hive contains unreferenced blocks, or (b) that there are
900  * referenced blocks that we did not visit because we don't have a full
901  * understanding of the hive format.
902  *
903  * Windows 7 registries often contain a few of these -- not clear
904  * how serious they are, but don't fail here.
905  *)
906 let () =
907   let unvisited = unvisited_blocks () in
908   IntMap.iter (
909     fun offset block ->
910       match block with
911       | (_, false, _) -> () (* ignore unused blocks *)
912       | (seg_len, true, _) ->
913           eprintf "used block %s (length %d) is not referenced\n"
914             (print_offset offset) seg_len
915   ) unvisited
916
917 (* Check the SKs are:
918  * (a) linked into a single circular list through the sk_prev/sk_next
919  * pointers
920  * (b) refcounts are correct
921  *)
922 let () =
923   if List.length sk_records > 0 then (
924     let sk0 = List.hd sk_records in (* start at any arbitrary sk *)
925     (* This loop follows the chain of sk pointers until we arrive
926      * back at the original, checking prev/next are consistent.
927      *)
928     let rec loop visited prevsk sk =
929       if sk <> sk0 then (
930         if not (IntSet.mem sk sk_set) then
931           eprintf "SK %s not an sk-record (faulty sk_next somewhere)\n"
932             (print_offset sk)
933         else (
934           let _, _, bits = lookup "loop sk circular list" sk in
935           bitmatch bits with
936           | { :sk_fields } ->
937               if sk_prev <> prevsk then
938                 eprintf "SK %s sk_prev != previous sk (%s, %s)\n"
939                   (print_offset sk)
940                   (print_offset sk_prev) (print_offset prevsk);
941               if IntSet.mem sk visited then
942                 eprintf "SK %s already visited (bad circular list)\n"
943                   (print_offset sk);
944               let visited = IntSet.add sk visited in
945               loop visited sk sk_next
946         )
947       )
948     in
949     let _, _, bits = lookup "start sk circular list" sk0 in
950     (bitmatch bits with
951      | { :sk_fields } ->
952          loop IntSet.empty sk_prev sk0
953     );
954
955     (* For every nk-record, if it references an sk-record count that,
956      * then check this matches the refcounts in the sk-records
957      * themselves.
958      *)
959     let refcounts = Counter.create () in
960     List.iter (
961       fun nk ->
962         let _, _, bits = lookup "sk refcounter (nk)" nk in
963         (bitmatch bits with
964          | { :nk_fields } ->
965              Counter.incr refcounts sk
966         )
967     ) nk_records;
968
969     List.iter (
970       fun sk ->
971         let _, _, bits = lookup "sk refcounter (sk)" sk in
972         (bitmatch bits with
973          | { :sk_fields } ->
974              let actual = Counter.get refcounts sk in
975              if actual <> refcount then
976                eprintf "SK %s incorrect refcount (actual %d, in file %d)\n"
977                  (print_offset sk) actual refcount
978         )
979     ) sk_records
980   )