volatility3.plugins.linux.pstree module

class PsTree(*args, **kwargs)[source]

Bases: PsList

Plugin for listing processes in a tree based on their parent process ID.

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.

classmethod create_pid_filter(pid_list=None)

Constructs a filter function for process IDs.

Parameters

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

Return type

Callable[[Any], bool]

Returns

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

find_level(pid)[source]

Finds how deep the PID is in the tasks hierarchy.

Parameters

pid (int) – PID to find the level in the hierarchy

Return type

None

classmethod get_requirements()

Returns a list of Requirement objects for this plugin.

Return type

List[RequirementInterface]

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

Lists all the tasks in the primary layer.

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

Yields

Task objects

Return type

Iterable[ObjectInterface]

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:

Return type

Dict[str, RequirementInterface]

unmet = configurable.unsatisfied(context, config_path)
if unmet:
    raise RuntimeError("Unsatisfied requirements: {}".format(unmet)
version = (2, 1, 0)