ReverseBox 0.23.2__tar.gz → 0.23.4__tar.gz

{reversebox-0.23.2 → reversebox-0.23.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ReverseBox
-Version: 0.23.2
+Version: 0.23.4
 Summary: A set of functions useful in reverse engineering.
 Home-page: https://github.com/bartlomiejduda/ReverseBox
 Author: Bartlomiej Duda
@@ -109,6 +109,7 @@ or software researchers).
   - ROT13 ✔️
   - XOR Cipher (Basic) ✔️
   - XOR Cipher (Basic) Guesser ✔️
+  - Hatch Engine Encryption ✔️
   - (game-specific) XOR Cipher (Retro64 ECO) ✔️
   - (game-specific) XOR Cipher (Giana’s Return ZDA) ✔️
 

{reversebox-0.23.2 → reversebox-0.23.4}/README.md

@@ -74,6 +74,7 @@ or software researchers).
   - ROT13 ✔️
   - XOR Cipher (Basic) ✔️
   - XOR Cipher (Basic) Guesser ✔️
+  - Hatch Engine Encryption ✔️
   - (game-specific) XOR Cipher (Retro64 ECO) ✔️
   - (game-specific) XOR Cipher (Giana’s Return ZDA) ✔️
 

{reversebox-0.23.2 → reversebox-0.23.4}/ReverseBox.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ReverseBox
-Version: 0.23.2
+Version: 0.23.4
 Summary: A set of functions useful in reverse engineering.
 Home-page: https://github.com/bartlomiejduda/ReverseBox
 Author: Bartlomiej Duda
@@ -109,6 +109,7 @@ or software researchers).
   - ROT13 ✔️
   - XOR Cipher (Basic) ✔️
   - XOR Cipher (Basic) Guesser ✔️
+  - Hatch Engine Encryption ✔️
   - (game-specific) XOR Cipher (Retro64 ECO) ✔️
   - (game-specific) XOR Cipher (Giana’s Return ZDA) ✔️
 

{reversebox-0.23.2 → reversebox-0.23.4}/ReverseBox.egg-info/SOURCES.txt

@@ -41,6 +41,7 @@ reversebox/crc/crc64_go_iso.py
 reversebox/crc/crc8.py
 reversebox/crc/crc_unix_cksum.py
 reversebox/encryption/__init__.py
+reversebox/encryption/encryption_hatch_engine.py
 reversebox/encryption/encryption_rot13.py
 reversebox/encryption/encryption_xor_basic.py
 reversebox/encryption/encryption_xor_basic_key_guesser.py

reversebox-0.23.4/reversebox/encryption/encryption_hatch_engine.py

@@ -0,0 +1,69 @@
+"""
+Copyright © 2025  Bartłomiej Duda
+License: GPL-3.0 License
+"""
+
+from reversebox.crc.crc32_iso_hdlc import CRC32Handler
+from reversebox.io_files.bytes_helper_functions import set_uint32, set_uint64
+
+# Encryption algorithm used in Hatch Engine games
+# e.g. Data.hatch archive from "Sonic Galactic" (Demo 2) game
+
+
+def decrypt_hatch_data(f_data: bytes, filename: str, f_size: int) -> bytes:
+    crc_handler = CRC32Handler()
+    keyA: bytearray = bytearray(16)
+    keyB: bytearray = bytearray(16)
+    decrypted_data: bytearray = bytearray(f_data)
+
+    filename_hash: int = crc_handler.calculate_crc32(filename.encode("ascii"))
+    encoded_filename_hash: bytes = set_uint32(filename_hash, "<")
+    encoded_size_value: bytes = set_uint64(f_size, "<")
+    size_hash: int = crc_handler.calculate_crc32(encoded_size_value)
+    encoded_size_hash: bytes = set_uint32(size_hash, "<")
+
+    for i in range(4):
+        keyA[i * 4 : (i + 1) * 4] = encoded_filename_hash
+
+    for i in range(4):
+        keyB[i * 4 : (i + 1) * 4] = encoded_size_hash
+
+    swap_nibbles: int = 0
+    index_keyA: int = 0
+    index_keyB: int = 8
+
+    xor_value = (f_size >> 2) & 0x7F
+
+    for x in range(f_size):
+        temp = decrypted_data[x]
+
+        temp ^= xor_value ^ keyB[index_keyB]
+        index_keyB += 1
+
+        if swap_nibbles:
+            temp = ((temp & 0x0F) << 4) | ((temp & 0xF0) >> 4)
+
+        temp ^= keyA[index_keyA]
+        index_keyA += 1
+
+        decrypted_data[x] = temp
+
+        if index_keyA <= 15:
+            if index_keyB > 12:
+                index_keyB = 0
+                swap_nibbles ^= 1
+        elif index_keyB <= 8:
+            index_keyA = 0
+            swap_nibbles ^= 1
+        else:
+            xor_value = (xor_value + 2) & 0x7F
+            if swap_nibbles:
+                swap_nibbles = 0
+                index_keyA = xor_value % 7
+                index_keyB = (xor_value % 12) + 2
+            else:
+                swap_nibbles = 1
+                index_keyA = (xor_value % 12) + 3
+                index_keyB = xor_value % 7
+
+    return decrypted_data

{reversebox-0.23.2 → reversebox-0.23.4}/reversebox/io_files/file_handler.py

@@ -16,18 +16,22 @@ from reversebox.io_files.bytes_helper_functions import (
     get_int16,
     get_int24,
     get_int32,
+    get_int64,
     get_uint8,
     get_uint16,
     get_uint24,
     get_uint32,
+    get_uint64,
     set_int8,
     set_int16,
     set_int24,
     set_int32,
+    set_int64,
     set_uint8,
     set_uint16,
     set_uint24,
     set_uint32,
+    set_uint64,
 )
 
 logger = get_logger(__name__)
@@ -218,6 +222,18 @@ class FileHandler:
         data = self.file.read(4)
         return get_uint32(data, self.endianess)
 
+    def read_int64(self) -> int:
+        self._check_file()
+        self._check_read_mode()
+        data = self.file.read(8)
+        return get_int64(data, self.endianess)
+
+    def read_uint64(self) -> int:
+        self._check_file()
+        self._check_read_mode()
+        data = self.file.read(8)
+        return get_uint64(data, self.endianess)
+
     ###
     ###
     ###
@@ -288,3 +304,15 @@ class FileHandler:
         self._check_write_mode()
         self.file.write(set_uint32(value, self.endianess))
         return True
+
+    def write_int64(self, value: int) -> bool:
+        self._check_file()
+        self._check_write_mode()
+        self.file.write(set_int64(value, self.endianess))
+        return True
+
+    def write_uint64(self, value: int) -> bool:
+        self._check_file()
+        self._check_write_mode()
+        self.file.write(set_uint64(value, self.endianess))
+        return True

{reversebox-0.23.2 → reversebox-0.23.4}/setup.py

@@ -8,7 +8,7 @@ from typing import Final
 
 import setuptools
 
-VERSION_NUM: Final[str] = "0.23.2"
+VERSION_NUM: Final[str] = "0.23.4"
 
 
 def get_long_description() -> str: