#!/usr/bin/env python3
"""Script to extract UserAssist information."""
import argparse
import logging
import sys
from dfvfs.helpers import volume_scanner as dfvfs_volume_scanner
from winregrc import output_writers
from winregrc import userassist
from winregrc import volume_scanner
[docs]
def Main():
"""Entry point of console script to extract UserAssist information.
Returns:
int: exit code that is provided to sys.exit().
"""
argument_parser = argparse.ArgumentParser(
description=(
"Extracts the UserAssist information from a NTUSER.DAT Registry file."
)
)
argument_parser.add_argument(
"--codepage",
dest="codepage",
action="store",
metavar="CODEPAGE",
default="cp1252",
help="the codepage of the extended ASCII strings.",
)
argument_parser.add_argument(
"-d",
"--debug",
dest="debug",
action="store_true",
default=False,
help="enable debug output.",
)
argument_parser.add_argument(
"source",
nargs="?",
action="store",
metavar="PATH",
default=None,
help=(
"path of the volume containing C:\\Windows, the filename of "
"a storage media image containing the C:\\Windows directory, "
"or the path of a NTUSER.DAT Registry file."
),
)
options = argument_parser.parse_args()
if not options.source:
print("Source value is missing.")
print("")
argument_parser.print_help()
print("")
return 1
logging.basicConfig(level=logging.INFO, format="[%(levelname)s] %(message)s")
output_writer = output_writers.StdoutOutputWriter()
if not output_writer.Open():
print("Unable to open output writer.")
print("")
return 1
mediator = volume_scanner.WindowsRegistryVolumeScannerMediator()
scanner = volume_scanner.WindowsRegistryVolumeScanner(mediator=mediator)
volume_scanner_options = dfvfs_volume_scanner.VolumeScannerOptions()
volume_scanner_options.partitions = ["all"]
volume_scanner_options.snapshots = ["none"]
volume_scanner_options.volumes = ["none"]
if not scanner.ScanForWindowsVolume(options.source, options=volume_scanner_options):
print(
(
f"Unable to retrieve the volume with the Windows directory from: "
f"{options.source:s}."
)
)
print("")
return 1
# TODO: map collector to available Registry keys.
collector_object = userassist.UserAssistCollector(
debug=options.debug, output_writer=output_writer
)
result = collector_object.Collect(scanner.registry)
if not result:
print("No UserAssist key found.")
else:
guid = None
for user_assist_entry in collector_object.user_assist_entries:
if user_assist_entry.guid != guid:
print(f"GUID\t\t: {user_assist_entry.guid:s}")
guid = user_assist_entry.guid
print(f"Name\t\t: {user_assist_entry.name:s}")
print(f"Original name\t: {user_assist_entry.value_name:s}")
print("")
output_writer.Close()
return 0
if __name__ == "__main__":
sys.exit(Main())