imgtool: Add support for VID and CID

Allow to specify VID and CID for an image.

Signed-off-by: Tomasz Chyrowicz <[email protected]>

Author: tomchy

scripts/imgtool/image.py

@@ -30,7 +30,9 @@
 import hashlib
 import array
 import os.path
+import re
 import struct
+import uuid
 from enum import Enum
 
 import click
@@ -96,6 +98,8 @@
         'DECOMP_SHA': 0x71,
         'DECOMP_SIGNATURE': 0x72,
         'COMP_DEC_SIZE' : 0x73,
+        'UUID_VID': 0x80,
+        'UUID_CID': 0x81,
 }
 
 TLV_SIZE = 4
@@ -254,6 +258,23 @@ def tlv_matches_key_type(tlv_type, key):
 
     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}'
+    if re.match(uuid_re, value):
+        uuid_bytes = bytes.fromhex(value.replace('-', ''))
+
+    # Check if UUID is in the string format
+    elif value.isprintable():
+        if namespace is not None:
+            uuid_bytes = uuid.uuid5(namespace, value).bytes
+        else:
+            raise ValueError(f"Unknown namespace for UUID: {value}")
+    else:
+        raise ValueError(f"Unknown UUID format: {value}")
+
+    return uuid_bytes
+
 
 class Image:
 
@@ -263,7 +284,7 @@ def __init__(self, version=None, header_size=IMAGE_HEADER_SIZE,
                  overwrite_only=False, endian="little", load_addr=0,
                  rom_fixed=None, erased_val=None, save_enctlv=False,
                  security_counter=None, max_align=None,
-                 non_bootable=False):
+                 non_bootable=False, vid=None, cid=None):
 
         if load_addr and rom_fixed:
             raise click.UsageError("Can not set rom_fixed and load_addr at the same time")
@@ -292,6 +313,8 @@ def __init__(self, version=None, header_size=IMAGE_HEADER_SIZE,
         self.enctlv_len = 0
         self.max_align = max(DEFAULT_MAX_ALIGN, align) if max_align is None else int(max_align)
         self.non_bootable = non_bootable
+        self.vid = vid
+        self.cid = cid
 
         if self.max_align == DEFAULT_MAX_ALIGN:
             self.boot_magic = bytes([
@@ -321,7 +344,7 @@ def __repr__(self):
         return "<Image version={}, header_size={}, security_counter={}, \
                 base_addr={}, load_addr={}, align={}, slot_size={}, \
                 max_sectors={}, overwrite_only={}, endian={} format={}, \
-                payloadlen=0x{:x}>".format(
+                payloadlen=0x{:x}, vid={}, cid={}>".format(
                     self.version,
                     self.header_size,
                     self.security_counter,
@@ -333,7 +356,9 @@ def __repr__(self):
                     self.overwrite_only,
                     self.endian,
                     self.__class__.__name__,
-                    len(self.payload))
+                    len(self.payload),
+                    self.vid,
+                    self.cid)
 
     def load(self, path):
         """Load an image from a given file"""
@@ -500,6 +525,16 @@ def create(self, key, public_key_format, enckey, dependencies=None,
             #                                   = 4 + 4 = 8 Bytes
             protected_tlv_size += TLV_SIZE + 4
 
+        if self.vid is not None:
+            # Size of the VID TLV: header ('HH') + payload ('16s')
+            #                                   = 4 + 16 = 20 Bytes
+            protected_tlv_size += TLV_SIZE + 16
+
+        if self.cid is not None:
+            # Size of the CID TLV: header ('HH') + payload ('16s')
+            #                                   = 4 + 16 = 20 Bytes
+            protected_tlv_size += TLV_SIZE + 16
+
         if sw_type is not None:
             if len(sw_type) > MAX_SW_TYPE_LENGTH:
                 msg = "'{}' is too long ({} characters) for sw_type. Its " \
@@ -603,6 +638,21 @@ def create(self, key, public_key_format, enckey, dependencies=None,
             if compression_tlvs is not None:
                 for tag, value in compression_tlvs.items():
                     prot_tlv.add(tag, value)
+
+            if self.vid is not None:
+                vid = parse_uuid(uuid.NAMESPACE_DNS, self.vid)
+                payload = struct.pack(e + '16s', vid)
+                prot_tlv.add('UUID_VID', payload)
+
+            if self.cid is not None:
+                if self.vid is not None:
+                    namespace = uuid.UUID(bytes=vid)
+                else:
+                    namespace = None
+                cid = parse_uuid(namespace, self.cid)
+                payload = struct.pack(e + '16s', cid)
+                prot_tlv.add('UUID_CID', payload)
+
             if custom_tlvs is not None:
                 for tag, value in custom_tlvs.items():
                     prot_tlv.add(tag, value)

scripts/imgtool/main.py

@@ -473,13 +473,17 @@ def convert(self, value, param, ctx):
 @click.command(help='''Create a signed or unsigned image\n
                INFILE and OUTFILE are parsed as Intel HEX if the params have
                .hex extension, otherwise binary format is used''')
+@click.option('--vid', default=None, required=False,
+              help='Unique vendor identifier, format: (<raw_uuid>|<domain_name)>')
+@click.option('--cid', default=None, required=False,
+              help='Unique image class identifier, format: (<raw_uuid>|<image_class_name>)')
 def sign(key, public_key_format, align, version, pad_sig, header_size,
          pad_header, slot_size, pad, confirm, max_sectors, overwrite_only,
          endian, encrypt_keylen, encrypt, compression, infile, outfile,
          dependencies, load_addr, hex_addr, erased_val, save_enctlv,
          security_counter, boot_record, custom_tlv, rom_fixed, max_align,
          clear, fix_sig, fix_sig_pubkey, sig_out, user_sha, hmac_sha, is_pure,
-         vector_to_sign, non_bootable):
+         vector_to_sign, non_bootable, vid, cid):
 
     if confirm:
         # Confirmed but non-padded images don't make much sense, because
@@ -492,7 +496,7 @@ def sign(key, public_key_format, align, version, pad_sig, header_size,
                       endian=endian, load_addr=load_addr, rom_fixed=rom_fixed,
                       erased_val=erased_val, save_enctlv=save_enctlv,
                       security_counter=security_counter, max_align=max_align,
-                      non_bootable=non_bootable)
+                      non_bootable=non_bootable, vid=vid, cid=cid)
     compression_tlvs = {}
     img.load(infile)
     key = load_key(key) if key else None
@@ -563,7 +567,8 @@ def sign(key, public_key_format, align, version, pad_sig, header_size,
                   overwrite_only=overwrite_only, endian=endian,
                   load_addr=load_addr, rom_fixed=rom_fixed,
                   erased_val=erased_val, save_enctlv=save_enctlv,
-                  security_counter=security_counter, max_align=max_align)
+                  security_counter=security_counter, max_align=max_align,
+                  vid=vid, cid=cid)
         compression_filters = [
             {"id": lzma.FILTER_LZMA2, "preset": comp_default_preset,
                 "dict_size": comp_default_dictsize, "lp": comp_default_lp,