volatility3.plugins.windows.windowstations module

class WindowStations(context, config_path, progress_callback=None)

Bases: PluginInterface

Scans for top level Windows Stations

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.

static create_gui_table(context, symbol_table, config_path)

Creates a symbol table for windows GUI types

Parameters:

• context (ContextInterface) – The context to retrieve required elements (layers, symbol tables) from

• symbol_table (str) – The name of an existing symbol table containing the kernel symbols

• config_path (str) – The configuration path within the context of the symbol table to create

Return type:

str

Returns:

The name of the constructed GUI table

classmethod get_requirements()

Returns a list of Requirement objects for this plugin.

Return type:

List[RequirementInterface]

classmethod get_session_map(context, module_name, gui_table_name)

Walks each session layer and returns a dictionary that maps session identifiers to a module in the session’s layer

Return type:

Dict[int, ModuleInterface]

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.

classmethod scan_gui_object(context, config_path, kernel_module_name, object_tag, object_type)

An API that generically scans for GUI (win32*.sys) objects allocated in the pools (which is nearly all of them)

This function scans within the kernel space for the tags and then uses get_session_map to instantiate objects in their correct session address space.

Parameters:

• context (ContextInterface)

• config_path (str)

• kernel_module_name (str)

• object_tag (bytes) – The 4 byte pool header tag to search for

• object_type (str) – The data structure of the GUI object within the pool

Return type:

Generator[ObjectInterface, None, None]

classmethod scan_window_stations(context, config_path, kernel_module_name)

Scans for window stations through scan_gui_object Yields each window station along with its name and session_id

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)