volatility3.plugins.windows.callbacks module

class Callbacks(context, config_path, progress_callback=None)[source]

Bases: PluginInterface

Lists kernel callbacks and notification routines.

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 create_callback_scan_constraints(context, symbol_table, is_vista_or_above)[source]

Creates a list of Pool Tag Constraints for callback objects.

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 symbols / types
is_vista_or_above (bool) – A boolean indicating whether the OS version is Vista or newer.

Return type:

List[PoolConstraint]

Returns:

The list containing the built constraints.

classmethod create_callback_symbol_table(context, nt_symbol_table, config_path)[source]

Creates a symbol table for kernel callback objects.

Parameters:

context (ContextInterface) – The context to retrieve required elements (layers, symbol tables) from
nt_symbol_table (str) – The name of the table containing the kernel symbols
config_path (str) – The config path where to find symbol files

Return type:

str

Returns:

The name of the constructed symbol table

classmethod get_requirements()[source]

Returns a list of Requirement objects for this plugin.

Return type:: List[RequirementInterface]

classmethod list_bugcheck_callbacks(context, kernel_module_name, callback_table_name)[source]

Lists all kernel bugcheck callbacks.

Parameters:

context (ContextInterface) – The context to retrieve required elements (layers, symbol tables) from
kernel_module_name (str) – The name of the module of the kernel
callback_table_name (str) – The name of the table containing the callback symbols

Yields:

A name, location and optional detail string

Return type:

Iterable[Tuple[str, int, Union[ObjectInterface, UnreadableValue]]]

classmethod list_bugcheck_reason_callbacks(context, kernel_module_name, callback_table_name)[source]

Lists all kernel bugcheck reason callbacks.

Parameters:

context (ContextInterface) – The context to retrieve required elements (layers, symbol tables) from
kernel_module_name (str) – The name of the module of the kernel
callback_table_name (str) – The name of the table containing the callback symbols

Yields:

A name, location and optional detail string

Return type:

Iterable[Tuple[str, int, BaseAbsentValue]]

classmethod list_notify_routines(context, kernel_module_name, callback_table_name)[source]

Lists all kernel notification routines.

Parameters:

context (ContextInterface) – The context to retrieve required elements (layers, symbol tables) from
kernel_module_name (str) – The name of the module of the kernel
callback_table_name (str) – The name of the table containing the callback symbols

Yields:

A name, location and optional detail string

Return type:

Iterable[Tuple[str, int, Optional[str]]]

classmethod list_registry_callbacks(context, kernel_module_name, callback_table_name)[source]

Lists all registry callbacks.

Parameters:

context (ContextInterface) – The context to retrieve required elements (layers, symbol tables) from
kernel_module_name (str) – The name of the module of the kernel
callback_table_name (str) – The name of the table containing the callback symbols

Yields:

A name, location and optional detail string

Return type:

Iterable[Tuple[str, int, Optional[str]]]

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(context, kernel_module_name, callback_symbol_table)[source]

Scans for callback objects using the poolscanner module and constraints.

Parameters:

context (ContextInterface) – The context to retrieve required elements (layers, symbol tables) from
kernel_module_name (str) – Name of the module for the kernel
callback_symbol_table (str) – The name of the table containing the callback object symbols (_SHUTDOWN_PACKET etc.)

Return type:

Iterable[Tuple[Union[str, BaseAbsentValue], int, Union[str, BaseAbsentValue]]]

Returns:

A list of callback objects found by scanning the layer_name layer for callback 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 = (3, 0, 0)