volatility3.plugins.windows.psscan module¶

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

Bases: volatility3.framework.interfaces.plugins.PluginInterface, volatility3.plugins.timeliner.TimeLinerInterface

Scans for 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

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: volatility3.framework.interfaces.configuration.HierarchicalDict¶

The Hierarchical configuration Dictionary for this Configurable object.

Return type: HierarchicalDict

property config_path: str¶

The configuration path on which this configurable lives.

Return type: str

property context: volatility3.framework.interfaces.context.ContextInterface¶

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

Return type: ContextInterface

generate_timeline()[source]¶

Method generates Tuples of (description, timestamp_type, timestamp)

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

classmethod get_osversion(context, layer_name, symbol_table)[source]¶

Returns the complete OS version (MAJ,MIN,BUILD)

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

Return type

Tuple[int, int, int]

Returns

A tuple with (MAJ,MIN,BUILD)

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

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()[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 scan_processes(context, layer_name, symbol_table, filter_func=<function PsScan.<lambda>>)[source]¶

Scans for processes using the poolscanner module and constraints.

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

Return type

Iterable[ObjectInterface]

Returns

A list of processes found by scanning the layer_name layer for process pool signatures

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, 1, 0)¶

classmethod virtual_process_from_physical(context, layer_name, symbol_table, proc)[source]¶

Returns a virtual process from a physical addressed one

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
proc (ObjectInterface) – the process object with phisical address

Return type

Iterable[ObjectInterface]

Returns

A process object on virtual address layer