volatility3.framework.automagic.linux module

class LinuxIntelStacker[source]

Bases: StackerLayerInterface

exclusion_list: List[str] = ['mac', 'windows']

The list operating systems/first-level plugin hierarchy that should exclude this stacker

classmethod find_aslr(context, symbol_table, layer_name, progress_callback=None)[source]

Determines the offset of the actual DTB in physical space and its symbol offset.

Return type:

Tuple[int, int]

classmethod stack(context, layer_name, progress_callback=None)[source]

Attempts to identify linux within this layer.

Return type:


stack_order = 35

The order in which to attempt stacking, the lower the earlier

classmethod stacker_slow_warning()
classmethod virtual_to_physical_address(addr)[source]

Converts a virtual linux address to a physical one (does not account of ASLR)

Return type:


class LinuxSymbolFinder(context, config_path)[source]

Bases: SymbolFinder

Linux symbol loader based on uname signature strings.

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

banner_config_key: str = 'kernel_banner'
property banners: Dict[bytes, List[str]]

Creates a cached copy of the results, but only it’s been requested.


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:


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.

exclusion_list = ['mac', 'windows']

A list of plugin categories (typically operating systems) which the plugin will not operate on

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

Return type:

List[Tuple[str, RequirementInterface]]


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:


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.

  • 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


The newly generated full configuration path

Return type:


operating_system: Optional[str] = 'linux'
priority = 40

An ordering to indicate how soon this automagic should be run

symbol_class: Optional[str] = 'volatility3.framework.symbols.linux.LinuxKernelIntermedSymbols'
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]