volatility3.plugins.mac.pslist module

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

Bases: PluginInterface

Lists the processes present in a particular mac memory image.

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 create_pid_filter(pid_list=None)[source]
Return type

Callable[[int], bool]

classmethod get_list_tasks(method)[source]

Returns the list_tasks method based on the selector

Parameters

method (str) – Must be one fo the available methods in get_task_choices

Return type

Callable[[ContextInterface, str, Callable[[int], bool]], Iterable[ObjectInterface]]

Returns

list_tasks method for listing tasks

classmethod get_requirements()[source]

Returns a list of Requirement objects for this plugin.

classmethod list_tasks_allproc(context, kernel_module_name, filter_func=<function PsList.<lambda>>)[source]

Lists all the processes in the primary layer based on the allproc method

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

  • kernel_module_name (str) – The name of the 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

Return type

Iterable[ObjectInterface]

Returns

The list of process objects from the processes linked list after filtering

classmethod list_tasks_pid_hash_table(context, kernel_module_name, filter_func=<function PsList.<lambda>>)[source]

Lists all the tasks in the primary layer using the pid hash table

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

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

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

Return type

Iterable[ObjectInterface]

Returns

The list of task objects from the layer_name layer’s tasks list after filtering

classmethod list_tasks_process_group(context, kernel_module_name, filter_func=<function PsList.<lambda>>)[source]

Lists all the tasks in the primary layer using process groups

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

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

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

Return type

Iterable[ObjectInterface]

Returns

The list of task objects from the layer_name layer’s tasks list after filtering

classmethod list_tasks_sessions(context, kernel_module_name, filter_func=<function PsList.<lambda>>)[source]

Lists all the tasks in the primary layer using sessions

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

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

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

Return type

Iterable[ObjectInterface]

Returns

The list of task objects from the layer_name layer’s tasks list after filtering

classmethod list_tasks_tasks(context, kernel_module_name, filter_func=<function PsList.<lambda>>)[source]

Lists all the tasks in the primary layer based on the tasks queue

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

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

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

Return type

Iterable[ObjectInterface]

Returns

The list of task objects from the layer_name layer’s tasks list after filtering

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

pslist_methods = ['tasks', 'allproc', 'process_group', 'sessions', 'pid_hash_table']
run()[source]

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