Refresh documentation.
[hivex.git] / 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 re-encoded
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 re-encode the
58 whole file before or after processing.
59
60 To re-encode 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.
93
94 C<CurrentControlSet> is usually an alias for C<ControlSet001>.  In
95 some circumstances it might refer to another control set.  The way
96 to find out is to look at the C<HKLM\SYSTEM\Select> key:
97
98  $ hivexregedit --export SYSTEM '\Select'
99  [\Select]
100  "Current"=dword:00000001
101  "Default"=dword:00000001
102  "Failed"=dword:00000000
103  "LastKnownGood"=dword:00000002
104
105 "Current" is the one which Windows will choose when it boots.
106
107 Similarly, other C<Current...> keys in the path may need to
108 be replaced.
109
110 =head1 EXAMPLE
111
112  $ virt-cat WindowsGuest /Windows/System32/config/software > software.hive
113  $ hivexregedit --export \
114      --prefix 'HKEY_LOCAL_MACHINE\SOFTWARE' \
115      software.hive '\Microsoft' > ms-keys.reg
116
117  $ hivexregedit --merge system.hive \
118      --prefix 'HKEY_LOCAL_MACHINE\SYSTEM' additions.reg
119
120 =head1 OPTIONS
121
122 =over 4
123
124 =cut
125
126 my $help;
127
128 =item B<--help>
129
130 Display help.
131
132 =cut
133
134 my $debug;
135
136 =item B<--debug>
137
138 Enable debugging in the hivex library.  This is useful for diagnosing
139 bugs and also malformed hive files.
140
141 =cut
142
143 my $merge;
144
145 =item B<--merge>
146
147  hivexregedit --merge [--prefix prefix] [--encoding enc] \
148          hivefile [regfile]
149
150 Merge C<regfile> (a regedit-format text file) into the hive
151 C<hivefile>.  If C<regfile> is omitted, then the program reads from
152 standard input.  (Also you can give multiple input files).
153
154 C<--prefix> specifies the Windows Registry prefix.  It is almost
155 always necessary to use this when dealing with real hive files.
156
157 C<--encoding> specifies the encoding for unmarked strings in the
158 input.  It defaults to C<UTF-16LE> which should work for recent
159 versions of Windows.  Another possibility is to use C<ASCII>.
160
161 =cut
162
163 my $export;
164
165 =item B<--export>
166
167  hivexregedit --export [--prefix prefix] hivefile key > regfile
168
169 C<key> is a path within the hive C<hivefile>.  (The key should not
170 contain any prefix and should be quoted to defend backslashes from the
171 shell).  The key is exported, recursively, to standard output in the
172 textual regedit format.
173
174 C<--prefix> specifies the Windows Registry prefix.  It is almost
175 always necessary to use this when dealing with real hive files.
176
177 =cut
178
179 my $prefix;
180
181 =item B<--prefix> prefix
182
183 Hive files and Windows Registry key names are indirectly related.  For
184 example, inside the software hive, all keys are stored relative to
185 C<HKEY_LOCAL_MACHINE\SOFTWARE>.  Thus
186 C<HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft> appears in the hive file as
187 C<\Microsoft>.
188
189 The hive format itself does not store this prefix, so you have to
190 supply it based on outside knowledge.  (L<virt-win-reg(1)>, amongst
191 other things, already knows about this).
192
193 Usually it is sufficient to pass the parameter
194 C<--prefix 'HKEY_LOCAL_MACHINE\SOFTWARE'> or similar when doing
195 merges and exports.
196
197 =cut
198
199 my $encoding;
200
201 =item B<--encoding> UTF-16LE|ASCII
202
203 When merging (only), you may need to specify the encoding for strings
204 to be used in the hive file.  This is explained in detail in
205 L<Win::Hivex::Regedit(3)/ENCODING STRINGS>.
206
207 The default is to use UTF-16LE, which should work with recent versions
208 of Windows.
209
210 =back
211
212 =cut
213
214 GetOptions ("help|?" => \$help,
215             "debug" => \$debug,
216             "merge|import" => \$merge,
217             "export" => \$export,
218             "prefix=s" => \$prefix,
219             "encoding=s" => \$encoding,
220     ) or pod2usage (2);
221 pod2usage (1) if $help;
222
223 if ($merge && $export) {
224     die "hivexregedit: cannot use --merge and --export at the same time\n"
225 }
226
227 unless ($merge || $export) {
228     die "hivexregedit: use --merge or --export, see the manpage for help\n"
229 }
230
231 if ($export && defined $encoding) {
232     die "hivexregedit: --encoding has no effect when used with --export\n"
233 }
234
235 if ($merge) {                   # --merge (reg_import)
236     if (@ARGV < 1) {
237         die "hivexregedit --merge hivefile [input.reg ...]\n"
238     }
239
240     my $hivefile = shift @ARGV;
241
242     my $h = Win::Hivex->open ($hivefile, write => 1, debug => $debug);
243
244     # Read from stdin unless other files have been specified.
245     unshift (@ARGV, '-') unless @ARGV;
246
247     foreach (@ARGV) {
248         open FILE, $_ or die "$_: $!";
249         reg_import (\*FILE, sub {
250             local $_ = shift;
251             # Remove prefix from the start of the path, matching
252             # case insensitively.
253             if (defined $prefix) {
254                 my $len = length $prefix;
255                 if (length $_ >= $len &&
256                     lc (substr ($_, 0, $len)) eq lc ($prefix)) {
257                     $_ = substr ($_, $len);
258                 }
259             }
260             ($h, $_)
261         });
262     }
263
264     $h->commit (undef);
265 } else {                        # --export (reg_export)
266     if (@ARGV != 2) {
267         die "hivexregedit --export hivefile key\n"
268     }
269
270     my $hivefile = shift @ARGV;
271     my $key = shift @ARGV;
272
273     my $h = Win::Hivex->open ($hivefile, debug => $debug);
274
275     print "Windows Registry Editor Version 5.00\n\n";
276
277     reg_export ($h, $key, \*STDOUT, prefix => $prefix);
278 }
279
280 =head1 SEE ALSO
281
282 L<virt-win-reg(1)>,
283 L<Win::Hivex::Regedit(3)>,
284 L<Win::Hivex(3)>,
285 L<hivexsh(1)>,
286 L<dos2unix(1)>,
287 L<unix2dos(1)>,
288 L<iconv(1)>,
289 L<http://libguestfs.org/>.
290
291 =head1 AUTHOR
292
293 Richard W.M. Jones L<http://people.redhat.com/~rjones/>
294
295 =head1 COPYRIGHT
296
297 Copyright (C) 2010 Red Hat Inc.
298
299 This program is free software; you can redistribute it and/or modify
300 it under the terms of the GNU General Public License as published by
301 the Free Software Foundation; either version 2 of the License, or
302 (at your option) any later version.
303
304 This program is distributed in the hope that it will be useful,
305 but WITHOUT ANY WARRANTY; without even the implied warranty of
306 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
307 GNU General Public License for more details.
308
309 You should have received a copy of the GNU General Public License
310 along with this program; if not, write to the Free Software
311 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.