def test_otfad(data_dir):
"""Test OTFAD generator"""
otfad = Otfad()
key = bytes.fromhex("B1A0C56AF31E98CD6936A79D9E6F829D")
counter = bytes.fromhex("5689fab8b4bfb264")
key_blob = KeyBlob(start_addr=0x08001000,
end_addr=0x0800F3FF,
key=key,
counter_iv=counter)
otfad.add_key_blob(key_blob)
assert otfad[0] == key_blob
with open(os.path.join(data_dir, "boot_image.bin"), "rb") as f:
image = f.read()
# invalid address
with pytest.raises(SPSDKError):
key_blob.encrypt_image(0x0, image, True)
encr_image = otfad.encrypt_image(image, 0x08001000, True)
otfad.encrypt_image(image, 0x08001000, False) # TODO finish the test
with open(os.path.join(data_dir, "otfad_image.bin"), "rb") as f:
otfad_image = f.read()
assert encr_image == otfad_image
otfad.info()
def gen_boot_section_otfad() -> BootSectionV2:
"""Generate a Boot Section with content encrypted by OTFAD."""
with open(f'{DATA_DIR}/boot_image.bin', 'rb') as boot_image_file:
boot_data = boot_image_file.read()
otfad = Otfad()
key = bytes.fromhex('B1A0C56AF31E98CD6936A79D9E6F829D')
counter = bytes.fromhex("5689fab8b4bfb264")
otfad.add_key_blob(
KeyBlob(0x08001000,
0x0800F3FF,
key,
counter,
zero_fill=bytes(4),
crc=bytes(
4))) # zero_fill and crc should be used only for testing !
enc_image = otfad.encrypt_image(boot_data, 0x08001000, True)
key_blobs = otfad.encrypt_key_blobs(
kek=bytes.fromhex('50F66BB4F23B855DCD8FEFC0DA59E963'))
assert len(key_blobs) == 256
boot_section = BootSectionV2(0,
CmdErase(address=0x08001000,
length=0x0800F000 - 0x08001000),
CmdLoad(address=0x08001000, data=enc_image),
CmdLoad(address=0x08000000, data=key_blobs),
CmdReset(),
hmac_count=10)
return boot_section
def test_oftad_invalid(data_dir):
"""Test OTFAD - image address range does not match to key blob"""
otfad = Otfad()
key = bytes.fromhex("B1A0C56AF31E98CD6936A79D9E6F829D")
counter = bytes.fromhex("5689fab8b4bfb264")
key_blob = KeyBlob(start_addr=0x08001000,
end_addr=0x0800F3FF,
key=key,
counter_iv=counter)
otfad.add_key_blob(key_blob)
assert otfad[0] == key_blob
with open(os.path.join(data_dir, "boot_image.bin"), "rb") as f:
image = f.read()
with pytest.raises(SPSDKError):
otfad.encrypt_image(image, 0x0800FFF, True)
def gen_boot_section_otfad() -> BootSectionV2:
"""Generate a Boot Section with content encrypted by OTFAD.
:raises SPSDKError: When length of key blobs is not 256
"""
with open(f"{DATA_DIR}/boot_image.bin", "rb") as boot_image_file:
boot_data = boot_image_file.read()
otfad = Otfad()
key = bytes.fromhex("B1A0C56AF31E98CD6936A79D9E6F829D")
counter = bytes.fromhex("5689fab8b4bfb264")
otfad.add_key_blob(
KeyBlob(
0x08001000,
0x0800F3FF,
key,
counter,
zero_fill=bytes(4),
crc=bytes(4),
)) # zero_fill and crc should be used only for testing !
enc_image = otfad.encrypt_image(boot_data, 0x08001000, True)
key_blobs = otfad.encrypt_key_blobs(
kek=bytes.fromhex("50F66BB4F23B855DCD8FEFC0DA59E963"))
if len(key_blobs) != 256:
raise SPSDKError("Length of key blobs is not 256")
boot_section = BootSectionV2(
0,
CmdErase(address=0x08001000, length=0x0800F000 - 0x08001000),
CmdLoad(address=0x08001000, data=enc_image),
CmdLoad(address=0x08000000, data=key_blobs),
CmdReset(),
hmac_count=10,
)
return boot_section
def test_sb_otfad_keystore(data_dir: str, subdir: str, image_name: str,
secure: bool) -> None:
"""Test creation of SB file for RT5xx with OTFAD encrypted image. SBKEK Key for SB file is stored in KEYSTORE.
:param data_dir: absolute path of the directory with data files for the test
:param image_name: file name of the signed image WITHOUT file extension
:param secure: whether security should be enabled
"""
if not TEST_IMG_CONTENT:
secure_boot_en = 0x900000 if secure else 0 # BOOT_CFG[0]: SECURE_BOOT_EN=?
write_shadow_regis(
data_dir,
[
(0x40130194, 0x00000080), # BOOT_CFG[5]: USE_PUF = 1
(0x401301A8, 0x00001000), # OTFAD CFG
(0x40130180, 0x00000010 +
secure_boot_en), # BOOT_CFG[0]: DEFAULT_ISP = 1(USB)
],
)
with open(os.path.join(data_dir, KEYSTORE_SUBDIR, "SBkek_PUF.txt"),
"r") as f:
sbkek_str = f.readline()
key_store = get_keystore(data_dir)
adv_params = SBV2xAdvancedParams(
dek=b"\xA0" * 32,
mac=b"\x0B" * 32,
nonce=bytes(16),
timestamp=datetime(2020, month=1, day=31, hour=0, tzinfo=timezone.utc),
)
# create SB file boot image
boot_image = BootImageV21(
kek=bytes.fromhex(sbkek_str),
product_version="1.0.0",
component_version="1.0.0",
build_number=1,
# parameters fixed for test only (to have always same output), do not use in production
advanced_params=adv_params,
flags=0x0008,
)
# certificate + private key
cert_block, priv_key_pem_data = create_cert_block(data_dir)
boot_image.cert_block = cert_block
boot_image.private_key_pem_data = priv_key_pem_data
fcb_data = load_binary(data_dir, FCB_FILE_NAME)
plain_image_data = load_binary(data_dir, subdir, image_name + ".bin")
# images are aligned for test purposes only, otherwise export will align with random data
fcb_data = align_block(fcb_data, 16)
plain_image_data = align_block(plain_image_data, 16)
otfad = Otfad()
# keys used to encrypt image, for RT5xx always define 4 key blobs!!
key = bytes.fromhex("B1A0C56AF31E98CD6936A79D9E6F829D")
counter = bytes.fromhex("5689fab8b4bfb264")
otfad.add_key_blob(
KeyBlob(0x8001000,
0x80FFFFF,
key,
counter,
zero_fill=bytes(4),
crc=bytes(
4))) # zero_fill and crc should be used only for testing !
# to use random keys: otfad.add_key_blob(KeyBlob(0x8001000, 0x80FFFFF))
otfad.add_key_blob(
KeyBlob(0x8FFD000,
0x8FFDFFF,
key,
counter,
zero_fill=bytes(4),
crc=bytes(
4))) # zero_fill and crc should be used only for testing !
otfad.add_key_blob(
KeyBlob(0x8FFE000,
0x8FFEFFF,
key,
counter,
zero_fill=bytes(4),
crc=bytes(
4))) # zero_fill and crc should be used only for testing !
otfad.add_key_blob(
KeyBlob(0x8FFF000,
0x8FFFFFF,
key,
counter,
zero_fill=bytes(4),
crc=bytes(
4))) # zero_fill and crc should be used only for testing !
encr_image_data = otfad.encrypt_image(plain_image_data, 0x8001000, False)
with open(os.path.join(data_dir, KEYSTORE_SUBDIR, "OTFADKek_PUF.txt"),
"r") as f:
otfad_kek = f.readline()
# create boot section 0
boot_section = BootSectionV2(
0,
# configure external FLASH
CmdFill(address=0x10C000, pattern=int("063040C0", 16)),
CmdMemEnable(0x10C000, 4, ExtMemId.FLEX_SPI_NOR),
# erase the FLASH
CmdErase(address=0x8000000, length=0x10000),
# load key blobs allowing th decrypt the image
CmdLoad(address=0x8000000,
data=otfad.encrypt_key_blobs(kek=otfad_kek)),
# load FCB data
CmdLoad(address=0x8000400, data=fcb_data),
# load key-store
CmdLoad(address=0x8000800, data=key_store.export()),
# load encrypted image
CmdLoad(address=0x8001000, data=encr_image_data),
)
boot_image.add_boot_section(boot_section)
dbg_info = list() # debug log for analysis of the binary output content
sb_file = boot_image.export(
padding=bytes(8),
dbg_info=dbg_info) # padding for unit test only, to avoid random data
write_dbg_log(data_dir, image_name + "_otfad_keystore.sb", dbg_info,
TEST_IMG_CONTENT)
write_sb(data_dir, image_name + "_otfad_keystore.sb", sb_file, key_store)
def test_sb_otfad_otp(data_dir: str, subdir: str, image_name: str,
secure: bool) -> None:
"""Test creation of SB file for RT5xx with OTFAD encrypted image.
SBKEK Key for SB file is derived from master key in OTP.
:param data_dir: absolute path of the directory with data files for the test
:param image_name: file name of the signed image WITHOUT file extension
:param secure: whether security should be enabled
"""
if not TEST_IMG_CONTENT:
secure_boot_en = 0x900000 if secure else 0 # BOOT_CFG[0]: SECURE_BOOT_EN=?
write_shadow_regis(
data_dir,
[
(0x401301A8, 0x00001000), # OTFAD CFG
# OTFAD KEY INPUT - 12aaaaaabb34bbbbcccc56ccdddddd78
(0x401301B0, 0xAAAAAA12),
(0x401301B4, 0xBBBB34BB),
(0x401301B8, 0xCC56CCCC),
(0x401301BC, 0x78DDDDDD),
],
)
write_shadow_regis(
data_dir,
[
# MASTER KEY - 000102030405060708090a0b0c0d0e0f00112233445566778899aabbccddeeff
(0x401301C0, 0xCCDDEEFF),
(0x401301C4, 0x8899AABB),
(0x401301C8, 0x44556677),
(0x401301CC, 0x00112233),
(0x401301D0, 0x0C0D0E0F),
(0x401301D4, 0x08090A0B),
(0x401301D8, 0x04050607),
(0x401301DC, 0x00010203),
# BOOT_CFG[0]: DEFAULT_ISP = 1(USB)
(0x40130180, 0x00000010 + secure_boot_en),
],
)
sbkek = KeyStore.derive_sb_kek_key(bytes.fromhex(MASTER_KEY))
otfad_kek = KeyStore.derive_otfad_kek_key(
bytes.fromhex(MASTER_KEY),
bytes.fromhex("12aaaaaabb34bbbbcccc56ccdddddd78"))
key_store = get_keystore(data_dir)
adv_params = SBV2xAdvancedParams(
dek=b"\xA0" * 32,
mac=b"\x0B" * 32,
nonce=bytes(16),
timestamp=datetime(2020, month=1, day=31, hour=0, tzinfo=timezone.utc),
)
# create SB file boot image
boot_image = BootImageV21(
kek=sbkek,
product_version="1.0.0",
component_version="1.0.0",
build_number=1,
# parameters fixed for test only (to have always same output), do not use in production
advanced_params=adv_params,
flags=0x0008,
)
# certificate + private key
cert_block, priv_key_pem_data = create_cert_block(data_dir)
boot_image.cert_block = cert_block
boot_image.private_key_pem_data = priv_key_pem_data
fcb_data = load_binary(data_dir, FCB_FILE_NAME)
plain_image_data = load_binary(data_dir, subdir, image_name + ".bin")
# images are aligned for test purposes only, otherwise export will align with random data
fcb_data = align_block(fcb_data, 16)
plain_image_data = align_block(plain_image_data, 16)
otfad = Otfad()
# keys used to encrypt image, for RT5xx always define 4 key blobs!!
key = bytes.fromhex("B1A0C56AF31E98CD6936A79D9E6F829D")
counter = bytes.fromhex("5689fab8b4bfb264")
otfad.add_key_blob(
KeyBlob(0x8001000,
0x80FFFFF,
key,
counter,
zero_fill=bytes(4),
crc=bytes(
4))) # zero_fill and crc should be used only for testing !
# to use random keys: otfad.add_key_blob(KeyBlob(0x8001000, 0x80FFFFF))
otfad.add_key_blob(
KeyBlob(0x8FFD000,
0x8FFDFFF,
key,
counter,
zero_fill=bytes(4),
crc=bytes(
4))) # zero_fill and crc should be used only for testing !
otfad.add_key_blob(
KeyBlob(0x8FFE000,
0x8FFEFFF,
key,
counter,
zero_fill=bytes(4),
crc=bytes(
4))) # zero_fill and crc should be used only for testing !
otfad.add_key_blob(
KeyBlob(0x8FFF000,
0x8FFFFFF,
key,
counter,
zero_fill=bytes(4),
crc=bytes(
4))) # zero_fill and crc should be used only for testing !
encr_image_data = otfad.encrypt_image(plain_image_data, 0x8001000, False)
# create boot section 0
boot_section = BootSectionV2(
0,
# configure external FLASH
CmdFill(address=0x10C000, pattern=int("063040C0", 16)),
CmdMemEnable(0x10C000, 4, ExtMemId.FLEX_SPI_NOR),
# erase the FLASH
CmdErase(address=0x8000000, length=0x10000),
# load key blobs allowing th decrypt the image
CmdLoad(address=0x8000000,
data=otfad.encrypt_key_blobs(kek=otfad_kek)),
# load FCB data
CmdLoad(address=0x8000400, data=fcb_data),
# load key-store
CmdLoad(address=0x8000800, data=key_store.export()),
# load encrypted image
CmdLoad(address=0x8001000, data=encr_image_data),
)
boot_image.add_boot_section(boot_section)
dbg_info = list() # debug log for analysis of the binary output content
sb_file = boot_image.export(
padding=bytes(8),
dbg_info=dbg_info) # padding for unit test only, to avoid random data
write_dbg_log(data_dir, image_name + "_otfad_otp.sb", dbg_info,
TEST_IMG_CONTENT)
write_sb(data_dir, image_name + "_otfad_otp.sb", sb_file, key_store)
