volatility3.plugins.linux.proc module

A module containing a collection of plugins that produce data typically found in Linux’s /proc file system.

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

Bases: PluginInterface

Lists all memory maps for all processes.

  • 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

MAXSIZE_DEFAULT = 1073741824

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.

classmethod get_requirements()[source]

Returns a list of Requirement objects for this plugin.

classmethod list_vmas(task, filter_func=<function Maps.<lambda>>)[source]

Lists the Virtual Memory Areas of a specific process.

Return type:

Generator[ObjectInterface, None, None]


Yields vmas based on the task and filtered based on the filter function

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 = (1, 0, 0)
classmethod vma_dump(context, task, vm_start, vm_end, open_method, maxsize=1073741824)[source]

Extracts the complete data for VMA as a FileInterface.

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

  • task (ObjectInterface) – an task_struct instance

  • vm_start (int) – The start virtual address from the vma to dump

  • vm_end (int) – The end virtual address from the vma to dump

  • open_method (Type[FileHandlerInterface]) – class to provide context manager for opening the file

  • maxsize (int) – Max size of VMA section (default MAXSIZE_DEFAULT)

Return type:



An open FileInterface object containing the complete data for the task or None in the case of failure