SBFile Module API
Module implementing SBFile.
SBFile Version 1
Module implementing SBFile version 1.
- class spsdk.sbfile.sb1.BcdVersion3(major=1, minor=0, service=0)
Bases:
objectVersion in format #.#.#, where # is BCD number (1-4 digits).
Initialize BcdVersion3.
- Parameters
major (
int) – number in BCD format, 1-4 decimal digitsminor (
int) – number in BCD format, 1-4 decimal digitsservice (
int) – number in BCD format, 1-4 decimal digits
- Raises
SPSDKError – Invalid version
- DEFAULT = '999.999.999'
- static from_str(text)
Convert string to BcdVersion instance.
- Parameters
text (
str) – version in format #.#.#, where # is 1-4 decimal digits- Return type
- Returns
BcdVersion3 instance
- Raises
SPSDKError – If format is not valid
- property nums: Sequence[int]
Return array of version numbers: [major, minor, service].
- Return type
Sequence[int]
- static to_version(input_version)
Convert different input formats into BcdVersion3 instance.
- Parameters
input_version (
Union[BcdVersion3,str]) – either directly BcdVersion3 or string- Raises
SPSDKError – Raises when the format is unsupported
- Return type
- Returns
BcdVersion3 instance
- class spsdk.sbfile.sb1.BootSectionV1(section_id, flags=0)
Bases:
spsdk.utils.crypto.abstract.BaseClassBoot Section for SB file 1.x.
Initialize BootSectionV1.
- Parameters
section_id (
int) – unique section ID, 32-bit intflags (
SecureBootFlagsV1) – see SecureBootFlagsV1
- append(cmd)
Append command.
- Parameters
cmd (
CmdBaseClass) – to be added- Return type
None
- property bootable: bool
Return whether section is bootable.
- Return type
bool
- property cmd_size: int
Return size of the binary representation of the commands.
- Return type
int
- property commands: Sequence[spsdk.sbfile.sb2.commands.CmdBaseClass]
Return sequence of all commands in the section.
- Return type
Sequence[CmdBaseClass]
- export(dbg_info=<spsdk.utils.misc.DebugInfo object>)
Return binary representation of the class (serialization).
- Return type
bytes
- property flags: spsdk.sbfile.sb1.headers.SecureBootFlagsV1
Return section flags.
- Return type
- info()
Return string representation.
- Return type
str
- classmethod parse(data, offset=0)
Deserialization from binary format.
- Parameters
data (
bytes) – to be parsedoffset (
int) – to start parsing
- Return type
- Returns
the parsed instance
- property rom_last_tag: bool
ReturnROM_LAST_TAG flag.
The last section header in an image always has its ROM_LAST_TAG flag set to help the ROM know at what point to stop searching.
- Return type
bool
- property section_id: int
Return unique ID of the section, 32 number.
- Return type
int
- property size: int
Return size of the binary representation of the section in bytes.
- Return type
int
- update()
Update settings.
- Return type
None
- class spsdk.sbfile.sb1.CmdCall(address=0, argument=0)
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassCommand Call.
The call statement is used for inserting a bootloader command that executes a function from one of the files that are loaded into the memory.
Initialize Command Call.
- property address: int
Return command’s address.
- Return type
int
- property argument: int
Return command’s argument.
- Return type
int
- class spsdk.sbfile.sb1.CmdErase(address=0, length=0, flags=0)
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassCommand Erase class.
Initialize Command Erase.
- property address: int
Return command’s address.
- Return type
int
- property flags: int
Return command’s flag.
- Return type
int
- property length: int
Return command’s count.
- Return type
int
- class spsdk.sbfile.sb1.CmdFill(address, pattern, length=None)
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassCommand Fill class.
Initialize Command Fill.
- Parameters
address (
int) – to write datapattern (
int) – data to be writtenlength (
Optional[int]) – length of data to be filled, defaults to 4
- Raises
SPSDKError – Raised when size is not aligned to 4 bytes
- PADDING_VALUE = 0
- property address: int
Return address of the command Fill.
- Return type
int
- export(dbg_info=<spsdk.utils.misc.DebugInfo object>)
Return command in binary form (serialization).
- Return type
bytes
- classmethod parse(data, offset=0)
Parse command from bytes.
- Parameters
data (
bytes) – Input data as bytesoffset (
int) – The offset of input data
- Return type
- Returns
Command Fill object
- Raises
SPSDKError – If incorrect header tag
- property pattern: bytes
Return binary data to fill.
- Return type
bytes
- property raw_size: int
Calculate raw size of header.
- Return type
int
- class spsdk.sbfile.sb1.CmdJump(address=0, argument=0, spreg=None)
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassCommand Jump class.
Initialize Command Jump.
- property address: int
Return address of the command Jump.
- Return type
int
- property argument: int
Return command’s argument.
- Return type
int
- classmethod parse(data, offset=0)
Parse command from bytes.
- Parameters
data (
bytes) – Input data as bytesoffset (
int) – The offset of input data
- Return type
- Returns
Command Jump object
- Raises
SPSDKError – If incorrect header tag
- property spreg: Optional[int]
Return command’s Stack Pointer.
- Return type
Optional[int]
- class spsdk.sbfile.sb1.CmdLoad(address, data, mem_id=0)
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassCommand Load. The load statement is used to store data into the memory.
Initialize CMD Load.
- property address: int
Return address in target processor to load data.
- Return type
int
- export(dbg_info=<spsdk.utils.misc.DebugInfo object>)
Export command as binary.
- Return type
bytes
- property mem_id: int
Return memory to be used.
- Return type
int
- classmethod parse(data, offset=0)
Parse command from bytes.
- Parameters
data (
bytes) – Input data as bytesoffset (
int) – The offset of input data
- Return type
- Returns
CMD Load object
- Raises
SPSDKError – Raised when there is invalid CRC
SPSDKError – When there is incorrect header tag
- property raw_size: int
Return aligned size of the command including header and data.
- Return type
int
- class spsdk.sbfile.sb1.CmdMemEnable(address, size, mem_type)
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassCommand to configure certain memory.
Initialize CmdMemEnable.
- Parameters
address (
int) – source address with configuration data for memory initializationsize (
int) – size of configuration data used for memory initializationmem_type (
MemId) – identification of external memory type, see enum for details
- property address: int
Return command’s address.
- Return type
int
- property mem_type: spsdk.mboot.memories.MemId
Return memory to be enabled.
- Return type
- classmethod parse(data, offset=0)
Parse command from bytes.
- Parameters
data (
bytes) – Input data as bytesoffset (
int) – The offset of input data
- Return type
- Returns
Command Memory Enable object
- Raises
SPSDKError – If incorrect header tag
- property size: int
Return command’s size.
- Return type
int
- class spsdk.sbfile.sb1.CmdNop
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassCommand NOP class.
Initialize Command Nop.
- class spsdk.sbfile.sb1.CmdProg(address, mem_id, data_word1, data_word2=0, flags=0)
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassCommand Program class.
Initialize CMD Prog.
- ROM_MEM_DEVICE_ID_MASK = 65280
- ROM_MEM_DEVICE_ID_SHIFT = 8
- property address: int
Return address in target processor to program data.
- Return type
int
- property data_word1: int
Return data word 1.
- Return type
int
- property data_word2: int
Return data word 2.
- Return type
int
- property flags: int
Return command’s flag.
- Return type
int
- class spsdk.sbfile.sb1.CmdReset
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassCommand Reset class.
Initialize Command Reset.
- class spsdk.sbfile.sb1.CmdTag
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassCommand TAG class.
It is also used as header for boot section for SB file 1.x.
Initialize Command Tag.
- class spsdk.sbfile.sb1.ExtMemId
Bases:
spsdk.utils.easy_enum.EnumMcuBoot External Memory Property Tags.
- FLASH_EXEC_ONLY = 16
- FLEX_SPI_NOR = 9
- FUSE = 4
- I2C_NOR_EEPROM = 273
- IFR = 4
- MMC_CARD = 289
- QUAD_SPI0 = 1
- SD_CARD = 288
- SEMC_NAND = 256
- SEMC_NOR = 8
- SPIFI_NOR = 10
- SPI_NAND = 257
- SPI_NOR_EEPROM = 272
- classmethod get_legacy_int(key)
Converts legacy int to new enum key.
- Parameters
key (
int) – int value of legacy enum- Return type
Union[str,int,None]- Returns
new enum value
- classmethod get_legacy_str(key)
Converts legacy str to new enum key.
- Parameters
key (
str) – str value of legacy enum- Return type
Union[str,int,None]- Returns
new enum value
- class spsdk.sbfile.sb1.SecureBootFlagsV1
Bases:
spsdk.utils.easy_enum.EnumFlags for SectionHeader.
- NONE = 0
- ROM_SECTION_BOOTABLE = 1
- ROM_SECTION_CLEARTEXT = 2
- class spsdk.sbfile.sb1.SecureBootV1(version='1.0', flags=0, drive_tag=0, product_version='999.999.999', component_version='999.999.999', dek=None, mac=None, digest=b'\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00', timestamp=None)
Bases:
spsdk.utils.crypto.abstract.BaseClassSB file 1.x.
Initialize Secure Boot Image V1.x.
- Parameters
version (
str) – string in format #.# Major version of the boot image format, currently 1. Minor version of the boot image format, currently 1 or 2.flags (
int) – for the header, 0 by default: Flags associated with the entire image.product_version (
Union[BcdVersion3,str]) – Product version.component_version (
Union[BcdVersion3,str]) – Component version.drive_tag (
int) – For header: identifier for the disk drive or partition containing this image.dek (
Optional[bytes]) – DEK key for encrypted SB file; this is not supported yetmac (
Optional[bytes]) – MAC for encrypted SB file, this is not supported yetdigest (
bytes) – SHA-1 digest of all fields of the header (it will be updated before export anyway) The first 16 bytes (of 20 total) also act as the initialization vector for CBC-encrypted regions.timestamp (
Optional[datetime]) – datetime of the file creation, use None for current date/time Fixed value should be used only for regression testing to generate same results
- append(section)
Add section into the SB file.
- Parameters
section (
BootSectionV1) – to be added- Return type
None
- export(header_padding8=None, auth_padding=None, dbg_info=<spsdk.utils.misc.DebugInfo object>)
Serialization to binary form.
- Parameters
header_padding8 (
Optional[bytes]) – optional header padding, 8-bytes; recommended to use None to apply random valueauth_padding (
Optional[bytes]) – optional padding used after authentication; recommended to use None to apply random valuedbg_info (
DebugInfo) – instance allowing to debug generated output
- Return type
bytes- Returns
serialize the instance into binary data
- Raises
SPSDKError – Invalid section data
SPSDKError – Invalid padding length
- property first_boot_section_id: int
Return id of first boot section.
- Return type
int
- info()
Return text info about the instance, multi-line string.
- Return type
str
- classmethod parse(data, offset=0)
Convert binary data into the instance (deserialization).
- Parameters
data (
bytes) – given binary data to be convertedoffset (
int) – to start parsing the data
- Return type
- Returns
converted instance
- Raises
ValueError – raised when digest does not match
SPSDKError – Raised when section is invalid
- property sections: Sequence[spsdk.sbfile.sb1.sections.BootSectionV1]
Return sequence of all sections on the SB file.
- Return type
Sequence[BootSectionV1]
- property size: int
Return size of the binary representation in bytes.
- Return type
int
- update()
Update content.
- Return type
None
- validate()
Validate settings.
- Raises
SPSDKError – If the settings is not consistent
- Return type
None
SBFile Version 1 commands
Commands for SBFile.
- spsdk.sbfile.sb1.commands.parse_v1_command(data, offset=0)
Parse SB V1.x command from binary format.
- Parameters
data (
bytes) – Input data as bytesoffset (
int) – The offset of input data to start parsing
- Return type
- Returns
parsed command object
- Raises
SPSDKError – Raised when there is unsupported command
SBFile Version 1 headers
Secure Boot Header.
- class spsdk.sbfile.sb1.headers.BootSectionHeaderV1(section_id=0, flags=0)
Bases:
spsdk.sbfile.sb2.commands.CmdTagHeader of boot section derived from command TAG.
Note: Command TAG was reused to save some code in Boot ROM
Initialize BootSectionHeaderV1.
- Parameters
section_id (
int) – unique section ID, 32-bit intflags (
SecureBootFlagsV1) – see SecureBootFlagsV1
- SIZE = 16
- property bootable: bool
Return whether section is bootable.
- Return type
bool
- property flags: spsdk.sbfile.sb1.headers.SecureBootFlagsV1
Return section flags.
- Return type
- property num_blocks: int
Return size of the section in number of cipher blocks.
- Return type
int
- classmethod parse(data, offset=0)
Parse from bytes into BootSectionHeaderV1 object.
- Return type
- property rom_last_tag: bool
Return ROM_LAST_TAG flag.
The last section header in an image always has its ROM_LAST_TAG flag set to help the ROM know at what point to stop searching.
- Return type
bool
- property section_id: int
Return unique ID of the section, 32 number.
- Return type
int
- class spsdk.sbfile.sb1.headers.SectionHeaderItemV1(identifier=0, offset=0, num_blocks=0, flags=0)
Bases:
spsdk.utils.crypto.abstract.BaseClassSection header item/row in section header table in in SB file V1.x.
Initialize SectionHeaderItemV1.
- Parameters
identifier (
int) – Unique 32-bit identifier for this section.offset (
int) – The starting cipher block for this section’s data from the beginning of the image.num_blocks (
int) – The length of the section data in cipher blocks.flags (
SecureBootFlagsV1) – Flags that apply to the entire section, see SectionHeaderV1Flags
- FORMAT = '<4I'
- SIZE = 16
- property bootable: bool
Return whether section is bootable.
- Return type
bool
- export()
Return serialization to binary format.
- Return type
bytes
- property flags: int
Return flags, see SectionHeaderV1Flags.
- Return type
int
- info()
Return Get text info of Header.
- Return type
str
- classmethod parse(data, offset=0)
Parse binary data into the instance (deserialization).
- Parameters
data (
bytes) – to be parsedoffset (
int) – to start parsing the data
- Return type
- Returns
the new instance
- Raises
SPSDKError – If size is not sufficient
- property size: int
Return size of exported data in bytes.
- Return type
int
- class spsdk.sbfile.sb1.headers.SecureBootFlagsV1
Bases:
spsdk.utils.easy_enum.EnumFlags for SectionHeader.
- NONE = 0
- ROM_SECTION_BOOTABLE = 1
- ROM_SECTION_CLEARTEXT = 2
- class spsdk.sbfile.sb1.headers.SecureBootHeaderV1(version='1.0', product_version='999.999.999', component_version='999.999.999', flags=0, drive_tag=0, digest=b'\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00', timestamp=None)
Bases:
spsdk.utils.crypto.abstract.BaseClassSecure Boot Header V1.
Initialize SecureBootHeaderV1.
- Parameters
version (
str) – of the format: 1.0 or 1.1 or 1.2product_version (
Union[BcdVersion3,str]) – Product version.component_version (
Union[BcdVersion3,str]) – Component version.flags (
int) – Flags associated with the entire image.drive_tag (
int) – Identifier for the disk drive or partition containing this image.digest (
bytes) – SHA-1 digest of all fields of the header, 20 bytes The first 16 bytes (of 20 total) also act as the initialization vector for CBC-encrypted regions.timestamp (
Optional[datetime]) – datetime of the file creation, use None for current date/time Fixed value should be used only for regression testing to generate same results
- Raises
SPSDKError – Invalid header version
- export(padding8=None, dbg_info=<spsdk.utils.misc.DebugInfo object>)
Serialization to binary form.
- Parameters
padding8 (
Optional[bytes]) – 8 padding bytes used for in the header, None to use random bytes This value shall be used only for regression testing to generate same resultsdbg_info (
DebugInfo) – class allowing to debug output from the export
- Return type
bytes- Returns
Serialize object into bytes
- property first_boot_tag_block: int
Return first boot tag block.
- Return type
int
- info()
Get info of Header as a string.
- Return type
str
- property key_dictionary_block: int
Return key dictionary block.
- Return type
int
- classmethod parse(data, offset=0)
Convert binary data into the instance (deserialization).
- Parameters
data (
bytes) – given binary data to be decodedoffset (
int) – to start parsing binary data; 0 by default
- Return type
- Returns
the instance of secure boot header v1
- Raises
SPSDKError – Raised when there is insufficient size
SPSDKError – Raised when there is invalid signature
SPSDKError – Raised when there is unexpected signature
- property size: int
Return size of the header in bytes.
- Return type
int
SBFile Version 1 images
Secure Boot Image Class.
- class spsdk.sbfile.sb1.images.SecureBootV1(version='1.0', flags=0, drive_tag=0, product_version='999.999.999', component_version='999.999.999', dek=None, mac=None, digest=b'\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00', timestamp=None)
Bases:
spsdk.utils.crypto.abstract.BaseClassSB file 1.x.
Initialize Secure Boot Image V1.x.
- Parameters
version (
str) – string in format #.# Major version of the boot image format, currently 1. Minor version of the boot image format, currently 1 or 2.flags (
int) – for the header, 0 by default: Flags associated with the entire image.product_version (
Union[BcdVersion3,str]) – Product version.component_version (
Union[BcdVersion3,str]) – Component version.drive_tag (
int) – For header: identifier for the disk drive or partition containing this image.dek (
Optional[bytes]) – DEK key for encrypted SB file; this is not supported yetmac (
Optional[bytes]) – MAC for encrypted SB file, this is not supported yetdigest (
bytes) – SHA-1 digest of all fields of the header (it will be updated before export anyway) The first 16 bytes (of 20 total) also act as the initialization vector for CBC-encrypted regions.timestamp (
Optional[datetime]) – datetime of the file creation, use None for current date/time Fixed value should be used only for regression testing to generate same results
- append(section)
Add section into the SB file.
- Parameters
section (
BootSectionV1) – to be added- Return type
None
- export(header_padding8=None, auth_padding=None, dbg_info=<spsdk.utils.misc.DebugInfo object>)
Serialization to binary form.
- Parameters
header_padding8 (
Optional[bytes]) – optional header padding, 8-bytes; recommended to use None to apply random valueauth_padding (
Optional[bytes]) – optional padding used after authentication; recommended to use None to apply random valuedbg_info (
DebugInfo) – instance allowing to debug generated output
- Return type
bytes- Returns
serialize the instance into binary data
- Raises
SPSDKError – Invalid section data
SPSDKError – Invalid padding length
- property first_boot_section_id: int
Return id of first boot section.
- Return type
int
- info()
Return text info about the instance, multi-line string.
- Return type
str
- classmethod parse(data, offset=0)
Convert binary data into the instance (deserialization).
- Parameters
data (
bytes) – given binary data to be convertedoffset (
int) – to start parsing the data
- Return type
- Returns
converted instance
- Raises
ValueError – raised when digest does not match
SPSDKError – Raised when section is invalid
- property sections: Sequence[spsdk.sbfile.sb1.sections.BootSectionV1]
Return sequence of all sections on the SB file.
- Return type
Sequence[BootSectionV1]
- property size: int
Return size of the binary representation in bytes.
- Return type
int
- update()
Update content.
- Return type
None
- validate()
Validate settings.
- Raises
SPSDKError – If the settings is not consistent
- Return type
None
SBFile Version 1 sections
Boot Selection for SB file.
- class spsdk.sbfile.sb1.sections.BootSectionV1(section_id, flags=0)
Bases:
spsdk.utils.crypto.abstract.BaseClassBoot Section for SB file 1.x.
Initialize BootSectionV1.
- Parameters
section_id (
int) – unique section ID, 32-bit intflags (
SecureBootFlagsV1) – see SecureBootFlagsV1
- append(cmd)
Append command.
- Parameters
cmd (
CmdBaseClass) – to be added- Return type
None
- property bootable: bool
Return whether section is bootable.
- Return type
bool
- property cmd_size: int
Return size of the binary representation of the commands.
- Return type
int
- property commands: Sequence[spsdk.sbfile.sb2.commands.CmdBaseClass]
Return sequence of all commands in the section.
- Return type
Sequence[CmdBaseClass]
- export(dbg_info=<spsdk.utils.misc.DebugInfo object>)
Return binary representation of the class (serialization).
- Return type
bytes
- property flags: spsdk.sbfile.sb1.headers.SecureBootFlagsV1
Return section flags.
- Return type
- info()
Return string representation.
- Return type
str
- classmethod parse(data, offset=0)
Deserialization from binary format.
- Parameters
data (
bytes) – to be parsedoffset (
int) – to start parsing
- Return type
- Returns
the parsed instance
- property rom_last_tag: bool
ReturnROM_LAST_TAG flag.
The last section header in an image always has its ROM_LAST_TAG flag set to help the ROM know at what point to stop searching.
- Return type
bool
- property section_id: int
Return unique ID of the section, 32 number.
- Return type
int
- property size: int
Return size of the binary representation of the section in bytes.
- Return type
int
- update()
Update settings.
- Return type
None
SBFile Version 2
Module implementing SB2 and SB2.1 File.
SBFile Version 2 commands
Commands used by SBFile module.
- class spsdk.sbfile.sb2.commands.CmdBaseClass(tag)
Bases:
spsdk.utils.crypto.abstract.BaseClassBase class for all commands.
Initialize CmdBase.
- export(dbg_info=<spsdk.utils.misc.DebugInfo object>)
Return object serialized into bytes.
- Return type
bytes
- property header: spsdk.sbfile.sb2.commands.CmdHeader
Return command header.
- Return type
- info()
Return text info about the instance.
- Return type
str
- abstract classmethod parse(data, offset=0)
Deserialize object from binary.
- Return type
- property raw_size: int
Return size of the command in binary format (including header).
- Return type
int
- class spsdk.sbfile.sb2.commands.CmdCall(address=0, argument=0)
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassCommand Call.
The call statement is used for inserting a bootloader command that executes a function from one of the files that are loaded into the memory.
Initialize Command Call.
- property address: int
Return command’s address.
- Return type
int
- property argument: int
Return command’s argument.
- Return type
int
- class spsdk.sbfile.sb2.commands.CmdErase(address=0, length=0, flags=0)
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassCommand Erase class.
Initialize Command Erase.
- property address: int
Return command’s address.
- Return type
int
- property flags: int
Return command’s flag.
- Return type
int
- property length: int
Return command’s count.
- Return type
int
- class spsdk.sbfile.sb2.commands.CmdFill(address, pattern, length=None)
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassCommand Fill class.
Initialize Command Fill.
- Parameters
address (
int) – to write datapattern (
int) – data to be writtenlength (
Optional[int]) – length of data to be filled, defaults to 4
- Raises
SPSDKError – Raised when size is not aligned to 4 bytes
- PADDING_VALUE = 0
- property address: int
Return address of the command Fill.
- Return type
int
- export(dbg_info=<spsdk.utils.misc.DebugInfo object>)
Return command in binary form (serialization).
- Return type
bytes
- classmethod parse(data, offset=0)
Parse command from bytes.
- Parameters
data (
bytes) – Input data as bytesoffset (
int) – The offset of input data
- Return type
- Returns
Command Fill object
- Raises
SPSDKError – If incorrect header tag
- property pattern: bytes
Return binary data to fill.
- Return type
bytes
- property raw_size: int
Calculate raw size of header.
- Return type
int
- class spsdk.sbfile.sb2.commands.CmdHeader(tag, flags=0)
Bases:
objectSBFile command header.
Initialize header.
- FORMAT = '<2BH3L'
- SIZE = 16
- property crc: int
Calculate CRC for the header data.
- Return type
int
- export()
Export command header as bytes.
- Return type
bytes
- class spsdk.sbfile.sb2.commands.CmdJump(address=0, argument=0, spreg=None)
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassCommand Jump class.
Initialize Command Jump.
- property address: int
Return address of the command Jump.
- Return type
int
- property argument: int
Return command’s argument.
- Return type
int
- classmethod parse(data, offset=0)
Parse command from bytes.
- Parameters
data (
bytes) – Input data as bytesoffset (
int) – The offset of input data
- Return type
- Returns
Command Jump object
- Raises
SPSDKError – If incorrect header tag
- property spreg: Optional[int]
Return command’s Stack Pointer.
- Return type
Optional[int]
- class spsdk.sbfile.sb2.commands.CmdKeyStoreBackup(address, controller_id)
Bases:
spsdk.sbfile.sb2.commands.CmdKeyStoreBackupRestoreCommand to backup keystore from non-volatile memory.
Initialize CmdKeyStoreBackupRestore.
- Parameters
address (
int) – where to backup key-store or source for restoring key-storecontroller_id (
ExtMemId) – ID of the memory to backup key-store or source memory to load key-store back
- Raises
SPSDKError – If invalid address
SPSDKError – If invalid id of memory
- classmethod cmd_id()
Return command ID for backup operation.
- Return type
- class spsdk.sbfile.sb2.commands.CmdKeyStoreBackupRestore(address, controller_id)
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassShared, abstract implementation for key-store backup and restore command.
Initialize CmdKeyStoreBackupRestore.
- Parameters
address (
int) – where to backup key-store or source for restoring key-storecontroller_id (
ExtMemId) – ID of the memory to backup key-store or source memory to load key-store back
- Raises
SPSDKError – If invalid address
SPSDKError – If invalid id of memory
- ROM_MEM_DEVICE_ID_MASK = 65280
- ROM_MEM_DEVICE_ID_SHIFT = 8
- property address: int
Return address where to backup key-store or source for restoring key-store.
- Return type
int
- abstract classmethod cmd_id()
Return command ID.
- Raises
NotImplementedError – Derived class has to implement this method
- Return type
- property controller_id: int
Return controller ID of the memory to backup key-store or source memory to load key-store back.
- Return type
int
- classmethod parse(data, offset=0)
Parse command from bytes.
- Parameters
data (
bytes) – Input data as bytesoffset (
int) – The offset of input data
- Return type
- Returns
CmdKeyStoreBackupRestore object
- Raises
SPSDKError – When there is invalid header tag
- class spsdk.sbfile.sb2.commands.CmdKeyStoreRestore(address, controller_id)
Bases:
spsdk.sbfile.sb2.commands.CmdKeyStoreBackupRestoreCommand to restore keystore into non-volatile memory.
Initialize CmdKeyStoreBackupRestore.
- Parameters
address (
int) – where to backup key-store or source for restoring key-storecontroller_id (
ExtMemId) – ID of the memory to backup key-store or source memory to load key-store back
- Raises
SPSDKError – If invalid address
SPSDKError – If invalid id of memory
- classmethod cmd_id()
Return command ID for restore operation.
- Return type
- class spsdk.sbfile.sb2.commands.CmdLoad(address, data, mem_id=0)
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassCommand Load. The load statement is used to store data into the memory.
Initialize CMD Load.
- property address: int
Return address in target processor to load data.
- Return type
int
- export(dbg_info=<spsdk.utils.misc.DebugInfo object>)
Export command as binary.
- Return type
bytes
- property mem_id: int
Return memory to be used.
- Return type
int
- classmethod parse(data, offset=0)
Parse command from bytes.
- Parameters
data (
bytes) – Input data as bytesoffset (
int) – The offset of input data
- Return type
- Returns
CMD Load object
- Raises
SPSDKError – Raised when there is invalid CRC
SPSDKError – When there is incorrect header tag
- property raw_size: int
Return aligned size of the command including header and data.
- Return type
int
- class spsdk.sbfile.sb2.commands.CmdMemEnable(address, size, mem_type)
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassCommand to configure certain memory.
Initialize CmdMemEnable.
- Parameters
address (
int) – source address with configuration data for memory initializationsize (
int) – size of configuration data used for memory initializationmem_type (
MemId) – identification of external memory type, see enum for details
- property address: int
Return command’s address.
- Return type
int
- property mem_type: spsdk.mboot.memories.MemId
Return memory to be enabled.
- Return type
- classmethod parse(data, offset=0)
Parse command from bytes.
- Parameters
data (
bytes) – Input data as bytesoffset (
int) – The offset of input data
- Return type
- Returns
Command Memory Enable object
- Raises
SPSDKError – If incorrect header tag
- property size: int
Return command’s size.
- Return type
int
- class spsdk.sbfile.sb2.commands.CmdNop
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassCommand NOP class.
Initialize Command Nop.
- class spsdk.sbfile.sb2.commands.CmdProg(address, mem_id, data_word1, data_word2=0, flags=0)
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassCommand Program class.
Initialize CMD Prog.
- ROM_MEM_DEVICE_ID_MASK = 65280
- ROM_MEM_DEVICE_ID_SHIFT = 8
- property address: int
Return address in target processor to program data.
- Return type
int
- property data_word1: int
Return data word 1.
- Return type
int
- property data_word2: int
Return data word 2.
- Return type
int
- property flags: int
Return command’s flag.
- Return type
int
- class spsdk.sbfile.sb2.commands.CmdReset
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassCommand Reset class.
Initialize Command Reset.
- class spsdk.sbfile.sb2.commands.CmdTag
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassCommand TAG class.
It is also used as header for boot section for SB file 1.x.
Initialize Command Tag.
- class spsdk.sbfile.sb2.commands.CmdVersionCheck(ver_type, version)
Bases:
spsdk.sbfile.sb2.commands.CmdBaseClassFW Version Check command class.
Validates version of secure or non-secure firmware. The command fails if version is < expected.
Initialize CmdVersionCheck.
- Parameters
ver_type (
VersionCheckType) – version check type, see VersionCheckType enumversion (
int) – to be checked
- Raises
SPSDKError – If invalid version check type
- classmethod parse(data, offset=0)
Parse command from bytes.
- Parameters
data (
bytes) – Input data as bytesoffset (
int) – The offset of input data
- Return type
- Returns
parsed command object
- Raises
SPSDKError – If incorrect header tag
- property type: spsdk.sbfile.sb2.commands.VersionCheckType
Return type of the check version, see VersionCheckType enumeration.
- Return type
- property version: int
Return minimal version expected.
- Return type
int
- class spsdk.sbfile.sb2.commands.EnumCmdTag
Bases:
spsdk.utils.easy_enum.EnumCommand tags.
- CALL = 5
- ERASE = 7
- FILL = 3
- FW_VERSION_CHECK = 11
- JUMP = 4
- LOAD = 2
- MEM_ENABLE = 9
- NOP = 0
- PROG = 10
- RESET = 8
- TAG = 1
- WR_KEYSTORE_FROM_NV = 13
- WR_KEYSTORE_TO_NV = 12
- class spsdk.sbfile.sb2.commands.EnumSectionFlag
Bases:
spsdk.utils.easy_enum.EnumSection flags.
- BOOTABLE = 1
- CLEARTEXT = 2
- LAST_SECT = 32768
- class spsdk.sbfile.sb2.commands.VersionCheckType
Bases:
spsdk.utils.easy_enum.EnumSelect type of the version check: either secure or non-secure firmware to be checked.
- NON_SECURE_VERSION = 1
- SECURE_VERSION = 0
- spsdk.sbfile.sb2.commands.parse_command(data, offset=0)
Parse SB 2.x command from bytes.
- Parameters
data (
bytes) – Input data as bytesoffset (
int) – The offset of input data to start parsing
- Return type
- Returns
parsed command object
- Raises
SPSDKError – Raised when there is unsupported command provided
SBFile Version 2 headers
Image header.
- class spsdk.sbfile.sb2.headers.ImageHeaderV2(version='2.0', product_version='1.0.0', component_version='1.0.0', build_number=0, flags=8, nonce=None, timestamp=None)
Bases:
spsdk.utils.crypto.abstract.BaseClassImage Header V2 class.
Initialize Image Header Version 2.x.
- Parameters
version (
str) – The image version value (default: 2.0)product_version (
str) – The product version (default: 1.0.0)component_version (
str) – The component version (default: 1.0.0)build_number (
int) – The build number value (default: 0)flags (
int) – The flags value (default: 0x08)nonce (
Optional[bytes]) – The NONCE value; None if TODO ????timestamp (
Optional[datetime]) – value requested in the test; None to use current value
- FORMAT = '<16s4s4s2BH4I4H4sQ12HI4s'
- SIGNATURE1 = b'STMP'
- SIGNATURE2 = b'sgtl'
- SIZE = 96
- export(padding=None)
Serialize object into bytes.
- Parameters
padding (
Optional[bytes]) – header padding 8 bytes (for testing purposes); None to use random value- Return type
bytes- Returns
binary representation
- Raises
SPSDKError – Raised when format is incorrect
SPSDKError – Raised when length of padding is incorrect
SPSDKError – Raised when length of header is incorrect
- flags_desc()
Return flag description.
- Return type
str
- info()
Get info of Header as string.
- Return type
str
- classmethod parse(data, offset=0)
Deserialization from binary form.
- Parameters
data (
bytes) – binary representationoffset (
int) – to start parsing data
- Return type
- Returns
parsed instance of the header
- Raises
Exception – raised when size/signature is incorrect
SBFile Version 2 images
Boot Image V2.0, V2.1.
- class spsdk.sbfile.sb2.images.BootImageV20(signed, kek, *sections, product_version='1.0.0', component_version='1.0.0', build_number=0, advanced_params=<spsdk.sbfile.sb2.images.SBV2xAdvancedParams object>)
Bases:
spsdk.utils.crypto.abstract.BaseClassBoot Image V2.0 class.
Initialize Secure Boot Image V2.0.
- Parameters
signed (
bool) – True if image is signed, False otherwisekek (
bytes) – key for wrapping DEK and MAC keysproduct_version (
str) – The product version (default: 1.0.0)component_version (
str) – The component version (default: 1.0.0)build_number (
int) – The build number value (default: 0)advanced_params (
SBV2xAdvancedParams) – Advanced parameters for encryption of the SB file, use for tests onlysections (
BootSectionV2) – Boot sections
- Raises
SPSDKError – Invalid dek or mac
- DEK_MAC_SIZE = 80
- HEADER_MAC_SIZE = 32
- KEY_BLOB_SIZE = 80
- add_boot_section(section)
Add new Boot section into image.
- Parameters
section (
BootSectionV2) – Boot section- Raises
SPSDKError – Raised when section is not instance of BootSectionV2 class
SPSDKError – Raised when boot section has duplicate UID
- Return type
None
- property cert_block: Optional[spsdk.utils.crypto.cert_blocks.CertBlockV2]
Return certificate block; None if SB file not signed or block not assigned yet.
- Return type
Optional[CertBlockV2]
- property cert_header_size: int
Return image raw size (not aligned) for certificate header.
- Return type
int
- property dek: bytes
Data encryption key.
- Return type
bytes
- export(padding=None)
Serialize image object.
- Parameters
padding (
Optional[bytes]) – header padding (8 bytes) for testing purpose; None to use random values (recommended)- Return type
bytes- Returns
exported bytes
- Raises
SPSDKError – Raised when there are no boot sections or is not signed or private keys are missing
SPSDKError – Raised when there is invalid dek or mac
SPSDKError – Raised when certificate data is not present
SPSDKError – Raised when there is invalid certificate block
SPSDKError – Raised when there is invalid length of exported data
- property header: spsdk.sbfile.sb2.headers.ImageHeaderV2
Return image header.
- Return type
- info()
Return text description of the instance.
- Return type
str
- property kek: bytes
Return key for wrapping DEK and MAC keys.
- Return type
bytes
- property mac: bytes
Message authentication code.
- Return type
bytes
- classmethod parse(data, offset=0, kek=b'')
Parse image from bytes.
- Parameters
data (
bytes) – Raw data of parsed imageoffset (
int) – The offset of input datakek (
bytes) – The Key for unwrapping DEK and MAC keys (required)
- Return type
- Returns
parsed image object
- Raises
Exception – raised when header is in wrong format
Exception – raised when there is invalid header version
Exception – raised when signature is incorrect
SPSDKError – Raised when kek is empty
Exception – raised when header’s nonce is not present
- property private_key_pem_data: Optional[bytes]
Return private key data for signed images, decrypted in PEM format.
- Return type
Optional[bytes]
- property raw_size: int
Return image raw size.
- Return type
int
- property raw_size_without_signature: int
Return image raw size without signature, used to calculate image blocks.
- Return type
int
- property signed: bool
Check whether sb is signed + encrypted or only encrypted.
- Return type
bool
- update()
Update boot image.
- Return type
None
- class spsdk.sbfile.sb2.images.BootImageV21(kek, *sections, product_version='1.0.0', component_version='1.0.0', build_number=0, advanced_params=<spsdk.sbfile.sb2.images.SBV2xAdvancedParams object>, flags=32776)
Bases:
spsdk.utils.crypto.abstract.BaseClassBoot Image V2.1 class.
Initialize Secure Boot Image V2.1.
- Parameters
kek (
bytes) – key to wrap DEC and MAC keysproduct_version (
str) – The product version (default: 1.0.0)component_version (
str) – The component version (default: 1.0.0)build_number (
int) – The build number value (default: 0)advanced_params (
SBV2xAdvancedParams) – optional advanced parameters for encryption; it is recommended to use default valueflags (
int) – see flags defined in class.sections (
BootSectionV2) – Boot sections
- FLAGS_ENCRYPTED_SIGNED_BIT = 8
- FLAGS_SHA_PRESENT_BIT = 32768
- HEADER_MAC_SIZE = 32
- KEY_BLOB_SIZE = 80
- SHA_256_SIZE = 32
- add_boot_section(section)
Add new Boot section into image.
- Parameters
section (
BootSectionV2) – Boot section to be added- Raises
SPSDKError – Raised when section is not instance of BootSectionV2 class
- Return type
None
- property cert_block: Optional[spsdk.utils.crypto.cert_blocks.CertBlockV2]
Return certificate block; None if SB file not signed or block not assigned yet.
- Return type
Optional[CertBlockV2]
- property cert_header_size: int
Return image raw size (not aligned) for certificate header.
- Return type
int
- property dek: bytes
Data encryption key.
- Return type
bytes
- export(padding=None, dbg_info=None)
Serialize image object.
- Parameters
padding (
Optional[bytes]) – header padding (8 bytes) for testing purpose; None to use random values (recommended)dbg_info (
Optional[List[str]]) – optional list, where debug info is exported in text form
- Return type
bytes- Returns
exported bytes
- Raises
SPSDKError – Raised when there is no boot section to be added
SPSDKError – Raised when certificate is not assigned
SPSDKError – Raised when private key is not assigned
SPSDKError – Raised when private header’s nonce is invalid
SPSDKError – Raised when private key does not match certificate
SPSDKError – Raised when there is no debug info
- property header: spsdk.sbfile.sb2.headers.ImageHeaderV2
Return image header.
- Return type
- info()
Return text description of the instance.
- Return type
str
- property kek: bytes
Return key to wrap DEC and MAC keys.
- Return type
bytes
- property mac: bytes
Message authentication code.
- Return type
bytes
- classmethod parse(data, offset=0, kek=b'', plain_sections=False)
Parse image from bytes.
- Parameters
data (
bytes) – Raw data of parsed imageoffset (
int) – The offset of input datakek (
bytes) – The Key for unwrapping DEK and MAC keys (required)plain_sections (
bool) – Sections are not encrypted; this is used only for debugging, not supported by ROM code
- Return type
- Returns
BootImageV21 parsed object
- Raises
Exception – raised when header is in incorrect format
Exception – raised when signature is incorrect
SPSDKError – Raised when kek is empty
Exception – raised when header’s nonce not present”
- property private_key_pem_data: Optional[bytes]
Return binary data of private key for signing; decrypted binary data in PEM format.
None if not assigned yet or image not signed.
- Return type
Optional[bytes]
- property raw_size: int
Return image raw size (not aligned).
- Return type
int
- property signed: bool
Return flag whether SB file is signed.
- Return type
bool
- update()
Update BootImageV21.
- Return type
None
- class spsdk.sbfile.sb2.images.SBV2xAdvancedParams(dek=None, mac=None, nonce=None, timestamp=None)
Bases:
objectThe class holds advanced parameters for the SB file encryption.
These parameters are used for the tests; for production, use can use default values (random keys + current time)
Initialize SBV2xAdvancedParams.
- Parameters
dek (
Optional[bytes]) – DEK keymac (
Optional[bytes]) – MAC keynonce (
Optional[bytes]) – noncetimestamp (
Optional[datetime]) – fixed timestamp for the header; use None to use current date/time
- Raises
SPSDKError – Invalid dek or mac
SPSDKError – Invalid length of nonce
- property dek: bytes
Return DEK key.
- Return type
bytes
- property mac: bytes
Return MAC key.
- Return type
bytes
- property nonce: bytes
Return NONCE.
- Return type
bytes
- property timestamp: datetime.datetime
Return timestamp.
- Return type
datetime
- spsdk.sbfile.sb2.images.generate_SB21(bd_file_path, key_file_path, private_key_file_path, signing_certificate_file_paths, root_key_certificate_paths, hoh_out_path, external_files)
Generate SecureBinary image from BD command file.
- Parameters
bd_file_path (
str) – path to BD file.key_file_path (
str) – path to key file.private_key_file_path (
str) – path to private key file for signing. This key relates to last certificate from signing certificate chain.signing_certificate_file_paths (
List[str]) – signing certificate chain.root_key_certificate_paths (
List[str]) – paths to root key certificate(s) for verifying other certificates. Only 4 root key certificates are allowed, others are ignored. One of the certificates must match the first certificate passed in signing_certificate_file_paths.hoh_out_path (
str) – output path to hash of hashes of root keys. If set to None, ‘hash.bin’ is created under working directory.external_files (
List[str]) – external files referenced from BD file.
- Raises
SPSDKError – If incorrect bd file is provided
- Return type
bytes
SBFile Version 2 sections
Sections within SBfile.
- class spsdk.sbfile.sb2.sections.BootSectionV2(uid, *commands, hmac_count=1)
Bases:
spsdk.utils.crypto.abstract.BaseClassBoot Section V2.
Initialize BootSectionV2.
- Parameters
uid (
int) – section unique identificationcommands (
CmdBaseClass) – List of commandshmac_count (
int) – The number of HMAC entries
- HMAC_SIZE = 32
- append(cmd)
Add command to section.
- Return type
None
- export(dek=b'', mac=b'', counter=None, dbg_info=None)
Serialize Boot Section object.
- Parameters
dek (
bytes) – The DEK value in bytes (required)mac (
bytes) – The MAC value in bytes (required)counter (
Optional[Counter]) – The counter object (required)dbg_info (
Optional[List[str]]) – Optional[List[str]] optional list to export debug information about content in text format
- Return type
bytes- Returns
exported bytes
- Raises
SPSDKError – raised when dek, mac, counter have invalid format
- property hmac_count: int
Number of HMACs.
- Return type
int
- info()
Get object info.
- Return type
str
- property is_last: bool
Check whether the section is the last one.
- Return type
bool
- classmethod parse(data, offset=0, plain_sect=False, dek=b'', mac=b'', counter=None)
Parse Boot Section from bytes.
- Parameters
data (
bytes) – Raw data of parsed imageoffset (
int) – The offset of input dataplain_sect (
bool) – If the sections are not encrypted; It is used for debugging only, not supported by ROM codedek (
bytes) – The DEK value in bytes (required)mac (
bytes) – The MAC value in bytes (required)counter (
Optional[Counter]) – The counter object (required)
- Return type
- Returns
exported bytes
- Raises
SPSDKError – raised when dek, mac, counter have invalid format
- property raw_size: int
Raw size of section.
- Return type
int
- property uid: int
Boot Section UID.
- Return type
int
- class spsdk.sbfile.sb2.sections.CertSectionV2(cert_block)
Bases:
spsdk.utils.crypto.abstract.BaseClassCertificate Section V2 class.
Initialize CertBlockV2.
- HMAC_SIZE = 32
- SECT_MARK = 1852270963
- property cert_block: spsdk.utils.crypto.cert_blocks.CertBlockV2
Return certification block.
- Return type
- export(dek=b'', mac=b'', counter=None)
Serialize Certificate Section object.
- Parameters
dek (
bytes) – The DEK value in bytes (required)mac (
bytes) – The MAC value in bytes (required)counter (
Optional[Counter]) – The counter object (required)
- Return type
bytes- Returns
exported bytes
- Raises
Exception – raised when dek, mac, counter have invalid format
SPSDKError – Raised size of exported bytes is invalid
- info()
Get object info.
- Return type
str
- classmethod parse(data, offset=0, dek=b'', mac=b'', counter=None)
Parse Certificate Section from bytes array.
- Parameters
data (
bytes) – Raw data of parsed imageoffset (
int) – The offset of input datadek (
bytes) – The DEK value in bytes (required)mac (
bytes) – The MAC value in bytes (required)counter (
Optional[Counter]) – The counter object (required)
- Return type
- Returns
parsed cert section v2 object
- Raises
SPSDKError – Raised when dek, mac, counter are not valid
SPSDKError – Raised when there is invalid header HMAC, TAG, FLAGS, Mark
SPSDKError – Raised when there is invalid certificate block HMAC
- property raw_size: int
Calculate raw size of section.
- Return type
int
SBFile Version 3.1.
SB31 module of sbfile.
- class spsdk.sbfile.sb31.CmdCall(address)
Bases:
spsdk.sbfile.sb31.commands.BaseCmdAddress will be the address to jump.
Constructor for Command.
- Parameters
address (
int) – Input address
- info()
Get info of command.
- Return type
str
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- class spsdk.sbfile.sb31.CmdConfigureMemory(address, memory_id=0)
Bases:
spsdk.sbfile.sb31.commands.BaseCmdConfigure memory.
Constructor for command.
- Parameters
address (
int) – Input addressmemory_id (
int) – Memory ID
- export()
Export command as bytes.
- Return type
bytes
- info()
Get info of command.
- Return type
str
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- classmethod parse(data, offset=0)
Parse command from bytes array.
- Parameters
data (
bytes) – Input data as bytes arrayoffset (
int) – The offset of input data
- Return type
- Returns
CmdConfigureMemory
- class spsdk.sbfile.sb31.CmdCopy(address, length, destination_address=0, memory_id_from=0, memory_id_to=0)
Bases:
spsdk.sbfile.sb31.commands.BaseCmdCopy data from one place to another.
Constructor for command.
- Parameters
address (
int) – Input addresslength (
int) – Input lengthdestination_address (
int) – Destination addressmemory_id_from (
int) – Memory IDmemory_id_to (
int) – Memory ID
- export()
Export command as bytes.
- Return type
bytes
- info()
Get info of command.
- Return type
str
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- class spsdk.sbfile.sb31.CmdErase(address, length, memory_id=0)
Bases:
spsdk.sbfile.sb31.commands.BaseCmdErase given address range. The erase will be rounded up to the sector size.
Constructor for command.
- Parameters
address (
int) – Input addresslength (
int) – Input lengthmemory_id (
int) – Memory ID
- export()
Export command as bytes.
- Return type
bytes
- info()
Get info of command.
- Return type
str
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- class spsdk.sbfile.sb31.CmdExecute(address)
Bases:
spsdk.sbfile.sb31.commands.BaseCmdAddress will be the jump-to address.
Constructor for Command.
- Parameters
address (
int) – Input address
- info()
Get info of command.
- Return type
str
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- classmethod parse(data, offset=0)
Parse command from bytes array.
- Parameters
data (
bytes) – Input data as bytes arrayoffset (
int) – The offset of input data
- Return type
- Returns
CmdExecute
- class spsdk.sbfile.sb31.CmdFillMemory(address, length, pattern)
Bases:
spsdk.sbfile.sb31.commands.BaseCmdFill memory range by pattern.
Constructor for command.
- Parameters
address (
int) – Input addresslength (
int) – Input lengthpattern (
int) – Pattern for fill memory with
- export()
Export command as bytes.
- Return type
bytes
- info()
Get info of command.
- Return type
str
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- classmethod parse(data, offset=0)
Parse command from bytes array.
- Parameters
data (
bytes) – Input data as bytes arrayoffset (
int) – The offset of input data
- Return type
- Returns
CmdErase
- Raises
SPSDKError – Invalid padding
- class spsdk.sbfile.sb31.CmdLoad(address, data, memory_id=0)
Bases:
spsdk.sbfile.sb31.commands.CmdLoadBaseData to write follows the range header.
Constructor for command.
- Parameters
address (
int) – Address for the load commanddata (
bytes) – Data to loadmemory_id (
int) – Memory ID
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
Union[CmdLoad,CmdLoadHashLocking,CmdLoadCmac]- Returns
Command object loaded from configuration.
- Raises
SPSDKError – Invalid configuration field.
- class spsdk.sbfile.sb31.CmdLoadCmac(address, data, memory_id=0)
Bases:
spsdk.sbfile.sb31.commands.CmdLoadBaseLoad cmac. ROM is calculating cmac from loaded data.
Constructor for command.
- Parameters
address (
int) – Address for the load commanddata (
bytes) – Data to loadmemory_id (
int) – Memory ID
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- Raises
SPSDKError – Invalid configuration field.
- class spsdk.sbfile.sb31.CmdLoadHashLocking(address, data, memory_id=0)
Bases:
spsdk.sbfile.sb31.commands.CmdLoadBaseLoad hash. ROM is calculating hash.
Constructor for command.
- Parameters
address (
int) – Address for the load commanddata (
bytes) – Data to loadmemory_id (
int) – Memory ID
- export()
Export command as bytes.
- Return type
bytes
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- Raises
SPSDKError – Invalid configuration field.
- class spsdk.sbfile.sb31.CmdLoadKeyBlob(offset, data, key_wrap_id)
Bases:
spsdk.sbfile.sb31.commands.BaseCmdLoad key blob.
Constructor for command.
- Parameters
offset (
int) – Input offsetkey_wrap_id (
int) – Key wrap ID (NXP_CUST_KEK_INT_SK = 16, NXP_CUST_KEK_EXT_SK = 17)data (
bytes) – Wrapped key blob
- FORMAT = '<L2H2L'
- class KeyWraps
Bases:
spsdk.utils.easy_enum.EnumKeyWrap IDs used by the CmdLoadKeyBlob command.
- NXP_CUST_KEK_EXT_SK = 17
- NXP_CUST_KEK_INT_SK = 16
- export()
Export command as bytes.
- Return type
bytes
- info()
Get info of command.
- Return type
str
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- classmethod parse(data, offset=0)
Parse command from bytes array.
- Parameters
data (
bytes) – Input data as bytes arrayoffset (
int) – The offset of input data
- Return type
- Returns
CmdLoadKeyBlob
- class spsdk.sbfile.sb31.CmdProgFuses(address, data)
Bases:
spsdk.sbfile.sb31.commands.CmdLoadBaseAddress will be address of fuse register.
Constructor for Command.
- Parameters
address (
int) – Input addressdata (
bytes) – Input data
- HAS_MEMORY_ID_BLOCK = False
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- classmethod parse(data, offset=0)
Parse command from bytes array.
- Parameters
data (
bytes) – Input data as bytes arrayoffset (
int) – The offset of input data
- Return type
- Returns
CmdProgFuses
- class spsdk.sbfile.sb31.CmdProgIfr(address, data)
Bases:
spsdk.sbfile.sb31.commands.CmdLoadBaseAddress will be the address into the IFR region.
Constructor for Command.
- Parameters
address (
int) – Input addressdata (
bytes) – Input data as bytes array
- HAS_MEMORY_ID_BLOCK = False
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- classmethod parse(data, offset=0)
Parse command from bytes array.
- Parameters
data (
bytes) – Input data as bytes arrayoffset (
int) – The offset of input data
- Return type
- Returns
CmdProgFuses
- class spsdk.sbfile.sb31.CmdSectionHeader(length, section_uid=1, section_type=1)
Bases:
spsdk.sbfile.sb31.commands.MainCmdCreate section header.
Constructor for Commands section.
- Parameters
section_uid (
int) – Input uidsection_type (
int) – Input typelength (
int) – Input length
- FORMAT = '<4L'
- SIZE = 16
- export()
Export command as bytes.
- Return type
bytes
- info()
Get info of Section header.
- Return type
str
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- Raises
SPSDKError – This situation cannot raise (the function here is just MYPY/PYLINT checks).
- classmethod parse(data, offset=0)
Parse command from bytes array.
- Parameters
data (
bytes) – Input data as bytes arrayoffset (
int) – The offset of input data
- Raises
SPSDKError – Raised when FORMAT is bigger than length of the data without offset
- Return type
- Returns
CmdSectionHeader
- class spsdk.sbfile.sb31.EnumCmdTag
Bases:
spsdk.utils.easy_enum.EnumContains commands tags.
- CALL = 4
- CONFIGURE_MEMORY = 11
- COPY = 8
- ERASE = 1
- EXECUTE = 3
- FILL_MEMORY = 12
- FW_VERSION_CHECK = 13
- LOAD = 2
- LOAD_CMAC = 7
- LOAD_HASH_LOCKING = 9
- LOAD_KEY_BLOB = 10
- NONE = 0
- PROGRAM_FUSES = 5
- PROGRAM_IFR = 6
SBFile Version 3.1. functions
File including helping functions.
- class spsdk.sbfile.sb31.functions.KeyDerivationMode
Bases:
spsdk.utils.easy_enum.EnumModes for Key derivation.
- BLK = 2
- KDK = 1
- class spsdk.sbfile.sb31.functions.KeyDerivator(pck, timestamp, key_length, kdk_access_rights)
Bases:
objectEngine for generating derived keys.
Initialize the KeyDerivator.
- Parameters
pck (
bytes) – Part Common Key, base user key for all key derivationstimestamp (
int) – Timestamp used for creating the KeyDerivationKeykey_length (
int) – Requested key length after derivation (128/256bits)kdk_access_rights (
int) – KeyDerivationKey access rights
- get_block_key(block_number)
Derive key for particular block.
- Return type
bytes
- spsdk.sbfile.sb31.functions.add_leading_zeros(byte_data, return_size)
Return data with leading zeros.
- Parameters
byte_data (
bytes) – Input data as bytes arrayreturn_size (
int) –
- Return type
bytes- Returns
bytes
- spsdk.sbfile.sb31.functions.add_trailing_zeros(byte_data, return_size)
Return data with trailing zeros.
- Parameters
byte_data (
bytes) – Input data as bytes arrayreturn_size (
int) –
- Return type
bytes- Returns
bytes
- spsdk.sbfile.sb31.functions.derive_block_key(kdk, block_number, key_length, kdk_access_rights)
Derive encryption AES key for given block.
- Parameters
kdk (
bytes) – Key Derivation Keyblock_number (
int) – Block numberkey_length (
int) – Required key length (128/256)kdk_access_rights (
int) – Key Derivation Key access rights (0-3)
- Return type
bytes- Returns
AES key for given block
- spsdk.sbfile.sb31.functions.derive_kdk(pck, timestamp, key_length, kdk_access_rights)
Derive the Key Derivation Key.
- Parameters
pck (
bytes) – Part Common Keytimestamp (
int) – Timestamp for KDK derivationkey_length (
int) – Requested key length (128/256b)kdk_access_rights (
int) – KDK access rights (0-3)
- Return type
bytes- Returns
Key Derivation Key
SBFile Version 3.1. commands
Module for creation commands.
- class spsdk.sbfile.sb31.commands.BaseCmd(address, length, cmd_tag=0)
Bases:
spsdk.sbfile.sb31.commands.MainCmdFunctions for creating cmd intended for inheritance.
Constructor for Commands header.
- Parameters
address (
int) – Input addresslength (
int) – Input lengthcmd_tag (
int) – Command tag
- FORMAT = '<4L'
- SIZE = 16
- TAG = 1437248085
- property address: int
Get address.
- Return type
int
- export()
Export command as bytes.
- Return type
bytes
- classmethod header_parse(cmd_tag, data, offset=0)
Parse header command from bytes array.
- Parameters
data (
bytes) – Input data as bytes arrayoffset (
int) – The offset of input datacmd_tag (
int) – Information about command tag
- Raises
SPSDKError – Raised if tag is not equal to required TAG
SPSDKError – Raised if cmd is not equal EnumCmdTag
- Return type
Tuple[int,int]- Returns
Tuple
- info()
Get info of command.
- Raises
NotImplementedError – Derived class has to implement this method
- Return type
str
- property length: int
Get length.
- Return type
int
- class spsdk.sbfile.sb31.commands.CmdCall(address)
Bases:
spsdk.sbfile.sb31.commands.BaseCmdAddress will be the address to jump.
Constructor for Command.
- Parameters
address (
int) – Input address
- info()
Get info of command.
- Return type
str
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- class spsdk.sbfile.sb31.commands.CmdConfigureMemory(address, memory_id=0)
Bases:
spsdk.sbfile.sb31.commands.BaseCmdConfigure memory.
Constructor for command.
- Parameters
address (
int) – Input addressmemory_id (
int) – Memory ID
- export()
Export command as bytes.
- Return type
bytes
- info()
Get info of command.
- Return type
str
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- classmethod parse(data, offset=0)
Parse command from bytes array.
- Parameters
data (
bytes) – Input data as bytes arrayoffset (
int) – The offset of input data
- Return type
- Returns
CmdConfigureMemory
- class spsdk.sbfile.sb31.commands.CmdCopy(address, length, destination_address=0, memory_id_from=0, memory_id_to=0)
Bases:
spsdk.sbfile.sb31.commands.BaseCmdCopy data from one place to another.
Constructor for command.
- Parameters
address (
int) – Input addresslength (
int) – Input lengthdestination_address (
int) – Destination addressmemory_id_from (
int) – Memory IDmemory_id_to (
int) – Memory ID
- export()
Export command as bytes.
- Return type
bytes
- info()
Get info of command.
- Return type
str
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- class spsdk.sbfile.sb31.commands.CmdErase(address, length, memory_id=0)
Bases:
spsdk.sbfile.sb31.commands.BaseCmdErase given address range. The erase will be rounded up to the sector size.
Constructor for command.
- Parameters
address (
int) – Input addresslength (
int) – Input lengthmemory_id (
int) – Memory ID
- export()
Export command as bytes.
- Return type
bytes
- info()
Get info of command.
- Return type
str
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- class spsdk.sbfile.sb31.commands.CmdExecute(address)
Bases:
spsdk.sbfile.sb31.commands.BaseCmdAddress will be the jump-to address.
Constructor for Command.
- Parameters
address (
int) – Input address
- info()
Get info of command.
- Return type
str
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- classmethod parse(data, offset=0)
Parse command from bytes array.
- Parameters
data (
bytes) – Input data as bytes arrayoffset (
int) – The offset of input data
- Return type
- Returns
CmdExecute
- class spsdk.sbfile.sb31.commands.CmdFillMemory(address, length, pattern)
Bases:
spsdk.sbfile.sb31.commands.BaseCmdFill memory range by pattern.
Constructor for command.
- Parameters
address (
int) – Input addresslength (
int) – Input lengthpattern (
int) – Pattern for fill memory with
- export()
Export command as bytes.
- Return type
bytes
- info()
Get info of command.
- Return type
str
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- classmethod parse(data, offset=0)
Parse command from bytes array.
- Parameters
data (
bytes) – Input data as bytes arrayoffset (
int) – The offset of input data
- Return type
- Returns
CmdErase
- Raises
SPSDKError – Invalid padding
- class spsdk.sbfile.sb31.commands.CmdFwVersionCheck(value, counter_id)
Bases:
spsdk.sbfile.sb31.commands.BaseCmdCheck counter value with stored value, if values are not same, SB file is rejected.
Constructor for command.
- Parameters
value (
int) – Input valuecounter_id (
int) – Counter ID (NONSECURE = 1, SECURE = 2)
- class CounterID
Bases:
spsdk.utils.easy_enum.EnumCounter IDs used by the CmdFwVersionCheck command.
- BOOTLOADER = 5
- NONE = 0
- NONSECURE = 1
- RADIO = 3
- SECURE = 2
- SNT = 4
- export()
Export command as bytes.
- Return type
bytes
- info()
Get info of command.
- Return type
str
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- classmethod parse(data, offset=0)
Parse command from bytes array.
- Parameters
data (
bytes) – Input data as bytes arrayoffset (
int) – The offset of input data
- Return type
- Returns
CmdFwVersionCheck
- class spsdk.sbfile.sb31.commands.CmdLoad(address, data, memory_id=0)
Bases:
spsdk.sbfile.sb31.commands.CmdLoadBaseData to write follows the range header.
Constructor for command.
- Parameters
address (
int) – Address for the load commanddata (
bytes) – Data to loadmemory_id (
int) – Memory ID
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
Union[CmdLoad,CmdLoadHashLocking,CmdLoadCmac]- Returns
Command object loaded from configuration.
- Raises
SPSDKError – Invalid configuration field.
- class spsdk.sbfile.sb31.commands.CmdLoadBase(cmd_tag, address, data, memory_id=0)
Bases:
spsdk.sbfile.sb31.commands.BaseCmdBase class for commands loading data.
Constructor for command.
- Parameters
cmd_tag (
int) – Command tag for the derived classaddress (
int) – Address for the load commanddata (
bytes) – Data to loadmemory_id (
int) – Memory ID
- HAS_MEMORY_ID_BLOCK = True
- export()
Export command as bytes.
- Return type
bytes
- info()
Get info about the load command.
- Return type
str
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- classmethod parse(data, offset=0)
Parse command from bytes array.
- Parameters
data (
bytes) – Input data as bytes arrayoffset (
int) – The offset of input data
- Return type
- Returns
CmdLoad
- Raises
SPSDKError – Invalid cmd_tag was found
- class spsdk.sbfile.sb31.commands.CmdLoadCmac(address, data, memory_id=0)
Bases:
spsdk.sbfile.sb31.commands.CmdLoadBaseLoad cmac. ROM is calculating cmac from loaded data.
Constructor for command.
- Parameters
address (
int) – Address for the load commanddata (
bytes) – Data to loadmemory_id (
int) – Memory ID
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- Raises
SPSDKError – Invalid configuration field.
- class spsdk.sbfile.sb31.commands.CmdLoadHashLocking(address, data, memory_id=0)
Bases:
spsdk.sbfile.sb31.commands.CmdLoadBaseLoad hash. ROM is calculating hash.
Constructor for command.
- Parameters
address (
int) – Address for the load commanddata (
bytes) – Data to loadmemory_id (
int) – Memory ID
- export()
Export command as bytes.
- Return type
bytes
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- Raises
SPSDKError – Invalid configuration field.
- class spsdk.sbfile.sb31.commands.CmdLoadKeyBlob(offset, data, key_wrap_id)
Bases:
spsdk.sbfile.sb31.commands.BaseCmdLoad key blob.
Constructor for command.
- Parameters
offset (
int) – Input offsetkey_wrap_id (
int) – Key wrap ID (NXP_CUST_KEK_INT_SK = 16, NXP_CUST_KEK_EXT_SK = 17)data (
bytes) – Wrapped key blob
- FORMAT = '<L2H2L'
- class KeyWraps
Bases:
spsdk.utils.easy_enum.EnumKeyWrap IDs used by the CmdLoadKeyBlob command.
- NXP_CUST_KEK_EXT_SK = 17
- NXP_CUST_KEK_INT_SK = 16
- export()
Export command as bytes.
- Return type
bytes
- info()
Get info of command.
- Return type
str
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- classmethod parse(data, offset=0)
Parse command from bytes array.
- Parameters
data (
bytes) – Input data as bytes arrayoffset (
int) – The offset of input data
- Return type
- Returns
CmdLoadKeyBlob
- class spsdk.sbfile.sb31.commands.CmdProgFuses(address, data)
Bases:
spsdk.sbfile.sb31.commands.CmdLoadBaseAddress will be address of fuse register.
Constructor for Command.
- Parameters
address (
int) – Input addressdata (
bytes) – Input data
- HAS_MEMORY_ID_BLOCK = False
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- classmethod parse(data, offset=0)
Parse command from bytes array.
- Parameters
data (
bytes) – Input data as bytes arrayoffset (
int) – The offset of input data
- Return type
- Returns
CmdProgFuses
- class spsdk.sbfile.sb31.commands.CmdProgIfr(address, data)
Bases:
spsdk.sbfile.sb31.commands.CmdLoadBaseAddress will be the address into the IFR region.
Constructor for Command.
- Parameters
address (
int) – Input addressdata (
bytes) – Input data as bytes array
- HAS_MEMORY_ID_BLOCK = False
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- classmethod parse(data, offset=0)
Parse command from bytes array.
- Parameters
data (
bytes) – Input data as bytes arrayoffset (
int) – The offset of input data
- Return type
- Returns
CmdProgFuses
- class spsdk.sbfile.sb31.commands.CmdSectionHeader(length, section_uid=1, section_type=1)
Bases:
spsdk.sbfile.sb31.commands.MainCmdCreate section header.
Constructor for Commands section.
- Parameters
section_uid (
int) – Input uidsection_type (
int) – Input typelength (
int) – Input length
- FORMAT = '<4L'
- SIZE = 16
- export()
Export command as bytes.
- Return type
bytes
- info()
Get info of Section header.
- Return type
str
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- Raises
SPSDKError – This situation cannot raise (the function here is just MYPY/PYLINT checks).
- classmethod parse(data, offset=0)
Parse command from bytes array.
- Parameters
data (
bytes) – Input data as bytes arrayoffset (
int) – The offset of input data
- Raises
SPSDKError – Raised when FORMAT is bigger than length of the data without offset
- Return type
- Returns
CmdSectionHeader
- class spsdk.sbfile.sb31.commands.MainCmd
Bases:
objectFunctions for creating cmd intended for inheritance.
- export()
Export command as bytes.
- Raises
NotImplementedError – Derived class has to implement this method
- Return type
bytes
- abstract info()
Get info of command.
- Raises
NotImplementedError – Derived class has to implement this method
- Return type
str
- classmethod load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
Dict[str,Any]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Command object loaded from configuration.
- Raises
NotImplementedError – Derived class has to implement this method
- classmethod parse(data, offset=0)
Parse command from bytes array.
- Raises
NotImplementedError – Derived class has to implement this method
- Return type
object
- spsdk.sbfile.sb31.commands.parse_command(data, offset=0)
Parse command from bytes array.
- Parameters
data (
bytes) – Input data as bytes arrayoffset (
int) – The offset of input data
- Raises
SPSDKError – Raised when tag is not in cmd_class
SPSDKError – Raised when tag is invalid
- Return type
object- Returns
object
SBFile Version 3.1. images
Module used for generation SecureBinary V3.1.
- class spsdk.sbfile.sb31.images.SecureBinary31(curve_name, cert_block, firmware_version, signing_key, pck=None, kdk_access_rights=None, description=None, is_nxp_container=False, flags=0, timestamp=None, is_encrypted=True)
Bases:
spsdk.utils.crypto.abstract.BaseClassSecure Binary SB3.1 class.
Constructor for Secure Binary v3.1 data container.
- Parameters
curve_name (
str) – Name of the ECC curve used for Secure binary (secp256r1/secp384r1).cert_block (
CertBlockV31) – Certification block.firmware_version (
int) – Firmware version (must be bigger than current CMPA record).signing_key (
bytes) – Key to final sign of SB3.1 image.pck (
Optional[bytes]) – Part Common Key (needed if is_encrypted is True), defaults to Nonekdk_access_rights (
Optional[int]) – Key Derivation Key access rights (needed if is_encrypted is True), defaults to Nonedescription (
Optional[str]) – Custom description up to 16 characters long, defaults to Noneis_nxp_container (
bool) – NXP provisioning SB file, defaults to Falseflags (
int) – Flags for SB file, defaults to 0timestamp (
Optional[int]) – Timestamp used for encryption (needed if is_encrypted is True), defaults to Noneis_encrypted (
bool) – Indicate whether commands should be encrypted or not, defaults to True
- export()
Generate binary output of SB3.1 file.
- Return type
bytes- Returns
Content of SB3.1 file in bytes.
- classmethod generate_config_template(family)
Generate configuration for selected family.
- Parameters
family (
str) – Family description.- Return type
Dict[str,str]- Returns
Dictionary of individual templates (key is name of template, value is template itself).
- static get_supported_families()
Return list of supported families.
- Return type
List[str]- Returns
List of supported families.
- classmethod get_validation_schemas(include_test_configuration=False)
Create the list of validation schemas.
- Parameters
include_test_configuration (
bool) – Add also testing configuration schemas.- Return type
List[Dict[str,Any]]- Returns
List of validation schemas.
- info()
Create string information about SB3.1 loaded file.
- Return type
str- Returns
Text information about SB3.1.
- classmethod load_from_config(config, search_paths=None)
Creates an instance of SecureBinary31 from configuration.
- Parameters
config (
Dict[str,Any]) – Input standard configuration.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
- Returns
Instance of Secure Binary V3.1 class
- classmethod parse(data, offset=0)
Deserialize object from bytes array.
- Raises
NotImplementedError – Not yet implemented
- Return type
- validate()
Validate the settings of class members.
- Raises
SPSDKError – Invalid configuration of SB3.1 class members.
- Return type
None
- class spsdk.sbfile.sb31.images.SecureBinary31Commands(curve_name, is_encrypted=True, pck=None, timestamp=None, kdk_access_rights=None)
Bases:
spsdk.utils.crypto.abstract.BaseClassBlob containing SB3.1 commands.
Initialize container for SB3.1 commands.
- Parameters
curve_name (
str) – Name of the ECC curve used for Secure binary (secp256r1/secp384r1)is_encrypted (
bool) – Indicate whether commands should be encrypted or not, defaults to Truepck (
Optional[bytes]) – Part Common Key (needed if is_encrypted is True), defaults to Nonetimestamp (
Optional[int]) – Timestamp used for encryption (needed if is_encrypted is True), defaults to Nonekdk_access_rights (
Optional[int]) – Key Derivation Key access rights (needed if is_encrypted is True), defaults to None
- Raises
SPSDKError – Key derivation arguments are not provided if is_encrypted is True
- DATA_CHUNK_LENGTH = 256
- add_command(command)
Add SB3.1 command.
- Return type
None
- export()
Export commands as bytes.
- Return type
bytes
- get_cmd_blocks_to_export()
Export commands as bytes.
- Return type
List[bytes]
- info()
Get string information for commands in the container.
- Return type
str
- load_from_config(config, search_paths=None)
Load configuration from dictionary.
- Parameters
config (
List[Dict[str,Any]]) – Dictionary with configuration fields.search_paths (
Optional[List[str]]) – List of paths where to search for the file, defaults to None
- Return type
None
- classmethod parse(data, offset=0)
Parse binary data into SecureBinary31Commands.
- Raises
NotImplementedError – Not yet implemented
- Return type
- process_cmd_blocks_to_export(data_blocks)
Process given data blocks for export.
- Return type
bytes
- set_commands(commands)
Set all SB3.1 commands at once.
- Return type
None
- validate()
Validate the settings of class members.
- Raises
SPSDKError – Invalid configuration of SB3.1 commands blob class members.
- Return type
None
- class spsdk.sbfile.sb31.images.SecureBinary31Header(firmware_version, curve_name, description=None, timestamp=None, is_nxp_container=False, flags=0)
Bases:
spsdk.utils.crypto.abstract.BaseClassHeader of the SecureBinary V3.1.
Initialize the SecureBinary V3.1 Header.
- Parameters
firmware_version (
int) – Firmware version (must be bigger than current CMPA record)curve_name (
str) – Name of the ECC curve used for Secure binary (secp256r1/secp384r1)description (
Optional[str]) – Custom description up to 16 characters long, defaults to Nonetimestamp (
Optional[int]) – Timestamp (number of seconds since Jan 1st, 200), if None use current timeis_nxp_container (
bool) – NXP provisioning SB file, defaults to Falseflags (
int) – Flags for SB file, defaults to 0
- DESCRIPTION_LENGTH = 16
- FORMAT_VERSION = '3.1'
- HEADER_FORMAT = '<4s2H3LQ4L16s'
- HEADER_SIZE = 60
- MAGIC = b'sbv3'
- calculate_block_size()
Calculate the the data block size.
- Return type
int
- calculate_cert_block_offset()
Calculate the offset to the Certification block.
- Return type
int
- export()
Serialize the SB file to bytes.
- Return type
bytes
- info()
Get info of SB v31 as a string.
- Return type
str
- classmethod parse(data, offset=0)
Parse binary data into SecureBinary31Header.
- Raises
NotImplementedError – Not yet implemented
- Return type
- update(commands, cert_block)
Updates the volatile fields in header by real commands and certification block data.
- Parameters
commands (
SecureBinary31Commands) – SB3.1 Commands blockcert_block (
CertBlockV31) – SB3.1 Certification block.
- Return type
None
- validate()
Validate the settings of class members.
- Raises
SPSDKError – Invalid configuration of SB3.1 header blob class members.
- Return type
None
SBFile - miscellaneous functions
Miscellaneous functions in SBFile module.
- class spsdk.sbfile.misc.BcdVersion3(major=1, minor=0, service=0)
Bases:
objectVersion in format #.#.#, where # is BCD number (1-4 digits).
Initialize BcdVersion3.
- Parameters
major (
int) – number in BCD format, 1-4 decimal digitsminor (
int) – number in BCD format, 1-4 decimal digitsservice (
int) – number in BCD format, 1-4 decimal digits
- Raises
SPSDKError – Invalid version
- DEFAULT = '999.999.999'
- static from_str(text)
Convert string to BcdVersion instance.
- Parameters
text (
str) – version in format #.#.#, where # is 1-4 decimal digits- Return type
- Returns
BcdVersion3 instance
- Raises
SPSDKError – If format is not valid
- property nums: Sequence[int]
Return array of version numbers: [major, minor, service].
- Return type
Sequence[int]
- static to_version(input_version)
Convert different input formats into BcdVersion3 instance.
- Parameters
input_version (
Union[BcdVersion3,str]) – either directly BcdVersion3 or string- Raises
SPSDKError – Raises when the format is unsupported
- Return type
- Returns
BcdVersion3 instance
- class spsdk.sbfile.misc.SecBootBlckSize
Bases:
objectHelper methods allowing to convert size to number of blocks and back.
Note: The class is not intended to be instantiated
- BLOCK_SIZE = 16
- static align(size)
Align given size to block size.
- Parameters
size (
int) – in bytes- Return type
int- Returns
size aligned up to block size
- static align_block_fill_random(data)
Align block size to cipher block size.
- Parameters
data (
bytes) – to be aligned- Return type
bytes- Returns
data aligned to cipher block size, filled with random values
- static is_aligned(size)
Whether size is aligned to cipher block size.
- Parameters
size (
int) – given size in bytes- Return type
bool- Returns
True if yes, False otherwise
- static to_num_blocks(size)
Converts size to number of cipher blocks.
- Parameters
size (
int) – to be converted, the size must be aligned to block boundary- Return type
int- Returns
corresponding number of cipher blocks
- Raises
SPSDKError – Raised when size is not aligned to block boundary
- spsdk.sbfile.misc.pack_timestamp(value)
Converts datetime to millisecond since 1.1.2000.
- Parameters
value (
datetime) – datetime to be converted- Return type
int- Returns
number of milliseconds since 1.1.2000 00:00:00; 64-bit integer
- Raises
SPSDKError – When there is incorrect result of conversion
- spsdk.sbfile.misc.unpack_timestamp(value)
Converts timestamp in milliseconds into datetime.
- Parameters
value (
int) – number of milliseconds since 1.1.2000 00:00:00; 64-bit integer- Return type
datetime- Returns
corresponding datetime
- Raises
SPSDKError – When there is incorrect result of conversion