volatility3.plugins.windows.mftscan module

class ADS(context, config_path, progress_callback=None)[source]

Bases: PluginInterface

Scans for Alternate Data Stream

Parameters:

context (ContextInterface) – The context that the plugin will operate within
config_path (str) – The path to configuration data within the context configuration data
progress_callback (Optional[Callable[[float, str], None]]) – A callable that can provide feedback at progress points

class ADSResult(offset, signature, record_number, attribute_type, filename, stream_name, content)[source]

Bases: NamedTuple

Create new instance of ADSResult(offset, signature, record_number, attribute_type, filename, stream_name, content)

attribute_type: str: Alias for field number 3

content: Union[LayerData, BaseAbsentValue]: Alias for field number 6

count(value, /): Return number of occurrences of value.

filename: Union[String, BaseAbsentValue]: Alias for field number 4

index(value, start=0, stop=9223372036854775807, /)

Return first index of value.

Raises ValueError if the value is not present.

offset: Hex: Alias for field number 0

record_number: Integer: Alias for field number 2

signature: String: Alias for field number 1

stream_name: Union[String, BaseAbsentValue]: Alias for field number 5

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: HierarchicalDict: The Hierarchical configuration Dictionary for this Configurable object.

property config_path: str: The configuration path on which this configurable lives.

property context: ContextInterface: The context object that this configurable belongs to/configuration is stored in.

classmethod get_requirements()[source]: Returns a list of Requirement objects for this plugin.

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

property open: Returns a context manager and thus can be called like open

classmethod parse_ads_data_records(mft_record)[source]

Return type:: Iterator[ADSResult]

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.

set_open_method(handler)

Sets the file handler to be used by this plugin.

Return type:: None

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]

version = (2, 0, 0)

class MFTScan(context, config_path, progress_callback=None)[source]

Bases: PluginInterface, TimeLinerInterface

Scans for MFT FILE objects present in a particular windows memory image.

Parameters:

context (ContextInterface) – The context that the plugin will operate within
config_path (str) – The path to configuration data within the context configuration data
progress_callback (Optional[Callable[[float, str], None]]) – A callable that can provide feedback at progress points

class MFTScanResult(offset, record_type, record_number, link_count, mft_type, permissions, attribute_type, created, modified, updated, accessed, filename)[source]

Bases: NamedTuple

Create new instance of MFTScanResult(offset, record_type, record_number, link_count, mft_type, permissions, attribute_type, created, modified, updated, accessed, filename)

accessed: Union[BaseAbsentValue, datetime]: Alias for field number 10

attribute_type: str: Alias for field number 6

count(value, /): Return number of occurrences of value.

created: Union[BaseAbsentValue, datetime]: Alias for field number 7

filename: Union[BaseAbsentValue, String]: Alias for field number 11

index(value, start=0, stop=9223372036854775807, /)

Return first index of value.

Raises ValueError if the value is not present.

link_count: Integer: Alias for field number 3

mft_type: str: Alias for field number 4

modified: Union[BaseAbsentValue, datetime]: Alias for field number 8

offset: Hex: Alias for field number 0

permissions: Union[str, BaseAbsentValue]: Alias for field number 5

record_number: Integer: Alias for field number 2

record_type: str: Alias for field number 1

updated: Union[BaseAbsentValue, datetime]: Alias for field number 9

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: HierarchicalDict: The Hierarchical configuration Dictionary for this Configurable object.

property config_path: str: The configuration path on which this configurable lives.

property context: ContextInterface: The context object that this configurable belongs to/configuration is stored in.

classmethod enumerate_mft_records(context, config_path, primary_layer_name)[source]

Return type:: Iterator[MFTEntry]

generate_timeline()[source]

Method generates Tuples of (description, timestamp_type, timestamp)

These need not be generated in any particular order, sorting will be done later

classmethod get_requirements()[source]: Returns a list of Requirement objects for this plugin.

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

property open: Returns a context manager and thus can be called like open

classmethod parse_filename_records(mft_record)[source]

Return type:: Iterator[Tuple[int, MFTScanResult]]

classmethod parse_mft_records(context, config_path, primary_layer_name)[source]

Return type:: Iterator[Tuple[int, MFTScanResult]]

classmethod parse_standard_information_records(mft_record)[source]

Return type:: Iterator[Tuple[int, MFTScanResult]]

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.

set_open_method(handler)

Sets the file handler to be used by this plugin.

Return type:: None

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]

version = (3, 0, 0)

class ResidentData(context, config_path, progress_callback=None)[source]

Bases: PluginInterface

Scans for MFT Records with Resident Data

Parameters:

context (ContextInterface) – The context that the plugin will operate within
config_path (str) – The path to configuration data within the context configuration data
progress_callback (Optional[Callable[[float, str], None]]) – A callable that can provide feedback at progress points

class ResidentDataResult(offset, signature, record_number, attribute_type, filename, content)[source]

Bases: NamedTuple

Create new instance of ResidentDataResult(offset, signature, record_number, attribute_type, filename, content)

attribute_type: str: Alias for field number 3

content: Union[LayerData, BaseAbsentValue]: Alias for field number 5

count(value, /): Return number of occurrences of value.

filename: Union[String, BaseAbsentValue]: Alias for field number 4

index(value, start=0, stop=9223372036854775807, /)

Return first index of value.

Raises ValueError if the value is not present.

offset: Hex: Alias for field number 0

record_number: int: Alias for field number 2

signature: String: Alias for field number 1

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: HierarchicalDict: The Hierarchical configuration Dictionary for this Configurable object.

property config_path: str: The configuration path on which this configurable lives.

property context: ContextInterface: The context object that this configurable belongs to/configuration is stored in.

classmethod get_requirements()[source]: Returns a list of Requirement objects for this plugin.

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

property open: Returns a context manager and thus can be called like open

classmethod parse_resident_data(mft_record)[source]

Returns the parsed data from a MFT record

Return type:: Optional[ResidentDataResult]

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.

set_open_method(handler)

Sets the file handler to be used by this plugin.

Return type:: None

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]

version = (2, 0, 0)