/usr/bin/virt-win-reg is in libguestfs-tools 1:1.36.13-1ubuntu3.
This file is owned by root:root, with mode 0o755.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 | #!/usr/bin/env perl
# virt-win-reg
# Copyright (C) 2010 Red Hat Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
use warnings;
use strict;
use Sys::Guestfs;
use Win::Hivex;
use Win::Hivex::Regedit qw(reg_import reg_export);
use Pod::Usage;
use Getopt::Long;
use File::Temp qw/tempdir/;
use File::Basename;
use Locale::TextDomain 'libguestfs';
=head1 NAME
virt-win-reg - Export and merge Windows Registry entries from a Windows guest
=head1 SYNOPSIS
virt-win-reg domname 'HKLM\Path\To\Subkey'
virt-win-reg domname 'HKLM\Path\To\Subkey' name
virt-win-reg domname 'HKLM\Path\To\Subkey' @
virt-win-reg --merge domname [input.reg ...]
virt-win-reg [--options] disk.img ... # instead of domname
=head1 WARNING
You must I<not> use C<virt-win-reg> with the I<--merge> option on live
virtual machines. If you do this, you I<will> get irreversible disk
corruption in the VM. C<virt-win-reg> tries to stop you from doing
this, but doesn't catch all cases.
Modifying the Windows Registry is an inherently risky operation. The format
is deliberately obscure and undocumented, and Registry changes
can leave the system unbootable. Therefore when using the I<--merge>
option, make sure you have a reliable backup first.
=head1 DESCRIPTION
This program can export and merge Windows Registry entries from a
Windows guest.
The first parameter is the libvirt guest name or the raw disk image of
a Windows guest.
If I<--merge> is I<not> specified, then the chosen registry
key is displayed/exported (recursively). For example:
$ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft'
You can also display single values from within registry keys,
for example:
$ cvkey='HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion'
$ virt-win-reg Windows7 $cvkey ProductName
Windows 7 Enterprise
With I<--merge>, you can merge a textual regedit file into
the Windows Registry:
$ virt-win-reg --merge Windows7 changes.reg
=head2 NOTE
This program is only meant for simple access to the registry. If you
want to do complicated things with the registry, we suggest you
download the Registry hive files from the guest using L<libguestfs(3)>
or L<guestfish(1)> and access them locally, eg. using L<hivex(3)>,
L<hivexsh(1)> or L<hivexregedit(1)>.
=head1 OPTIONS
=over 4
=cut
my $help;
=item B<--help>
Display brief help.
=cut
my $version;
=item B<--version>
Display version number and exit.
=cut
my $debug;
=item B<--debug>
Enable debugging messages.
=cut
my $uri;
=item B<-c URI>
=item B<--connect URI>
If using libvirt, connect to the given I<URI>. If omitted, then we
connect to the default libvirt hypervisor.
If you specify guest block devices directly, then libvirt is not used
at all.
=cut
my $format;
=item B<--format> raw
Specify the format of disk images given on the command line. If this
is omitted then the format is autodetected from the content of the
disk image.
If disk images are requested from libvirt, then this program asks
libvirt for this information. In this case, the value of the format
parameter is ignored.
If working with untrusted raw-format guest disk images, you should
ensure the format is always specified.
=cut
my $merge;
=item B<--merge>
In merge mode, this merges a textual regedit file into the Windows
Registry of the virtual machine. If this flag is I<not> given then
virt-win-reg displays or exports Registry entries instead.
Note that I<--merge> is I<unsafe> to use on live virtual machines, and
will result in disk corruption. However exporting (without this flag)
is always safe.
=cut
my $encoding;
=item B<--encoding> UTF-16LE|ASCII
When merging (only), you may need to specify the encoding for strings
to be used in the hive file. This is explained in detail in
L<Win::Hivex::Regedit(3)/ENCODING STRINGS>.
The default is to use UTF-16LE, which should work with recent versions
of Windows.
=cut
my $unsafe_printable_strings;
=item B<--unsafe-printable-strings>
When exporting (only), assume strings are UTF-16LE and print them as
strings instead of hex sequences. Remove the final zero codepoint
from strings if present.
This is unsafe and does not preserve the fidelity of strings in the
original Registry for various reasons:
=over 4
=item *
Assumes the original encoding is UTF-16LE. ASCII strings and strings
in other encodings will be corrupted by this transformation.
=item *
Assumes that everything which has type 1 or 2 is really a string
and that everything else is not a string, but the type field in
real Registries is not reliable.
=item *
Loses information about whether a zero codepoint followed the string
in the Registry or not.
=back
This all happens because the Registry itself contains no information
about how strings are encoded (see
L<Win::Hivex::Regedit(3)/ENCODING STRINGS>).
You should only use this option for quick hacking and debugging of the
Registry contents, and I<never> use it if the output is going to be
passed into another program or stored in another Registry.
=back
=cut
my %opts = ("help|?" => \$help,
"version" => \$version,
"connect|c=s" => \$uri,
"debug|d" => \$debug,
"format=s" => \$format,
"merge" => \$merge,
"encoding=s" => \$encoding,
"unsafe-printable-strings" => \$unsafe_printable_strings,
"long-options" => \&display_long_options,
"short-options" => \&display_short_options);
GetOptions (%opts) or pod2usage (2);
pod2usage (1) if $help;
if ($version) {
my $g = Sys::Guestfs->new ();
my %h = $g->version ();
print "virt-win-reg $h{major}.$h{minor}.$h{release}$h{extra}\n";
exit
}
sub display_long_options
{
foreach (sort keys %opts) {
if (m/^(.*?)([\|=].*)?$/ && !/-options$/) { print "--$1\n" }
}
exit
}
sub display_short_options
{
foreach (sort keys %opts) {
if (m/\|(.)/) { print "-$1\n" }
}
exit
}
# virt-win-reg only takes a single disk image ...
die __"no libvirt domain name or disk image given\n" if @ARGV == 0;
my $domname_or_image = shift @ARGV;
warn "launching libguestfs ..." if $debug;
my @lib_args = ();
push @lib_args, readonly => 1 unless $merge;
push @lib_args, format => $format if defined $format;
my $g = Sys::Guestfs->new ();
# If the parameter looks like a URI, try parsing it using guestfish.
# This is a massive hack, but we'll fix it when virt-win-reg gets
# rewritten in C ...
if ($domname_or_image =~ m|://|) {
# Whitelist the characters permitted in the URI.
die "$0: $domname_or_image: URI parameter contains invalid characters"
unless $domname_or_image =~ m|^[A-Za-z0-9/:#%&*+,-.=?@_~]+$|;
my $cmd = "LANG=C guestfish -a '$domname_or_image' -x exit 2>&1 | grep 'trace: add_drive [^=]'";
open CMD, "$cmd|" or die "open: $cmd: $!";
$_ = <CMD>;
close CMD or die "close: $cmd: $!";
chomp;
die "$0: could not parse '$_'"
unless m/^libguestfs: trace: add_drive "(.*?)"(.*)/;
my @args = ($1, @lib_args);
$_ = $2;
while (/\S/) {
die "$0: cound not parse remainder from '$_'"
unless $_ =~ /^\s*"([a-z]+):(.*?)"(.*)/;
if ($1 ne "server") {
push @args, $1, $2;
} else {
push @args, $1, [$2];
}
$_ = $3;
}
$g->add_drive (@args);
}
# If the parameter looks like a local file:
elsif (-e $domname_or_image) {
$g->add_drive ($domname_or_image, @lib_args);
}
# Try a libvirt domain name:
else {
push @lib_args, libvirturi => $uri if defined $uri;
$g->add_domain ($domname_or_image, @lib_args);
}
$g->launch ();
warn "inspecting guest ..." if $debug;
my @roots = $g->inspect_os ();
if (@roots == 0) {
die __x("{prog}: No operating system could be detected inside this disk image.\n\nThis may be because the file is not a disk image, or is not a virtual machine\nimage, or because the OS type is not understood by libguestfs.\n\nIf you feel this is an error, please file a bug report including as much\ninformation about the disk image as possible.\n",
prog => basename ($0));
}
if (@roots > 1) {
die __x("{prog}: multiboot operating systems are not supported.\n",
prog => basename ($0))
}
my %fses = $g->inspect_get_mountpoints ($roots[0]);
my @fses = sort { length $a <=> length $b } keys %fses;
my $mountopts = $merge ? "" : "ro";
foreach (@fses) {
$g->mount_options ($mountopts, $fses{$_}, $_);
}
my $systemroot = $g->inspect_get_windows_systemroot ($roots[0]);
# Create a working directory to store the downloaded registry files.
my $tmpdir = tempdir (CLEANUP => 1);
# Used when merging (only) to map from the downloaded hiveshortname to
# various properties about the hive. The key is hiveshortname. The
# value is a hashref containing {h} (hive handle) and {hivefile} (full
# hive path on the Windows side).
my %hives;
if (!$merge) { # Export mode.
die __"expecting 1 or 2 more parameters, subkey path and optionally the value to export\n"
if @ARGV < 1 || @ARGV > 2;
my $path = shift @ARGV;
my $name = shift @ARGV; # or undef
# Map this to the hive name. This function dies on failure.
my ($hiveshortname, $hivefile, $prefix);
($hiveshortname, $hivefile, $path, $prefix) = map_path_to_hive ($path);
# Download the chosen hive.
download_hive ($hivefile, $hiveshortname);
# Open it.
my $h = Win::Hivex->open ("$tmpdir/$hiveshortname",
unsafe => 1, debug => $debug);
unless ($name) {
# Export it.
warn "exporting $path from $hiveshortname with prefix $prefix ..."
if $debug;
reg_export ($h, $path, \*STDOUT,
prefix => $prefix,
unsafe_printable_strings => $unsafe_printable_strings);
} else {
# Export a single key using hivexget.
my @args = ("hivexget", "$tmpdir/$hiveshortname", $path, $name);
warn "running ", join (" ", @args), " ..." if $debug;
system (@args) == 0 or die "hivexget failed: $?"
}
}
else { # Import mode.
if (@ARGV == 0) {
reg_import (\*STDIN, \&import_mapper, encoding => $encoding);
} else {
foreach (@ARGV) {
open my $fh, $_ or die "open: $_: $!";
reg_import ($fh, \&import_mapper, encoding => $encoding);
}
}
# Now we've done importing, commit all the hive handles and
# close them all.
foreach (values %hives) {
my $h = $_->{h};
delete $_->{h};
$h->commit (undef);
}
# Upload all the downloaded hives.
foreach my $hiveshortname (keys %hives) {
upload_hive ($hiveshortname, $hives{$hiveshortname}->{hivefile})
}
# Close.
$g->shutdown ();
$g->close ();
}
exit 0;
# map function passed to reg_import.
sub import_mapper
{
local $_ = shift;
my ($hiveshortname, $hivefile, $path, $prefix) = map_path_to_hive ($_);
# Need to download this hive?
unless (-f "$tmpdir/$hiveshortname") {
download_hive ($hivefile, $hiveshortname);
my $h = Win::Hivex->open ("$tmpdir/$hiveshortname",
write => 1, debug => $debug);
my %hash = ( h => $h, hivefile => $hivefile );
$hives{$hiveshortname} = \%hash;
}
return ($hives{$hiveshortname}->{h}, $path);
}
# Given a path, map that to the name of the hive and the true path
# within that hive.
sub map_path_to_hive
{
local $_ = shift;
my ($hiveshortname, $hivefile, $path, $prefix);
if (/^\\?(?:HKEY_LOCAL_MACHINE|HKLM)\\SAM(\\.*)?$/i) {
$hiveshortname = "sam";
$hivefile = "$systemroot/system32/config/$hiveshortname";
$path = defined $1 ? $1 : "\\";
$prefix = "HKEY_LOCAL_MACHINE\\SAM";
}
elsif (/^\\?(?:HKEY_LOCAL_MACHINE|HKLM)\\SECURITY(\\.*)?$/i) {
$hiveshortname = "security";
$hivefile = "$systemroot/system32/config/$hiveshortname";
$path = defined $1 ? $1 : "\\";
$prefix = "HKEY_LOCAL_MACHINE\\SECURITY";
}
elsif (/^\\?(?:HKEY_LOCAL_MACHINE|HKLM)\\SOFTWARE(\\.*)?$/i) {
$hiveshortname = "software";
$hivefile = "$systemroot/system32/config/$hiveshortname";
$path = defined $1 ? $1 : "\\";
$prefix = "HKEY_LOCAL_MACHINE\\SOFTWARE";
}
elsif (/^\\?(?:HKEY_LOCAL_MACHINE|HKLM)\\SYSTEM(\\.*)?$/i) {
$hiveshortname = "system";
$hivefile = "$systemroot/system32/config/$hiveshortname";
$path = defined $1 ? $1 : "\\";
$prefix = "HKEY_LOCAL_MACHINE\\SYSTEM";
}
elsif (/^\\?(?:HKEY_USERS|HKU)\\.DEFAULT(\\.*)?$/i) {
$hiveshortname = "default";
$hivefile = "$systemroot/system32/config/$hiveshortname";
$path = defined $1 ? $1 : "\\";
$prefix = "HKEY_LOCAL_MACHINE\\.DEFAULT";
}
elsif (/^\\?(?:HKEY_USERS|HKU)\\(S-1-5-[-\d]+)(\\.*)?$/i) {
my $sid = $1;
$hiveshortname = $sid;
$prefix = "HKEY_USERS\\$sid";
$path = defined $2 ? $2 : "\\";
# This requires a recursive call to download the SOFTWARE hive.
$hivefile = lookup_pip_of_user_sid ($sid) . "/ntuser.dat";
}
elsif (/^\\?(?:HKEY_USERS|HKU)\\LocalSystem(\\.*)?$/i) {
my $sid = "S-1-5-18";
$hiveshortname = $sid;
$prefix = "HKEY_USERS\\$sid";
$path = defined $1 ? $1 : "\\";
# This requires a recursive call to download the SOFTWARE hive.
$hivefile = lookup_pip_of_user_sid ($sid) . "/ntuser.dat";
}
elsif (/^\\?(?:HKEY_USERS|HKU)\\LocalService(\\.*)?$/i) {
my $sid = "S-1-5-19";
$hiveshortname = $sid;
$prefix = "HKEY_USERS\\$sid";
$path = defined $1 ? $1 : "\\";
# This requires a recursive call to download the SOFTWARE hive.
$hivefile = lookup_pip_of_user_sid ($sid) . "/ntuser.dat";
}
elsif (/^\\?(?:HKEY_USERS|HKU)\\NetworkService(\\.*)?$/i) {
my $sid = "S-1-5-20";
$hiveshortname = $sid;
$prefix = "HKEY_USERS\\$sid";
$path = defined $1 ? $1 : "\\";
# This requires a recursive call to download the SOFTWARE hive.
$hivefile = lookup_pip_of_user_sid ($sid) . "/ntuser.dat";
}
elsif (/^\\?(?:HKEY_USERS|HKU)\\(.*?)(\\.*)?$/i) {
$hiveshortname = "user_$1";
$prefix = "HKEY_USERS\\$1";
$path = defined $2 ? $2 : "\\";
# XXX We should probably look this up properly.
if (is_dir_nocase ("/Users/$1")) {
$hivefile = "/Users/$1/ntuser.dat"
} elsif (is_dir_nocase ("/Documents and Settings/$1")) {
$hivefile = "/Documents and Settings/$1/ntuser.dat"
} else {
die __x("virt-win-reg: {p}: cannot find user directory\n",
p => $1)
}
}
else {
die __x("virt-win-reg: {p}: not a supported Windows Registry path\n",
p => $_)
}
return ($hiveshortname, $hivefile, $path, $prefix);
}
# Given a User SID, consult
# HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\ProfileList\$sid
# and return the ProfileImagePath value.
sub lookup_pip_of_user_sid
{
local $_;
my $sid = shift;
my $path =
"HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\ProfileList\\".
$sid;
my ($hiveshortname, $hivefile, $prefix);
($hiveshortname, $hivefile, $path, $prefix) = map_path_to_hive ($path);
download_hive ($hivefile, $hiveshortname)
unless -f "$tmpdir/$hiveshortname";
my @args = ("$tmpdir/$hiveshortname", $path, "ProfileImagePath");
warn "running hivexget ", join (" ", @args), " ..." if $debug;
my $fh;
open $fh, "-|", "hivexget", @args
or die "hivexget: see earlier errors: $!";
$_ = <$fh>;
close $fh or die "hivexget: see earlier errors: $!";
chomp;
# The contents of the registry are a windows path, possibly
# containing %systemroot% and %systemdrive% (on Win XP). Expand
# it and remove some other windows-isms. The caller will do
# case_sensitive_path for us, so we don't need to do that.
s/%systemroot%/$systemroot/i;
s/%systemdrive%//i;
s/^c://i;
s,\\,/,g;
$_;
}
sub is_dir_nocase
{
local $_;
my $dir = shift;
my $windir;
eval { $windir = $g->case_sensitive_path ($dir); };
if ($@) {
return 0;
}
return $g->is_dir ($windir);
}
# Download a named hive file. Die on failure.
sub download_hive
{
local $_;
my $hivefile = shift;
my $hiveshortname = shift;
my $winfile = $g->case_sensitive_path ($hivefile);
warn "downloading $winfile ..." if $debug;
eval { $g->download ($winfile, "$tmpdir/$hiveshortname"); };
if ($@) {
die __x("virt-win-reg: {p}: could not download registry file: {err}\n",
p => $winfile, err => $@);
}
}
# Upload a named hive file. Die on failure.
sub upload_hive
{
local $_;
my $hiveshortname = shift;
my $hivefile = shift;
my $winfile = $g->case_sensitive_path ($hivefile);
warn "uploading $winfile ..." if $debug;
eval { $g->upload ("$tmpdir/$hiveshortname", $winfile); };
if ($@) {
die __x("virt-win-reg: {p}: could not upload registry file: {err}\n",
p => $winfile, err => $@);
}
}
=head1 SUPPORTED SYSTEMS
The program currently supports Windows NT-derived guests starting with
Windows XP through to at least Windows 8.
The following Registry keys are supported:
=over 4
=item C<HKEY_LOCAL_MACHINE\SAM>
=item C<HKEY_LOCAL_MACHINE\SECURITY>
=item C<HKEY_LOCAL_MACHINE\SOFTWARE>
=item C<HKEY_LOCAL_MACHINE\SYSTEM>
=item C<HKEY_USERS\.DEFAULT>
=item C<HKEY_USERS\I<SID>>
where I<SID> is a Windows User SID (eg. C<S-1-5-18>).
=item C<HKEY_USERS\I<username>>
where I<username> is a local user name (this is a libguestfs extension).
=back
You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and
C<HKU> for C<HKEY_USERS>.
The literal keys C<HKEY_USERS\$SID> and C<HKEY_CURRENT_USER> are not
supported (there is no "current user").
=head2 WINDOWS 8
Windows 8 "fast startup" can prevent virt-win-reg from being
able to edit the Registry. See
L<guestfs(3)/WINDOWS HIBERNATION AND WINDOWS 8 FAST STARTUP>.
=head1 ENCODING
C<virt-win-reg> expects that regedit files have already been reencoded
in the local encoding. Usually on Linux hosts, this means UTF-8 with
Unix-style line endings. Since Windows regedit files are often in
UTF-16LE with Windows-style line endings, you may need to reencode the
whole file before or after processing.
To reencode a file from Windows format to Linux (before processing it
with the I<--merge> option), you would do something like this:
iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg
To go in the opposite direction, after exporting and before sending
the file to a Windows user, do something like this:
unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg
For more information about encoding, see L<Win::Hivex::Regedit(3)>.
If you are unsure about the current encoding, use the L<file(1)>
command. Recent versions of Windows regedit.exe produce a UTF-16LE
file with Windows-style (CRLF) line endings, like this:
$ file software.reg
software.reg: Little-endian UTF-16 Unicode text, with very long lines,
with CRLF line terminators
This file would need conversion before you could I<--merge> it.
=head1 CurrentControlSet etc.
Registry keys like C<CurrentControlSet> don't really exist in the
Windows Registry at the level of the hive file, and therefore you
cannot modify these.
C<CurrentControlSet> is usually an alias for C<ControlSet001>. In
some circumstances it might refer to another control set. The way
to find out is to look at the C<HKLM\SYSTEM\Select> key:
# virt-win-reg WindowsGuest 'HKLM\SYSTEM\Select'
[HKEY_LOCAL_MACHINE\SYSTEM\Select]
"Current"=dword:00000001
"Default"=dword:00000001
"Failed"=dword:00000000
"LastKnownGood"=dword:00000002
"Current" is the one which Windows will choose when it boots.
Similarly, other C<Current...> keys in the path may need to
be replaced.
=head1 DELETING REGISTRY KEYS AND VALUES
To delete a whole registry key, use the syntax:
[-HKEY_LOCAL_MACHINE\Foo]
To delete a single value within a key, use the syntax:
[HKEY_LOCAL_MACHINE\Foo]
"Value"=-
=head1 WINDOWS TIPS
Note that some of these tips modify the guest disk image. The guest
I<must> be shut off, else you will get disk corruption.
=head2 RUNNING A BATCH SCRIPT WHEN A USER LOGS IN
Prepare a DOS batch script, VBScript or executable. Upload this using
L<guestfish(1)>. For this example the script is called C<test.bat>
and it is uploaded into C<C:\>:
guestfish -i -d WindowsGuest upload test.bat /test.bat
Prepare a regedit file containing the registry change:
cat > test.reg <<'EOF'
[HKLM\Software\Microsoft\Windows\CurrentVersion\RunOnce]
"Test"="c:\\test.bat"
EOF
In this example we use the key C<RunOnce> which means that the script
will run precisely once when the first user logs in. If you want it
to run every time a user logs in, replace C<RunOnce> with C<Run>.
Now update the registry:
virt-win-reg --merge WindowsGuest test.reg
=head2 INSTALLING A SERVICE
This section assumes you are familiar with Windows services, and you
either have a program which handles the Windows Service Control
Protocol directly or you want to run any program using a service
wrapper like SrvAny or the free RHSrvAny.
First upload the program and optionally the service wrapper. In this
case the test program is called C<test.exe> and we are using the
RHSrvAny wrapper:
guestfish -i -d WindowsGuest <<EOF
upload rhsrvany.exe /rhsrvany.exe
upload test.exe /test.exe
EOF
Prepare a regedit file containing the registry changes. In this
example, the first registry change is needed for the service itself or
the service wrapper (if used). The second registry change is only
needed because I am using the RHSrvAny service wrapper.
cat > service.reg <<'EOF'
[HKLM\SYSTEM\ControlSet001\services\RHSrvAny]
"Type"=dword:00000010
"Start"=dword:00000002
"ErrorControl"=dword:00000001
"ImagePath"="c:\\rhsrvany.exe"
"DisplayName"="RHSrvAny"
"ObjectName"="NetworkService"
[HKLM\SYSTEM\ControlSet001\services\RHSrvAny\Parameters]
"CommandLine"="c:\\test.exe"
"PWD"="c:\\Temp"
EOF
Notes:
=over 4
=item *
For use of C<ControlSet001> see the section above in this manual page.
You may need to adjust this according to the control set that is in
use by the guest.
=item *
C<"ObjectName"> controls the privileges that the service will have.
An alternative is C<"ObjectName"="LocalSystem"> which would be the
most privileged account.
=item *
For the meaning of the magic numbers, see this Microsoft KB article:
L<http://support.microsoft.com/kb/103000>.
=back
Update the registry:
virt-win-reg --merge WindowsGuest service.reg
=head1 SHELL QUOTING
Be careful when passing parameters containing C<\> (backslash) in the
shell. Usually you will have to use 'single quotes' or double
backslashes (but not both) to protect them from the shell.
Paths and value names are case-insensitive.
=head1 SEE ALSO
L<hivex(3)>,
L<hivexsh(1)>,
L<hivexregedit(1)>,
L<guestfs(3)>,
L<guestfish(1)>,
L<virt-cat(1)>,
L<virt-tail(1)>,
L<Sys::Guestfs(3)>,
L<Win::Hivex(3)>,
L<Win::Hivex::Regedit(3)>,
L<Sys::Virt(3)>,
L<http://libguestfs.org/>.
=head1 AUTHOR
Richard W.M. Jones L<http://people.redhat.com/~rjones/>
=head1 COPYRIGHT
Copyright (C) 2010 Red Hat Inc.
|