Module Contents#




Base class for plugins.



Format the value if it is None



dissect.target.plugins.filesystem.ntfs.mft_timeline.format_none_value(value: Any) str | Any#

Format the value if it is None

class dissect.target.plugins.filesystem.ntfs.mft_timeline.Extras#
in_use: bool | None#
resident: bool | None#
owner: str | None#
size: int | None#
serial: int | None#
volume_uuid: str | None#
format() str#
dissect.target.plugins.filesystem.ntfs.mft_timeline.format_info(segment: int, path: str, extras: Extras, info: dissect.ntfs.attr.FileName | dissect.ntfs.attr.StandardInformation, info_type: dissect.target.plugins.filesystem.ntfs.utils.InformationType, idx: str = '') Iterator[str]#
class dissect.target.plugins.filesystem.ntfs.mft_timeline.MftTimelinePlugin(target: dissect.target.Target)#

Bases: dissect.target.plugin.Plugin

Base class for plugins.

Plugins can optionally be namespaced by specifying the __namespace__ class attribute. Namespacing results in your plugin needing to be prefixed with this namespace when being called. For example, if your plugin has specified test as namespace and a function called example, you must call your plugin with test.example:

A Plugin class has the following private class attributes:

  • __namespace__

  • __record_descriptors__

With the following three being assigned in register():

  • __plugin__

  • __functions__

  • __exports__

Additionally, the methods and attributes of Plugin receive more private attributes by using decorators.

The export() decorator adds the following private attributes

  • __exported__

  • __output__: Set with the export() decorator.

  • __record__: Set with the export() decorator.

The internal() decorator and InternalPlugin set the __internal__ attribute. Finally. args() decorator sets the __args__ attribute.


target – The Target object to load the plugin for.

check_compatible() None#

Perform a compatibility check with the target.

This function should return None if the plugin is compatible with the current target (self.target). For example, check if a certain file exists. Otherwise it should raise an UnsupportedPluginError.


UnsupportedPluginError – If the plugin could not be loaded.

mft_timeline(ignore_dos: bool = False)#

Return the MFT records of all NTFS filesystems in a human readable format (unsorted).

The Master File Table (MFT) contains metadata about every file and folder on a NFTS filesystem.