tools/virt-win-reg

   1 #!/usr/bin/perl -w
   2 # virt-win-reg
   3 # Copyright (C) 2010 Red Hat Inc.
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 2 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program; if not, write to the Free Software
  17 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 use warnings;
  20 use strict;
  21
  22 use Sys::Guestfs;
  23 use Sys::Guestfs::Lib qw(open_guest get_partitions resolve_windows_path
  24   inspect_all_partitions inspect_partition
  25   inspect_operating_systems mount_operating_system);
  26 use Win::Hivex;
  27 use Win::Hivex::Regedit qw(reg_import reg_export);
  28
  29 use Pod::Usage;
  30 use Getopt::Long;
  31 use File::Temp qw/tempdir/;
  32 use Locale::TextDomain 'libguestfs';
  33
  34 =encoding utf8
  35
  36 =head1 NAME
  37
  38 virt-win-reg - Export and merge Windows Registry entries from a Windows guest
  39
  40 =head1 SYNOPSIS
  41
  42  virt-win-reg domname 'HKLM\Path\To\Subkey'
  43
  44  virt-win-reg domname 'HKLM\Path\To\Subkey' name
  45
  46  virt-win-reg domname 'HKLM\Path\To\Subkey' @
  47
  48  virt-win-reg --merge domname [input.reg ...]
  49
  50  virt-win-reg [--options] disk.img ... # instead of domname
  51
  52 =head1 WARNING
  53
  54 You must I<not> use C<virt-win-reg> with the C<--merge> option on live
  55 virtual machines.  If you do this, you I<will> get irreversible disk
  56 corruption in the VM.  C<virt-win-reg> tries to stop you from doing
  57 this, but doesn't catch all cases.
  58
  59 Modifying the Windows Registry is an inherently risky operation.  The format
  60 is deliberately obscure and undocumented, and Registry changes
  61 can leave the system unbootable.  Therefore when using the C<--merge>
  62 option, make sure you have a reliable backup first.
  63
  64 =head1 DESCRIPTION
  65
  66 This program can export and merge Windows Registry entries from a
  67 Windows guest.
  68
  69 The first parameter is the libvirt guest name or the raw disk image of
  70 a Windows guest.
  71
  72 If C<--merge> is I<not> specified, then the chosen registry
  73 key is displayed/exported (recursively).  For example:
  74
  75  $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft'
  76
  77 You can also display single values from within registry keys,
  78 for example:
  79
  80  $ cvkey='HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion'
  81  $ virt-win-reg Windows7 $cvkey ProductName
  82  Windows 7 Enterprise
  83
  84 With C<--merge>, you can merge a textual regedit file into
  85 the Windows Registry:
  86
  87  $ virt-win-reg --merge Windows7 changes.reg
  88
  89 =head2 SUPPORTED SYSTEMS
  90
  91 The program currently supports Windows NT-derived guests starting with
  92 Windows XP through to at least Windows 7.
  93
  94 Registry support is done for C<HKEY_LOCAL_MACHINE\SAM>,
  95 C<HKEY_LOCAL_MACHINE\SECURITY>, C<HKEY_LOCAL_MACHINE\SOFTWARE>,
  96 C<HKEY_LOCAL_MACHINE\SYSTEM> and C<HKEY_USERS\.DEFAULT>.
  97
  98 You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and
  99 C<HKU> for C<HKEY_USERS>.
 100
 101 C<HKEY_USERS\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at
 102 this time.
 103
 104 =head2 NOTE
 105
 106 This program is only meant for simple access to the registry.  If you
 107 want to do complicated things with the registry, we suggest you
 108 download the Registry hive files from the guest using L<libguestfs(3)>
 109 or L<guestfish(1)> and access them locally, eg. using L<hivex(3)>,
 110 L<hivexsh(1)> or L<hivexregedit(1)>.
 111
 112 =head2 ENCODING
 113
 114 C<virt-win-reg> expects that regedit files have already been reencoded
 115 in the local encoding.  Usually on Linux hosts, this means UTF-8 with
 116 Unix-style line endings.  Since Windows regedit files are often in
 117 UTF-16LE with Windows-style line endings, you may need to reencode the
 118 whole file before or after processing.
 119
 120 To reencode a file from Windows format to Linux (before processing it
 121 with the C<--merge> option), you would do something like this:
 122
 123  iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg
 124
 125 To go in the opposite direction, after exporting and before sending
 126 the file to a Windows user, do something like this:
 127
 128  unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg
 129
 130 For more information about encoding, see L<Win::Hivex::Regedit(3)>.
 131
 132 If you are unsure about the current encoding, use the L<file(1)>
 133 command.  Recent versions of Windows regedit.exe produce a UTF-16LE
 134 file with Windows-style (CRLF) line endings, like this:
 135
 136  $ file software.reg
 137  software.reg: Little-endian UTF-16 Unicode text, with very long lines,
 138  with CRLF line terminators
 139
 140 This file would need conversion before you could C<--merge> it.
 141
 142 =head2 SHELL QUOTING
 143
 144 Be careful when passing parameters containing C<\> (backslash) in the
 145 shell.  Usually you will have to use 'single quotes' or double
 146 backslashes (but not both) to protect them from the shell.
 147
 148 Paths and value names are case-insensitive.
 149
 150 =head2 CurrentControlSet etc.
 151
 152 Registry keys like C<CurrentControlSet> don't really exist in the
 153 Windows Registry at the level of the hive file, and therefore you
 154 cannot modify these.
 155
 156 C<CurrentControlSet> is usually an alias for C<ControlSet001>.  In
 157 some circumstances it might refer to another control set.  The way
 158 to find out is to look at the C<HKLM\SYSTEM\Select> key:
 159
 160  # virt-win-reg WindowsGuest 'HKLM\SYSTEM\Select'
 161  [HKEY_LOCAL_MACHINE\SYSTEM\Select]
 162  "Current"=dword:00000001
 163  "Default"=dword:00000001
 164  "Failed"=dword:00000000
 165  "LastKnownGood"=dword:00000002
 166
 167 "Default" is the one which Windows will choose when it boots.
 168
 169 Similarly, other C<Current...> keys in the path may need to
 170 be replaced.
 171
 172 =head1 OPTIONS
 173
 174 =over 4
 175
 176 =cut
 177
 178 my $help;
 179
 180 =item B<--help>
 181
 182 Display brief help.
 183
 184 =cut
 185
 186 my $version;
 187
 188 =item B<--version>
 189
 190 Display version number and exit.
 191
 192 =cut
 193
 194 my $debug;
 195
 196 =item B<--debug>
 197
 198 Enable debugging messages.
 199
 200 =cut
 201
 202 my $uri;
 203
 204 =item B<--connect URI> | B<-c URI>
 205
 206 If using libvirt, connect to the given I<URI>.  If omitted, then we
 207 connect to the default libvirt hypervisor.
 208
 209 If you specify guest block devices directly, then libvirt is not used
 210 at all.
 211
 212 =cut
 213
 214 my $merge;
 215
 216 =item B<--merge>
 217
 218 In merge mode, this merges a textual regedit file into the Windows
 219 Registry of the virtual machine.  If this flag is I<not> given then
 220 virt-win-reg displays or exports Registry entries instead.
 221
 222 Note that C<--merge> is I<unsafe> to use on live virtual machines, and
 223 will result in disk corruption.  However exporting (without this flag)
 224 is always safe.
 225
 226 =cut
 227
 228 my $encoding;
 229
 230 =item B<--encoding> UTF-16LE|ASCII
 231
 232 When merging (only), you may need to specify the encoding for strings
 233 to be used in the hive file.  This is explained in detail in
 234 L<Win::Hivex::Regedit(3)/ENCODING STRINGS>.
 235
 236 The default is to use UTF-16LE, which should work with recent versions
 237 of Windows.
 238
 239 =back
 240
 241 =cut
 242
 243 GetOptions ("help|?" => \$help,
 244             "version" => \$version,
 245             "connect|c=s" => \$uri,
 246             "debug|d" => \$debug,
 247             "merge" => \$merge,
 248             "encoding=s" => \$encoding,
 249     ) or pod2usage (2);
 250 pod2usage (1) if $help;
 251 if ($version) {
 252     my $g = Sys::Guestfs->new ();
 253     my %h = $g->version ();
 254     print "$h{major}.$h{minor}.$h{release}$h{extra}\n";
 255     exit
 256 }
 257
 258 # virt-win-reg only takes a single disk image ...
 259 die __"no libvirt domain name or disk image given\n" if @ARGV == 0;
 260 my $domname_or_image = shift @ARGV;
 261
 262 warn "launching libguestfs ..." if $debug;
 263
 264 my @lib_args = ([$domname_or_image]);
 265 push @lib_args, address => $uri if $uri;
 266 push @lib_args, rw => 1 if $merge;
 267 my $g = open_guest (@lib_args);
 268 $g->launch ();
 269
 270 warn "inspecting guest ..." if $debug;
 271
 272 # List of possible filesystems.
 273 my @partitions = get_partitions ($g);
 274
 275 # Now query each one to build up a picture of what's in it.
 276 my %fses =
 277     inspect_all_partitions ($g, \@partitions,
 278       use_windows_registry => 0);
 279
 280 my $oses = inspect_operating_systems ($g, \%fses);
 281
 282 my @roots = keys %$oses;
 283 die __"no root device found in this operating system image" if @roots == 0;
 284 die __"multiboot operating systems are not supported by virt-win-reg" if @roots > 1;
 285 my $root_dev = $roots[0];
 286
 287 my $os = $oses->{$root_dev};
 288 my $ro = $merge ? 0 : 1;
 289 mount_operating_system ($g, $os, $ro);
 290
 291 # Create a working directory to store the downloaded registry files.
 292 my $tmpdir = tempdir (CLEANUP => 1);
 293
 294 # Only used when merging to map downloaded hive names to hive handles.
 295 my %hives;
 296
 297 if (!$merge) {                  # Export mode.
 298     die __"expecting 1 or 2 more parameters, subkey path and optionally the value to export\n"
 299         if @ARGV < 1 || @ARGV > 2;
 300
 301     my $path = shift @ARGV;
 302     my $name = shift @ARGV; # or undef
 303
 304     # Map this to the hive name.  This function dies on failure.
 305     my ($hivename, $prefix);
 306     ($hivename, $path, $prefix) = map_path_to_hive ($path);
 307
 308     # Download the chosen hive.
 309     download_hive ($hivename);
 310
 311     # Open it.
 312     my $h = Win::Hivex->open ("$tmpdir/$hivename", debug => $debug);
 313
 314     unless ($name) {
 315         # Export it.
 316         warn "exporting $path from $hivename with prefix $prefix ..." if $debug;
 317         reg_export ($h, $path, \*STDOUT, prefix => $prefix);
 318     } else {
 319         # Export a single key using hivexget.
 320         my @args = ("hivexget", "$tmpdir/$hivename", $path, $name);
 321         warn "running ", join (" ", @args), " ..." if $debug;
 322         system (@args) == 0 or die "hivexget failed: $?"
 323     }
 324 }
 325 else {                          # Import mode.
 326     if (@ARGV == 0) {
 327         reg_import (\*STDIN, \&import_mapper, encoding => $encoding);
 328     } else {
 329         foreach (@ARGV) {
 330             open my $fh, $_ or die "open: $_: $!";
 331             reg_import ($fh, \&import_mapper, encoding => $encoding);
 332         }
 333     }
 334
 335     # Now we've done importing, commit all the hive handles and
 336     # close them all.
 337     $_->commit (undef) foreach values %hives;
 338     %hives = ();
 339
 340     # Look in the tmpdir for all the hive files which have been
 341     # downloaded / modified by the import mapper, and upload
 342     # each one.
 343     opendir my $dh, $tmpdir or die "$tmpdir: $!";
 344     foreach (readdir $dh) {
 345         unless (/^\./) {
 346             upload_hive ($_)
 347         }
 348     }
 349
 350     # Sync everything.
 351     $g->umount_all ();
 352     $g->sync ();
 353 }
 354
 355 exit 0;
 356
 357 # map function passed to reg_import.
 358 sub import_mapper
 359 {
 360     local $_ = shift;
 361
 362     my ($hivename, $path, $prefix) = map_path_to_hive ($_);
 363
 364     # Need to download this hive?
 365     unless (-f "$tmpdir/$hivename") {
 366         download_hive ($hivename);
 367
 368         my $h = Win::Hivex->open ("$tmpdir/$hivename",
 369                                   write => 1, debug => $debug);
 370         $hives{$hivename} = $h;
 371     }
 372
 373     return ($hives{$hivename}, $path);
 374 }
 375
 376 # Given a path, map that to the name of the hive and the true path
 377 # within that hive.
 378 sub map_path_to_hive
 379 {
 380     local $_ = shift;
 381     my ($hivename, $prefix);
 382
 383     if (/^\\?(?:HKEY_LOCAL_MACHINE|HKLM)\\SAM(\\.*)?$/i) {
 384         $hivename = "sam";
 385         $_ = defined $1 ? $1 : "\\";
 386         $prefix = "HKEY_LOCAL_MACHINE\\SAM";
 387     }
 388     elsif (/^\\?(?:HKEY_LOCAL_MACHINE|HKLM)\\SECURITY(\\.*)?$/i) {
 389         $hivename = "security";
 390         $_ = defined $1 ? $1 : "\\";
 391         $prefix = "HKEY_LOCAL_MACHINE\\SECURITY";
 392     }
 393     elsif (/^\\?(?:HKEY_LOCAL_MACHINE|HKLM)\\SOFTWARE(\\.*)?$/i) {
 394         $hivename = "software";
 395         $_ = defined $1 ? $1 : "\\";
 396         $prefix = "HKEY_LOCAL_MACHINE\\SOFTWARE";
 397     }
 398     elsif (/^\\?(?:HKEY_LOCAL_MACHINE|HKLM)\\SYSTEM(\\.*)?$/i) {
 399         $hivename = "system";
 400         $_ = defined $1 ? $1 : "\\";
 401         $prefix = "HKEY_LOCAL_MACHINE\\SYSTEM";
 402     }
 403     elsif (/^\\?(?:HKEY_USERS|HKU)\\.DEFAULT(\\.*)?$/i) {
 404         $hivename = "default";
 405         $_ = defined $1 ? $1 : "\\";
 406         $prefix = "HKEY_LOCAL_MACHINE\\.DEFAULT";
 407     }
 408     else {
 409         die __x("virt-win-reg: {p}: not a supported Windows Registry path\n",
 410                 p => $_)
 411     }
 412
 413     return ($hivename, $_, $prefix);
 414 }
 415
 416 # Download a named hive file.  Die on failure.
 417 sub download_hive
 418 {
 419     local $_;
 420     my $hivename = shift;
 421
 422     my $systemroot = $os->{root}->{systemroot} || "/windows";
 423     my $winfile_before = "$systemroot/system32/config/$hivename";
 424     my $winfile;
 425     eval { $winfile = $g->case_sensitive_path ($winfile_before); };
 426     if ($@) {
 427         die __x("virt-win-reg: {p}: file not found in guest: {err}\n",
 428                 p => $winfile_before, err => $@);
 429     }
 430
 431     warn "downloading $winfile ..." if $debug;
 432     eval { $g->download ($winfile, "$tmpdir/$hivename"); };
 433     if ($@) {
 434         die __x("virt-win-reg: {p}: could not download registry file: {err}\n",
 435                 p => $winfile, err => $@);
 436     }
 437 }
 438
 439 # Upload a named hive file.  Die on failure.
 440 sub upload_hive
 441 {
 442     local $_;
 443     my $hivename = shift;
 444
 445     my $systemroot = $os->{root}->{systemroot} || "/windows";
 446     my $winfile_before = "$systemroot/system32/config/$hivename";
 447     my $winfile;
 448     eval { $winfile = $g->case_sensitive_path ($winfile_before); };
 449     if ($@) {
 450         die __x("virt-win-reg: {p}: file not found in guest: {err}\n",
 451                 p => $winfile_before, err => $@);
 452     }
 453
 454     warn "uploading $winfile ..." if $debug;
 455     eval { $g->upload ("$tmpdir/$hivename", $winfile); };
 456     if ($@) {
 457         die __x("virt-win-reg: {p}: could not upload registry file: {err}\n",
 458                 p => $winfile, err => $@);
 459     }
 460 }
 461
 462 =head1 SEE ALSO
 463
 464 L<hivex(3)>,
 465 L<hivexsh(1)>,
 466 L<hivexregedit(1)>,
 467 L<guestfs(3)>,
 468 L<guestfish(1)>,
 469 L<virt-cat(1)>,
 470 L<Sys::Guestfs(3)>,
 471 L<Sys::Guestfs::Lib(3)>,
 472 L<Win::Hivex(3)>,
 473 L<Win::Hivex::Regedit(3)>,
 474 L<Sys::Virt(3)>,
 475 L<http://libguestfs.org/>.
 476
 477 =head1 BUGS
 478
 479 When reporting bugs, please enable debugging and capture the
 480 I<complete> output:
 481
 482  export LIBGUESTFS_DEBUG=1
 483  virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1
 484
 485 Attach /tmp/virt-win-reg.log to a new bug report at
 486 L<https://bugzilla.redhat.com/>
 487
 488 =head1 AUTHOR
 489
 490 Richard W.M. Jones L<http://people.redhat.com/~rjones/>
 491
 492 =head1 COPYRIGHT
 493
 494 Copyright (C) 2010 Red Hat Inc.
 495
 496 This program is free software; you can redistribute it and/or modify
 497 it under the terms of the GNU General Public License as published by
 498 the Free Software Foundation; either version 2 of the License, or
 499 (at your option) any later version.
 500
 501 This program is distributed in the hope that it will be useful,
 502 but WITHOUT ANY WARRANTY; without even the implied warranty of
 503 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 504 GNU General Public License for more details.
 505
 506 You should have received a copy of the GNU General Public License
 507 along with this program; if not, write to the Free Software
 508 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.