volatility3.framework.automagic.symbol_cache module

class RemoteBannerFormat(location)

Bases: object

process(banners, operating_system)

process_v1(banners, operating_system)

class SymbolBannerCache(context, config_path, *args, **kwargs)

Bases: volatility3.framework.interfaces.automagic.AutomagicInterface

Runs through all symbols tables and caches their banners.

Basic initializer that allows configurables to access their own config settings.

banner_path: Optional[str] = None

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: volatility3.framework.interfaces.configuration.HierarchicalDict

The Hierarchical configuration Dictionary for this Configurable object.

Return type

HierarchicalDict

property config_path: str

The configuration path on which this configurable lives.

Return type

str

property context: volatility3.framework.interfaces.context.ContextInterface

The context object that this configurable belongs to/configuration is stored in.

Return type

ContextInterface

classmethod find_new_banner_files(banners, operating_system)

Gathers all files and remove existing banners

Return type

List[str]

find_requirements(context, config_path, requirement_root, requirement_type, shortcut=True)

Determines if there is actually an unfulfilled Requirement waiting.

This ensures we do not carry out an expensive search when there is no need for a particular Requirement

Parameters

• context (ContextInterface) – Context on which to operate

• config_path (str) – Configuration path of the top-level requirement

• requirement_root (RequirementInterface) – Top-level requirement whose subrequirements will all be searched

• requirement_type (Union[Tuple[Type[RequirementInterface], ...], Type[RequirementInterface]]) – Type of requirement to find

• shortcut (bool) – Only returns requirements that live under unsatisfied requirements

Return type

List[Tuple[str, RequirementInterface]]

Returns

A list of tuples containing the config_path, sub_config_path and requirement identifying the unsatisfied Requirements

classmethod get_requirements()

Returns a list of RequirementInterface objects required by this object.

Return type

List[RequirementInterface]

classmethod load_banners()

Return type

Dict[bytes, List[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

os: Optional[str] = None

priority = 0

An ordering to indicate how soon this automagic should be run

classmethod read_new_banners(context, config_path, new_urls, symbol_name, operating_system=None, progress_callback=None)

Reads the any new banners for the OS in question

Return type

Optional[Dict[bytes, List[str]]]

classmethod remote_banners(banners, operating_system=None, banner_location=None)

Adds remote URLs to the banner list

classmethod save_banners(banners)

symbol_name: str = 'banner_name'

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]