volatility3.plugins.linux.capabilities module

class Capabilities(context, config_path, progress_callback=None)

Bases: PluginInterface

Lists process capabilities

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 get_requirements()

Returns a list of Requirement objects for this plugin.

Return type:

List[RequirementInterface]

classmethod get_task_capabilities(task)

Returns a tuple with the task basic information along with its capabilities

Parameters:

task (ObjectInterface) – A task object from where to get the fields.

Return type:

Tuple[TaskData, CapabilitiesData]

Returns:

A tuple with the task basic information and its capabilities

classmethod get_tasks_capabilities(tasks)

Yields a tuple for each task containing the task’s basic information along with its capabilities

Parameters:

tasks (List[ObjectInterface]) – An iterable with the tasks to process.

Yields:

A tuple for each task containing the task’s basic information and its capabilities

Return type:

Iterable[Tuple[TaskData, CapabilitiesData]]

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:

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

Return type:

Dict[str, RequirementInterface]

version = (1, 0, 0)

class CapabilitiesData(cap_inheritable, cap_permitted, cap_effective, cap_bset, cap_ambient)

Bases: object

Stores each set of capabilties for a task

astuple()

Returns a shallow copy of the capability sets in a tuple.

Otherwise, when dataclasses.astuple() performs a deep-copy recursion on ObjectInterface will take a substantial amount of time.

Return type:

Tuple

cap_ambient: ObjectInterface

cap_bset: ObjectInterface

cap_effective: ObjectInterface

cap_inheritable: ObjectInterface

cap_permitted: ObjectInterface

class TaskData(comm, pid, tgid, ppid, euid)

Bases: object

Stores basic information about a task

comm: str

euid: int

pid: int

ppid: int

tgid: int