volatility3.framework.automagic.construct_layers module¶

An automagic module to use configuration data to configure and then construct classes that fulfill the descendants of a ConfigurableInterface.

class ConstructionMagic(context, config_path, *args, **kwargs)[source]¶

Bases: volatility3.framework.interfaces.automagic.AutomagicInterface

Constructs underlying layers.

Class to run through the requirement tree of the ConfigurableInterface and from the bottom of the tree upwards, attempt to construct all ConstructableRequirementInterface based classes.

Warning: This automagic should run first to allow existing configurations to have been constructed for use by later automagic

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

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¶

The Hierarchical configuration Dictionary for this Configurable object.

Return type: HierarchicalDict

property config_path¶

The configuration path on which this configurable lives.

Return type: str

property context¶

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

Return type: ContextInterface

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

priority = 0¶

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]