volatility3.framework.layers.physical module¶
- class BufferDataLayer(context, config_path, name, buffer, metadata=None)[source]¶
Bases:
volatility3.framework.interfaces.layers.DataLayerInterface
A DataLayer class backed by a buffer in memory, designed for testing and swift data access.
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.
- Return type
- 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: volatility3.framework.interfaces.configuration.HierarchicalDict¶
The Hierarchical configuration Dictionary for this Configurable object.
- Return type
- property context: volatility3.framework.interfaces.context.ContextInterface¶
The context object that this configurable belongs to/configuration is stored in.
- Return type
- property dependencies: List[str]¶
A list of other layer names required by this layer.
Note
DataLayers must never define other layers
- 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()[source]¶
Returns a list of Requirement objects for this type of layer.
- 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
- property metadata: Mapping¶
Returns a ReadOnly copy of the metadata published by this layer.
- 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 (
Optional
[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 FileLayer(context, config_path, name, metadata=None)[source]¶
Bases:
volatility3.framework.interfaces.layers.DataLayerInterface
a DataLayer backed by a file on the filesystem.
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.
- Return type
- 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: volatility3.framework.interfaces.configuration.HierarchicalDict¶
The Hierarchical configuration Dictionary for this Configurable object.
- Return type
- property context: volatility3.framework.interfaces.context.ContextInterface¶
The context object that this configurable belongs to/configuration is stored in.
- Return type
- property dependencies: List[str]¶
A list of other layer names required by this layer.
Note
DataLayers must never define other layers
- classmethod get_requirements()[source]¶
Returns a list of Requirement objects for this type of layer.
- 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
- property metadata: Mapping¶
Returns a ReadOnly copy of the metadata published by this layer.
- 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 (
Optional
[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