:py:mod:`dissect.target.plugins.filesystem.ntfs.usnjrnl`
========================================================

.. py:module:: dissect.target.plugins.filesystem.ntfs.usnjrnl


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   dissect.target.plugins.filesystem.ntfs.usnjrnl.UsnjrnlPlugin




Attributes
~~~~~~~~~~

.. autoapisummary::

   dissect.target.plugins.filesystem.ntfs.usnjrnl.UsnjrnlRecord


.. py:data:: UsnjrnlRecord

   

.. py:class:: UsnjrnlPlugin(target: dissect.target.Target)


   Bases: :py:obj:`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 :func:`register`:

   - ``__plugin__``
   - ``__functions__``
   - ``__exports__``

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

   The :func:`export` decorator adds the following private attributes

   - ``__exported__``
   - ``__output__``: Set with the :func:`export` decorator.
   - ``__record__``: Set with the :func:`export` decorator.

   The :func:`internal` decorator and :class:`InternalPlugin` set the ``__internal__`` attribute.
   Finally. :func:`args` decorator sets the ``__args__`` attribute.

   :param target: The :class:`~dissect.target.target.Target` object to load the plugin for.

   .. py:method:: 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``.

      :raises UnsupportedPluginError: If the plugin could not be loaded.


   .. py:method:: usnjrnl() -> Iterator[UsnjrnlRecord]

      Return the UsnJrnl entries of all NTFS filesystems.

      The Update Sequence Number Journal (UsnJrnl) is a feature of an NTFS file system and contains information about
      filesystem activities. Each volume has its own UsnJrnl.

      If the filesystem is part of a virtual NTFS filesystem (a ``VirtualFilesystem`` with the UsnJrnl
      properties added to it through a "fake" ``NtfsFilesystem``), the paths returned in the UsnJrnl records
      are based on the mount point of the ``VirtualFilesystem``. This ensures that the proper original drive
      letter is used when available.
      When no drive letter can be determined, the path will show as e.g. ``\$fs$\fs0``.

      .. rubric:: References

      - https://en.wikipedia.org/wiki/USN_Journal
      - https://velociraptor.velocidex.com/the-windows-usn-journal-f0c55c9010e