:py:mod:`dissect.fve.luks.metadata`
===================================

.. py:module:: dissect.fve.luks.metadata


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

Classes
~~~~~~~

.. autoapisummary::

   dissect.fve.luks.metadata.JsonItem
   dissect.fve.luks.metadata.Config
   dissect.fve.luks.metadata.KeyslotArea
   dissect.fve.luks.metadata.KeyslotKdf
   dissect.fve.luks.metadata.KeyslotAf
   dissect.fve.luks.metadata.Keyslot
   dissect.fve.luks.metadata.Digest
   dissect.fve.luks.metadata.SegmentIntegrity
   dissect.fve.luks.metadata.Segment
   dissect.fve.luks.metadata.Token
   dissect.fve.luks.metadata.Metadata




Attributes
~~~~~~~~~~

.. autoapisummary::

   dissect.fve.luks.metadata.items


.. py:class:: JsonItem

   .. py:method:: from_json(obj: str) -> JsonItem
      :classmethod:



   .. py:method:: from_dict(obj: dict[str, str | int | dict | list]) -> JsonItem
      :classmethod:



.. py:class:: Config

   Bases: :py:obj:`JsonItem`


   .. py:attribute:: json_size
      :type:  int


   .. py:attribute:: keyslots_size
      :type:  int | None


   .. py:attribute:: flags
      :type:  list[str] | None


   .. py:attribute:: requirements
      :type:  list[str] | None


.. py:class:: KeyslotArea

   Bases: :py:obj:`JsonItem`


   .. py:attribute:: type
      :type:  str


   .. py:attribute:: offset
      :type:  int


   .. py:attribute:: size
      :type:  int


   .. py:attribute:: encryption
      :type:  str | None


   .. py:attribute:: key_size
      :type:  int | None


   .. py:attribute:: hash
      :type:  str | None


   .. py:attribute:: sector_size
      :type:  int | None


   .. py:attribute:: shift_size
      :type:  int | None


.. py:class:: KeyslotKdf

   Bases: :py:obj:`JsonItem`


   .. py:attribute:: type
      :type:  str


   .. py:attribute:: salt
      :type:  bytes


   .. py:attribute:: hash
      :type:  str | None


   .. py:attribute:: iterations
      :type:  int | None


   .. py:attribute:: time
      :type:  int | None


   .. py:attribute:: memory
      :type:  int | None


   .. py:attribute:: cpus
      :type:  int | None


.. py:class:: KeyslotAf

   Bases: :py:obj:`JsonItem`


   .. py:attribute:: type
      :type:  str


   .. py:attribute:: stripes
      :type:  int | None


   .. py:attribute:: hash
      :type:  str | None


.. py:class:: Keyslot

   Bases: :py:obj:`JsonItem`


   .. py:attribute:: type
      :type:  str


   .. py:attribute:: key_size
      :type:  int


   .. py:attribute:: area
      :type:  KeyslotArea


   .. py:attribute:: priority
      :type:  int | None


   .. py:attribute:: kdf
      :type:  KeyslotKdf | None


   .. py:attribute:: af
      :type:  KeyslotAf | None


   .. py:attribute:: mode
      :type:  str | None


   .. py:attribute:: direction
      :type:  str | None


.. py:class:: Digest

   Bases: :py:obj:`JsonItem`


   .. py:attribute:: type
      :type:  str


   .. py:attribute:: keyslots
      :type:  list[int]


   .. py:attribute:: segments
      :type:  list[int]


   .. py:attribute:: salt
      :type:  bytes


   .. py:attribute:: digest
      :type:  bytes


   .. py:attribute:: hash
      :type:  str | None


   .. py:attribute:: iterations
      :type:  int | None


.. py:class:: SegmentIntegrity

   Bases: :py:obj:`JsonItem`


   .. py:attribute:: type
      :type:  str


   .. py:attribute:: journal_encryption
      :type:  str


   .. py:attribute:: journal_integrity
      :type:  str


.. py:class:: Segment

   Bases: :py:obj:`JsonItem`


   .. py:attribute:: type
      :type:  str


   .. py:attribute:: offset
      :type:  int


   .. py:attribute:: size
      :type:  int | str


   .. py:attribute:: flags
      :type:  list[str] | None


   .. py:attribute:: iv_tweak
      :type:  int | None


   .. py:attribute:: encryption
      :type:  str | None


   .. py:attribute:: sector_size
      :type:  int | None


   .. py:attribute:: integrity
      :type:  SegmentIntegrity | None


.. py:class:: Token

   Bases: :py:obj:`JsonItem`


   .. py:attribute:: type
      :type:  str


   .. py:attribute:: keyslots
      :type:  list[int]


.. py:class:: Metadata

   Bases: :py:obj:`JsonItem`


   .. py:attribute:: config
      :type:  Config


   .. py:attribute:: keyslots
      :type:  dict[int, Keyslot]


   .. py:attribute:: digests
      :type:  dict[int, Digest]


   .. py:attribute:: segments
      :type:  dict[int, Segment]


   .. py:attribute:: tokens
      :type:  dict[int, Token]


   .. py:method:: from_luks1_header(header: dissect.fve.luks.c_luks.c_luks.luks_phdr) -> Metadata
      :classmethod:


      Map LUKS1 header information into a :class:`Metadata` dataclass.



.. py:data:: items