scripts: Fix ruff issues

Fixed all ruff's issues from PR #2502.

Signed-off-by: Lukasz Fundakowski <[email protected]>

Author: fundakol

ci/fih_test_docker/damage_image.py

@@ -114,7 +114,9 @@ def __len__(self):
 
 def get_arguments():
     parser = argparse.ArgumentParser(description='Corrupt an MCUBoot image')
-    parser.add_argument("-i", "--in-file", required=True, help='The input image to be corrupted (read only)')
+    parser.add_argument(
+        "-i", "--in-file", required=True, help='The input image to be corrupted (read only)'
+    )
     parser.add_argument("-o", "--out-file", required=True, help='the corrupted image')
     parser.add_argument('-a', '--image-hash',
                         default=False,
@@ -147,7 +149,10 @@ def damage_image(args, in_file, out_file_content, image_offset):
     # Find the Image header
     image_header = ImageHeader.read_from_binary(in_file)
     if image_header.ih_magic != IMAGE_MAGIC:
-        raise Exception(f"Invalid magic in image_header: 0x{image_header.ih_magic:X} instead of 0x{IMAGE_MAGIC:X}")
+        raise Exception(
+            f"Invalid magic in image_header: 0x{image_header.ih_magic:X} "
+            "instead of 0x{IMAGE_MAGIC:X}"
+        )
 
     # Find the TLV header
     tlv_info_offset = image_header.ih_hdr_size + image_header.ih_img_size
@@ -157,7 +162,10 @@ def damage_image(args, in_file, out_file_content, image_offset):
     if tlv_info.it_magic == TLV_PROT_INFO_MAGIC:
         logging.debug(f"Protected TLV found at offset 0x{tlv_info_offset:X}")
         if image_header.ih_protect_tlv_size != tlv_info.it_tlv_tot:
-            raise Exception(f"Invalid prot TLV len ({image_header.ih_protect_tlv_size:d} vs. {tlv_info.it_tlv_tot:d})")
+            raise Exception(
+                f"Invalid prot TLV len ({image_header.ih_protect_tlv_size:d} "
+                "vs. {tlv_info.it_tlv_tot:d})"
+            )
 
         # seek to unprotected TLV
         tlv_info_offset += tlv_info.it_tlv_tot
@@ -170,7 +178,9 @@ def damage_image(args, in_file, out_file_content, image_offset):
 
     logging.debug(f"Unprotected TLV found at offset 0x{tlv_info_offset:X}")
     if tlv_info.it_magic != TLV_INFO_MAGIC:
-        raise Exception(f"Invalid magic in tlv info: 0x{tlv_info.it_magic:X} instead of 0x{TLV_INFO_MAGIC:X}")
+        raise Exception(
+            f"Invalid magic in tlv info: 0x{tlv_info.it_magic:X} instead of 0x{TLV_INFO_MAGIC:X}"
+        )
 
     tlv_off = tlv_info_offset + len(ImageTLVInfo())
     tlv_end = tlv_info_offset + tlv_info.it_tlv_tot
@@ -180,9 +190,15 @@ def damage_image(args, in_file, out_file_content, image_offset):
         in_file.seek(image_offset + tlv_off, 0)
         tlv = ImageTLV.read_from_binary(in_file)
 
-        logging.debug(f"    tlv {get_tlv_type_string(tlv.it_type):24s} len = {tlv.it_len:4d}, len = {len(tlv):4d}")
+        logging.debug(
+            f"    tlv {get_tlv_type_string(tlv.it_type):24s} "
+            "len = {tlv.it_len:4d}, len = {len(tlv):4d}"
+        )
 
-        if is_valid_signature(tlv) and args.signature or tlv.it_type == TLV_VALUES['SHA256'] and args.image_hash:
+        if (
+            is_valid_signature(tlv) and args.signature
+            or tlv.it_type == TLV_VALUES['SHA256'] and args.image_hash
+        ):
             damage_tlv(image_offset, tlv_off, tlv, out_file_content)
 
         tlv_off += len(tlv)
@@ -194,17 +210,13 @@ def main():
     logging.debug("The script was started")
 
     copyfile(args.in_file, args.out_file)
-    in_file = open(args.in_file, 'rb')
+    with open(args.in_file, 'rb') as in_file:
+        out_file_content = bytearray(in_file.read())
 
-    out_file_content = bytearray(in_file.read())
+        damage_image(args, in_file, out_file_content, 0)
 
-    damage_image(args, in_file, out_file_content, 0)
-
-    in_file.close()
-
-    file_to_damage = open(args.out_file, 'wb')
-    file_to_damage.write(out_file_content)
-    file_to_damage.close()
+    with open(args.out_file, 'wb') as file_to_damage:
+        file_to_damage.write(out_file_content)
 
 
 if __name__ == "__main__":

ci/fih_test_docker/generate_test_report.py

@@ -23,20 +23,28 @@ def print_results(results):
 
     print("{:s}: {:d}.".format(CATEGORIES['TOTAL'], test_stats[CATEGORIES['TOTAL']]))
     print("{:s} ({:d}):".format(CATEGORIES['SUCCESS'], test_stats[CATEGORIES['SUCCESS']]))
-    print("    {:s}: ({:d}):".format(CATEGORIES['ADDRES_NOEXEC'], test_stats[CATEGORIES['ADDRES_NOEXEC']]))
+    print("    {:s}: ({:d}):".format(
+        CATEGORIES['ADDRES_NOEXEC'], test_stats[CATEGORIES['ADDRES_NOEXEC']])
+    )
     test_with_skip = test_stats[CATEGORIES['SUCCESS']] - test_stats[CATEGORIES['ADDRES_NOEXEC']]
     print("    {:s}: ({:d}):".format(CATEGORIES['SKIPPED'], test_with_skip))
-    print("    {:s} ({:d}):".format(CATEGORIES['NO_BOOT'], test_with_skip - test_stats[CATEGORIES['BOOT']]))
+    print("    {:s} ({:d}):".format(
+        CATEGORIES['NO_BOOT'], test_with_skip - test_stats[CATEGORIES['BOOT']])
+    )
     for last_line in failed_boot_last_lines:
         print(f"        last line: {last_line:s} ({failed_boot_last_lines[last_line]:d})")
     print("    {:s} ({:d})".format(CATEGORIES['BOOT'], test_stats[CATEGORIES['BOOT']]))
-    print("{:s} ({:d}):".format(CATEGORIES['FAILED'], test_stats[CATEGORIES['TOTAL']] - test_stats[CATEGORIES['SUCCESS']]))
+    print("{:s} ({:d}):".format(
+        CATEGORIES['FAILED'], test_stats[CATEGORIES['TOTAL']] - test_stats[CATEGORIES['SUCCESS']])
+    )
     for reason in exec_fail_reasons:
         print(f"    {reason:s} ({exec_fail_reasons[reason]:d})")
 
 
 def main():
-    parser = argparse.ArgumentParser(description='''Process a FIH test output yaml file, and output a human readable report''')
+    parser = argparse.ArgumentParser(
+        description='''Process a FIH test output yaml file, and output a human readable report'''
+    )
     parser.add_argument('filename', help='yaml file to process')
 
     args = parser.parse_args()

ci/get_features.py

@@ -16,29 +16,38 @@
 
 import argparse
 import os.path
+import sys
 
 try:
     import tomllib
 except ModuleNotFoundError:
     import tomli as tomllib
 
-parser = argparse.ArgumentParser(description='Print features from a Cargo.toml.')
-parser.add_argument('infile', help='Input file to parse')
 
-args = parser.parse_args()
-if not os.path.isfile(args.infile):
-    print("File not found")
-    exit(1)
+def main() -> int:
+    parser = argparse.ArgumentParser(description='Print features from a Cargo.toml.')
+    parser.add_argument('infile', help='Input file to parse')
 
-try:
-    cargo_toml = open(args.infile).read()
-except Exception:
-    print(f"Error reading \"{args.infile}\"")
-    exit(1)
+    args = parser.parse_args()
+    if not os.path.isfile(args.infile):
+        print("File not found")
+        return 1
+
+    try:
+        with open(args.infile) as file:
+            cargo_toml = file.read()
+    except Exception:
+        print(f"Error reading \"{args.infile}\"")
+        return 1
+
+    config = tomllib.loads(cargo_toml)
+    if 'features' not in config:
+        print("Missing \"[features]\" section")
+        return 1
+
+    print(" ".join([k for k in config['features'] if k != 'default']))
+    return 0
 
-config = tomllib.loads(cargo_toml)
-if 'features' not in config:
-    print("Missing \"[features]\" section")
-    exit(1)
 
-print(" ".join([k for k in config['features'] if k != 'default']))
+if __name__ == "__main__":
+    sys.exit(main())

scripts/assemble.py

@@ -36,7 +36,9 @@ def same_keys(a, b):
             return False
     return all(bk in a for bk in b)
 
-offset_re = re.compile(r"^#define DT_FLASH_AREA_([0-9A-Z_]+)_OFFSET(_0)?\s+(0x[0-9a-fA-F]+|[0-9]+)$")
+offset_re = re.compile(
+    r"^#define DT_FLASH_AREA_([0-9A-Z_]+)_OFFSET(_0)?\s+(0x[0-9a-fA-F]+|[0-9]+)$"
+)
 size_re   = re.compile(r"^#define DT_FLASH_AREA_([0-9A-Z_]+)_SIZE(_0)?\s+(0x[0-9a-fA-F]+|[0-9]+)$")
 
 class Assembly:

scripts/imgtool/boot_record.py

@@ -48,5 +48,6 @@ def create_sw_component_data(sw_type, sw_version, sw_measurement_description,
     # Note: The measurement value must be the last item of the property
     #       list because later it will be modified by the bootloader.
     last_key = list(properties.keys())[-1]
-    assert last_key == SwComponent.MEASUREMENT_VALUE, 'Measurement value is not the last item of the property list'
+    assert last_key == SwComponent.MEASUREMENT_VALUE, \
+        'Measurement value is not the last item of the property list'
     return dumps(properties)

scripts/imgtool/dumpinfo.py

@@ -62,7 +62,11 @@ def parse_size(size_hex):
 
 
 def parse_status(status_hex):
-    return f"{STATUS[status_hex]} ({status_hex})" if status_hex in STATUS else f"INVALID ({status_hex})"
+    return (
+        f"{STATUS[status_hex]} ({status_hex})"
+        if status_hex in STATUS
+        else f"INVALID ({status_hex})"
+    )
 
 
 def parse_boot_magic(trailer_magic):
@@ -131,7 +135,7 @@ def dump_imginfo(imgfile, outfile=None, silent=False):
         with open(imgfile, "rb") as f:
             b = f.read()
     except FileNotFoundError:
-        raise click.UsageError(f"Image file not found ({imgfile})")
+        raise click.UsageError(f"Image file not found ({imgfile})") from None
 
     # Parsing the image header
     _header = struct.unpack('IIHHIIBBHI', b[:28])

scripts/imgtool/image.py

@@ -103,14 +103,19 @@
 TLV_VENDOR_RES_MIN = 0x00a0
 TLV_VENDOR_RES_MAX = 0xfffe
 
-STRUCT_ENDIAN_DICT = {
-        'little': '<',
-        'big':    '>'
-}
+STRUCT_ENDIAN_DICT = {'little': '<', 'big': '>'}
 
-VerifyResult = Enum('VerifyResult',
-                    ['OK', 'INVALID_MAGIC', 'INVALID_TLV_INFO_MAGIC', 'INVALID_HASH', 'INVALID_SIGNATURE',
-                     'KEY_MISMATCH'])
+VerifyResult = Enum(
+    'VerifyResult',
+    [
+        'OK',
+        'INVALID_MAGIC',
+        'INVALID_TLV_INFO_MAGIC',
+        'INVALID_HASH',
+        'INVALID_SIGNATURE',
+        'KEY_MISMATCH',
+    ],
+)
 
 
 def align_up(num, align):
@@ -134,8 +139,11 @@ def add(self, kind, payload):
         e = STRUCT_ENDIAN_DICT[self.endian]
         if isinstance(kind, int):
             if not TLV_VENDOR_RES_MIN <= kind <= TLV_VENDOR_RES_MAX:
-                msg = f"Invalid custom TLV type value '0x{kind:04x}', allowed " \
-                      f"value should be between 0x{TLV_VENDOR_RES_MIN:04x} and 0x{TLV_VENDOR_RES_MAX:04x}"
+                msg = (
+                    f"Invalid custom TLV type value '0x{kind:04x}', allowed "
+                    f"value should be between 0x{TLV_VENDOR_RES_MIN:04x} and "
+                    "0x{TLV_VENDOR_RES_MAX:04x}"
+                )
                 raise click.UsageError(msg)
             buf = struct.pack(e + 'HH', kind, len(payload))
         else:
@@ -216,8 +224,8 @@ def key_and_user_sha_to_alg_and_tlv(key, user_sha, is_pure = False):
         allowed = allowed_key_ssh[type(key)]
 
     except KeyError:
-        raise click.UsageError(f"Colud not find allowed hash algorithms for {type(key)}"
-                               )
+        raise click.UsageError(
+            f"Could not find allowed hash algorithms for {type(key)}") from None
 
     # Pure enforces auto, and user selection is ignored
     if user_sha == 'auto' or is_pure:
@@ -226,8 +234,10 @@ def key_and_user_sha_to_alg_and_tlv(key, user_sha, is_pure = False):
     if user_sha in allowed:
         return USER_SHA_TO_ALG_AND_TLV[user_sha]
 
-    raise click.UsageError(f"Key {key.sig_type()} can not be used with --sha {user_sha}; allowed sha are one of {allowed}"
-                           )
+    raise click.UsageError(
+        f"Key {key.sig_type()} can not be used with --sha {user_sha}; "
+        "allowed sha are one of {allowed}"
+    ) from None
 
 
 def get_digest(tlv_type, hash_region):
@@ -245,11 +255,12 @@ def tlv_matches_key_type(tlv_type, key):
         # return True, on exception we return False.
         _, _ = key_and_user_sha_to_alg_and_tlv(key, tlv_sha_to_sha(tlv_type))
         return True
-    except:
+    except Exception:
         pass
 
     return False
 
+
 def parse_uuid(namespace, value):
     # Check if UUID is in the RAW format (12345678-1234-5678-1234-567812345678)
     uuid_re = r'[0-9A-f]{8}-[0-9A-f]{4}-[0-9A-f]{4}-[0-9A-f]{4}-[0-9A-f]{12}'
@@ -371,7 +382,7 @@ def load(self, path):
                     self.infile_data = f.read()
                     self.payload = copy.copy(self.infile_data)
         except FileNotFoundError:
-            raise click.UsageError("Input file not found")
+            raise click.UsageError("Input file not found") from None
 
         # Add the image header if needed.
         if self.pad_header and self.header_size > 0:
@@ -444,10 +455,13 @@ def save(self, path, hex_addr=None):
                 f.write(self.payload)
 
     def check_header(self):
-        if self.header_size > 0 and not self.pad_header:
-            if any(v != 0 for v in self.payload[0:self.header_size]):
-                raise click.UsageError("Header padding was not requested and "
-                                       "image does not start with zeros")
+        if (
+            self.header_size > 0 and not self.pad_header
+            and any(v != 0 for v in self.payload[0: self.header_size])
+        ):
+            raise click.UsageError(
+                "Header padding was not requested and image does not start with zeros"
+            )
 
     def check_trailer(self):
         if self.slot_size > 0:
@@ -719,7 +733,9 @@ def create(self, key, public_key_format, enckey, dependencies=None,
                 tlv.add(pub_key.sig_tlv(), fixed_sig['value'])
                 self.signature = fixed_sig['value']
             else:
-                raise click.UsageError("Can not sign using key and provide fixed-signature at the same time")
+                raise click.UsageError(
+                    "Can not sign using key and provide fixed-signature at the same time"
+                )
 
         # At this point the image was hashed + signed, we can remove the
         # protected TLVs from the payload (will be re-added later)
@@ -738,7 +754,8 @@ def create(self, key, public_key_format, enckey, dependencies=None,
                     hmac_sha_alg = hashes.SHA256()
                 elif hmac_sha == '512':
                     if not isinstance(enckey, x25519.X25519Public):
-                        raise click.UsageError("Currently only ECIES-X25519 supports HMAC-SHA512")
+                        raise click.UsageError(
+                            "Currently only ECIES-X25519 supports HMAC-SHA512")
                     hmac_sha_alg = hashes.SHA512()
                 else:
                     raise click.UsageError("Unsupported HMAC-SHA")
@@ -886,7 +903,7 @@ def verify(imgfile, key):
                 with open(imgfile, 'rb') as f:
                     b = f.read()
         except FileNotFoundError:
-            raise click.UsageError(f"Image file {imgfile} not found")
+            raise click.UsageError(f"Image file {imgfile} not found") from None
 
         magic, _, header_size, _, img_size = struct.unpack('IIHHI', b[:16])
         version = struct.unpack('BBHI', b[20:28])

scripts/imgtool/keys/__init__.py

@@ -34,11 +34,28 @@
 from .rsa import RSA, RSA_KEY_SIZES, RSAPublic, RSAUsageError
 from .x25519 import X25519, X25519Public, X25519UsageError
 
+__all__ = [
+    "ECDSA256P1",
+    "ECDSA384P1",
+    "ECDSA256P1Public",
+    "ECDSA384P1Public",
+    "ECDSAUsageError",
+    "Ed25519",
+    "Ed25519Public",
+    "Ed25519UsageError",
+    "RSA",
+    "RSA_KEY_SIZES",
+    "RSAPublic",
+    "RSAUsageError",
+    "X25519",
+    "X25519Public",
+    "X25519UsageError",
+]
+
 
 class PasswordRequired(Exception):
     """Raised to indicate that the key is password protected, but a
     password was not specified."""
-    pass
 
 
 def load(path, passwd=None):