volatility3.plugins.windows.registry.hivelist module

class HiveGenerator(cmhive, forward=True)[source]

Bases: object

Walks the registry HiveList linked list in a given direction and stores an invalid offset if it’s unable to fully walk the list

property invalid
Return type

Optional[int]

class HiveList(context, config_path, progress_callback=None)[source]

Bases: volatility3.framework.interfaces.plugins.PluginInterface

Lists the registry hives present in a particular memory image.

Parameters
  • context (ContextInterface) – The context that the plugin will operate within

  • config_path (str) – The path to configuration data within the context configuration data

  • progress_callback (Optional[Callable[[float, str], None]]) – A callable that can provide feedback at progress points

build_configuration()

Constructs a HierarchicalDictionary of all the options required to build this component in the current context.

Ensures that if the class has been created, it can be recreated using the configuration built Inheriting classes must override this to ensure any dependent classes update their configurations too

Return type

HierarchicalDict

property config

The Hierarchical configuration Dictionary for this Configurable object.

Return type

HierarchicalDict

property config_path

The configuration path on which this configurable lives.

Return type

str

property context

The context object that this configurable belongs to/configuration is stored in.

Return type

ContextInterface

classmethod get_requirements()[source]

Returns a list of Requirement objects for this plugin.

Return type

List[RequirementInterface]

classmethod list_hive_objects(context, layer_name, symbol_table, filter_string=None)[source]

Lists all the hives in the primary layer.

Parameters
  • context (ContextInterface) – The context to retrieve required elements (layers, symbol tables) from

  • layer_name (str) – The name of the layer on which to operate

  • symbol_table (str) – The name of the table containing the kernel symbols

  • filter_string (Optional[str]) – A string which must be present in the hive name if specified

Return type

Iterator[ObjectInterface]

Returns

The list of registry hives from the layer_name layer as filtered against using the filter_string

classmethod list_hives(context, base_config_path, layer_name, symbol_table, filter_string=None, hive_offsets=None)[source]

Walks through a registry, hive by hive returning the constructed registry layer name.

Parameters
  • context (ContextInterface) – The context to retrieve required elements (layers, symbol tables) from

  • base_config_path (str) – The configuration path for any settings required by the new table

  • layer_name (str) – The name of the layer on which to operate

  • symbol_table (str) – The name of the table containing the kernel symbols

  • filter_string (Optional[str]) – An optional string which must be present in the hive name if specified

  • offset – An optional offset to specify a specific hive to iterate over (takes precedence over filter_string)

Yields

A registry hive layer name

Return type

Iterable[RegistryHive]

classmethod make_subconfig(context, base_config_path, **kwargs)

Convenience function to allow constructing a new randomly generated sub-configuration path, containing each element from kwargs.

Parameters
  • context (ContextInterface) – The context in which to store the new configuration

  • base_config_path (str) – The base configuration path on which to build the new configuration

  • kwargs – Keyword arguments that are used to populate the new configuration path

Returns

The newly generated full configuration path

Return type

str

property open

Returns a context manager and thus can be called like open

run()[source]

Executes the functionality of the code.

Note

This method expects self.validate to have been called to ensure all necessary options have been provided

Return type

TreeGrid

Returns

A TreeGrid object that can then be passed to a Renderer.

set_open_method(handler)

Sets the file handler to be used by this plugin.

Return type

None

classmethod unsatisfied(context, config_path)

Returns a list of the names of all unsatisfied requirements.

Since a satisfied set of requirements will return [], it can be used in tests as follows:

unmet = configurable.unsatisfied(context, config_path)
if unmet:
    raise RuntimeError("Unsatisfied requirements: {}".format(unmet)
Return type

Dict[str, RequirementInterface]

version = (1, 0, 0)