volatility3.plugins.linux.pslist module

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

Bases: PluginInterface

Lists the processes present in a particular linux memory image.

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

classmethod create_pid_filter(pid_list=None)[source]

Constructs a filter function for process IDs.


pid_list (List[int]) – List of process IDs that are acceptable (or None if all are acceptable)

Return type:

Callable[[Any], bool]


Function which, when provided a process object, returns True if the process is to be filtered out of the list

classmethod get_requirements()[source]

Returns a list of Requirement objects for this plugin.

Return type:


classmethod get_task_fields(task, decorate_comm=False)[source]

Extract the fields needed for the final output :type task: ObjectInterface :param task: A task object from where to get the fields. :type decorate_comm: bool :param decorate_comm:

If True, it decorates the comm string of
  • User threads: in curly brackets,

  • Kernel threads: in square brackets

Defaults to False.

Return type:

Tuple[int, int, int, str]


A tuple with the fields to show in the plugin output.

classmethod list_tasks(context, vmlinux_module_name, filter_func=<function PsList.<lambda>>, include_threads=False)[source]

Lists all the tasks in the primary layer.

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

  • vmlinux_module_name (str) – The name of the kernel module on which to operate

  • filter_func (Callable[[int], bool]) – A function which takes a process object and returns True if the process should be ignored/filtered

  • include_threads (bool) – If True, it will also return user threads.


Task objects

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, 2, 1)