volatility.plugins.windows.registry.printkey module

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

Bases: volatility.framework.interfaces.plugins.PluginInterface

Lists the registry keys under a hive or specific key value.

  • 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


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


property config

The Hierarchical configuration Dictionary for this Configurable object.

Return type


property config_path

The configuration path on which this configurable lives.

Return type


property context

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

Return type


classmethod get_requirements()[source]

Returns a list of Requirement objects for this plugin.

Return type


classmethod key_iterator(hive, node_path=None, recurse=False)[source]

Walks through a set of nodes from a given node (last one in node_path). Avoids loops by not traversing into nodes already present in the node_path.

  • hive (RegistryHive) – The registry hive to walk

  • node_path (Optional[Sequence[StructType]]) – The list of nodes that make up the

  • recurse (bool) – Traverse down the node tree or stay only on the same level


A tuple of results (depth, is_key, last write time, path, volatile, and the node).

Return type

Iterable[Tuple[int, bool, datetime, str, bool, ObjectInterface]]

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.

  • 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


The newly generated full configuration path

Return type



Adds a file to the plugin’s file store and returns the chosen filename for the file.

Return type



Executes the functionality of the code.


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


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


Sets the file consumer to be used by this plugin.

Return type


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)