volatility3.plugins.windows.info module

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

Bases: PluginInterface

Show OS & kernel details of the memory sample being analyzed.

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 get_depends(context, layer_name, index=0)[source]

List the dependencies of a given layer.

Parameters
  • context (ContextInterface) – The context to retrieve required layers from

  • layer_name (str) – the name of the starting layer

  • index (int) – the index/order of the layer

Return type

Iterable[Tuple[int, DataLayerInterface]]

Returns

An iterable containing the levels and layer objects for all dependent layers

classmethod get_kdbg_structure(context, config_path, layer_name, symbol_table)[source]

Returns the KDDEBUGGER_DATA64 structure for a kernel

Return type

ObjectInterface

classmethod get_kernel_module(context, layer_name, symbol_table)[source]

Returns the kernel module based on the layer and symbol_table

classmethod get_kuser_structure(context, layer_name, symbol_table)[source]

Returns the _KUSER_SHARED_DATA structure for a kernel

Return type

ObjectInterface

classmethod get_ntheader_structure(context, config_path, layer_name)[source]

Gets the ntheader structure for the kernel of the specified layer

Return type

ObjectInterface

classmethod get_requirements()[source]

Returns a list of Requirement objects for this plugin.

Return type

List[RequirementInterface]

classmethod get_version_structure(context, layer_name, symbol_table)[source]

Returns the KdVersionBlock information from a kernel

Return type

ObjectInterface

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.

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:

Return type

Dict[str, RequirementInterface]

unmet = configurable.unsatisfied(context, config_path)
if unmet:
    raise RuntimeError("Unsatisfied requirements: {}".format(unmet)
version = (1, 0, 0)