:py:mod:`dissect.target.volumes.luks`
=====================================

.. py:module:: dissect.target.volumes.luks


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

Classes
~~~~~~~

.. autoapisummary::

   dissect.target.volumes.luks.LUKSVolumeSystem




Attributes
~~~~~~~~~~

.. autoapisummary::

   dissect.target.volumes.luks.log


.. py:data:: log

.. py:exception:: LUKSVolumeSystemError(message: str | None = None, extra: list[Exception] | None = None)

   Bases: :py:obj:`dissect.target.exceptions.VolumeSystemError`


   A volume system error occurred.


.. py:class:: LUKSVolumeSystem(fh: BinaryIO | list[BinaryIO], *args, **kwargs)

   Bases: :py:obj:`dissect.target.volume.EncryptedVolumeSystem`


   An extension of the :class:`VolumeSystem` class that provides additional functionality for
   dealing with encryption.

   It adds helper functions for interacting with the :attr:`~dissect.target.helpers.keychain.KEYCHAIN`,
   so that subclasses don't have to manually interact with it.

   :param fh: The file-like object on which to open the encrypted volume system.


   .. py:attribute:: __type__
      :value: 'luks'


      A short string identifying the type of volume system.


   .. py:attribute:: luks


   .. py:method:: unlock_with_volume_encryption_key(key: bytes, keyslot: int | None = None, is_wildcard: bool = False) -> None


   .. py:method:: unlock_with_passphrase(passphrase: str, keyslot: int | None = None, is_wildcard: bool = False) -> None


   .. py:method:: unlock_with_key_file(key_file: pathlib.Path, keyslot: int | None = None, is_wildcard: bool = False) -> None


   .. py:method:: unlock_volume() -> dissect.util.stream.AlignedStream