volatility3.plugins.windows.consoles module

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

Bases: PluginInterface

Looks for Windows console buffers

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_conhost_symbol_table(context, layer_name, nt_symbol_table, config_path, conhost_layer_name, conhost_base)[source]

Creates a symbol table for conhost structures.

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
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 determine_conhost_version(context, layer_name, nt_symbol_table, config_path, conhost_layer_name, conhost_base)[source]

Tries to determine which symbol filename to use for the image’s console information. This is similar to the netstat plugin.

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
nt_symbol_table (str) – The name of the table containing the kernel symbols
config_path (str) – The config path where to find symbol files
conhost_layer_name (str) – The name of the conhot process memory layer
conhost_base (int) – the base address of conhost.exe

Return type:

Tuple[str, Type]

Returns:

The filename of the symbol table to use and the associated class types.

classmethod find_conhost_proc(proc_list)[source]

Walks the process list and returns the conhost instances.

Parameters:: proc_list (Generator[ObjectInterface, None, None]) – The process list generator
Return type:: Tuple[ContextInterface, str]
Returns:: The process object and layer name for conhost

classmethod find_conhostexe(conhost_proc)[source]

Finds the base address of conhost.exe

Parameters:: conhost_proc (ContextInterface) – the process object for conhost.exe
Returns:: conhostexe_base: the base address of conhost.exe conhostexe_size: the size of the VAD for conhost.exe
Return type:: A tuple of

classmethod get_console_info(context, kernel_layer_name, kernel_table_name, config_path, procs, max_history, max_buffers)[source]

Gets the Console Information structure and its related properties for each conhost process

Parameters:

context (ContextInterface) – The context to retrieve required elements (layers, symbol tables) from
kernel_layer_name (str) – The name of the layer on which to operate
kernel_table_name (str) – The name of the table containing the kernel symbols
config_path (str) – The config path where to find symbol files
procs (Generator[ObjectInterface, None, None]) – list of process objects
max_history (Set[int]) – an initial set of CommandHistorySize values
max_buffers (Set[int]) – an initial list of HistoryBufferMax values

Return type:

Tuple[ContextInterface, ContextInterface, Dict[str, Any]]

Returns:

The conhost process object, the console information structure, a dictionary of properties for that console information structure.

classmethod get_console_settings_from_registry(context, config_path, kernel_layer_name, kernel_symbol_table_name, max_history, max_buffers)[source]

Walks the Registry user hives and extracts any CommandHistorySize and HistoryBufferMax values for scanning

Parameters:

context (ContextInterface) – The context to retrieve required elements (layers, symbol tables) from
config_path (str) – The config path where to find symbol files
kernel_layer_name (str) – The name of the layer on which to operate
kernel_symbol_table_name (str) – The name of the table containing the kernel symbols
max_history (Set[int]) – an initial set of CommandHistorySize values
max_buffers (Set[int]) – an initial list of HistoryBufferMax values

Return type:

Tuple[Set[int], Set[int]]

Returns:

The updated max_history and max_buffers sets.

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.

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)