volatility.plugins.windows.pstree module¶

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

Bases: volatility.plugins.windows.pslist.PsList

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

Args: 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

PHYSICAL_DEFAULT = False¶

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_name_filter(name_list=None)¶

A factory for producing filter functions that filter based on a list of process names.

Parameters: name_list (Optional[List[str]]) – A list of process names that are acceptable, all other processes will be filtered out
Return type: Callable[[ObjectInterface], bool]
Returns: Filter function for passing to the list_processes method

classmethod create_pid_filter(pid_list=None)¶

A factory for producing filter functions that filter based on a list of process IDs.

Parameters: pid_list (Optional[List[int]]) – A list of process IDs that are acceptable, all other processes will be filtered out
Return type: Callable[[ObjectInterface], bool]
Returns: Filter function for passing to the list_processes method

find_level(pid)[source]¶

Finds how deep the pid is in the processes list.

Return type: None

generate_timeline()¶

Method generates Tuples of (description, timestamp_type, timestamp)

These need not be generated in any particular order, sorting will be done later

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

classmethod list_processes(context, layer_name, symbol_table, filter_func=<function PsList.<lambda>>)¶

Lists all the processes in the primary layer that are in the pid config option.

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
symbol_table (str) – The name of the table containing the kernel symbols
filter_func (Callable[[ObjectInterface], bool]) – A function which takes an EPROCESS object and returns True if the process should be ignored/filtered

Return type

Iterable[ObjectInterface]

Returns

The list of EPROCESS objects from the layer_name layer’s PsActiveProcessHead 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()¶

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)¶