Packages and Binaries:

libhivex-bin

libhivex is a self-contained library for reading and writing Windows Registry “hive” binary files.

This package contains a few command line programs that utilize libhivex.

Installed size: 239 KB
How to install: sudo apt install libhivex-bin

Dependencies:
  • libc6
  • libhivex0
  • libreadline8
  • libxml2
hivexget

Get subkey from a Windows Registry binary “hive” file

root@kali:~# man hivexget
hivexget(1)                    Windows Registry                    hivexget(1)

NAME
       hivexget - Get subkey from a Windows Registry binary "hive" file

SYNOPSIS
        hivexget hivefile '\Path\To\SubKey'

        hivexget hivefile '\Path\To\SubKey' name

NOTE
       This is a low-level tool.  For a more convenient way to navigate the
       Windows Registry in Windows virtual machines, see virt-win-reg(1).  For
       proper regedit formatting, use hivexregedit(1).

DESCRIPTION
       This program navigates through a Windows Registry binary "hive" file
       and extracts either all the (key, value) data pairs stored in that
       subkey or just the single named data item.

       In the first form:

        hivexget hivefile '\Path\To\SubKey'

       "hivefile" is some Windows Registry binary hive, and "\Path\To\Subkey"
       is a path within that hive.  NB the path is relative to the top of this
       hive, and is not the full path as you would use in Windows (eg.
       "HKEY_LOCAL_MACHINE\SYSTEM" is not a valid path).

       If the subkey exists, then the output lists all data pairs under this
       subkey, in a format similar to "regedit" in Windows.

       In the second form:

        hivexget hivefile '\Path\To\SubKey' name

       "hivefile" and path are as above.  "name" is the name of the value of
       interest (use "@" for the default value).

       The corresponding data item is printed "raw" (ie. no processing or
       escaping) except:

       1.  If  it's  a string we will convert it from Windows UTF-16 to UTF-8,
           if this conversion is possible.   The  string  is  printed  with  a
           single trailing newline.

       2.  If  it's  a  multiple-string  value,  each  string  is printed on a
           separate line.

       3.  If it's a numeric value, it is printed as a decimal number.

SEE ALSO
       hivex(3),  hivexml(1),  hivexsh(1),  hivexregedit(1),  virt-win-reg(1),
       guestfs(3), <http://libguestfs.org/>, virt-cat(1), virt-edit(1).

AUTHORS
       Richard W.M. Jones ("rjones at redhat dot com")

COPYRIGHT
       Copyright (C) 2009 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.

hivex-1.3.23                      2024-01-10                       hivexget(1)

hivexml

Convert Windows Registry binary “hive” into XML

root@kali:~# man hivexml
hivexml(1)                     Windows Registry                     hivexml(1)

NAME
       hivexml - Convert Windows Registry binary "hive" into XML

SYNOPSIS
        hivexml [-dk] hivefile > output.xml

DESCRIPTION
       This program converts a single Windows Registry binary "hive" file into
       a self-describing XML format.

OPTIONS
       -d  Enable  lots  of  debug messages.  If you find a Registry file that
           this program cannot parse, please enable this option and  post  the
           complete output and the Registry file in your bug report.

       -k  Keep going even if we find errors in the Registry file.  This skips
           over any parts of the Registry that we cannot read.

       -u  Use  heuristics  to  tolerate  certain  levels of corruption within
           hives.

           This is unsafe but may allow to export/merge valid  keys/values  in
           an othewise corrupted hive.

SEE ALSO
       hivex(3),  hivexget(1),  hivexsh(1),  hivexregedit(1), virt-win-reg(1),
       guestfs(3), <http://libguestfs.org/>, virt-cat(1), virt-edit(1).

AUTHORS
       Richard W.M. Jones ("rjones at redhat dot com")

COPYRIGHT
       Copyright (C) 2009 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.

hivex-1.3.23                      2024-01-10                        hivexml(1)

hivexsh

Windows Registry hive shell

root@kali:~# man hivexsh
hivexsh(1)                     Windows Registry                     hivexsh(1)

NAME
       hivexsh - Windows Registry hive shell

SYNOPSIS
        hivexsh [-options] [hivefile]

