regedit/hivexregedit

   1 #!/usr/bin/perl -w
   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
  15 # along with this program; if not, write to the Free Software
  16 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 use warnings;
  19 use strict;
  20
  21 use Win::Hivex;
  22 use Win::Hivex::Regedit qw(reg_import reg_export);
  23
  24 use Pod::Usage;
  25 use Getopt::Long;
  26
  27 =encoding utf8
  28
  29 =head1 NAME
  30
  31 hivexregedit - Merge and export Registry changes from regedit-format files.
  32
  33 =head1 SYNOPSIS
  34
  35  hivexregedit --merge [--prefix prefix] [--encoding enc] \
  36          hivefile [regfile]
  37
  38  hivexregedit --export [--prefix prefix] hivefile key > regfile
  39
  40 =head1 DESCRIPTION
  41
  42 Please note hivexregedit is a low-level tool for manipulating hive
  43 files directly.  To merge or export registry changes to Windows
  44 virtual machines it's better to use L<virt-win-reg(1)>.
  45
  46 Given a local binary ("hive") file, there are two modes.  C<--merge>
  47 imports (merges) changes from a regedit-format file into the hive.  It
  48 is similar to using the C</s> switch in Windows regedit.exe.
  49
  50 C<--export> exports a Registry key (recursively) into the regedit format.
  51
  52 =head2 ENCODING
  53
  54 C<hivexregedit> expects that regedit files have already been reencoded
  55 in the local encoding.  Usually on Linux hosts, this means UTF-8 with
  56 Unix-style line endings.  Since Windows regedit files are often in
  57 UTF-16LE with Windows-style line endings, you may need to reencode the
  58 whole file before or after processing.
  59
  60 To reencode a file from Windows format to Linux (before processing it
  61 with the C<--merge> option), you would do something like this:
  62
  63  iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg
  64
  65 To go in the opposite direction, after using C<--export> and before
  66 sending the file to a Windows user, do something like this:
  67
  68  unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg
  69
  70 For more information about encoding, see L<Win::Hivex::Regedit(3)>.
  71
  72 If you are unsure about the current encoding, use the L<file(1)>
  73 command.  Recent versions of Windows regedit.exe produce a UTF-16LE
  74 file with Windows-style (CRLF) line endings, like this:
  75
  76  $ file software.reg
  77  software.reg: Little-endian UTF-16 Unicode text, with very long lines,
  78  with CRLF line terminators
  79
  80 This file would need conversion before you could C<--merge> it.
  81
  82 =head2 SHELL QUOTING
  83
  84 Be careful when passing parameters containing C<\> (backslash) in the
  85 shell.  Usually you will have to use 'single quotes' or double
  86 backslashes (but not both) to protect them from the shell.
  87
  88 =head2 CurrentControlSet etc.
  89
  90 Registry keys like C<CurrentControlSet> don't really exist in the
  91 Windows Registry at the level of the hive file, and therefore you
  92 cannot modify these.  Replace this with C<ControlSet001>, and
  93 similarly for other C<Current...> keys.
  94
  95 =head1 EXAMPLE
  96
  97  $ virt-cat WindowsGuest /Windows/System32/config/software > software.hive
  98  $ hivexregedit --export \
  99      --prefix 'HKEY_LOCAL_MACHINE\SOFTWARE' \
 100      software.hive '\Microsoft' > ms-keys.reg
 101
 102  $ hivexregedit --merge system.hive \
 103      --prefix 'HKEY_LOCAL_MACHINE\SYSTEM' additions.reg
 104
 105 =head1 OPTIONS
 106
 107 =over 4
 108
 109 =cut
 110
 111 my $help;
 112
 113 =item B<--help>
 114
 115 Display help.
 116
 117 =cut
 118
 119 my $debug;
 120
 121 =item B<--debug>
 122
 123 Enable debugging in the hivex library.  This is useful for diagnosing
 124 bugs and also malformed hive files.
 125
 126 =cut
 127
 128 my $merge;
 129
 130 =item B<--merge>
 131
 132  hivexregedit --merge [--prefix prefix] [--encoding enc] \
 133          hivefile [regfile]
 134
 135 Merge C<regfile> (a regedit-format text file) into the hive
 136 C<hivefile>.  If C<regfile> is omitted, then the program reads from
 137 standard input.  (Also you can give multiple input files).
 138
 139 C<--prefix> specifies the Windows Registry prefix.  It is almost
 140 always necessary to use this when dealing with real hive files.
 141
 142 C<--encoding> specifies the encoding for unmarked strings in the
 143 input.  It defaults to C<UTF-16LE> which should work for recent
 144 versions of Windows.  Another possibility is to use C<ASCII>.
 145
 146 =cut
 147
 148 my $export;
 149
 150 =item B<--export>
 151
 152  hivexregedit --export [--prefix prefix] hivefile key > regfile
 153
 154 C<key> is a path within the hive C<hivefile>.  (The key should not
 155 contain any prefix and should be quoted to defend backslashes from the
 156 shell).  The key is exported, recursively, to standard output in the
 157 textual regedit format.
 158
 159 C<--prefix> specifies the Windows Registry prefix.  It is almost
 160 always necessary to use this when dealing with real hive files.
 161
 162 =cut
 163
 164 my $prefix;
 165
 166 =item B<--prefix> prefix
 167
 168 Hive files and Windows Registry key names are indirectly related.  For
 169 example, inside the software hive, all keys are stored relative to
 170 C<HKEY_LOCAL_MACHINE\SOFTWARE>.  Thus
 171 C<HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft> appears in the hive file as
 172 C<\Microsoft>.
 173
 174 The hive format itself does not store this prefix, so you have to
 175 supply it based on outside knowledge.  (L<virt-win-reg(1)>, amongst
 176 other things, already knows about this).
 177
 178 Usually it is sufficient to pass the parameter
 179 C<--prefix 'HKEY_LOCAL_MACHINE\SOFTWARE'> or similar when doing
 180 merges and exports.
 181
 182 =cut
 183
 184 my $encoding;
 185
 186 =item B<--encoding> UTF-16LE|ASCII
 187
 188 When merging (only), you may need to specify the encoding for strings
 189 to be used in the hive file.  This is explained in detail in
 190 L<Win::Hivex::Regedit(3)/ENCODING STRINGS>.
 191
 192 The default is to use UTF-16LE, which should work with recent versions
 193 of Windows.
 194
 195 =back
 196
 197 =cut
 198
 199 GetOptions ("help|?" => \$help,
 200             "debug" => \$debug,
 201             "merge|import" => \$merge,
 202             "export" => \$export,
 203             "prefix=s" => \$prefix,
 204             "encoding=s" => \$encoding,
 205     ) or pod2usage (2);
 206 pod2usage (1) if $help;
 207
 208 if ($merge && $export) {
 209     die "hivexregedit: cannot use --merge and --export at the same time\n"
 210 }
 211
 212 unless ($merge || $export) {
 213     die "hivexregedit: use --merge or --export, see the manpage for help\n"
 214 }
 215
 216 if ($export && defined $encoding) {
 217     die "hivexregedit: --encoding has no effect when used with --export\n"
 218 }
 219
 220 if ($merge) {                   # --merge (reg_import)
 221     if (@ARGV < 1) {
 222         die "hivexregedit --merge hivefile [input.reg ...]\n"
 223     }
 224
 225     my $hivefile = shift @ARGV;
 226
 227     my $h = Win::Hivex->open ($hivefile, write => 1, debug => $debug);
 228
 229     # Read from stdin unless other files have been specified.
 230     unshift (@ARGV, '-') unless @ARGV;
 231
 232     foreach (@ARGV) {
 233         open FILE, $_ or die "$_: $!";
 234         reg_import (\*FILE, sub {
 235             local $_ = shift;
 236             # Remove prefix from the start of the path, matching
 237             # case insensitively.
 238             if (defined $prefix) {
 239                 my $len = length $prefix;
 240                 if (length $_ >= $len &&
 241                     lc (substr ($_, 0, $len)) eq lc ($prefix)) {
 242                     $_ = substr ($_, $len);
 243                 }
 244             }
 245             ($h, $_)
 246         });
 247     }
 248
 249     $h->commit (undef);
 250 } else {                        # --export (reg_export)
 251     if (@ARGV != 2) {
 252         die "hivexregedit --export hivefile key\n"
 253     }
 254
 255     my $hivefile = shift @ARGV;
 256     my $key = shift @ARGV;
 257
 258     my $h = Win::Hivex->open ($hivefile, debug => $debug);
 259
 260     print "Windows Registry Editor Version 5.00\n\n";
 261
 262     reg_export ($h, $key, \*STDOUT, prefix => $prefix);
 263 }
 264
 265 =head1 SEE ALSO
 266
 267 L<virt-win-reg(1)>,
 268 L<Win::Hivex::Regedit(3)>,
 269 L<Win::Hivex(3)>,
 270 L<hivexsh(1)>,
 271 L<dos2unix(1)>,
 272 L<unix2dos(1)>,
 273 L<iconv(1)>,
 274 L<http://libguestfs.org/>.
 275
 276 =head1 AUTHOR
 277
 278 Richard W.M. Jones L<http://people.redhat.com/~rjones/>
 279
 280 =head1 COPYRIGHT
 281
 282 Copyright (C) 2010 Red Hat Inc.
 283
 284 This program is free software; you can redistribute it and/or modify
 285 it under the terms of the GNU General Public License as published by
 286 the Free Software Foundation; either version 2 of the License, or
 287 (at your option) any later version.
 288
 289 This program is distributed in the hope that it will be useful,
 290 but WITHOUT ANY WARRANTY; without even the implied warranty of
 291 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 292 GNU General Public License for more details.
 293
 294 You should have received a copy of the GNU General Public License
 295 along with this program; if not, write to the Free Software
 296 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.