volatility3.plugins.layerwriter module

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

Bases: PluginInterface

Runs the automagics and writes out the primary layer produced by the stacker.

  • 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: HierarchicalDict

The Hierarchical configuration Dictionary for this Configurable object.

property config_path: str

The configuration path on which this configurable lives.

property context: ContextInterface

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

default_block_size = 5242880
classmethod get_requirements()[source]

Returns a list of Requirement objects for this plugin.

Return type:


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:


property open

Returns a context manager and thus can be called like open


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 handler 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 = (2, 0, 1)
classmethod write_layer(context, layer_name, preferred_name, open_method, chunk_size=None, progress_callback=None)[source]

Produces a FileHandler from the named layer in the provided context or None on failure

  • context (ContextInterface) – the context from which to read the memory layer

  • layer_name (str) – the name of the layer to write out

  • preferred_name (str) – a string with the preferred filename for hte file

  • chunk_size (Optional[int]) – an optional size for the chunks that should be written (defaults to 0x500000)

  • open_method (Type[FileHandlerInterface]) – class for creating FileHandler context managers

  • progress_callback (Optional[Callable[[float, str], None]]) – an optional function that takes a percentage and a string that displays output

Return type: