volatility3.framework.layers.vmware module¶
-
exception
VmwareFormatException
(layer_name, *args)[source]¶ Bases:
volatility3.framework.exceptions.LayerException
Thrown when an error occurs with the underlying VMware vmem file format.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
class
VmwareLayer
(context, config_path, name, metadata=None)[source]¶ Bases:
volatility3.framework.layers.segmented.SegmentedLayer
Basic initializer that allows configurables to access their own config settings.
-
property
address_mask
¶ 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
¶ The Hierarchical configuration Dictionary for this Configurable object.
- Return type
-
property
context
¶ The context object that this configurable belongs to/configuration is stored in.
- Return type
-
property
dependencies
¶ 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]¶ This vmware translation layer always requires a separate metadata layer.
- Return type
-
group_structure
= '64sQQ'¶
-
header_structure
= '<4sII'¶
-
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.
-
property
metadata
¶ Returns a ReadOnly copy of the metadata published by this layer.
- Return type
-
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 (
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
-
property
-
class
VmwareStacker
[source]¶ Bases:
volatility3.framework.interfaces.automagic.StackerLayerInterface
-
exclusion_list
= []¶
-
classmethod
stack
(context, layer_name, progress_callback=None)[source]¶ Attempt to stack this based on the starting information.
- Return type
-
stack_order
= 20¶
-
classmethod
stacker_slow_warning
()¶
-