kaitai: adjustments and rearrangements for python2/3 compat

1 files changed, 144 insertions, 0 deletions

diff --git a/python/examples/kaitai/luks.py b/python/examples/kaitai/luks.py
new file mode 100644
index 00000000..90ca7cd7
--- /dev/null
+++ b/python/examples/kaitai/luks.py
@@ -0,0 +1,144 @@
+# This is a generated file! Please edit source .ksy file and use kaitai-struct-compiler to rebuild
+
+from pkg_resources import parse_version
+from .kaitaistruct import __version__ as ks_version, KaitaiStruct, KaitaiStream, BytesIO
+import collections
+from enum import Enum
+
+
+if parse_version(ks_version) < parse_version('0.7'):
+    raise Exception("Incompatible Kaitai Struct Python API: 0.7 or later is required, but you have %s" % (ks_version))
+
+class Luks(KaitaiStruct):
+    """Linux Unified Key Setup (LUKS) is a format specification for storing disk
+    encryption parameters and up to 8 user keys (which can unlock the master key).
+    
+    .. seealso::
+       Source - https://gitlab.com/cryptsetup/cryptsetup/wikis/LUKS-standard/on-disk-format.pdf
+    """
+    SEQ_FIELDS = ["partition_header"]
+    def __init__(self, _io, _parent=None, _root=None):
+        self._io = _io
+        self._parent = _parent
+        self._root = _root if _root else self
+        self._debug = collections.defaultdict(dict)
+
+    def _read(self):
+        self._debug['partition_header']['start'] = self._io.pos()
+        self.partition_header = self._root.PartitionHeader(self._io, self, self._root)
+        self.partition_header._read()
+        self._debug['partition_header']['end'] = self._io.pos()
+
+    class PartitionHeader(KaitaiStruct):
+        SEQ_FIELDS = ["magic", "version", "cipher_name_specification", "cipher_mode_specification", "hash_specification", "payload_offset", "number_of_key_bytes", "master_key_checksum", "master_key_salt_parameter", "master_key_iterations_parameter", "uuid", "key_slots"]
+        def __init__(self, _io, _parent=None, _root=None):
+            self._io = _io
+            self._parent = _parent
+            self._root = _root if _root else self
+            self._debug = collections.defaultdict(dict)
+
+        def _read(self):
+            self._debug['magic']['start'] = self._io.pos()
+            self.magic = self._io.ensure_fixed_contents(b"\x4C\x55\x4B\x53\xBA\xBE")
+            self._debug['magic']['end'] = self._io.pos()
+            self._debug['version']['start'] = self._io.pos()
+            self.version = self._io.ensure_fixed_contents(b"\x00\x01")
+            self._debug['version']['end'] = self._io.pos()
+            self._debug['cipher_name_specification']['start'] = self._io.pos()
+            self.cipher_name_specification = (self._io.read_bytes(32)).decode(u"ASCII")
+            self._debug['cipher_name_specification']['end'] = self._io.pos()
+            self._debug['cipher_mode_specification']['start'] = self._io.pos()
+            self.cipher_mode_specification = (self._io.read_bytes(32)).decode(u"ASCII")
+            self._debug['cipher_mode_specification']['end'] = self._io.pos()
+            self._debug['hash_specification']['start'] = self._io.pos()
+            self.hash_specification = (self._io.read_bytes(32)).decode(u"ASCII")
+            self._debug['hash_specification']['end'] = self._io.pos()
+            self._debug['payload_offset']['start'] = self._io.pos()
+            self.payload_offset = self._io.read_u4be()
+            self._debug['payload_offset']['end'] = self._io.pos()
+            self._debug['number_of_key_bytes']['start'] = self._io.pos()
+            self.number_of_key_bytes = self._io.read_u4be()
+            self._debug['number_of_key_bytes']['end'] = self._io.pos()
+            self._debug['master_key_checksum']['start'] = self._io.pos()
+            self.master_key_checksum = self._io.read_bytes(20)
+            self._debug['master_key_checksum']['end'] = self._io.pos()
+            self._debug['master_key_salt_parameter']['start'] = self._io.pos()
+            self.master_key_salt_parameter = self._io.read_bytes(32)
+            self._debug['master_key_salt_parameter']['end'] = self._io.pos()
+            self._debug['master_key_iterations_parameter']['start'] = self._io.pos()
+            self.master_key_iterations_parameter = self._io.read_u4be()
+            self._debug['master_key_iterations_parameter']['end'] = self._io.pos()
+            self._debug['uuid']['start'] = self._io.pos()
+            self.uuid = (self._io.read_bytes(40)).decode(u"ASCII")
+            self._debug['uuid']['end'] = self._io.pos()
+            self._debug['key_slots']['start'] = self._io.pos()
+            self.key_slots = [None] * (8)
+            for i in range(8):
+                if not 'arr' in self._debug['key_slots']:
+                    self._debug['key_slots']['arr'] = []
+                self._debug['key_slots']['arr'].append({'start': self._io.pos()})
+                _t_key_slots = self._root.PartitionHeader.KeySlot(self._io, self, self._root)
+                _t_key_slots._read()
+                self.key_slots[i] = _t_key_slots
+                self._debug['key_slots']['arr'][i]['end'] = self._io.pos()
+
+            self._debug['key_slots']['end'] = self._io.pos()
+
+        class KeySlot(KaitaiStruct):
+
+            class KeySlotStates(Enum):
+                disabled_key_slot = 57005
+                enabled_key_slot = 11301363
+            SEQ_FIELDS = ["state_of_key_slot", "iteration_parameter", "salt_parameter", "start_sector_of_key_material", "number_of_anti_forensic_stripes"]
+            def __init__(self, _io, _parent=None, _root=None):
+                self._io = _io
+                self._parent = _parent
+                self._root = _root if _root else self
+                self._debug = collections.defaultdict(dict)
+
+            def _read(self):
+                self._debug['state_of_key_slot']['start'] = self._io.pos()
+                self.state_of_key_slot = KaitaiStream.resolve_enum(self._root.PartitionHeader.KeySlot.KeySlotStates, self._io.read_u4be())
+                self._debug['state_of_key_slot']['end'] = self._io.pos()
+                self._debug['iteration_parameter']['start'] = self._io.pos()
+                self.iteration_parameter = self._io.read_u4be()
+                self._debug['iteration_parameter']['end'] = self._io.pos()
+                self._debug['salt_parameter']['start'] = self._io.pos()
+                self.salt_parameter = self._io.read_bytes(32)
+                self._debug['salt_parameter']['end'] = self._io.pos()
+                self._debug['start_sector_of_key_material']['start'] = self._io.pos()
+                self.start_sector_of_key_material = self._io.read_u4be()
+                self._debug['start_sector_of_key_material']['end'] = self._io.pos()
+                self._debug['number_of_anti_forensic_stripes']['start'] = self._io.pos()
+                self.number_of_anti_forensic_stripes = self._io.read_u4be()
+                self._debug['number_of_anti_forensic_stripes']['end'] = self._io.pos()
+
+            @property
+            def key_material(self):
+                if hasattr(self, '_m_key_material'):
+                    return self._m_key_material if hasattr(self, '_m_key_material') else None
+
+                _pos = self._io.pos()
+                self._io.seek((self.start_sector_of_key_material * 512))
+                self._debug['_m_key_material']['start'] = self._io.pos()
+                self._m_key_material = self._io.read_bytes((self._parent.number_of_key_bytes * self.number_of_anti_forensic_stripes))
+                self._debug['_m_key_material']['end'] = self._io.pos()
+                self._io.seek(_pos)
+                return self._m_key_material if hasattr(self, '_m_key_material') else None
+
+
+
+    @property
+    def payload(self):
+        if hasattr(self, '_m_payload'):
+            return self._m_payload if hasattr(self, '_m_payload') else None
+
+        _pos = self._io.pos()
+        self._io.seek((self.partition_header.payload_offset * 512))
+        self._debug['_m_payload']['start'] = self._io.pos()
+        self._m_payload = self._io.read_bytes_full()
+        self._debug['_m_payload']['end'] = self._io.pos()
+        self._io.seek(_pos)
+        return self._m_payload if hasattr(self, '_m_payload') else None
+
+