volatility3.framework.layers.registry module

exception RegistryFormatException(layer_name, *args)[source]

Bases: volatility3.framework.exceptions.LayerException

Thrown when an error occurs with the underlying Registry file format.

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

class RegistryHive(context, config_path, name, metadata=None)[source]

Bases: volatility3.framework.layers.linear.LinearlyMappedLayer

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

property address_mask: int

Return a mask that allows for the volatile bit to be set.

Return type

int

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

HierarchicalDict

property config: volatility3.framework.interfaces.configuration.HierarchicalDict

The Hierarchical configuration Dictionary for this Configurable object.

Return type

HierarchicalDict

property config_path: str

The configuration path on which this configurable lives.

Return type

str

property context: volatility3.framework.interfaces.context.ContextInterface

The context object that this configurable belongs to/configuration is stored in.

Return type

ContextInterface

property dependencies: List[str]

Returns a list of layer names that this layer translates onto.

Return type

List[str]

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

None

get_cell(cell_offset)[source]

Returns the appropriate Cell value for a cell offset.

Return type

StructType

get_key(key, return_list=False)[source]

Gets a specific registry key by key path.

return_list specifies whether the return result will be a single node (default) or a list of nodes from root to the current node (if return_list is true).

Return type

Union[List[StructType], StructType]

get_name()[source]
Return type

str

get_node(cell_offset)[source]

Returns the appropriate Node, interpreted from the Cell based on its Signature.

Return type

StructType

classmethod get_requirements()[source]

Returns a list of Requirement objects for this type of layer.

Return type

List[RequirementInterface]

property hive_offset: int
Return type

int

is_valid(offset, length=1)[source]

Returns a boolean based on whether the offset is valid or not.

Return type

bool

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 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

Returns

The newly generated full configuration path

Return type

str

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

Return type

Iterable[Tuple[int, int, int, int, str]]

property maximum_address: int

Returns the maximum valid address of the space.

Return type

int

property metadata: Mapping

Returns a ReadOnly copy of the metadata published by this layer.

Return type

Mapping

property minimum_address: int

Returns the minimum valid address of the space.

Return type

int

property name: str

Returns the layer name.

Return type

str

read(offset, length, pad=False)

Reads an offset for length bytes and returns ‘bytes’ (not ‘str’) of length size.

Return type

bytes

property root_cell_offset: int

Returns the offset for the root cell in this hive.

Return type

int

scan(context, scanner, progress_callback=None, sections=None)

Scans a Translation layer by chunk.

Note: this will skip missing/unmappable chunks of memory

Parameters
Return type

Iterable[Any]

Returns

The output iterable from the scanner object having been run against the layer

translate(offset, ignore_errors=False)
Return type

Tuple[Optional[int], Optional[str]]

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]

visit_nodes(visitor, node=None)[source]

Applies a callable (visitor) to all nodes within the registry tree from a given node.

Return type

None

write(offset, value)

Writes a value at offset, distributing the writing across any underlying mapping.

Return type

None

exception RegistryInvalidIndex(layer_name, *args)[source]

Bases: volatility3.framework.exceptions.LayerException

Thrown when an index that doesn’t exist or can’t be found occurs.

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.