volatility.plugins.mac.pslist module¶

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

Bases: volatility.framework.interfaces.plugins.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¶

The Hierarchical configuration Dictionary for this Configurable object.

Return type: HierarchicalDict

property config_path¶

The configuration path on which this configurable lives.

Return type: str

property context¶

The context object that this configurable belongs to/configuration is stored in.

Return type: ContextInterface

classmethod create_pid_filter(pid_list=None)[source]¶

Return type: Callable[[int], bool]

classmethod get_requirements()[source]¶: Returns a list of Requirement objects for this plugin.

classmethod list_tasks(context, layer_name, darwin_symbols, filter_func=<function PsList.<lambda>>)[source]¶

Lists all the processes in the primary layer.

Parameters

context (ContextInterface) – The context to retrieve required elements (layers, symbol tables) from
layer_name (str) – The name of the layer on which to operate
darwin_symbols (str) – The name of the table containing the kernel symbols
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 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

produce_file(filedata)¶

Adds a file to the plugin’s file store and returns the chosen filename for the file.

Return type: None

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_file_consumer(consumer)¶

Sets the file consumer 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:

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

Return type: Dict[str, RequirementInterface]

version = (1, 0, 0)¶