1 /* hivexml - Convert Windows Registry "hive" to XML file.
2 * Copyright (C) 2009 Red Hat Inc.
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.
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.
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.
31 #include <libxml/xmlwriter.h>
37 #define _(str) dgettext(PACKAGE, (str))
38 //#define N_(str) dgettext(PACKAGE, (str))
44 static char *filetime_to_8601 (int64_t windows_ticks);
46 /* Callback functions. */
47 static int node_start (hive_h *, void *, hive_node_h, const char *name);
48 static int node_end (hive_h *, void *, hive_node_h, const char *name);
49 static int value_string (hive_h *, void *, hive_node_h, hive_value_h, hive_type t, size_t len, const char *key, const char *str);
50 static int value_multiple_strings (hive_h *, void *, hive_node_h, hive_value_h, hive_type t, size_t len, const char *key, char **argv);
51 static int value_string_invalid_utf16 (hive_h *, void *, hive_node_h, hive_value_h, hive_type t, size_t len, const char *key, const char *str);
52 static int value_dword (hive_h *, void *, hive_node_h, hive_value_h, hive_type t, size_t len, const char *key, int32_t);
53 static int value_qword (hive_h *, void *, hive_node_h, hive_value_h, hive_type t, size_t len, const char *key, int64_t);
54 static int value_binary (hive_h *, void *, hive_node_h, hive_value_h, hive_type t, size_t len, const char *key, const char *value);
55 static int value_none (hive_h *, void *, hive_node_h, hive_value_h, hive_type t, size_t len, const char *key, const char *value);
56 static int value_other (hive_h *, void *, hive_node_h, hive_value_h, hive_type t, size_t len, const char *key, const char *value);
58 static struct hivex_visitor visitor = {
59 .node_start = node_start,
61 .value_string = value_string,
62 .value_multiple_strings = value_multiple_strings,
63 .value_string_invalid_utf16 = value_string_invalid_utf16,
64 .value_dword = value_dword,
65 .value_qword = value_qword,
66 .value_binary = value_binary,
67 .value_none = value_none,
68 .value_other = value_other
71 #define XML_CHECK(proc, args) \
73 if ((proc args) == -1) { \
74 fprintf (stderr, _("%s: failed to write XML document\n"), #proc); \
75 exit (EXIT_FAILURE); \
80 main (int argc, char *argv[])
82 setlocale (LC_ALL, "");
83 #ifdef HAVE_BINDTEXTDOMAIN
84 bindtextdomain (PACKAGE, LOCALEBASEDIR);
92 while ((c = getopt (argc, argv, "dk")) != EOF) {
95 open_flags |= HIVEX_OPEN_DEBUG;
98 visit_flags |= HIVEX_VISIT_SKIP_BAD;
101 fprintf (stderr, "hivexml [-dk] regfile > output.xml\n");
106 if (optind + 1 != argc) {
107 fprintf (stderr, _("hivexml: missing name of input file\n"));
111 hive_h *h = hivex_open (argv[optind], open_flags);
113 perror (argv[optind]);
117 /* Note both this macro, and xmlTextWriterStartDocument leak memory. There
118 * doesn't seem to be any way to recover that memory, but it's not a
123 xmlTextWriterPtr writer;
124 writer = xmlNewTextWriterFilename ("/dev/stdout", 0);
125 if (writer == NULL) {
126 fprintf (stderr, _("xmlNewTextWriterFilename: failed to create XML writer\n"));
130 XML_CHECK (xmlTextWriterStartDocument, (writer, NULL, "utf-8", NULL));
131 XML_CHECK (xmlTextWriterStartElement, (writer, BAD_CAST "hive"));
133 int64_t hive_mtime = hivex_last_modified (h);
134 if (hive_mtime >= 0) {
135 char *timebuf = filetime_to_8601 (hive_mtime);
137 XML_CHECK (xmlTextWriterStartElement, (writer, BAD_CAST "mtime"));
138 XML_CHECK (xmlTextWriterWriteString, (writer, BAD_CAST timebuf));
139 XML_CHECK (xmlTextWriterEndElement, (writer));
144 if (hivex_visit (h, &visitor, sizeof visitor, writer, visit_flags) == -1) {
145 perror (argv[optind]);
149 if (hivex_close (h) == -1) {
150 perror (argv[optind]);
154 XML_CHECK (xmlTextWriterEndElement, (writer));
155 XML_CHECK (xmlTextWriterEndDocument, (writer));
156 xmlFreeTextWriter (writer);
161 /* Convert Windows filetime to ISO 8601 format.
162 * http://stackoverflow.com/questions/6161776/convert-windows-filetime-to-second-in-unix-linux/6161842#6161842
164 * Source for time_t->char* conversion: Fiwalk version 0.6.14's
167 * The caller should free the returned buffer.
170 #define WINDOWS_TICK 10000000LL
171 #define SEC_TO_UNIX_EPOCH 11644473600LL
172 #define TIMESTAMP_BUF_LEN 32
175 filetime_to_8601 (int64_t windows_ticks)
181 t = windows_ticks / WINDOWS_TICK - SEC_TO_UNIX_EPOCH;
186 ret = malloc (TIMESTAMP_BUF_LEN);
192 if (strftime (ret, TIMESTAMP_BUF_LEN, "%FT%TZ", tm) == 0) {
201 node_start (hive_h *h, void *writer_v, hive_node_h node, const char *name)
203 int64_t last_modified;
206 xmlTextWriterPtr writer = (xmlTextWriterPtr) writer_v;
207 XML_CHECK (xmlTextWriterStartElement, (writer, BAD_CAST "node"));
208 XML_CHECK (xmlTextWriterWriteAttribute, (writer, BAD_CAST "name", BAD_CAST name));
210 if (node == hivex_root (h)) {
211 XML_CHECK (xmlTextWriterWriteAttribute, (writer, BAD_CAST "root", BAD_CAST "1"));
214 last_modified = hivex_node_timestamp (h, node);
215 if (last_modified >= 0) {
216 timebuf = filetime_to_8601 (last_modified);
218 XML_CHECK (xmlTextWriterStartElement, (writer, BAD_CAST "mtime"));
219 XML_CHECK (xmlTextWriterWriteString, (writer, BAD_CAST timebuf));
220 XML_CHECK (xmlTextWriterEndElement, (writer));
229 node_end (hive_h *h, void *writer_v, hive_node_h node, const char *name)
231 xmlTextWriterPtr writer = (xmlTextWriterPtr) writer_v;
232 XML_CHECK (xmlTextWriterEndElement, (writer));
237 start_value (xmlTextWriterPtr writer,
238 const char *key, const char *type, const char *encoding)
240 XML_CHECK (xmlTextWriterStartElement, (writer, BAD_CAST "value"));
241 XML_CHECK (xmlTextWriterWriteAttribute, (writer, BAD_CAST "type", BAD_CAST type));
243 XML_CHECK (xmlTextWriterWriteAttribute, (writer, BAD_CAST "encoding", BAD_CAST encoding));
245 XML_CHECK (xmlTextWriterWriteAttribute, (writer, BAD_CAST "key", BAD_CAST key));
246 else /* default key */
247 XML_CHECK (xmlTextWriterWriteAttribute, (writer, BAD_CAST "default", BAD_CAST "1"));
251 end_value (xmlTextWriterPtr writer)
253 XML_CHECK (xmlTextWriterEndElement, (writer));
257 value_string (hive_h *h, void *writer_v, hive_node_h node, hive_value_h value,
258 hive_type t, size_t len, const char *key, const char *str)
260 xmlTextWriterPtr writer = (xmlTextWriterPtr) writer_v;
264 case hive_t_string: type = "string"; break;
265 case hive_t_expand_string: type = "expand"; break;
266 case hive_t_link: type = "link"; break;
271 case hive_t_dword_be:
272 case hive_t_multiple_strings:
273 case hive_t_resource_list:
274 case hive_t_full_resource_description:
275 case hive_t_resource_requirements_list:
277 abort (); /* internal error - should not happen */
283 start_value (writer, key, type, NULL);
284 XML_CHECK (xmlTextWriterWriteString, (writer, BAD_CAST str));
290 value_multiple_strings (hive_h *h, void *writer_v, hive_node_h node,
291 hive_value_h value, hive_type t, size_t len,
292 const char *key, char **argv)
294 xmlTextWriterPtr writer = (xmlTextWriterPtr) writer_v;
295 start_value (writer, key, "string-list", NULL);
298 for (i = 0; argv[i] != NULL; ++i) {
299 XML_CHECK (xmlTextWriterStartElement, (writer, BAD_CAST "string"));
300 XML_CHECK (xmlTextWriterWriteString, (writer, BAD_CAST argv[i]));
301 XML_CHECK (xmlTextWriterEndElement, (writer));
309 value_string_invalid_utf16 (hive_h *h, void *writer_v, hive_node_h node,
310 hive_value_h value, hive_type t, size_t len,
312 const char *str /* original data */)
314 xmlTextWriterPtr writer = (xmlTextWriterPtr) writer_v;
318 case hive_t_string: type = "bad-string"; break;
319 case hive_t_expand_string: type = "bad-expand"; break;
320 case hive_t_link: type = "bad-link"; break;
321 case hive_t_multiple_strings: type = "bad-string-list"; break;
326 case hive_t_dword_be:
327 case hive_t_resource_list:
328 case hive_t_full_resource_description:
329 case hive_t_resource_requirements_list:
331 abort (); /* internal error - should not happen */
337 start_value (writer, key, type, "base64");
338 XML_CHECK (xmlTextWriterWriteBase64, (writer, str, 0, len));
345 value_dword (hive_h *h, void *writer_v, hive_node_h node, hive_value_h value,
346 hive_type t, size_t len, const char *key, int32_t v)
348 xmlTextWriterPtr writer = (xmlTextWriterPtr) writer_v;
349 start_value (writer, key, "int32", NULL);
350 XML_CHECK (xmlTextWriterWriteFormatString, (writer, "%" PRIi32, v));
356 value_qword (hive_h *h, void *writer_v, hive_node_h node, hive_value_h value,
357 hive_type t, size_t len, const char *key, int64_t v)
359 xmlTextWriterPtr writer = (xmlTextWriterPtr) writer_v;
360 start_value (writer, key, "int64", NULL);
361 XML_CHECK (xmlTextWriterWriteFormatString, (writer, "%" PRIi64, v));
367 value_binary (hive_h *h, void *writer_v, hive_node_h node, hive_value_h value,
368 hive_type t, size_t len, const char *key, const char *v)
370 xmlTextWriterPtr writer = (xmlTextWriterPtr) writer_v;
371 start_value (writer, key, "binary", "base64");
372 XML_CHECK (xmlTextWriterWriteBase64, (writer, v, 0, len));
378 value_none (hive_h *h, void *writer_v, hive_node_h node, hive_value_h value,
379 hive_type t, size_t len, const char *key, const char *v)
381 xmlTextWriterPtr writer = (xmlTextWriterPtr) writer_v;
382 start_value (writer, key, "none", "base64");
383 if (len > 0) XML_CHECK (xmlTextWriterWriteBase64, (writer, v, 0, len));
389 value_other (hive_h *h, void *writer_v, hive_node_h node, hive_value_h value,
390 hive_type t, size_t len, const char *key, const char *v)
392 xmlTextWriterPtr writer = (xmlTextWriterPtr) writer_v;
399 case hive_t_dword_be:
402 case hive_t_expand_string:
404 case hive_t_multiple_strings:
405 abort (); /* internal error - should not happen */
407 case hive_t_resource_list: type = "resource-list"; break;
408 case hive_t_full_resource_description: type = "resource-description"; break;
409 case hive_t_resource_requirements_list: type = "resource-requirements"; break;
415 start_value (writer, key, type, "base64");
416 if (len > 0) XML_CHECK (xmlTextWriterWriteBase64, (writer, v, 0, len));