volatility3.plugins.windows.modules module

class Modules(*args, **kwargs)

Bases: PluginInterface

Lists the loaded kernel modules.

Parameters:

• context – The context that the plugin will operate within

• config_path – The path to configuration data within the context configuration data

• progress_callback – 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.

dump_module(session_layers, pe_table_name, mod)

classmethod find_session_layer(context, session_layers, base_address)

Given a base address and a list of layer names, find a layer that can access the specified address.

Parameters:

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

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

• symbol_table – The name of the table containing the kernel symbols

• session_layers (Iterable[str]) – A list of session layer names

• base_address (int) – The base address to identify the layers that can access it

Returns:

Layer name or None if no layers that contain the base address can be found

classmethod get_kernel_space_start(context, module_name)

Returns the starting address of the kernel address space

This method allows plugins that analyze kernel data structures to quickly detect smeared or otherwise invalid data as many pointers must point into the kernel or access during runtime would crash the system

Return type:

int

classmethod get_requirements()

Returns a list of Requirement objects for this plugin.

Return type:

List[RequirementInterface]

classmethod get_session_layers(context, kernel_module_name, pids=None)

Parameters:

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

• kernel_module_name (str) – The name of the module for the kernel

• pids (Optional[List[int]]) – A list of process identifiers to include exclusively or None for no filter

Return type:

Generator[str, None, None]

Yields the names of the unique memory layers that map sessions

classmethod get_session_layers_map(context, kernel_module_name, pids=None)

Parameters:

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

• kernel_module_name (str) – The name of the module for the kernel

• pids (Optional[List[int]]) – A list of process identifiers to include exclusively or None for no filter

Return type:

Dict[int, str]

Wraps _do_get_session_layers to produce a dictionary where each key is a session_id and the value is the name of the layer for that session

classmethod list_modules(context, kernel_module_name)

Lists all the modules in the primary layer.

Parameters:

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

• kernel_module_name (str) – The name of the module for the kernel

Return type:

Iterable[ObjectInterface]

Returns:

A list of Modules as retrieved from PsLoadedModuleList

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 = (3, 0, 0)