1 /* hivexsh - Hive shell.
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 #ifdef HAVE_LIBREADLINE
32 #include <readline/readline.h>
33 #include <readline/history.h>
38 #define _(str) dgettext(PACKAGE, (str))
39 //#define N_(str) dgettext(PACKAGE, (str))
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)
59 #include "byte_conversions.h"
61 #define HIVEX_MAX_VALUES 1000
65 static hive_h *h = NULL;
66 static char *prompt_string = NULL; /* Normal prompt string. */
67 static char *loaded = NULL; /* Basename of loaded file, if any. */
68 static hive_node_h cwd; /* Current node. */
69 static int open_flags = 0; /* Flags used when loading a hive file. */
71 static void usage (void) __attribute__((noreturn));
72 static void print_node_path (hive_node_h, FILE *);
73 static void set_prompt_string (void);
74 static void initialize_readline (void);
75 static void cleanup_readline (void);
76 static void add_history_line (const char *);
77 static char *rl_gets (const char *prompt_string);
78 static void sort_strings (char **strings, int len);
79 static int get_xdigit (char c);
80 static int dispatch (char *cmd, char *args);
81 static int cmd_add (char *name);
82 static int cmd_cd (char *path);
83 static int cmd_close (char *path);
84 static int cmd_commit (char *path);
85 static int cmd_del (char *args);
86 static int cmd_help (char *args);
87 static int cmd_load (char *hivefile);
88 static int cmd_ls (char *args);
89 static int cmd_lsval (char *args);
90 static int cmd_setval (char *args);
95 fprintf (stderr, "hivexsh [-dfw] [hivefile]\n");
100 main (int argc, char *argv[])
102 setlocale (LC_ALL, "");
103 bindtextdomain (PACKAGE, LOCALEBASEDIR);
104 textdomain (PACKAGE);
107 const char *filename = NULL;
109 set_prompt_string ();
111 while ((c = getopt (argc, argv, "df:w")) != EOF) {
114 open_flags |= HIVEX_OPEN_DEBUG;
120 open_flags |= HIVEX_OPEN_WRITE;
128 if (optind + 1 != argc)
130 if (cmd_load (argv[optind]) == -1)
134 /* -f filename parameter */
137 if (open (filename, O_RDONLY) == -1) {
145 initialize_readline ();
150 "Welcome to hivexsh, the hivex interactive shell for examining\n"
151 "Windows Registry binary hive files.\n"
153 "Type: 'help' for help summary\n"
154 " 'quit' to quit the shell\n"
158 char *buf = rl_gets (prompt_string);
166 while (*buf && c_isspace (*buf))
169 /* Ignore blank line. */
172 /* If the next character is '#' then this is a comment. */
173 if (*buf == '#') continue;
175 /* Parsing is very simple - much simpler than guestfish. This is
176 * because Registry keys often contain spaces, and we don't want
177 * to bother with quoting. Therefore here we just split at the
178 * first whitespace into "cmd<whitespace>arg(s)". We let the
179 * command decide how to deal with arg(s), if at all.
181 size_t len = strcspn (buf, " \t");
183 if (len == 0) continue;
188 if (buf[len] == '\0') {
189 /* This is mostly safe. Although the cmd_* functions do sometimes
190 * modify args, then shouldn't do so when args is "".
197 args = buf + len + 1 + strspn (&buf[len+1], " \t");
200 while (len > 0 && c_isspace (args[len-1])) {
206 /*printf ("command: '%s' args: '%s'\n", cmd, args)*/;
207 int r = dispatch (cmd, args);
208 if (!is_tty && r == -1)
213 free (prompt_string);
215 if (h) hivex_close (h);
219 /* Set the prompt string. This is called whenever it could change, eg.
220 * after loading a file or changing directory.
223 set_prompt_string (void)
225 free (prompt_string);
226 prompt_string = NULL;
231 fp = open_memstream (&ptr, &size);
233 perror ("open_memstream");
238 assert (loaded != NULL);
242 print_node_path (cwd, fp);
250 /* Print the \full\path of a node. */
252 print_node_path (hive_node_h node, FILE *fp)
254 hive_node_h root = hivex_root (h);
261 hive_node_h parent = hivex_node_parent (h, node);
263 fprintf (stderr, _("hivexsh: error getting parent of node %zu\n"), node);
266 print_node_path (parent, fp);
271 char *name = hivex_node_name (h, node);
273 fprintf (stderr, _("hivexsh: error getting node name of node %zx\n"), node);
281 static char *line_read = NULL;
284 rl_gets (const char *prompt_string)
286 #ifdef HAVE_LIBREADLINE
294 line_read = readline (prompt_string);
296 if (line_read && *line_read)
297 add_history_line (line_read);
302 #endif /* HAVE_LIBREADLINE */
304 static char buf[8192];
308 printf ("%s", prompt_string);
309 line_read = fgets (buf, sizeof buf, stdin);
312 len = strlen (line_read);
313 if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0';
319 #ifdef HAVE_LIBREADLINE
320 static char histfile[1024];
321 static int nr_history_lines = 0;
325 initialize_readline (void)
327 #ifdef HAVE_LIBREADLINE
330 home = getenv ("HOME");
332 snprintf (histfile, sizeof histfile, "%s/.hivexsh", home);
334 (void) read_history (histfile);
337 rl_readline_name = "hivexsh";
342 cleanup_readline (void)
344 #ifdef HAVE_LIBREADLINE
347 if (histfile[0] != '\0') {
348 fd = open (histfile, O_WRONLY|O_CREAT, 0644);
355 (void) append_history (nr_history_lines, histfile);
361 add_history_line (const char *line)
363 #ifdef HAVE_LIBREADLINE
370 compare (const void *vp1, const void *vp2)
372 char * const *p1 = (char * const *) vp1;
373 char * const *p2 = (char * const *) vp2;
374 return strcasecmp (*p1, *p2);
378 sort_strings (char **strings, int len)
380 qsort (strings, len, sizeof (char *), compare);
387 case '0'...'9': return c - '0';
388 case 'a'...'f': return c - 'a' + 10;
389 case 'A'...'F': return c - 'A' + 10;
395 dispatch (char *cmd, char *args)
397 if (STRCASEEQ (cmd, "help"))
398 return cmd_help (args);
399 else if (STRCASEEQ (cmd, "load"))
400 return cmd_load (args);
401 else if (STRCASEEQ (cmd, "exit") ||
402 STRCASEEQ (cmd, "q") ||
403 STRCASEEQ (cmd, "quit")) {
408 /* If no hive file is loaded (!h) then only the small selection of
409 * commands above will work.
412 fprintf (stderr, _("hivexsh: you must load a hive file first using 'load hivefile'\n"));
416 if (STRCASEEQ (cmd, "add"))
417 return cmd_add (args);
418 else if (STRCASEEQ (cmd, "cd"))
419 return cmd_cd (args);
420 else if (STRCASEEQ (cmd, "close") || STRCASEEQ (cmd, "unload"))
421 return cmd_close (args);
422 else if (STRCASEEQ (cmd, "commit"))
423 return cmd_commit (args);
424 else if (STRCASEEQ (cmd, "del"))
425 return cmd_del (args);
426 else if (STRCASEEQ (cmd, "ls"))
427 return cmd_ls (args);
428 else if (STRCASEEQ (cmd, "lsval"))
429 return cmd_lsval (args);
430 else if (STRCASEEQ (cmd, "setval"))
431 return cmd_setval (args);
433 fprintf (stderr, _("hivexsh: unknown command '%s', use 'help' for help summary\n"),
440 cmd_load (char *hivefile)
442 if (STREQ (hivefile, "")) {
443 fprintf (stderr, _("hivexsh: load: no hive file name given to load\n"));
447 if (h) hivex_close (h);
455 h = hivex_open (hivefile, open_flags);
459 "hivexsh: failed to open hive file: %s: %m\n"
461 "If you think this file is a valid Windows binary hive file (_not_\n"
462 "a regedit *.reg file) then please run this command again using the\n"
463 "hivexsh option '-d' and attach the complete output _and_ the hive file\n"
464 "which fails into a bug report at https://bugzilla.redhat.com/\n"
470 /* Get the basename of the file for the prompt. */
471 char *p = strrchr (hivefile, '/');
473 loaded = strdup (p+1);
475 loaded = strdup (hivefile);
481 cwd = hivex_root (h);
483 set_prompt_string ();
489 cmd_close (char *args)
491 if (STRNEQ (args, "")) {
492 fprintf (stderr, _("hivexsh: '%s' command should not be given arguments\n"),
497 if (h) hivex_close (h);
505 set_prompt_string ();
511 cmd_commit (char *path)
513 if (STREQ (path, ""))
516 if (hivex_commit (h, path, 0) == -1) {
517 perror ("hivexsh: commit");
527 if (STREQ (path, "")) {
528 print_node_path (cwd, stdout);
529 fputc ('\n', stdout);
533 if (path[0] == '\\' && path[1] == '\\') {
534 fprintf (stderr, _("%s: %s: \\ characters in path are doubled - are you escaping the path parameter correctly?\n"), "hivexsh", path);
538 hive_node_h new_cwd = cwd;
539 hive_node_h root = hivex_root (h);
541 if (path[0] == '\\') {
547 size_t len = strcspn (path, "\\");
554 path = path[len] == '\0' ? &path[len] : &path[len+1];
557 if (len == 1 && STREQ (elem, "."))
560 if (len == 2 && STREQ (elem, "..")) {
562 new_cwd = hivex_node_parent (h, new_cwd);
567 new_cwd = hivex_node_get_child (h, new_cwd, elem);
570 perror ("hivexsh: cd");
572 fprintf (stderr, _("hivexsh: cd: subkey '%s' not found\n"),
578 if (new_cwd != cwd) {
580 set_prompt_string ();
587 cmd_help (char *args)
590 "Navigate through the hive's keys using the 'cd' command, as if it\n"
591 "contained a filesystem, and use 'ls' to list the subkeys of the\n"
592 "current key. Full documentation is in the hivexsh(1) manual page.\n"));
600 if (STRNEQ (args, "")) {
601 fprintf (stderr, _("hivexsh: '%s' command should not be given arguments\n"),
606 /* Get the subkeys. */
607 hive_node_h *children = hivex_node_children (h, cwd);
608 if (children == NULL) {
613 /* Get names for each subkey. */
615 for (len = 0; children[len] != 0; ++len)
618 char **names = calloc (len, sizeof (char *));
626 for (i = 0; i < len; ++i) {
627 names[i] = hivex_node_name (h, children[i]);
628 if (names[i] == NULL) {
629 perror ("hivex_node_name");
634 /* Sort the names. */
635 sort_strings (names, len);
637 for (i = 0; i < len; ++i)
638 printf ("%s\n", names[i]);
643 for (i = 0; i < len; ++i)
650 cmd_lsval (char *key)
652 if (STRNEQ (key, "")) {
656 if (STREQ (key, "@")) /* default key written as "@" */
657 value = hivex_node_get_value (h, cwd, "");
659 value = hivex_node_get_value (h, cwd, key);
664 /* else key not found */
665 fprintf (stderr, _("%s: %s: key not found\n"), "hivexsh", key);
669 /* Print the value. */
672 if (hivex_value_type (h, value, &t, &len) == -1)
677 case hive_t_expand_string:
679 char *str = hivex_value_string (h, value);
683 puts (str); /* note: this adds a single \n character */
689 case hive_t_dword_be: {
690 int32_t j = hivex_value_dword (h, value);
691 printf ("%" PRIi32 "\n", j);
696 int64_t j = hivex_value_qword (h, value);
697 printf ("%" PRIi64 "\n", j);
701 case hive_t_multiple_strings: {
702 char **strs = hivex_value_multiple_strings (h, value);
706 for (j = 0; strs[j] != NULL; ++j) {
716 case hive_t_resource_list:
717 case hive_t_full_resource_description:
718 case hive_t_resource_requirements_list:
720 char *data = hivex_value_value (h, value, &t, &len);
724 if (fwrite (data, 1, len, stdout) != len)
732 /* No key specified, so print all keys in this node. We do this
733 * in a format which looks like the output of regedit, although
734 * this isn't a particularly useful format.
736 hive_value_h *values;
738 values = hivex_node_values (h, cwd);
743 for (i = 0; values[i] != 0; ++i) {
744 char *key = hivex_value_key (h, values[i]);
745 if (!key) goto error;
750 for (j = 0; key[j] != 0; ++j) {
751 if (key[j] == '"' || key[j] == '\\')
757 printf ("\"@\""); /* default key in regedit files */
763 if (hivex_value_type (h, values[i], &t, &len) == -1)
768 case hive_t_expand_string:
770 char *str = hivex_value_string (h, values[i]);
774 if (t != hive_t_string)
775 printf ("str(%d):", t);
778 for (j = 0; str[j] != 0; ++j) {
779 if (str[j] == '"' || str[j] == '\\')
789 case hive_t_dword_be: {
790 int32_t j = hivex_value_dword (h, values[i]);
791 printf ("dword:%08" PRIx32, j);
795 case hive_t_qword: /* sic */
798 case hive_t_multiple_strings:
799 case hive_t_resource_list:
800 case hive_t_full_resource_description:
801 case hive_t_resource_requirements_list:
803 unsigned char *data =
804 (unsigned char *) hivex_value_value (h, values[i], &t, &len);
808 printf ("hex(%d):", t);
810 for (j = 0; j < len; ++j) {
813 printf ("%02x", data[j]);
828 perror ("hivexsh: lsval");
833 cmd_setval (char *nrvals_str)
837 /* Parse number of values. */
839 xerr = xstrtol (nrvals_str, NULL, 0, &nrvals, "");
840 if (xerr != LONGINT_OK) {
841 fprintf (stderr, _("%s: %s: invalid integer parameter (%s returned %d)\n"),
842 "setval", "nrvals", "xstrtol", xerr);
845 if (nrvals < 0 || nrvals > HIVEX_MAX_VALUES) {
846 fprintf (stderr, _("%s: %s: integer out of range\n"),
851 struct hive_set_value *values =
852 calloc (nrvals, sizeof (struct hive_set_value));
853 if (values == NULL) {
860 /* Read nrvals * 2 lines of input, nrvals * (key, value) pairs, as
861 * explained in the man page.
864 for (i = 0; i < nrvals; ++i) {
866 char *buf = rl_gets (" key> ");
868 fprintf (stderr, _("hivexsh: setval: unexpected end of input\n"));
873 /* Note that buf will be overwritten by the next call to rl_gets. */
874 if (STREQ (buf, "@"))
875 values[i].key = strdup ("");
877 values[i].key = strdup (buf);
878 if (values[i].key == NULL) {
884 buf = rl_gets ("value> ");
886 fprintf (stderr, _("hivexsh: setval: unexpected end of input\n"));
891 if (STREQ (buf, "none")) {
892 values[i].t = hive_t_none;
895 else if (STRPREFIX (buf, "string:")) {
897 values[i].t = hive_t_string;
898 int nr_chars = strlen (buf);
899 values[i].len = 2 * (nr_chars + 1);
900 values[i].value = malloc (values[i].len);
901 if (!values[i].value) {
905 for (j = 0; j <= /* sic */ nr_chars; ++j) {
907 fprintf (stderr, _("hivexsh: string(utf16le): only 7 bit ASCII strings are supported for input\n"));
910 values[i].value[2*j] = buf[j];
911 values[i].value[2*j+1] = '\0';
914 else if (STRPREFIX (buf, "expandstring:")) {
916 values[i].t = hive_t_expand_string;
917 int nr_chars = strlen (buf);
918 values[i].len = 2 * (nr_chars + 1);
919 values[i].value = malloc (values[i].len);
920 if (!values[i].value) {
924 for (j = 0; j <= /* sic */ nr_chars; ++j) {
926 fprintf (stderr, _("hivexsh: string(utf16le): only 7 bit ASCII strings are supported for input\n"));
929 values[i].value[2*j] = buf[j];
930 values[i].value[2*j+1] = '\0';
933 else if (STRPREFIX (buf, "dword:")) {
935 values[i].t = hive_t_dword;
937 values[i].value = malloc (4);
938 if (!values[i].value) {
943 xerr = xstrtol (buf, NULL, 0, &n, "");
944 if (xerr != LONGINT_OK) {
945 fprintf (stderr, _("%s: %s: invalid integer parameter (%s returned %d)\n"),
946 "setval", "dword", "xstrtol", xerr);
950 if (n < 0 || n > UINT32_MAX) {
951 fprintf (stderr, _("%s: %s: integer out of range\n"),
956 uint32_t u32 = htole32 (n);
957 memcpy (values[i].value, &u32, 4);
959 else if (STRPREFIX (buf, "qword:")) {
961 values[i].t = hive_t_qword;
963 values[i].value = malloc (8);
964 if (!values[i].value) {
969 xerr = xstrtoll (buf, NULL, 0, &n, "");
970 if (xerr != LONGINT_OK) {
971 fprintf (stderr, _("%s: %s: invalid integer parameter (%s returned %d)\n"),
972 "setval", "dword", "xstrtoll", xerr);
976 if (n < 0 || n > UINT64_MAX) {
977 fprintf (stderr, _("%s: %s: integer out of range\n"),
982 uint64_t u64 = htole64 (n);
983 memcpy (values[i].value, &u64, 4);
985 else if (STRPREFIX (buf, "hex:")) {
988 size_t len = strcspn (buf, ":");
990 if (buf[len] == '\0') /* "hex:t" */
992 else { /* "hex:t:..." */
994 nextbuf = &buf[len+1];
998 xerr = xstrtol (buf, NULL, 0, &t, "");
999 if (xerr != LONGINT_OK) {
1000 fprintf (stderr, _("%s: %s: invalid integer parameter (%s returned %d)\n"),
1001 "setval", "hex", "xstrtol", xerr);
1005 if (t < 0 || t > UINT32_MAX) {
1006 fprintf (stderr, _("%s: %s: integer out of range\n"),
1013 /* Read the hex data. */
1016 /* The allocation length is an overestimate, but it doesn't matter. */
1017 values[i].value = malloc (1 + strlen (buf) / 2);
1018 if (!values[i].value) {
1020 exit (EXIT_FAILURE);
1027 for (j = 0; *buf && j < 2; buf++) {
1028 if (c_isxdigit (*buf)) { /* NB: ignore non-hex digits. */
1030 c |= get_xdigit (*buf);
1035 if (j == 2) values[i].value[values[i].len++] = c;
1037 fprintf (stderr, _("hivexsh: setval: trailing garbage after hex string\n"));
1044 _("hivexsh: setval: cannot parse value string, please refer to the man page hivexsh(1) for help: %s\n"),
1050 ret = hivex_node_set_values (h, cwd, nrvals, values, 0);
1053 /* Free values array. */
1054 for (i = 0; i < nrvals; ++i) {
1055 free (values[i].key);
1056 free (values[i].value);
1064 cmd_del (char *args)
1066 if (STRNEQ (args, "")) {
1067 fprintf (stderr, _("hivexsh: '%s' command should not be given arguments\n"),
1072 if (cwd == hivex_root (h)) {
1073 fprintf (stderr, _("hivexsh: del: the root node cannot be deleted\n"));
1077 hive_node_h new_cwd = hivex_node_parent (h, cwd);
1079 if (hivex_node_delete_child (h, cwd) == -1) {
1080 perror ("hivexsh: del");
1085 set_prompt_string ();
1090 cmd_add (char *name)
1092 hive_node_h node = hivex_node_add_child (h, cwd, name);
1094 perror ("hivexsh: add");