psptool 2.8__tar.gz → 3.1__tar.gz

{psptool-2.8 → psptool-3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: psptool
-Version: 2.8
+Version: 3.1
 Summary: PSPTool is a tool for dealing with AMD binary blobs
 Home-page: https://github.com/PSPReverse/PSPTool
 Author: Christian Werling
@@ -13,9 +13,6 @@ Classifier: Programming Language :: Python :: 3.8
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: setuptools
-Requires-Dist: cryptography>=38.0.0
-Requires-Dist: prettytable
 
 # PSPTool
 
@@ -798,40 +795,41 @@ usage: psptool [-V | -E | -X | -R] [file]
 Display, extract, and manipulate AMD PSP firmware inside BIOS ROMs.
 
 positional arguments:
-  file                 Binary file to be parsed for PSP firmware
+  file                Binary file to be parsed for PSP firmware
 
 optional arguments:
   -V, --version
-  -E, --entries        Default: Parse and display PSP firmware entries.
-                       [-n] [-j] [-t]
-                       
-                       -n:      list unique entries only ordered by their offset
-                       -j:      output in JSON format instead of tables
-                       -t:      print tree of all signed entities and their certifying keys
-                       
-  -X, --extract-entry  Extract one or more PSP firmware entries.
-                       [[-r idx] -d idx [-e idx]] [-n] [-u] [-c] [-k] [-o outfile]
-                       
-                       -r idx:  specifies rom_index (default: 0)
-                       -d idx:  specifies directory_index (default: all directories)
-                       -e idx:  specifies entry_index (default: all entries)
-                       -n:      skip duplicate entries and extract unique entries only
-                       -u:      uncompress compressed entries
-                       -c:      try to decrypt entries
-                       -k:      convert pubkeys into PEM format
-                       -o file: specifies outfile/outdir (default: stdout/{file}_extracted)
-                       
-  -R, --replace-entry  Copy a new entry (including header and signature) into the
-                       ROM file and update metadata accordingly.
-                       [-r idx] -d idx -e idx -s subfile -o outfile [-p file-stub] [-a pass]
-                       
-                       -r idx:  specifies rom_index (default: 0)
-                       -d idx:  specifies directory_index
-                       -e idx:  specifies entry_index
-                       -s file: specifies subfile (i.e. the new entry contents)
-                       -o file: specifies outfile
-                       -p file: specifies file-stub (e.g. 'keys/id') for the re-signing keys
-                       -a pass: specifies password for the re-signing keys
+  -E, --entries       Default: Parse and display PSP firmware entries.
+                      [-n] [-j] [-t]
+
+                      -n:      list unique entries only ordered by their offset
+                      -j:      output in JSON format instead of tables
+                      -t:      print tree of all signed entities and their certifying keys
+                      -m:      print parsing metrics for testing
+
+  -X, --extract-file  Extract one or more PSP firmware files.
+                      [-d idx [-e idx]] [-n] [-u] [-c] [-k] [-o outfile]
+
+                      -r idx:  specifies rom_index (default: 0)
+                      -d idx:  specifies directory_index (default: all directories)
+                      -e idx:  specifies file_index (default: all files)
+                      -n:      skip duplicate files and extract unique files only
+                      -u:      uncompress compressed files
+                      -c:      try to decrypt files
+                      -k:      convert pubkeys into PEM format
+                      -o file: specifies outfile/outdir (default: stdout/{file}_extracted)
+
+  -R, --replace-file  Copy a new file (including header and signature) into the
+                      ROM file and update file and other metadata accordingly.
+                      -d idx -e idx -s subfile -o outfile [-p file-stub] [-a pass]
+
+                      -r idx:  specifies rom_index (default: 0)
+                      -d idx:  specifies directory_index
+                      -e idx:  specifies file_index
+                      -s file: specifies subfile (i.e. the new file contents)
+                      -o file: specifies outfile
+                      -p file: specifies file-stub (e.g. 'keys/id') for the re-signing keys
+                      -a pass: specifies password for the re-signing keys
 ```
 
 ## Python Usage
@@ -867,13 +865,13 @@ PSPTool can be **used as a Python module**, e.g. in an interactive IPython sessi
 |   |    14 |  0xeba00 |  0xbd60 | 0x36 |                             |  AR6B | 17.9.18.12 | OEM_PSP_FW_PUBLIC_KEY |
 |   |    15 | 0x149000 |   0x400 | 0x40 |    !PL2_SECONDARY_DIRECTORY |       |            |                       |
 +---+-------+----------+---------+------+-----------------------------+-------+------------+-----------------------+
-> psp.blob.roms[0].directories[0].entries[0]
-PubkeyEntry(type=0x0, address=0x77400, size=0x240, len(references)=1)
-> psp.blob.directories[0].entries[0].get_bytes()
+> psp.blob.roms[0].directories[0].files[0]
+PubkeyFile(type=0x0, address=0x77400, size=0x240, len(references)=1)
+> psp.blob.directories[0].files[0].get_bytes()
 b'\x01\x00\x00\x00\x1b\xb9\x87\xc3YIF\x06\xb1t\x94V\x01\xc9\xea[\x1b\xb9\x87\xc3YIF\x06\xb1t\x94V\x01\xc9\xea[\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00\x00\x08\x00\x00\x01\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'
 [...]
 > my_stuff = [...]
-> psp.blob.roms[0].directories[0].entries[1].move_buffer(0x60000, 0x1000)
+> psp.blob.roms[0].directories[0].files[1].move_buffer(0x60000, 0x1000)
 > psp.blob.roms[0].set_bytes(0x60000, 0x1000, my_stuff)
 > psp.to_file('my_modified_bios.bin')
 ```

{psptool-2.8 → psptool-3.1}/README.md

@@ -779,40 +779,41 @@ usage: psptool [-V | -E | -X | -R] [file]
 Display, extract, and manipulate AMD PSP firmware inside BIOS ROMs.
 
 positional arguments:
-  file                 Binary file to be parsed for PSP firmware
+  file                Binary file to be parsed for PSP firmware
 
 optional arguments:
   -V, --version
-  -E, --entries        Default: Parse and display PSP firmware entries.
-                       [-n] [-j] [-t]
-                       
-                       -n:      list unique entries only ordered by their offset
-                       -j:      output in JSON format instead of tables
-                       -t:      print tree of all signed entities and their certifying keys
-                       
-  -X, --extract-entry  Extract one or more PSP firmware entries.
-                       [[-r idx] -d idx [-e idx]] [-n] [-u] [-c] [-k] [-o outfile]
-                       
-                       -r idx:  specifies rom_index (default: 0)
-                       -d idx:  specifies directory_index (default: all directories)
-                       -e idx:  specifies entry_index (default: all entries)
-                       -n:      skip duplicate entries and extract unique entries only
-                       -u:      uncompress compressed entries
-                       -c:      try to decrypt entries
-                       -k:      convert pubkeys into PEM format
-                       -o file: specifies outfile/outdir (default: stdout/{file}_extracted)
-                       
-  -R, --replace-entry  Copy a new entry (including header and signature) into the
-                       ROM file and update metadata accordingly.
-                       [-r idx] -d idx -e idx -s subfile -o outfile [-p file-stub] [-a pass]
-                       
-                       -r idx:  specifies rom_index (default: 0)
-                       -d idx:  specifies directory_index
-                       -e idx:  specifies entry_index
-                       -s file: specifies subfile (i.e. the new entry contents)
-                       -o file: specifies outfile
-                       -p file: specifies file-stub (e.g. 'keys/id') for the re-signing keys
-                       -a pass: specifies password for the re-signing keys
+  -E, --entries       Default: Parse and display PSP firmware entries.
+                      [-n] [-j] [-t]
+
+                      -n:      list unique entries only ordered by their offset
+                      -j:      output in JSON format instead of tables
+                      -t:      print tree of all signed entities and their certifying keys
+                      -m:      print parsing metrics for testing
+
+  -X, --extract-file  Extract one or more PSP firmware files.
+                      [-d idx [-e idx]] [-n] [-u] [-c] [-k] [-o outfile]
+
+                      -r idx:  specifies rom_index (default: 0)
+                      -d idx:  specifies directory_index (default: all directories)
+                      -e idx:  specifies file_index (default: all files)
+                      -n:      skip duplicate files and extract unique files only
+                      -u:      uncompress compressed files
+                      -c:      try to decrypt files
+                      -k:      convert pubkeys into PEM format
+                      -o file: specifies outfile/outdir (default: stdout/{file}_extracted)
+
+  -R, --replace-file  Copy a new file (including header and signature) into the
+                      ROM file and update file and other metadata accordingly.
+                      -d idx -e idx -s subfile -o outfile [-p file-stub] [-a pass]
+
+                      -r idx:  specifies rom_index (default: 0)
+                      -d idx:  specifies directory_index
+                      -e idx:  specifies file_index
+                      -s file: specifies subfile (i.e. the new file contents)
+                      -o file: specifies outfile
+                      -p file: specifies file-stub (e.g. 'keys/id') for the re-signing keys
+                      -a pass: specifies password for the re-signing keys
 ```
 
 ## Python Usage
@@ -848,13 +849,13 @@ PSPTool can be **used as a Python module**, e.g. in an interactive IPython sessi
 |   |    14 |  0xeba00 |  0xbd60 | 0x36 |                             |  AR6B | 17.9.18.12 | OEM_PSP_FW_PUBLIC_KEY |
 |   |    15 | 0x149000 |   0x400 | 0x40 |    !PL2_SECONDARY_DIRECTORY |       |            |                       |
 +---+-------+----------+---------+------+-----------------------------+-------+------------+-----------------------+
-> psp.blob.roms[0].directories[0].entries[0]
-PubkeyEntry(type=0x0, address=0x77400, size=0x240, len(references)=1)
-> psp.blob.directories[0].entries[0].get_bytes()
+> psp.blob.roms[0].directories[0].files[0]
+PubkeyFile(type=0x0, address=0x77400, size=0x240, len(references)=1)
+> psp.blob.directories[0].files[0].get_bytes()
 b'\x01\x00\x00\x00\x1b\xb9\x87\xc3YIF\x06\xb1t\x94V\x01\xc9\xea[\x1b\xb9\x87\xc3YIF\x06\xb1t\x94V\x01\xc9\xea[\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00\x00\x08\x00\x00\x01\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'
 [...]
 > my_stuff = [...]
-> psp.blob.roms[0].directories[0].entries[1].move_buffer(0x60000, 0x1000)
+> psp.blob.roms[0].directories[0].files[1].move_buffer(0x60000, 0x1000)
 > psp.blob.roms[0].set_bytes(0x60000, 0x1000, my_stuff)
 > psp.to_file('my_modified_bios.bin')
 ```

{psptool-2.8 → psptool-3.1}/psptool/__init__.py

@@ -15,6 +15,6 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 from .psptool import PSPTool
+from importlib.metadata import version
 
-import pkg_resources
-__version__ = pkg_resources.get_distribution("psptool").version
+__version__ = version("psptool")

psptool-3.1/psptool/__main__.py

@@ -0,0 +1,282 @@
+# PSPTool - Display, extract and manipulate PSP firmware inside UEFI images
+# Copyright (C) 2021 Christian Werling, Robert Buhren, Hans Niklas Jacob
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+import sys
+import os
+import re
+
+from .psptool import PSPTool
+from . import __version__
+from .utils import ObligingArgumentParser, PrintHelper
+from .header_file import HeaderFile
+from .pubkey_file import PubkeyFile
+from .crypto import PrivateKeyDict
+
+from argparse import RawTextHelpFormatter, SUPPRESS
+
+
+def find_files_by_type_regex(psp, pattern, rom_index=0):
+    """Find files whose type matches the given regex pattern.
+
+    Returns a tuple of (matching_files, are_identical) where:
+    - matching_files: list of matching files
+    - are_identical: boolean indicating if all matching files have identical content
+    """
+    matching_files = []
+    regex = re.compile(pattern, re.IGNORECASE)
+
+    # Search through all directories in the specified ROM
+    for directory in psp.blob.roms[rom_index].directories:
+        for file in directory.files:
+            if file is not None:
+                file_type = file.get_readable_type()
+                if regex.search(file_type):
+                    matching_files.append(file)
+
+    # Check if all matching files are identical
+    are_identical = True
+    if len(matching_files) > 1:
+        first_bytes = matching_files[0].get_bytes()
+        for file in matching_files[1:]:
+            if file.get_bytes() != first_bytes:
+                are_identical = False
+                break
+
+    return matching_files, are_identical
+
+
+def main():
+    # CLI stuff to create a PSPTool object and interact with it
+    parser = ObligingArgumentParser(description='Display, extract, and manipulate AMD PSP firmware inside BIOS ROMs.\n',
+                                    formatter_class=RawTextHelpFormatter, add_help=False)
+
+    parser.add_argument('file', help='Binary file to be parsed for PSP firmware', nargs='?')
+    parser.add_argument('-h', '--help', action='help', help=SUPPRESS)
+    parser.add_argument('-v', '--verbose', help=SUPPRESS, action='store_true')
+
+    parser.add_argument('-r', '--rom-index', help=SUPPRESS, type=int, default=0)
+    parser.add_argument('-d', '--directory-index', help=SUPPRESS, type=int)
+    parser.add_argument('-e', '--file-index', help=SUPPRESS, type=int)
+    parser.add_argument('-s', '--subfile', help=SUPPRESS)
+    parser.add_argument('-o', '--outfile', help=SUPPRESS)
+    parser.add_argument('-u', '--decompress', help=SUPPRESS, action='store_true')
+    parser.add_argument('-c', '--decrypt', help=SUPPRESS, action='store_true')
+    parser.add_argument('-k', '--pem-key', help=SUPPRESS, action='store_true')
+    parser.add_argument('-n', '--no-duplicates', help=SUPPRESS, action='store_true')
+    parser.add_argument('-j', '--json', help=SUPPRESS, action='store_true')
+    parser.add_argument('-t', '--key-tree', help=SUPPRESS, action='store_true')
+    parser.add_argument('-m', '--metrics', help=SUPPRESS, action='store_true')
+    parser.add_argument('-p', '--privkeystub', help=SUPPRESS)
+    parser.add_argument('-a', '--privkeypass', help=SUPPRESS)
+    parser.add_argument('-T', '--type-regex', help=SUPPRESS)
+
+    action = parser.add_mutually_exclusive_group(required=False)
+
+    action.add_argument('-V', '--version', action='store_true')
+
+    action.add_argument('-E', '--entries', help='\n'.join([
+        'Default: Parse and display PSP firmware entries.',
+        '[-n] [-j] [-t]',
+        '',
+        '-n:      list unique entries only ordered by their offset',
+        '-j:      output in JSON format instead of tables',
+        '-t:      print tree of all signed entities and their certifying keys',
+        '-m:      print parsing metrics for testing',
+        '', '']), action='store_true')
+
+    action.add_argument('-X', '--extract-file', help='\n'.join([
+        'Extract one or more PSP firmware files.',
+        '[-d idx [-e idx]] [-n] [-u] [-c] [-k] [-o outfile] [-T regex]',
+        '',
+        '-r idx:  specifies rom_index (default: ROM 0 only)',
+        '-d idx:  specifies directory_index (default: all directories)',
+        '-e idx:  specifies file_index (default: all files)',
+        '-T regex: extract file(s) whose type matches the regex pattern',
+        '          (e.g., "SMUSCS" matches "FW_PSP_SMUSCS~0x5f")',
+        '          If multiple identical files match, extracts one with warning',
+        '          If multiple different files match, exits with error',
+        '-n:      skip duplicate files and extract unique files only',
+        '-u:      uncompress compressed files',
+        '-c:      try to decrypt files',
+        '-k:      convert pubkeys into PEM format',
+        '-o file: specifies outfile/outdir (default: stdout/{file}_extracted)',
+        '', '']), action='store_true')
+
+    action.add_argument('-R', '--replace-file', help='\n'.join([
+        'Copy a new file (including header and signature) into the',
+        'ROM file and update file and other metadata accordingly.',
+        '-d idx -e idx -s subfile -o outfile [-p file-stub] [-a pass]',
+        '',
+        '-r idx:  specifies rom_index (default: 0)',
+        '-d idx:  specifies directory_index',
+        '-e idx:  specifies file_index',
+        '-s file: specifies subfile (i.e. the new file contents)',
+        '-o file: specifies outfile',
+        '-p file: specifies file-stub (e.g. \'keys/id\') for the re-signing keys',
+        '-a pass: specifies password for the re-signing keys'
+        '', '']), action='store_true')
+
+    args = parser.parse_args()
+    ph = PrintHelper(args.verbose)
+
+    if args.version:
+        print(__version__)
+        sys.exit(0)
+    elif not args.file:
+        parser.print_help(sys.stderr)
+        sys.exit(0)
+
+    psp = PSPTool.from_file(args.file, verbose=args.verbose)
+    output = None
+
+    if args.extract_file:
+        file = None
+
+        # Option 1) A single file should be extracted and we get it from a regex-based type search
+        if args.type_regex:
+            matching_files, are_identical = find_files_by_type_regex(psp, args.type_regex, args.rom_index)
+
+            if not matching_files:
+                ph.print_error_and_exit(f'No files found matching type regex: {args.type_regex}')
+            elif len(matching_files) > 1:
+                if are_identical:
+                    ph.print_warning(f'Found {len(matching_files)} files matching "{args.type_regex}" but they are identical. Extracting one of them.')
+                    file = matching_files[0]
+                else:
+                    ph.print_error_and_exit(f'Found {len(matching_files)} files matching "{args.type_regex}" but they have different contents. Not extracting any.')
+            else:
+                file = matching_files[0]
+
+        elif args.directory_index is not None and args.file_index is not None:
+            # Option 2) A single file should be extracted and we get it from (rom_index, directory_index, file_index)
+            file = psp.blob.roms[args.rom_index].directories[args.directory_index].files[args.file_index]
+
+        if file:
+            # For Options 1 and 2, do additional extraction magic if requested
+            if args.decompress:
+                if not file.compressed:
+                    ph.print_error_and_exit(f'File is not compressed {file.get_readable_type()}')
+                output = file.get_signed_bytes()
+            elif args.decrypt:
+                if not file.encrypted:
+                    ph.print_error_and_exit(f'File is not encrypted {file.get_readable_type()}')
+                output = file.to_decrypted_file_bytes()
+            elif args.pem_key:
+                output = file.get_pem_encoded()
+            else:
+                output = file.get_bytes()
+
+        # Option 3) Multiple files should be extracted
+        if args.file_index is None:
+            if args.directory_index is not None: # Option 3a) All files from a given directory_index
+                directories = [psp.blob.roms[args.rom_index].directories[args.directory_index]]
+            else: # Option 3b) All files from all directories from the given ROM (default: 0)
+                directories = psp.blob.roms[args.rom_index].directories
+
+            if args.no_duplicates is False:
+                outdir = args.outfile or f'./{psp.filename}_extracted'
+                for dir_index, directory in enumerate(directories):
+                    for file_index, file in enumerate(directory.files):
+                        if args.decompress and type(file) is HeaderFile:
+                            out_bytes = file.get_signed_bytes()
+                        elif args.decrypt and type(file) is HeaderFile:
+                            out_bytes = file.get_decrypted()
+                        elif args.pem_key and type(file) is PubkeyFile:
+                            out_bytes = file.get_pem_encoded()
+                        else:
+                            out_bytes = file.get_bytes()
+
+                        outpath = outdir + '/d%.2d_e%.2d_%s' % (dir_index, file_index, file.get_readable_type())
+                        if type(file) is HeaderFile:
+                            outpath += f'_{file.get_readable_version()}'
+
+                        os.makedirs(os.path.dirname(outpath), exist_ok=True)
+                        with open(outpath, 'wb') as f:
+                            f.write(out_bytes)
+            else:  # no_duplicates is True
+                for file in psp.blob.unique_files():
+                    if args.decompress and type(file) is HeaderFile:
+                        out_bytes = file.get_signed_bytes()
+                    elif args.decrypt and type(file) is HeaderFile:
+                        out_bytes = file.get_decrypted()
+                    elif args.pem_key and type(file) is PubkeyFile:
+                        out_bytes = file.get_pem_encoded()
+                    else:
+                        out_bytes = file.get_bytes()
+
+                    outdir = args.outfile or f'./{psp.filename}_unique_extracted'
+                    outpath = outdir + '/%s' % (file.get_readable_type())
+
+                    if issubclass(type(file), HeaderFile):
+                        outpath += f'_{file.get_readable_version()}'
+
+                    os.makedirs(os.path.dirname(outpath), exist_ok=True)
+                    with open(outpath, 'wb') as f:
+                        f.write(out_bytes)
+            ph.print_info(f"Extracted all files to {outdir}")
+        else:
+            parser.print_help(sys.stderr)
+
+    elif args.replace_file:
+        if args.directory_index is not None and args.file_index is not None and args.outfile is not None:
+            file = psp.blob.roms[args.rom_index].directories[args.directory_index].files[args.file_index]
+
+            # Substituting an file is actually optional to allow plain re-signs
+            if args.subfile is not None:
+                with open(args.subfile, 'rb') as f:
+                    sub_binary = f.read()
+                # Keep the existing file's address, but adapt its size
+                file.move_buffer(file.get_address(), len(sub_binary))
+                file.set_bytes(0, len(sub_binary), sub_binary)
+
+            privkeys = None
+            if args.privkeystub:
+                privkeys = PrivateKeyDict.read_from_files(args.privkeystub, args.privkeypass)
+
+            if hasattr(file, 'signed_entity') and file.signed_entity:
+                file.signed_entity.resign_and_replace(privkeys=privkeys, recursive=True)
+            else:
+                ph.print_warning("Did not resign anything since target file is not signed")
+
+            psp.to_file(args.outfile)
+
+            if privkeys:
+                privkeys.save_to_files(args.privkeystub, args.privkeypass)
+        else:
+            parser.print_help(sys.stderr)
+    else:
+        if args.json:
+            psp.ls_json(verbose=args.verbose)
+        elif args.key_tree:
+            psp.cert_tree.print_key_tree()
+        elif args.metrics:
+            psp.print_metrics()
+        elif args.no_duplicates:
+            psp.ls_files(verbose=args.verbose)
+        else:
+            psp.ls(verbose=args.verbose)
+
+    # Output handling (stdout or outfile)
+    if output is not None:
+        if args.outfile is None:
+            sys.stdout.buffer.write(output)
+        else:
+            with open(args.outfile, 'wb') as f:
+                f.write(output)
+
+
+if __name__ == '__main__':
+    main()