BIOSUtilities v24.10.01

Complete repository overhaul into python project
Re-designed BIOSUtility base template class flow
Re-structured utilities as BIOSUtility inherited
Re-structured project for 3rd-party compatibility
Unified project requirements and package version
Code overhaul with type hints and linting support
Switched external executable dependencies via PATH
BIOSUtility enforces simple check and parse methods
Utilities now work with both path and buffer inputs
Adjusted class, method, function names and parameters
Improved Dell PFS Update Extractor sub-PFAT processing
Improved Award BIOS Module Extractor corruption handling
Improved Apple EFI Image Identifier to expose the EFI ID
Improved Insyde iFlash/iFdPacker Extractor with ISH & PDT
Re-written Apple EFI Package Extractor to support all PKG

biosutilities/vaio_package_extract.py

@@ -0,0 +1,181 @@
+#!/usr/bin/env python3 -B
+# coding=utf-8
+
+"""
+VAIO Package Extractor
+VAIO Packaging Manager Extractor
+Copyright (C) 2019-2024 Plato Mavropoulos
+"""
+
+import os
+
+from re import Match
+
+from biosutilities.common.compression import is_szip_supported, szip_decompress
+from biosutilities.common.paths import make_dirs
+from biosutilities.common.patterns import PAT_VAIO_CAB, PAT_VAIO_CFG, PAT_VAIO_CHK, PAT_VAIO_EXT
+from biosutilities.common.system import printer
+from biosutilities.common.templates import BIOSUtility
+from biosutilities.common.texts import file_to_bytes
+
+
+class VaioPackageExtract(BIOSUtility):
+    """ VAIO Packaging Manager Extractor """
+
+    TITLE: str = 'VAIO Packaging Manager Extractor'
+
+    def check_format(self, input_object: str | bytes | bytearray) -> bool:
+        """ Check if input is VAIO Packaging Manager """
+
+        input_buffer: bytes = file_to_bytes(in_object=input_object)
+
+        return bool(PAT_VAIO_CFG.search(string=input_buffer))
+
+    def parse_format(self, input_object: str | bytes | bytearray, extract_path: str, padding: int = 0) -> int:
+        """ Parse & Extract or Unlock VAIO Packaging Manager """
+
+        input_buffer: bytes = file_to_bytes(input_object)
+
+        input_name: str = os.path.basename(input_object) if isinstance(input_buffer, str) else 'VAIO_Package'
+
+        make_dirs(in_path=extract_path, delete=True)
+
+        if self._vaio_cabinet(name=input_name, buffer=input_buffer, extract_path=extract_path, padding=padding) == 0:
+            printer(message='Successfully Extracted!', padding=padding)
+        elif self._vaio_unlock(name=input_name, buffer=input_buffer, extract_path=extract_path, padding=padding) == 0:
+            printer(message='Successfully Unlocked!', padding=padding)
+        else:
+            printer(message='Error: Failed to Extract or Unlock executable!', padding=padding)
+
+            return 1
+
+        return 0
+
+    @staticmethod
+    def _vaio_cabinet(name: str, buffer: bytes | bytearray, extract_path: str, padding: int = 0) -> int:
+        """ Extract VAIO Packaging Manager executable """
+
+        # Microsoft CAB Header XOR 0xFF
+        match_cab: Match[bytes] | None = PAT_VAIO_CAB.search(string=buffer)
+
+        if not match_cab:
+            return 1
+
+        printer(message='Detected obfuscated CAB archive!', padding=padding)
+
+        # Get LE XOR CAB size
+        cab_size: int = int.from_bytes(bytes=buffer[match_cab.start() + 0x8:match_cab.start() + 0xC],
+                                       byteorder='little')
+
+        # Create CAB size XOR value
+        xor_size: int = int.from_bytes(bytes=b'\xFF' * 0x4, byteorder='little')
+
+        # Perform XOR 0xFF and get actual CAB size
+        cab_size ^= xor_size
+
+        printer(message='Removing obfuscation...', padding=padding + 4)
+
+        # Get BE XOR CAB data
+        cab_data: int = int.from_bytes(bytes=buffer[match_cab.start():match_cab.start() + cab_size], byteorder='big')
+
+        # Create CAB data XOR value
+        xor_data: int = int.from_bytes(bytes=b'\xFF' * cab_size, byteorder='big')
+
+        # Perform XOR 0xFF and get actual CAB data
+        raw_data: bytes = (cab_data ^ xor_data).to_bytes(cab_size, 'big')
+
+        printer(message='Extracting archive...', padding=padding + 4)
+
+        cab_path: str = os.path.join(extract_path, f'{name}_Temporary.cab')
+
+        # Create temporary CAB archive
+        with open(file=cab_path, mode='wb') as cab_file:
+            cab_file.write(raw_data)
+
+        if is_szip_supported(in_path=cab_path, padding=padding + 8, silent=False):
+            if szip_decompress(in_path=cab_path, out_path=extract_path, in_name='VAIO CAB',
+                               padding=padding + 8, check=True) == 0:
+                os.remove(path=cab_path)
+            else:
+                return 3
+        else:
+            return 2
+
+        return 0
+
+    @staticmethod
+    def _vaio_unlock(name: str, buffer: bytes | bytearray, extract_path: str, padding: int = 0) -> int:
+        """ Unlock VAIO Packaging Manager executable """
+
+        input_buffer: bytearray = bytearray(buffer) if isinstance(buffer, bytes) else buffer
+
+        match_cfg: Match[bytes] | None = PAT_VAIO_CFG.search(string=input_buffer)
+
+        if not match_cfg:
+            return 1
+
+        printer(message='Attempting to Unlock executable!', padding=padding)
+
+        # Initialize VAIO Package Configuration file variables (assume overkill size of 0x500)
+        cfg_bgn, cfg_end, cfg_false, cfg_true = [match_cfg.start(), match_cfg.start() + 0x500, b'', b'']
+
+        # Get VAIO Package Configuration file info, split at new_line and stop at payload DOS header (EOF)
+        cfg_info: list[bytearray] = input_buffer[cfg_bgn:cfg_end].split(
+            b'\x0D\x0A\x4D\x5A')[0].replace(b'\x0D', b'').split(b'\x0A')
+
+        printer(message='Retrieving True/False values...', padding=padding + 4)
+
+        # Determine VAIO Package Configuration file True & False values
+        for info in cfg_info:
+            if info.startswith(b'ExtractPathByUser='):
+                # Should be 0/No/False
+                cfg_false = bytearray(b'0' if info[18:] in (b'0', b'1') else info[18:])
+
+            if info.startswith(b'UseCompression='):
+                # Should be 1/Yes/True
+                cfg_true = bytearray(b'1' if info[15:] in (b'0', b'1') else info[15:])
+
+        # Check if valid True/False values have been retrieved
+        if cfg_false == cfg_true or not cfg_false or not cfg_true:
+            printer(message='Error: Could not retrieve True/False values!', padding=padding + 8)
+
+            return 2
+
+        printer(message='Adjusting UseVAIOCheck entry...', padding=padding + 4)
+
+        # Find and replace UseVAIOCheck entry from 1/Yes/True to 0/No/False
+        vaio_check: Match[bytes] | None = PAT_VAIO_CHK.search(string=input_buffer[cfg_bgn:])
+
+        if vaio_check:
+            input_buffer[cfg_bgn + vaio_check.end():cfg_bgn + vaio_check.end() + len(cfg_true)] = cfg_false
+        else:
+            printer(message='Error: Could not find entry UseVAIOCheck!', padding=padding + 8)
+
+            return 3
+
+        printer(message='Adjusting ExtractPathByUser entry...', padding=padding + 4)
+
+        # Find and replace ExtractPathByUser entry from 0/No/False to 1/Yes/True
+        user_path: Match[bytes] | None = PAT_VAIO_EXT.search(string=input_buffer[cfg_bgn:])
+
+        if user_path:
+            input_buffer[cfg_bgn + user_path.end():cfg_bgn + user_path.end() + len(cfg_false)] = cfg_true
+        else:
+            printer(message='Error: Could not find entry ExtractPathByUser!', padding=padding + 8)
+
+            return 4
+
+        printer(message='Storing unlocked executable...', padding=padding + 4)
+
+        # Store Unlocked VAIO Packaging Manager executable
+        if vaio_check and user_path:
+            unlock_path: str = os.path.join(extract_path, f'{name}_Unlocked.exe')
+
+            with open(file=unlock_path, mode='wb') as unl_file:
+                unl_file.write(input_buffer)
+
+        return 0
+
+
+if __name__ == '__main__':
+    VaioPackageExtract().run_utility()