hivex/hivexsh.pod

   1 =encoding utf8
   2
   3 =head1 NAME
   4
   5 hivexsh - Windows Registry hive shell
   6
   7 =head1 SYNOPSIS
   8
   9  hivexsh [-options] [hivefile]
  10
  11 =head1 DESCRIPTION
  12
  13 This program provides a simple shell for navigating Windows Registry
  14 'hive' files.  It uses the hivex library for access to these binary
  15 files.
  16
  17 Firstly you will need to provide a hive file from a Windows operating
  18 system.  The hive files are usually located in
  19 C<C:\Windows\System32\Config> and have names like C<software>,
  20 C<system> etc (without any file extension).  For more information
  21 about hive files, read L<hivex(3)>.  For information about downloading
  22 files from virtual machines, read L<virt-cat(1)> and L<guestfish(1)>.
  23
  24 You can provide the name of the hive file to examine on the command
  25 line.  For example:
  26
  27  hivexsh software
  28
  29 Or you can start C<hivexsh> without any arguments, and immediately use
  30 the C<load> command to load a hive:
  31
  32  $ hivexsh
  33
  34  Welcome to hivexsh, the hivex interactive shell for examining
  35  Windows Registry binary hive files.
  36
  37  Type: 'help' for help with commands
  38        'quit' to quit the shell
  39
  40  > load software
  41  software\>
  42
  43 Navigate through the hive's keys using the C<cd> command, as if it
  44 contained a filesystem, and use C<ls> to list the subkeys of the
  45 current key.  Other commands are listed below.
  46
  47 =head1 OPTIONS
  48
  49 =over 4
  50
  51 =item B<-d>
  52
  53 Enable lots of debug messages.  If you find a Registry file that this
  54 program cannot parse, please enable this option and post the complete
  55 output I<and> the Registry hive file in your bug report.
  56
  57 =item B<-f> filename
  58
  59 Read commands from C<filename> instead of stdin.  To write a hivexsh
  60 script, use:
  61
  62  #!/usr/bin/hivexsh -f
  63
  64 =item B<-w>
  65
  66 If this option is given, then writes are allowed to the hive
  67 (see L</commit> command below, and the discussion of
  68 modifying hives in L<hivex(3)/WRITING TO HIVE FILES>).
  69
  70 B<Important Note:> Even if you specify this option, nothing is written
  71 to a hive unless you call the L</commit> command.  If you exit the
  72 shell without committing, all changes will be discarded.
  73
  74 If this option is not given, then write commands are disabled.
  75
  76 =back
  77
  78 =head1 COMMANDS
  79
  80 =over 4
  81
  82 =item B<cd> path
  83
  84 Change to the subkey C<path>.  Use Windows-style backslashes to
  85 separate path elements, and start with a backslash in order to start
  86 from the root of the hive.  For example:
  87
  88  cd \Classes\*
  89
  90 moves from the root node, to the C<Classes> node, to the C<*> node.
  91 If you were already at the root node, you could do this instead:
  92
  93  cd Classes\*
  94
  95 or even:
  96
  97  cd Classes
  98  cd *
  99
 100 Path elements (node names) are matched case insensitively, and
 101 characters like space, C<*>, and C<?> have I<no> special significance.
 102
 103 C<..> may be used to go to the parent directory.
 104
 105 =item B<close> | B<unload>
 106
 107 Close the currently loaded hive.
 108
 109 If you modified the hive, all uncommitted writes are lost when you
 110 call this command (or if the shell exits).  You have to call C<commit>
 111 to write changes.
 112
 113 =item B<commit> [newfile]
 114
 115 Commit changes to the hive.  If the optional C<newfile> parameter is
 116 supplied, then the hive is written to that file, else the original
 117 file is overwritten.
 118
 119 Note that you have to specify the C<-w> flag, otherwise no writes are
 120 allowed.
 121
 122 =item B<exit> | B<quit>
 123
 124 Exit the shell.
 125
 126 =item B<load> hivefile
 127
 128 Load the binary hive named C<hivefile>.  The currently loaded hive, if
 129 any, is closed.  The current directory is changed back to the root
 130 node.
 131
 132 =item B<ls>
 133
 134 List the subkeys of the current hive Registry key.  Note this command
 135 does not take any arguments.
 136
 137 =item B<lsval> [key]
 138
 139 List the (key, value) pairs of the current hive Registry key.  If no
 140 argument is given then all pairs are displayed.  If C<key> is given,
 141 then the value of the named key is displayed.  If C<@> is given, then
 142 the value of the default key is displayed.
 143
 144 =item B<setval> nrvals
 145
 146 This command replaces all (key, value) pairs at the current node with
 147 the values in subsequent input.  C<nrvals> is the number of values
 148 (ie. (key, value) pairs), and any existing values at this node are
 149 deleted.  So C<setval 0> just deletes any values at the current node.
 150
 151 The command reads 2 * nrvals lines of input, with each pair of
 152 lines of input corresponding to a key and a value to add.
 153
 154 For example, the following setval command replaces whatever is at the
 155 current node with two (key, value) pairs.  The default key is set to
 156 the UTF16-LE-encoded string "abcd".  The other value is named
 157 "ANumber" and is a little-endian DWORD 0x12345678.
 158
 159  setval 2
 160  @
 161  string:abcd
 162  ANumber
 163  dword:12345678
 164
 165 The first line of each pair is the key (the special key C<@> means
 166 the default key, but you can also use a blank line).
 167
 168 The second line of each pair is the value, which has a special format
 169 C<type:value> with possible types summarized in the table below:
 170
 171  none                 No data is stored, and the type is set to 0.
 172
 173  string:abc           "abc" is stored as a UTF16-LE-encoded
 174                       string (type 1).  Note that only 7 bit
 175                       ASCII strings are supported as input.
 176
 177  expandstring:...     Same as string but with type 2.
 178
 179  dword:0x01234567     A DWORD (type 4) with the hex value
 180                       0x01234567.  You can also use decimal
 181                       or octal numbers here.
 182
 183  qword:0x0123456789abcdef
 184                       A QWORD (type 11) with the hex value
 185                       0x0123456789abcdef.  You can also use
 186                       decimal or octal numbers here.
 187
 188  hex:<type>:<hexbytes>
 189  hex:1:41,00,42,00,43,00,44,00,00,00
 190                       This is the generic way to enter any
 191                       value.  <type> is the integer value type.
 192                       <hexbytes> is a list of pairs of hex
 193                       digits which are treated as bytes.
 194                       (Any non-hex-digits here are ignored,
 195                       so you can separate bytes with commas
 196                       or spaces if you want).
 197
 198 =back
 199
 200 =head1 EXAMPLE
 201
 202  $ guestfish --ro -i Windows7
 203  ><fs> download win:c:\windows\system32\config\software software
 204  ><fs> quit
 205
 206  $ hivexsh software
 207
 208  Welcome to hivexsh, the hivex interactive shell for examining
 209  Windows Registry binary hive files.
 210
 211  Type: 'help' for help with commands
 212        'quit' to quit the shell
 213
 214  software\> ls
 215  ATI Technologies
 216  Classes
 217  Clients
 218  Intel
 219  Microsoft
 220  ODBC
 221  Policies
 222  RegisteredApplications
 223  Sonic
 224  Wow6432Node
 225  software\> quit
 226
 227 =head1 SEE ALSO
 228
 229 L<hivex(3)>,
 230 L<hivexget(1)>,
 231 L<hivexml(1)>,
 232 L<virt-win-reg(1)>,
 233 L<guestfs(3)>,
 234 L<http://libguestfs.org/>,
 235 L<virt-cat(1)>,
 236 L<virt-edit(1)>.
 237
 238 =head1 AUTHORS
 239
 240 Richard W.M. Jones (C<rjones at redhat dot com>)
 241
 242 =head1 COPYRIGHT
 243
 244 Copyright (C) 2009-2010 Red Hat Inc.
 245
 246 This program is free software; you can redistribute it and/or modify
 247 it under the terms of the GNU General Public License as published by
 248 the Free Software Foundation; either version 2 of the License, or
 249 (at your option) any later version.
 250
 251 This program is distributed in the hope that it will be useful,
 252 but WITHOUT ANY WARRANTY; without even the implied warranty of
 253 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 254 GNU General Public License for more details.
 255
 256 You should have received a copy of the GNU General Public License along
 257 with this program; if not, write to the Free Software Foundation, Inc.,
 258 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.