volatility3.plugins.windows.pedump module

class PEDump(context, config_path, progress_callback=None)

Bases: PluginInterface

Allows extracting PE Files from a specific address in a specific address space

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: 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.

classmethod dump_kernel_pe_at_base(context, kernel, pe_table_name, open_method, base)

classmethod dump_ldr_entry(context, pe_table_name, ldr_entry, open_method, layer_name=None, prefix='')

Extracts the PE file referenced an LDR_DATA_TABLE_ENTRY (DLL, kernel module) instance

Parameters:

• context (ContextInterface) – the context to operate upon

• pe_table_name (str) – the name for the symbol table containing the PE format symbols

• ldr_entry (ObjectInterface) – the object representing the module

• open_method (Type[FileHandlerInterface]) – class for constructing output files

• layer_name (str) – the layer that the DLL lives within

• prefix (str) – optional string to prepend to filename

Return type:

Optional[str]

Returns:

The output file name or None in the case of failure

classmethod dump_pe(context, pe_table_name, layer_name, open_method, file_name, base)

Returns the filename of the dump file or None

Return type:

Optional[str]

classmethod dump_pe_at_base(context, pe_table_name, layer_name, open_method, proc_offset, pid, base)

Return type:

Optional[str]

classmethod dump_processes(context, kernel, pe_table_name, open_method, filter_func, base)

classmethod get_requirements()

Returns a list of Requirement objects for this plugin.

Return type:

List[RequirementInterface]

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()

Executes the functionality of the code.

Note

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

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)