DESCRIPTION
       This program provides a simple shell for navigating Windows Registry
       'hive' files.  It uses the hivex library for access to these binary
       files.

       Firstly you will need to provide a hive file from a Windows operating
       system.  The hive files are usually located in
       "C:\Windows\System32\Config" and have names like "software", "system"
       etc (without any file extension).  For more information about hive
       files, read hivex(3).  For information about downloading files from
       virtual machines, read virt-cat(1) and guestfish(1).

       You can provide the name of the hive file to examine on the command
       line.  For example:

        hivexsh software

       Or you can start "hivexsh" without any arguments, and immediately use
       the "load" command to load a hive:

        $ hivexsh

        Welcome to hivexsh, the hivex interactive shell for examining
        Windows Registry binary hive files.

        Type: 'help' for help with commands
              'quit' to quit the shell

        > load software
        software\>

       Navigate through the hive's keys using the "cd" command, as if it
       contained a filesystem, and use "ls" to list the subkeys of the current
       key.  Other commands are listed below.

OPTIONS
       -d  Enable  lots  of  debug messages.  If you find a Registry file that
           this program cannot parse, please enable this option and  post  the
           complete output and the Registry hive file in your bug report.

       -f filename
           Read commands from "filename" instead of stdin.  To write a hivexsh
           script, use:

            #!/usr/bin/hivexsh -f

       -u  Use  heuristics  to  tolerate  certain  levels of corruption within
           hives.

           This is unsafe but may allow to export/merge valid  keys/values  in
           an othewise corrupted hive.

       -w  If  this  option is given, then writes are allowed to the hive (see
           "commit" command below, and the discussion of  modifying  hives  in
           "WRITING TO HIVE FILES" in hivex(3)).

           Important Note: Even if you specify this option, nothing is written
           to  a  hive  unless you call the "commit" command.  If you exit the
           shell without committing, all changes will be discarded.

           If this option is not given, then write commands are disabled.

COMMANDS
       add name
           Add a subkey named "name" below the current  node.   The  name  may
           contain  spaces and punctuation characters, and does not need to be
           quoted.

           The new key will have no subkeys and no values (see "setval").

           There must be no existing subkey called  "name",  or  this  command
           will  fail.   To  replace  an existing subkey, delete it first like
           this:

            cd name
            del

       cd path
           Change to the subkey  "path".   Use  Windows-style  backslashes  to
           separate  path  elements,  and  start  with a backslash in order to
           start from the root of the hive.  For example:

            cd \Classes\*

           moves from the root node, to the "Classes" node, to the  "*"  node.
           If you were already at the root node, you could do this instead:

            cd Classes\*

           or even:

            cd Classes
            cd *

           Path  elements  (node  names)  are  matched case insensitively, and
           characters like space, "*", and "?" have no special significance.

           "cd .." may be used to go to the parent directory.

           "cd" without any arguments prints the current path.

           Be  careful  with  "cd  \"  since  the  readline  library  has   an
           undocumented behaviour where it will think the final backslash is a
           continuation (it reads the next line of input and appends it).  Put
           a single space after the backslash.

       close | unload
           Close the currently loaded hive.

           If  you modified the hive, all uncommitted writes are lost when you
           call this command (or if  the  shell  exits).   You  have  to  call
           "commit" to write changes.

       commit [newfile]
           Commit changes to the hive.  If the optional "newfile" parameter is
           supplied,  then the hive is written to that file, else the original
           file is overwritten.

           Note that you have to specify the "-w" flag,  otherwise  no  writes
           are allowed.

       del Delete  the  current  node  and everything beneath it.  The current
           directory is moved up one level (as if you did "cd ..") after  this
           command.

           You cannot delete the root node.

       exit | quit
           Exit the shell.

       load hivefile
           Load  the binary hive named "hivefile".  The currently loaded hive,
           if any, is closed.  The current directory is changed  back  to  the
           root node.

       ls  List  the  subkeys  of  the  current  hive Registry key.  Note this
           command does not take any arguments.

       lsval [key]
           List the (key, value) pairs of the current hive Registry  key.   If
           no  argument  is  given  then all pairs are displayed.  If "key" is
           given, then the value of the named key is  displayed.   If  "@"  is
           given, then the value of the default key is displayed.

       setval nrvals
           This  command  replaces  all (key, value) pairs at the current node
           with the values in subsequent input.  "nrvals"  is  the  number  of
           values  (ie.  (key,  value) pairs), and any existing values at this
           node are deleted.  So "setval 0" just deletes  any  values  at  the
           current node.

           The  command  reads  2  *  nrvals lines of input, with each pair of
           lines of input corresponding to a key and a value to add.

           For example, the following setval command replaces whatever  is  at
           the  current  node with two (key, value) pairs.  The default key is
           set to the UTF16-LE-encoded string  "abcd".   The  other  value  is
           named "ANumber" and is a little-endian DWORD 0x12345678.

            setval 2
            @
            string:abcd
            ANumber
            dword:12345678

           The  first  line of each pair is the key (the special key "@" means
           the default key, but you can also use a blank line).

           The second line of each pair is the  value,  which  has  a  special
           format  "type:value"  with  possible  types summarized in the table
           below:

            none                 No data is stored, and the type is set to 0.

            string:abc           "abc" is stored as a UTF16-LE-encoded
                                 string (type 1).  Note that only 7 bit
                                 ASCII strings are supported as input.

            expandstring:...     Same as string but with type 2.

            dword:0x01234567     A DWORD (type 4) with the hex value
                                 0x01234567.  You can also use decimal
                                 or octal numbers here.

            qword:0x0123456789abcdef
                                 A QWORD (type 11) with the hex value
                                 0x0123456789abcdef.  You can also use
                                 decimal or octal numbers here.

            hex:<type>:<hexbytes>
            hex:1:41,00,42,00,43,00,44,00,00,00
                                 This is the generic way to enter any
                                 value.  <type> is the integer value type.
                                 <hexbytes> is a list of pairs of hex
                                 digits which are treated as bytes.
                                 (Any non-hex-digits here are ignored,
                                 so you can separate bytes with commas
                                 or spaces if you want).

EXAMPLE
        $ guestfish --ro -i Windows7
        ><fs> download win:c:\windows\system32\config\software software
        ><fs> quit

        $ hivexsh software

        Welcome to hivexsh, the hivex interactive shell for examining
        Windows Registry binary hive files.

        Type: 'help' for help with commands
              'quit' to quit the shell

        software\> ls
        ATI Technologies
        Classes
        Clients
        Intel
        Microsoft
        ODBC
        Policies
        RegisteredApplications
        Sonic
        Wow6432Node
        software\> quit

SEE ALSO
       hivex(3),   hivexget(1),   hivexml(1),   virt-win-reg(1),   guestfs(3),
       <http://libguestfs.org/>, virt-cat(1), virt-edit(1).

AUTHORS
       Richard W.M. Jones ("rjones at redhat dot com")

COPYRIGHT
       Copyright (C) 2009-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.

hivex-1.3.23                      2024-01-10                        hivexsh(1)

libhivex-dev

libhivex is a self-contained library for reading and writing Windows Registry “hive” binary files.

This package provides static libraries and header files.

Installed size: 158 KB
How to install: sudo apt install libhivex-dev

Dependencies:
  • libhivex0

libhivex-ocaml

OCaml bindings for libhivex, a library for reading and writing Windows Registry “hive” binary files.

This package include only the shared runtime stub libraries.

Installed size: 39 KB
How to install: sudo apt install libhivex-ocaml

Dependencies:
  • libc6
  • libhivex0
  • libstdlib-ocaml-ep7y0
  • ocaml-base-4.14.1

libhivex-ocaml-dev

OCaml bindings for libhivex, a library for reading and writing Windows Registry “hive” binary files.

This package contains all the files needed to develop OCaml programs which use OCaml bindings to libhivex.

Installed size: 88 KB
How to install: sudo apt install libhivex-ocaml-dev

Dependencies:
  • libhivex-dev
  • libhivex-ocaml-je149
  • libstdlib-ocaml-dev-ep7y0
  • ocaml-4.14.1

libhivex0

libhivex is a self-contained library for reading and writing Windows Registry “hive” binary files.

Unlike many other tools in this area, it doesn’t use the textual .REG format for output, because parsing that is as much trouble as parsing the original binary format. Instead it makes the file available through a C API, or there is a separate program to export the hive as XML.

