volatility3.plugins.windows.dumpfiles module
- class DumpFiles(context, config_path, progress_callback=None)[source]
Bases:
PluginInterface
Dumps cached file contents from Windows memory samples.
- Parameters:
- 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.
- classmethod dump_file_producer(file_object, memory_object, open_method, layer, desired_file_name)[source]
Produce a file from the memory object’s get_available_pages() interface.
- Parameters:
file_object (
ObjectInterface
) – the parent _FILE_OBJECTmemory_object (
ObjectInterface
) – the _CONTROL_AREA or _SHARED_CACHE_MAPopen_method (
Type
[FileHandlerInterface
]) – class for constructing output fileslayer (
DataLayerInterface
) – the memory layer to read fromdesired_file_name (
str
) – name of the output file
- Return type:
- Returns:
result status
- classmethod get_requirements()[source]
Returns a list of Requirement objects for this plugin.
- 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 open
Returns a context manager and thus can be called like open
- classmethod process_file_object(context, primary_layer_name, open_method, file_obj)[source]
Given a FILE_OBJECT, dump data to separate files for each of the three file caches.
- Parameters:
context (
ContextInterface
) – the context to operate uponprimary_layer_name (
str
) – primary/virtual layer to operate onopen_method (
Type
[FileHandlerInterface
]) – class for constructing output filesfile_obj (
ObjectInterface
) – the FILE_OBJECT
- Return type:
- run()[source]
Executes the functionality of the code.
Note
This method expects self.validate to have been called to ensure all necessary options have been provided
- Returns:
A TreeGrid object that can then be passed to a Renderer.
- 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:
- version = (1, 0, 0)