1. Applicable products
Here is the list of applicable products for SFI on STM32H5 with Secure Manager:
| Type | Products |
|---|---|
| Microcontroller | STM32H573xx |
2. Environment setup
As explained in SFI Image generation, the Secure Firmware Install (SFI) image generation and the SFI image test rely on the Secure Manager Access Kit (SMAK).
Follow SMAK prerequisites and SMAK package contents for the SFI environment setup.
3. Development at OEM offices: firmware creation
The purpose of this SFI service is to securely install the OEM firmware developed with Secure Manager.
Therefore, to use this SFI service, the OEM must develop its nonsecure application during the SMAK development phase.
The OEM firmware file is .hex extension.
STMicroelectronics provides an application example in STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\Applications\ROT\SMAK_Appli\Binary\appli_enc_sign.hex.
4. Secure room at OEM offices: SFI image generation and HSM provisioning at OEM trusted offices
4.1. HSM programming
If you want to install your SFI with a chip-specific license, you need to program a STM32HSM-V2.
Inputs for HSM programming:
- OEM key (encryption AES key + nonce)
To program the HSM, you can follow the steps described in HSM programming.
After programming the HSM, it is now ready to be shipped to the Contract Manufacturer (CM) together With the SFI that will be created in SFI image generation
4.2. Generating a global license
If you want to install your SFI with a global license, simply follow the Generation and installation of the SFI
4.3. SFI image generation
Once the OEM completes its nonsecure application development, the OEM must prepare and test the final encrypted image (SFI image) used for OEM secure manufacturing with the SMAK production preparation phase.
4.3.1. Step by step procedure
4.3.1.1. Step 1: Configuration
For this step, JSON and ini files will be manipulated. These files are designed to be customized.
4.3.1.1.1. OEM Application
- Copy your OEM application in the Binary folder (called oem_app.hex hereafter):
cp oem_app.hex STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\Binary
- Copy the JSON template in the Binary folder :
cp STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\Binary\JSON\Templates\ns_app_template.json STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\Binary\JSON\ns_app_oem.json
This JSON file indicates to ROT_Provisioning\SM\provisioning.py the path of a nonsecure application to be installed in the SFI procedure. This path can be an absolute path or a relative path from the JSON itself to a nonsecure application already encrypted and signed with OEM keys available in ROT_Provisioning\SM\Keys.
- Modify the content of ns_app_oem.json by replacing the existing path with the path to your OEM application as shown in the code snippet below:
"binary":"../../Binary/oem_app.hex"
- Finally, modify STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\Config\sm.ini.
In this file, the dictionary "images" must contain a key "ns_app" and a corresponding path to a JSON file. This path can be an absolute path or a relative path from the sm.ini itself. In this case, the path is the path to ns_app_oem.json previously modified:
images = {"ns_app" : "../Binary/JSON/ns_app_oem.json",
4.3.1.1.2. Modules without license
- Copy your module in the Binary folder (called oem_module.hex hereafter):
cp module.hex STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\Binary
- Copy the JSON template in the Binary folder :
cp STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\Binary\JSON\Templates\module_template.json STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\Binary\JSON\module_oem.json
This JSON file indicates to ROT_Provisioning\SM\provisioning.py the path of a module to be installed in the SFI procedure. This path can be an absolute path or a relative path from the JSON itself to a module already encrypted and signed with OEM keys available in ROT_Provisioning\SM\Keys.
- Modify the content of module_oem.json by replacing the existing path with the path to your OEM module as shown in the code snippet below:
"binary":"../../Binary/oem_module.hex"
- Finally, modify STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\Config\sm.ini.
In this file, the dictionary "images" must contain a key "module_0" and a corresponding path to a JSON file. This path can be an absolute path or a relative path from the sm.ini itself. In this case, the path is the path to module_oem.json previously modified:
images = {"ns_app" : "../Binary/JSON/ns_app_oem.json",
"module_0" : "../Binary/JSON/module_oem.json",
4.3.1.1.3. Modules with a global license
- Copy your third-party module (3rdPartyModule.smu) and its license (3rdPartyGlobalLicense.bin) in the Binary folder:
cp 3rdPartyModule.smu STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\Binary
cp 3rdPartyGlobalLicense.bin STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\Binary
- Copy the JSON template in the Binary folder :
cp STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\Binary\JSON\Templates\module_with_global_license_template.json STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\Binary\JSON\module_with_global_license.json
This JSON file indicates to ROT_Provisioning\SM\provisioning.py the paths of a third-party module with its license to be installed in the SFI procedure. These paths can be an absolute path or a relative path from the JSON itself to a module encrypted and signed with its global license.
- Modify the content of module_with_global_license.json by replacing the existing paths with the path to your third-party module and its license as shown in the code snippet below:
"binary":"../../Binary/3rdPartyModule.smu",
"license":"../../Binary/3rdPartyGlobalLicense.bin"
- Finally, modify STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\Config\sm.ini.
In this file, the dictionary "images" must contain a key "module_0" and a corresponding path to a JSON file. This path can be an absolute path or a relative path from the sm.ini itself. In this case, the path is the path to module_with_global_license.json previously modified:
images = {"ns_app" : "../Binary/JSON/ns_app_oem.json",
"module_0" : "../Binary/JSON/module_with_global_license.json",
4.3.1.1.4. Modules with a chip-specific license
- Copy your third-party module in the Binary folder (called 3rdPartyModule.smu hereafter):
cp 3rdPartyModule.smu STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\Binary
- Copy the JSON template in the Binary folder :
cp STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\Binary\JSON\Templates\module_with_chip_specific_license_template.json STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\Binary\JSON\module_with_chip_specific_license.json
This JSON file indicates to ROT_Provisioning\SM\provisioning.py the path of a third-party module with a chip-specific license to be installed in the SFI procedure. This path can be an absolute path or a relative path from the JSON itself to a module encrypted and signed with a chip-specific license.
- Modify the content of module_with_chip_specific_license.json by replacing the existing path with the path to your third-party module as shown in the code snippet below:
"binary":"../../Binary/3rdPartyModule.smu"
- Finally, modify STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\Config\sm.ini.
In this file, the dictionary "images" must contain a key "module_0" and a corresponding path to a JSON file. This path can be an absolute path or a relative path from the sm.ini itself. In this case, the path is the path to module_with_chip_specific_license.json previously modified:
images = {"ns_app" : "../Binary/JSON/ns_app_oem.json",
"module_0" : "../Binary/JSON/module_with_chip_specific_license.json",
4.3.1.2. Step 2: Generation and installation of the SFI
Follow Script provisioning.py step 1: Configuration and Script provisioning.py step 2: Installation.
After these steps, the SFI image is generated and installed. The OEM application and module (if any) are running on target and ready for tests.
If no renaming, the important files for further installations are located in:
- STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\Binary\SecureManagerPackage.sfi The tested SFI image ready for manufacturing
- STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\Keys\SFI_Global_License.bin The SFI global license
If there is a module, these files must be also kept:
- STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\Binary\modules.mcsv This file contains the module information's
- The module itself, with the same path provided during the configuration phase
- The global license (if any) , with the same path provided during the configuration of a module with a global license phase
- The HSM card in case of a module with chip-specific license
In case of issue:
- Check the STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\provisioning.log file
- Perform a regression by opening a terminal in STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\SM\ and execute the command below:
python provisioning.py --regression
5. Programming at OEM-CM manufacturing: Secure Firmware Installation
In this step, the CM receives from the OEM:
- The SFI image to be installed (SecureManagerPackage.sfi)
- The SFI global license (SFI_Global_License.bin) or in case of SFI chip-specific license, the HSM card provisioned with the OEM key and initialized with a max counter of licenses
- In case of module:
- The module information's (modules.mcsv)
- The module itself
- In case of module with a global license, the module global license file (3rdPartyGlobalLicense.bin) or in case of module chip-specific license, the HSM card provisioned with the module secret key and initialized with a max counter of licenses
The SFI process could be performed through a regular JTAG/SWD interface or the system bootloader interface (you can refer to the application note AN2606[1] for details on the supported interface for each microcontroller).
The following covers the JTAG/SWD and system bootloader interface for each of the sections below:
- Hardware connection
- Software adaptation
- Target initial state
- Secure firmware install
5.1. Hardware connection
5.1.1. Board
5.1.2. HSM card
Plug your HSM card provisioned with the SFI OEM key in case of SFI chip-specific license.
Let us assume that the HSM card is plugged in the smart card reader slot 1.
Plug your HSM card provisioned with the module secret key in case of module chip-specific license.
Let us assume that the HSM card is plugged in the smart card reader slot 2.
5.2. Target initial state
The target must be in Open product state.
If it is not the case, a debug authentication (DA) full regression must be performed by opening a terminal in STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\DA.
python da.py --regression
After this step, the device is ready for the SFI process.
5.3. Secure Firmware Install
This command starts the SFI process:
- with sfi global license
- without module
and proceeds with the installation:
STM32_Programmer_CLI.exe -log .\sfi.log -c port=SWD mode=HOTPLUG -sfi .\image.sfi hsm=0 license=.\sfi_global_license.bin -rsse C:\Program Files\STMicroelectronics\STM32Cube\STM32CubeProgrammer\bin\RSSe\H5\enc_signed_RSSe_SFI_STM32H5_v2.0.0.0.bin
This command starts the SFI process with:
- sfi chip specific license
- module with license
and proceeds with the installation:
STM32_Programmer_CLI.exe -log .\sfi.log -c port=SWD mode=HOTPLUG -sfi .\image.sfi hsm=1 slot=0 -rsse C:\Program Files\STMicroelectronics\STM32Cube\STM32CubeProgrammer\bin\RSSe\H5\enc_signed_RSSe_SFI_STM32H5_v2.0.0.0.bin -mcsv .\module.mcsv
This command starts the SFI process with:
- sfi global license
- module with license
and proceeds with the installation:
STM32_Programmer_CLI.exe -log .\sfi.log -c port=SWD mode=HOTPLUG -sfi .\image.sfi hsm=0 license=.\sfi_global_license.bin -rsse C:\Program Files\STMicroelectronics\STM32Cube\STM32CubeProgrammer\bin\RSSe\H5\enc_signed_RSSe_SFI_STM32H5_v2.0.0.0.bin -mcsv .\module.mcsv
This command starts the SFI process with:
- sfi global license
- module without license
and proceeds with the installation:
STM32_Programmer_CLI.exe -log .\sfi.log -c port=SWD mode=HOTPLUG -sfi .\image.sfi hsm=0 license=.\sfi_global_license.bin -rsse C:\Program Files\STMicroelectronics\STM32Cube\STM32CubeProgrammer\bin\RSSe\H5\enc_signed_RSSe_SFI_STM32H5_v2.0.0.0.bin
You can check the log of the process saved in the file sfi.log:
-------------------------------------------------------------------
STM32CubeProgrammer v2.14.0
-------------------------------------------------------------------
ST-LINK SN : 003600374D46501220383832
ST-LINK FW : V3J10M3
Board : STM32H573I-DK
Voltage : 3.29V
SWD freq : 8000 KHz
Connect mode: Hot Plug
Reset mode : Software reset
Device ID : 0x484
Revision ID : --
Device name : STM32H5xx
Flash size : 2 MBytes
Device type : MCU
Device CPU : Cortex-M33
BL Version : 0xE4
SFSP Version: v2.4.0
Protocol Information : static
SFI File Information :
SFI file path : .\image.sfi
SFI license file path : .\HSM_License_V1.bin
SFI header information :
SFI protocol version : 2
SFI total number of areas : 11
SFI image version : 0
SFI Areas information :
Parsing Area 1/11 :
Area type : H
Area size : 16
Area destination address : 0x0
Parsing Area 2/11 :
Area type : O
Area size : 112
Area destination address : 0xFFD0100
Parsing Area 3/11 :
Area type : O
Area size : 272
Area destination address : 0xFFD0200
Parsing Area 4/11 :
Area type : O
Area size : 192
Area destination address : 0xFFD09D0
Parsing Area 5/11 :
Area type : O
Area size : 112
Area destination address : 0xFFD0A80
Parsing Area 6/11 :
Area type : S
Area size : 102952
Area destination address : 0x0
Parsing Area 7/11 :
Area type : S
Area size : 99350
Area destination address : 0x0
Parsing Area 8/11 :
Area type : F
Area size : 5744
Area destination address : 0x8100000
Parsing Area 9/11 :
Area type : K
Area size : 16
Area destination address : 0x0
Parsing Area 10/11 :
Area type : m
Area size : 131072
Area destination address : 0x8172000
Parsing Area 11/11 :
Area type : C
Area size : 48
Area destination address : 0x0
Warning: Option byte: BOOT_UBE, value: 0xB4, was not modified.
Warning: Option bytes are unchanged, Data won't be downloaded
Time elapsed during option bytes configuration: 00:00:00.002
Reconnecting...
Reconnected !
Reconnecting...
Reconnected !
Time elapsed during option bytes configuration: 00:00:02.442
ST-LINK SN : 003600374D46501220383832
ST-LINK FW : V3J10M3
Board : STM32H573I-DK
Voltage : 3.29 V
SWD freq : 8000 kHz
Connect mode: Hot Plug
Reset mode : Software reset
Device ID : 0x484
Revision ID : --
Warning: Option byte: SECBOOT_LOCK, value: 0xC3, was not modified.
Warning: Option bytes are unchanged, Data won't be downloaded
Time elapsed during option bytes configuration: 00:00:00.004
Warning: Option Byte: SECBOOTADD, value: 0xC0000, was not modified.
Warning: Option Byte: SECWM1_END, value: 0x7F, was not modified.
Warning: Option Byte: SECWM1_STRT, value: 0x0, was not modified.
Warning: Option Byte: SECWM2_END, value: 0x7F, was not modified.
Warning: Option Byte: SECWM2_STRT, value: 0x0, was not modified.
Warning: Option Byte: SRAM1_3_RST, value: 0x1, was not modified.
Reconnecting...
Reconnected !
Time elapsed during option bytes configuration: 00:00:01.253
ST-LINK SN : 003600374D46501220383832
ST-LINK FW : V3J10M3
Board : STM32H573I-DK
Voltage : 3.29 V
SWD freq : 8000 kHz
Connect mode: Hot Plug
Reset mode : Software reset
Device ID : 0x484
Revision ID : --
Reconnecting...
Reconnected !
Reconnecting...
Reconnected !
Time elapsed during option bytes configuration: 00:00:02.884
ST-LINK SN : 003600374D46501220383832
ST-LINK FW : V3J10M3
Board : STM32H573I-DK
Voltage : 3.29 V
SWD freq : 8000 kHz
Connect mode: Hot Plug
Reset mode : Software reset
Device ID : 0x484
Revision ID : --
Installing RSSe
Memory Programming ...
Opening and parsing file: enc_signed_RSSe_SFI_STM32H5_v2.0.0.0.bin
File : enc_signed_RSSe_SFI_STM32H5_v2.0.0.0.bin
Size : 53.81 KB
Address : 0x20054100
Erasing memory corresponding to segment 0:
Download in Progress:
File download complete
Time elapsed during download operation: 00:00:00.134
MCU Reset
ST-LINK SN : 003600374D46501220383832
ST-LINK FW : V3J10M3
Board : STM32H573I-DK
Voltage : 3.29 V
SWD freq : 8000 kHz
Connect mode: Hot Plug
Reset mode : Software reset
Device ID : 0x484
Revision ID : --
Get RSSe status...
RSS version = 2.2.0
RSSe version = 2.0.0
Starting SFI
Processing license...
Get RSSe status...
Processing Image Header
Get RSSe status...
Processing Area 1...
Get RSSe status...
Area Address = 0x0
Area Type = H
Processing Area 2...
Get RSSe status...
Area Address = 0xFFD0100
Area Type = O
Processing Area 3...
Get RSSe status...
Area Address = 0xFFD0200
Area Type = O
Processing Area 4...
Get RSSe status...
Area Address = 0xFFD09D0
Area Type = O
Processing Area 5...
Get RSSe status...
Area Address = 0xFFD0A80
Area Type = O
Processing Area 6...
Get RSSe status...
Area Address = 0x0
Area Type = S
Processing Area 7...
Get RSSe status...
Area Address = 0x0
Area Type = S
Processing Area 8...
Get RSSe status...
Area Address = 0x8100000
Area Type = F
Processing Area 9...
Get RSSe status...
Area Address = 0x0
Area Type = K
MCSV file parsing...
Total modules number: 1
+ Module number : [0]
Name : .\module.smu
Type : Global license
Size : 128.00 KB
Address : 0x08172000
Prepare module payload with license data...
Processing Area 10...
Get RSSe status...
Area Address = 0x8172000
Area Type = m
Processing Area 11...
Can not verify last area
Area Address = 0x0
Area Type = C
SFI Process Finished!
SFI file .\image.sfi Install Operation Success
Time elapsed during SFI install operation: 00:00:18.984
At this step, the device is programmed with the secure manager, the module, the OEM nonsecure application, and the option bytes. The product state is Closed or Locked.
5.4. Troubleshooting
In case of failure:
- check sfi.log
- if not in Locked state, open a terminal in STM32Cube_FW_H5_VX.X.X\Projects\STM32H573I-DK\ROT_Provisioning\DA and execute the command below to come back in Open state and be able to launch a new SFI procedur:
python da.py --regression
6. References
AN4992 [1] Introduction to secure firmware install (SFI) for STM32 MCUs
AN6035 Third party programmers guide for STM32H5 MCUs => contact STMicroelectronics sales representative.
AN5391 Introduction to SFI tools, bootloader, and RSS interface for STM32 MCUs => contact STMicroelectronics sales representative.