Installed size: 84 KB
How to install: sudo apt install libhivex0

Dependencies:
  • libc6

libwin-hivex-perl

Perl bindings for libhivex, a library for reading and writing Windows Registry “hive” binary files.

This package also contains hivexregedit, a low-level command-line tool for manipulating and dumping registry hives.

Installed size: 119 KB
How to install: sudo apt install libwin-hivex-perl

Dependencies:
  • libc6
  • libhivex0
  • perl
  • perlapi-5.38.2
hivexregedit

Merge and export Registry changes from regedit-format files.

root@kali:~# hivexregedit -h
Usage:
     hivexregedit --merge [--prefix prefix] [--encoding enc] \
             hivefile [regfile]

     hivexregedit --export [--prefix prefix] hivefile key > regfile

Options:
    --help
        Display help.

    --debug
        Enable debugging in the hivex library. This is useful for diagnosing
        bugs and also malformed hive files.

    --merge
         hivexregedit --merge [--prefix prefix] [--encoding enc] \
                 hivefile [regfile]

        Merge "regfile" (a regedit-format text file) into the hive
        "hivefile". If "regfile" is omitted, then the program reads from
        standard input. (Also you can give multiple input files).

        "--prefix" specifies the Windows Registry prefix. It is almost
        always necessary to use this when dealing with real hive files.

        "--encoding" specifies the encoding for unmarked strings in the
        input. It defaults to "UTF-16LE" which should work for recent
        versions of Windows. Another possibility is to use "ASCII".

    --export
         hivexregedit --export [--prefix prefix] hivefile key > regfile

        "key" is a path within the hive "hivefile". (The key should not
        contain any prefix and should be quoted to defend backslashes from
        the shell). The key is exported, recursively, to standard output in
        the textual regedit format.

        "--prefix" specifies the Windows Registry prefix. It is almost
        always necessary to use this when dealing with real hive files.

    --prefix prefix
        Hive files and Windows Registry key names are indirectly related.
        For example, inside the software hive, all keys are stored relative
        to "HKEY_LOCAL_MACHINE\SOFTWARE". Thus
        "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft" appears in the hive file as
        "\Microsoft".

        The hive format itself does not store this prefix, so you have to
        supply it based on outside knowledge. (virt-win-reg(1), amongst
        other things, already knows about this).

        Usually it is sufficient to pass the parameter "--prefix
        'HKEY_LOCAL_MACHINE\SOFTWARE'" or similar when doing merges and
        exports.

    --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
        "ENCODING STRINGS" in Win::Hivex::Regedit(3).

        The default is to use UTF-16LE, which should work with recent
        versions of Windows.

    --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 hive for various reasons:

        *   Assumes the original encoding is UTF-16LE. ASCII strings and
            strings in other encodings will be corrupted by this
            transformation.

        *   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 hives is not reliable.

        *   Loses information about whether a zero codepoint followed the
            string in the hive or not.

        This all happens because the hive itself contains no information
        about how strings are encoded (see "ENCODING STRINGS" in
        Win::Hivex::Regedit(3)).

        You should only use this option for quick hacking and debugging of
        the hive contents, and never use it if the output is going to be
        passed into another program or stored in another hive.

    --unsafe
        Use heuristics to tolerate certain levels of corruption within
        hives.

        This is unsafe but may allow to export/merge valid keys/values in an
        othewise corrupted hive.

    --max-depth depth
        Limits the recursion depth of the export. For example, an export
        with a max depth of 1 will only include values directly under the
        specified key/prefix. A max depth of 0 will return no values.

        Exports include all child keys by default (fully recursive), which
        may take a while if the registry hive is large / bloated. This
        behavior can also be achieved by providing a negative max depth.


python3-hivex

Python 3 bindings for libhivex, a library for reading and writing Windows Registry “hive” binary files.

Installed size: 73 KB
How to install: sudo apt install python3-hivex

Dependencies:
  • libc6
  • libhivex0
  • python3
  • python3

ruby-hivex

Ruby bindings for libhivex, a library for reading and writing Windows Registry “hive” binary files.

Installed size: 49 KB
How to install: sudo apt install ruby-hivex

Dependencies:
  • libc6
  • libhivex0
  • libruby
  • libruby3.1

Updated on: 2024-Feb-16