volatility3.framework.layers.avml module
Functions that read AVML files.
The user of the file doesn’t have to worry about the compression, but random access is not allowed.
- class AVMLLayer(*args, **kwargs)[source]
Bases:
NonLinearlySegmentedLayer
A Lime format TranslationLayer.
Lime is generally used to store physical memory images where there are large holes in the physical layer
Basic initializer that allows configurables to access their own config settings.
- property address_mask: int
Returns a mask which encapsulates all the active bits of an address for this layer.
- 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:
- property config: HierarchicalDict
The Hierarchical configuration Dictionary for this Configurable object.
- property context: ContextInterface
The context object that this configurable belongs to/configuration is stored in.
- property dependencies: List[str]
Returns a list of the lower layers that this layer is dependent upon.
- destroy()
Causes a DataLayer to close any open handles, etc.
Systems that make use of Data Layers should call destroy when they are done with them. This will close all handles, and make the object unreadable (exceptions will be thrown using a DataLayer after destruction)
- Return type:
- classmethod get_requirements()
Returns a list of Requirement objects for this type of layer.
- Return type:
- is_valid(offset, length=1)
Returns whether the address offset can be translated to a valid address.
- 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.
- Parameters:
context (
ContextInterface
) – The context in which to store the new configurationbase_config_path (
str
) – The base configuration path on which to build the new configurationkwargs – Keyword arguments that are used to populate the new configuration path
- Returns:
The newly generated full configuration path
- Return type:
- mapping(offset, length, ignore_errors=False)
Returns a sorted iterable of (offset, length, mapped_offset, mapped_length, layer) mappings.
- read(offset, length, pad=False)
Reads an offset for length bytes and returns ‘bytes’ (not ‘str’) of length size.
- Return type:
- scan(context, scanner, progress_callback=None, sections=None)
Scans a Translation layer by chunk.
Note: this will skip missing/unmappable chunks of memory
- Parameters:
context (
ContextInterface
) – The context containing the data layerscanner (
ScannerInterface
) – The constructed Scanner object to be appliedprogress_callback (
Optional
[Callable
[[float
,str
],None
]]) – Method that is called periodically during scanning to update progresssections (
Iterable
[Tuple
[int
,int
]]) – A list of (start, size) tuples defining the portions of the layer to scan
- Return type:
- Returns:
The output iterable from the scanner object having been run against the layer
- 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:
- class AVMLStacker[source]
Bases:
StackerLayerInterface
-
exclusion_list:
List
[str
] = [] The list operating systems/first-level plugin hierarchy that should exclude this stacker
- classmethod stack(context, layer_name, progress_callback=None)[source]
Method to determine whether this builder can operate on the named layer. If so, modify the context appropriately.
Returns the name of any new layer stacked on top of this layer or None. The stacking is therefore strictly linear rather than tree driven.
Configuration options provided by the context are ignored, and defaults are to be used by this method to build a space where possible.
- Parameters:
- Return type:
- stack_order = 10
The order in which to attempt stacking, the lower the earlier
- classmethod stacker_slow_warning()
-
exclusion_list: