volatility3.plugins.mac.pslist module¶
-
class
PsList
(context, config_path, progress_callback=None)[source]¶ Bases:
volatility3.framework.interfaces.plugins.PluginInterface
Lists the processes present in a particular mac memory image.
- Parameters
-
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
-
property
config
¶ The Hierarchical configuration Dictionary for this Configurable object.
- Return type
-
property
context
¶ The context object that this configurable belongs to/configuration is stored in.
- Return type
-
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
,str
,Callable
[[int
],bool
]],Iterable
[ObjectInterface
]]- Returns
list_tasks method for listing tasks
-
classmethod
list_tasks_allproc
(context, layer_name, darwin_symbols, 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) fromlayer_name (
str
) – The name of the layer on which to operatedarwin_symbols (
str
) – The name of the table containing the kernel symbolsfilter_func (
Callable
[[int
],bool
]) – A function which takes a process object and returns True if the process should be ignored/filtered
- Return type
- Returns
The list of process objects from the processes linked list after filtering
-
classmethod
list_tasks_pid_hash_table
(context, layer_name, darwin_symbols, 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) fromlayer_name (
str
) – The name of the layer on which to operatedarwin_symbols (
str
) – The name of the table containing the kernel symbolsfilter_func (
Callable
[[int
],bool
]) – A function which takes a task object and returns True if the task should be ignored/filtered
- Return type
- Returns
The list of task objects from the layer_name layer’s tasks list after filtering
-
classmethod
list_tasks_process_group
(context, layer_name, darwin_symbols, 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) fromlayer_name (
str
) – The name of the layer on which to operatedarwin_symbols (
str
) – The name of the table containing the kernel symbolsfilter_func (
Callable
[[int
],bool
]) – A function which takes a task object and returns True if the task should be ignored/filtered
- Return type
- Returns
The list of task objects from the layer_name layer’s tasks list after filtering
-
classmethod
list_tasks_sessions
(context, layer_name, darwin_symbols, 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) fromlayer_name (
str
) – The name of the layer on which to operatedarwin_symbols (
str
) – The name of the table containing the kernel symbolsfilter_func (
Callable
[[int
],bool
]) – A function which takes a task object and returns True if the task should be ignored/filtered
- Return type
- Returns
The list of task objects from the layer_name layer’s tasks list after filtering
-
classmethod
list_tasks_tasks
(context, layer_name, darwin_symbols, 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) fromlayer_name (
str
) – The name of the layer on which to operatedarwin_symbols (
str
) – The name of the table containing the kernel symbolsfilter_func (
Callable
[[int
],bool
]) – A function which takes a task object and returns True if the task should be ignored/filtered
- Return type
- 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 configurationbase_config_path (
str
) – The base configuration path on which to build the new configurationkwargs – Keyword arguments that are used to populate the new configuration path
- Returns
The newly generated full configuration path
- Return type
-
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.
-
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
-
version
= (2, 0, 0)¶