volatility3.plugins.windows.pslist module

class PsList(context, config_path, progress_callback=None)

Bases: PluginInterface, TimeLinerInterface

Lists the processes present in a particular windows 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

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: 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_active_process_filter()

A factory for producing a filter function that only returns

active, userland processes. This prevents plugins from operating on terminated processes that are still in the process list due to smear or handle leaks as well as kernel processes (System, Registry, etc.). Use of this filter for plugins searching for system state anomalies significantly reduces false positive in smeared and terminated processes.

Return type:

Callable[[ObjectInterface], bool]

Returns:

Filter function for passing to the list_processes method

classmethod create_name_filter(name_list=None, exclude=False)

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

Parameters:

• name_list (List[str]) – A list of process names that are acceptable, all other processes will be filtered out

• exclude (bool) – Accept only tasks that are not in name_list

Return type:

Callable[[ObjectInterface], bool]

Returns:

Filter function for passing to the list_processes method

classmethod create_pid_filter(pid_list=None, exclude=False)

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

Parameters:

• pid_list (List[int]) – A list of process IDs that are acceptable, all other processes will be filtered out

• exclude (bool) – Accept only tasks that are not in pid_list

Return type:

Callable[[ObjectInterface], bool]

Returns:

Filter function for passing to the list_processes method

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:

Iterator[EPROCESS]

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

property open

Returns a context manager and thus can be called like open

classmethod process_dump(context, kernel_table_name, pe_table_name, proc, open_method)

Extracts the complete data for a process as a FileHandlerInterface

Parameters:

• context (ContextInterface) – the context to operate upon

• kernel_table_name (str) – the name for the symbol table containing the kernel’s symbols

• pe_table_name (str) – the name for the symbol table containing the PE format symbols

• proc (ObjectInterface) – the process object whose memory should be output

• open_method (Type[FileHandlerInterface]) – class to provide context manager for opening the file

Return type:

FileHandlerInterface

Returns:

An open FileHandlerInterface object containing the complete data for the process or None in the case of failure

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