volatility3.framework.layers.msf module
- exception PDBFormatException(layer_name, *args)[source]
Bases:
LayerException
Thrown when an error occurs with the underlying MSF file format.
- add_note()
Exception.add_note(note) – add a note to the exception
- args
- with_traceback()
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- class PdbMSFStream(context, config_path, name, metadata=None)[source]
Bases:
LinearlyMappedLayer
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.
- 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:
- is_valid(offset, length=1)[source]
Returns a boolean based on whether the entire chunk of data (from offset to length) is valid or not.
- 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)[source]
Returns a sorted iterable of (offset, sublength, mapped_offset, mapped_length, layer) mappings.
ignore_errors will provide all available maps with gaps, but their total length may not add up to the requested length This allows translation layers to provide maps of contiguous regions in one layer
- 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 PdbMultiStreamFormat(context, config_path, name, metadata=None)[source]
Bases:
LinearlyMappedLayer
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()[source]
Returns a list of Requirement objects for this type of layer.
- Return type:
- is_valid(offset, length=1)[source]
Returns a boolean based on whether the entire chunk of data (from offset to length) is valid or not.
- 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)[source]
Returns a sorted iterable of (offset, sublength, mapped_offset, mapped_length, layer) mappings.
ignore_errors will provide all available maps with gaps, but their total length may not add up to the requested length This allows translation layers to provide maps of contiguous regions in one layer
- property page_size
- 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: