volatility3.plugins.windows.cmdscan module

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

Bases: PluginInterface

Looks for Windows Command History lists

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_command_history(context, kernel_layer_name, kernel_symbol_table_name, config_path, procs, max_history)[source]

Gets the list of commands from each Command History structure

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_symbol_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

Return type:

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

Returns:

The conhost process object, the command history structure, a dictionary of properties for that command history structure.

classmethod get_filtered_vads(conhost_proc, size_filter=1073741824)[source]

Returns vads of a process with size smaller than size_filter

Parameters:: conhost_proc (ContextInterface) – the process object for conhost.exe
Returns:: vad_base: the base address vad_size: the size of the VAD
Return type:: A list of tuples of

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