How to start with OEMiRoT on STM32H7S

Literature

OEMiRoT STM32H7S How to Introduction
How to start with DA access on STM32H7RS
UM2237 STM32CubeProgrammer software description
UM2238 STM32 trusted package creator (TPC) tool software description
AN5054 Secure programming using STM32CubeProgrammer

Target description

The purpose of this article is to explain step by step how to use the STM32CubeFW example provided by ST, for OEMiRoT, using the STM32H7S discovery board.

How to use the script provided by ST and perform all the required steps.
How to install and run the user application example which is provided.
How to perform a regression to retrieve an empty board with initial settings.

Information

How to start with DA access on STM32H7RS wiki article can also guide you to practice with debug opening, and download a new image from a closed device in download slot, that will generate a firmware update at next reset.

Introduction

Start by reading the OEMiRoT STM32H7S How to Introduction article.

One example of OEMiRoT is provided in the STM32Cube_FW that is used in this "getting started".

Through this practical example you will learn:

What OEMiRoT is and how to use the STM32CubeFW example which is provided.
How to configure the OEMiRoT and the debug authentication for this example.
How to generate an encrypted and signed image for the user application firmware.
What the device provisioning is and how to perform the setup of the device.
How the user application is installed.
How to perform a regression to retrieve an empty board.

Prerequisites

Hardware
- STM32H7S discovery board: the STM32H7S devices have all the available security features, including the HW crypto accelerator (the HW cryptographic acceleration is not support for STM327R devices).
- Discovery MB1736- STM32H7S (need USBC cable)

Required tools
- STM32Cube_FW_H7RS_V1.0.0 or later
- STM32CubeProgrammer v2.16.0 or more recent (with trusted package creator (TPC) selected at installation)
- IAR Embedded Workbench^® rev 9.60 or later.
  or IAR Embedded Workbench^® rev 9.20.1 or later + IAR Patch EWARMv9_STM32H7R-Sxx_Vx.x.x
  - IAR patch is available in the STM32CubeFW: STM32Cube_FW_H7RS_Vx.x.x\Utilities\PC_Software
- Tera Term / Putty or equivalent terminal emulator

Information

The TPC installed together with CubeProgrammer in the bin folder located in default STM32CubeProgrammer path : C:\Program Files\STMicroelectronics\STM32Cube\STM32CubeProgrammer\bin You can pin this tool to the taskbar to simplify the "STiRoT Getting started" process :

STM32Cube Firmware
- Download the STM32Cube_FW_H7RS Cube firmware (advise is to place it close form the C: in order to avoid long windows paths).
- A directory STM32H7S78-DK is included in "STM32Cube_FW_H7RS\Projects" .

Open the env.bat file

1- If the STM32CubeProgrammer has not been installed in the default folder:

C:\Program Files\STMicroelectronics\STM32Cube\STM32CubeProgrammer, the customized installation path needs to be updated.

2- Update the COM port to be aligned with your COM port number.

Use the Windows device manager to find out your COM port number, as shown in figure below:

3- Check that the OEMiRoT_Appli path is OK. The picture below shows the configuration path for the STM32CubeFW example but it is possible to select an other application that respects OEMiRoT template.

1. Example with PASSWORD configuration

This chapter explains how to start with the provisioning script.
It is used to configure the OEMiRoT and the debug authentication.

1.1. Preliminary stage

The different steps to configure and use the OEMiRoT are based on a script provided in the STM32CubeFW:

Projects\STM32H7S78-DK\ROT_Provisioning\OEMiROT\provisioning.bat

The following documentation is a guide through all the steps of this script, and explains how to perform each of them.

The figure below shows where the script is located in the STM32CubeFW.

Before running the provisioning script be careful to disconnect the UART from any terminal tool otherwise the provisioning might fail.
Launch the script: provisioning.bat (double click) and keep it running during all the following steps.
- Type the product state: CLOSED (don't use LOCKED for this tutorial, this state is used only to set a final product state).
- Type the chosen Debug Authentication: PASSWORD (for explanation about certificate and password refer to intro article).

1.2. OEMiRoT configuration

The next steps indicated by the script is to open the OEMiROT_Config.xml file, to update to the wanted configuration and to generate the OBk file.

Open STM32TrustedPackageCreator

Select the shield
Select OBkey tab
Select the OEMiRoT_Config.xml configuration file. All the default settings for this hands-on are already filled-in and it is not needed to regenerate the encryption and authentication keys. In case these keys are regenerated, the firmware image needs to be regenerated (in case this image is already available)
Generate OBkey
The confirmation window is displayed

According to the path specified in the OEMiROT_Config.xml, an OEMiROT_Config.obk file is generated in Projects\STM32H7S78-DK\ROT_Provisioning\OEMiROT\Binary folder. This file will be used by the script during the provisioning step.

1.3. Debug Authentication configuration

The Debug Authentication (DA) configuration is the next step of the script.

Warning

If you are using a STM32H7R device, you must modify the xml file to disable encryption as it is not supported on these devices.

Open the DA_Config.xml configuration file in Projects\NUCLEO-H7S3L8\ROT_Provisioning\DA\Config with an editor, for example Notepad, and set the parameter DoEncryption to 0 as it is shown below:

Using STM32TrustedPackageCreator

Select the shield
Select OBkey tab
Select the DA_ConfigWithPassword.xml configuration file. All the default settings for this hands-on are already filled-in
Generate OBkey
A success message is displayed for the password file password.bin generation
The confirmation window is displayed

Warning

In the Information tab you can see if the encryption option is enabled or disabled.

For the use of STM32H7S devices this option has to be enabled, otherwise the board can be locked. For STM32H7R devices, the encryption option must be disabled.
To modify the encryption option, open DA_Config.xml configuration file (or DA_Configwithpassword.xml file if you are using the password method) in Projects\NUCLEO-H7S3L8\ROT_Provisioning\DA\Config with an editor, for example Notepad, and set the parameter DoEncryption to 0 to disable the option, or to 1 to enable the encryption.

Warning: for a commercial product, it is important to define your own key. But for trials it is advised to use the default provided, to avoid blocked regression due to lost password.

According to the path specified in the DA_Config.xml, a DA_Config.obk file is generated in Projects\STM32H7S78-DK\ROT_Provisioning\DA\Binary folder. This file will be used by the script during the provisioning step.

1.4. Image generation

Check that the STM32H7R IAR™ provided patch is correctly installed and check that your IAR Embedded Workbench™ version is recent enough.

Two code examples for IAR Embedded Workbench™ are provided:

OEMiROT_Boot corresponds to the Secure Boot.

It performs authenticity and integrity checks of the project firmware and data images.

OEMiROT_Appli is an example of application managed by OEMiROT.

OEMiROT_Boot project configuration
The step 3 of the script is the generation of the OEMiROT_Boot and OEMiROT_Appli applications firmware images.

Open the Project.eww located in the EWARM directory: Projects\STM32H7S78-DK\Applications\ROT\OEMiROT_Boot\EWARM.

Number of Code images and Data images is defined in flash_layout.h file in the ./Projects\STM32H7S78-DK\Applications\ROT\OEMiROT_Boot\Inc folder.

This example is configured by default for one application image and no data image. You can check these default parameters in file flash_layout.h as shown in figure below :

Information

During the OEMiROT_Boot execution, if the number of images is wrong, Bootloader is launched to load new code and/or data images.

OEMiROT_Boot project compilation

Open Project -> Option -> General Options: The device and CPU core should be automatically recognized and you should see the following windows:

SECURITY H7S-Options for node Project IAR .png

If the device is not recognized, check that the STM32H7 IAR™ provided patch is correctly installed, and check that your IAR Embedded Workbench™ version is recent enough.

Perform: Project -> Rebuild all (don’t upload the code, only perform a compilation)

The following binary is created: Projects\STM32H7S78-DK\Applications\ROT\OEMiROT_Boot\Binary\OEMiROT_Boot.bin.

OEMiROT_Appli project compilation

Open the Project.eww located in the EWARM directory:

Projects\STM32H7S78-DK\Applications\ROT\OEMiROT_Appli\EWARM

Open Project -> Option -> General Options

The device and CPU core should be automatically recognized.

Perform: Project -> Rebuild all (don’t upload the code, only perform a compilation)

The following image is created: Projects\STM32H7S78-DK\Applications\ROT\OEMiROT_Appli\Binary\rot_app_enc_sign.hex.

Don’t close the EWARM project.

1.5. Board programming

In the next steps the script will automatically perform:

The provisioning of the Option Byte
Flash the previously generated image in the downloads area
Perform the needed reset to install the code
Set the final state of the product

If all the steps have been executed successfully, a confirmation is displayed as shown in the figure above.

1.6. OEMiRoT application execution

Close the script
Launch the Teraterm (or equivalent)
File => New connection
The COM port number should be the same as indicated by your Windows device manager and also written in the env.bat file (see Prerequisites chapter)
Setup => Serial port -> update to 115200 (and see the figure below for other configurations) -> New Setting

Press the reset button (black button of the discovery board)
The OEMiRoT application is executed (figure below)

1.7. Full regression

There are two ways to perform a regression
- Using the graphic interface of the STM32CubeProgrammer
- Using the regression script provided in the STM32CubeFW

1.7.1. Full regression using the script provided in the STM32CubeFW

Launch the script as shown in the figure below

You need to specify if the Debug Authentication provisioning as been done with Certificate or Password
Type "Password" for this example
The script is executed and indicate that the regression has been performed successfully

1.7.2. Full regression using the graphic interface of the STM32CubeProgrammer

Click in STM32CubeProgrammer
Select Debug Authentication.
Click “Discover”
The information window will be filled:

Enter the file password.bin path and click Regression

2. Example with CERTIFICATE configuration

2.1. OEMiRoT and debug authentication configuration

This chapter explains how to start with the provisioning script. It is used to configure the OEMiRoT and the debug authentication (in this case a configuration using a certificate)

2.2. Preliminary stage

The same provisioning script is used as for the example for a Debug Authentication configuration with Password.

Script located at: STM32CubeFW: STM32H7S78-DK\ROT_Provisioning\STiROT\provisioning.bat.

The following documentation is a guide through all the steps of this script, and explains how to perform each of them.

Before running the provisioning script be careful to disconnect the UART from any terminal tool otherwise the provisioning might fail.
Launch the script: provisioning.bat (double click) and keep it running during all the following steps.
Type the product state: CLOSED (don't use LOCKED for this tutorial, this state is used only to set a final product state)
Type the chosen Debug Authentication: CERTIFICATE (for explanation about certificate and password refer to intro article)

2.3. OEMiRoT configuration

The next step indicated by the script is to open the OEMiROT_Config.xml file, update to the wanted configuration and to generate the OBk file.

Open STM32TrustedPackageCreator.

Select the shield
Select OBkey tab
Select the OEMiRoT_Config.xml configuration file. All the default settings for this hands-on are already filled-in and it is not needed to regenerate the encryption and authentication keys. In case these keys are regenerated, the firmware image needs to be regenerated (in case this image is already available)
Generate OBkey
The confirmation window is displayed

According to the path specified in the OEMiROT_Config.xml, an OEMiROT_Config.obk file is generated in Projects\STM32H7S78-DK\ROT_Provisioning\OEMiROT\Binary folder. This file will be used by the script during the provisioning step.

2.4. Debug Authentication configuration

The Debug Authentication (DA) configuration is the next step of the script.

Using STM32TrustedPackageCreator

Select the shield
Select OBkey tab
Select the DA_Config.xml configuration file (file for the DA configuration with Certificate). All the default settings for this hands-on are already filled-in and a default Debug Authentication root key is provided.
Generate OBkey
The confirmation window is displayed

Warning: for a commercial product, it is important to regenerate your own Debug Authentication root key. But for trials it is advised to use the default provided, to avoid blocked regression due to lost key.

According to the path specified in the DA_Config.xml, a DA_Config.obk file is generated as shown in the figure below.
This file will be used by the script during the provisioning step.

2.5. Image generation

Check that the STM32H7 IAR™ provided patch is correctly installed and check that your IAR Embedded Workbench™ version is recent enough.

Two code examples for IAR Embedded Workbench™ are provided:

OEMiROT_Boot corresponds to the Secure Boot.

It performs authenticity and integrity checks of the project firmware and data images.

OEMiROT_Appli is an example of application managed by OEMiROT.

OEMiROT_Boot project configuration
The step 3 of the scripte is the generation of the OEMiROT_Boot and OEMiROT_Appli applications firmware images.

Open the Project.eww located in the EWARM directory: Projects\STM32H7S78-DK\Applications\ROT\OEMiROT_Boot\EWARM

Number of code images and Data images is defined in
flash_layout.h file in the ./Projects\STM32H7S78-DK\Applications\ROT\OEMiROT_Boot\Inc folder.

This example is configured by default for one application image and no data image. You can check these default parameters in file flash_layout.h as shown in figure below :

Information

During the OEMiROT_Boot execution, if the number of images is wrong, Bootloader is launched to load new code and/or data images.

OEMiROT_Boot project compilation

Open Project -> Option -> General Options: The device and CPU core should be automatically recognized and you should see the following windows:

If the device is not recognized, check that the STM32H5 IAR™ provided patch is correctly installed, and check that your IAR Embedded Workbench™ version is recent enough.

Perform: Project -> Rebuild all (don’t upload the code, only perform a compilation)

The following binary is created: Projects\STM32H7S78-DK\Applications\ROT\OEMiROT_Boot\Binary\OEMiROT_Boot.bin

OEMiROT_Appli project compilation

Open the Project.eww located in the EWARM directory:

Projects\STM32H7S78-DK\Applications\ROT\OEMiROT_Appli\EWARM

Open Project -> Option -> General Options

The device and CPU core should be automatically recognized.

Perform: Project -> Rebuild all (don’t upload the code, only perform a compilation)

The following image is created: Projects\STM32H7S78-DK\Applications\ROT\OEMiROT_Appli\Binary\rot_app_enc_sign.hex.

Don’t close the EWARM project.

2.6. Board programming

In the next steps the script will automatically perform:

The provisioning of the Option Byte
Flash the previously generated image in the downloads area
Perform the needed reset to install the code
Set the final state of the product

If all the steps have been executed successfully, a confirmation is displayed as shown in the figure above.

2.7. OEMiRoT application execution

Close the script
Launch the Teraterm (or equivalent)
File => New connection
The COM port number should be the same as indicated by your Windows device manager and also written in the env.bat file (see Prerequisites chapter)
Setup => Serial port -> update to 115200 (and see the figure below for other configurations) -> New Setting

Press the reset button (black button of the discovery board)
The OEMiRoT application is executed (figure below)

2.8. Debug Authentication and firmware modification or full regression

How to open the debugger, attach an IDE to make a step-by-step user application execution, make a modification of the user application and upload the modified firmware is explained in the following chapters.
If no further trials are done, it is advised to make a regression to retrieve an empty board.
- The following section of this article is describing how to proceed. Full regression using the STM32CubeFW script.

3. Debug Opening (intrusive debug)

For a device in closed state the debugger is no open and you have an error message if you try to connect STM32CubeProgrammer.
To open the debug it is mandatory that the device has been provisioned in closed state with Certificate Debug Authentication.

Warning

If the device has been provisioned with Password Debug Authentication, only a full regression is possible and a debug opening is not allowed.

Information

Only the owner of the key and certificate can open the debugger.

3.1. Prerequisites

Please follow OEMiRoT example with CERTIFICATE configuration until 2.7 OEMiRoT application execution. Don't perform a full regression, the device must be in closed state.

3.2. Debug Opening procedure

Open STM32CubeProgrammer
Select the shield
Click on "Discover" -> the product state "Closed" is displayed
Browse the paths for the root key and the certificate, as indicated in the figure below
Click on continue -> the permission window is open
Select "Level 3 Intrusive Debug"

Information

For the OEMiRoT example the application code is in HDPL3, see OEMiRoT and OEMuRoT for STM32H7S article.

A debug opening in level 2 or in level 3 will make the application visible.

Click Execute -> A Debug Authentication Success message is displayed

The debugger is open and the content of the flash can be readout, as shown in figure below

Information

The memory mapping of the code is detailed in Project.map located in:

Projects\STM32H7S78-DK\Applications\ROT\OEMiROT_Appli\EWARM\STM32H7S78-DK\List

The debugger will stay open until the next hardware reset.

Disconnect STM32CubeProgrammer

Warning

! Don’t power ON / OFF the board, it closes the debugger.

3.3. IAR connection, step by step user application execution

To attach an IDE:

Disconnect STM32CubeProgrammer

Warning

! Don’t power ON / OFF the board, it closes the debugger

Open the Project.eww located in the EWARM.
Select: Project -> Attach to running target
Open the main.c
Set a break point, run the program in the debugger
Reset the board (black button) and the execution will stop at this point
Select: View->Memory-> Memory1 and enter the flash address => The nonsecure code is visible @ 0x70000400

4. Download a new image from a closed device

The following description shows how to access to bootloader from a closed device in order to download a new image. After a reset a firmware update will be generated.
Forced download feature allows to access to secure bootloader.
At the date of writing this article, the GUI graphical interface is not yet functional to use Forced download feature.

The following example shows how to proceed using the debug authentication script and download new image through command line.

4.1. Prerequisites

To follow the procedure described bellow the device must be provisioned in closed state with OEMiRoT.
If you followed the paragraph Debug opening, your device must be in closed state. Please disconnect and reconnect your board with the USB cable to be sure your device is not in debug opening mode.

If you didn't follow the debug opening part of this wiki, please perform OEMiRoT example with CERTIFICATE configuration until 2.7 OEMiRoT application execution. Don't perform a full regression, the device must be in closed state.

4.2. Firmware modification

Make some modifications of the OEMiRoT_Appli and rebuild all the file ->an encrypted image is created through postbuild command.

For example you can make this proposed modification in main.c file and rebuild the project :

If applicable: close IAR or Disconnect STM32CubeProgrammer

4.3. Debug Authentification

Unplug/ replug the Discovery board USB cable to make a hardware reset. If the debugger was open, it will be closed again.
Launch the dbg_auth.bat script.

Type "e" to select the Forced Download. (See the permission set during the certificate generation, DA setting using TPC).
The script will indicate an error. Ignore it, this will be fixed in later script version.

4.4. New application code image download

In a command prompt: execute the command indicated below
Depending on your PC administrator rights, you need to run it from the STM32CubeProgrammer installation directory: C:\Program Files\STMicroelectronics\STM32Cube\STM32CubeProgrammer_revx.x.x-H7RS-xxx\bin
Command to execute:

STM32_Programmer_CLI.exe -c port=COMxx br=921600  -elbl "ExternalLoader\MX66UW1G45G_STM32H7S78-DK_XSPIM1-SFIx.stldr" -d C:\Users\'''xxxxx'''\STM32Cube_FW_H7RS_Vx.x.x\Projects\STM32H7S78-DK\Applications\ROT\OEMiROT_Appli\Binary\rot_app_enc_sign.hex

Note:the xxx needs to be adapted for your configuration.

The new image of the application code is downloaded in the external flash donwload area defined during the OEMiRoT configuration defined previously
At next reset the OEMiRoT will detect that a new firmware needs to be installed and perform automatically the installation (this is transparent for a user)

Security Firmware upgrade command line.png

4.5. New installed application code execution

Launch the Teraterm (or equivalent)
Reminder:
- File => New connection
- The COM port number should be the same as indicated by your Windows device manager and also written in the env.bat file (see Prerequisites chapter)
- Setup => Serial port -> update to 115200 (and see the figure below for other configurations) -> New Setting
Press the reset button (black button of the discovery board)
The new OEMiRoT application is executed as shown in the figure below, and the modification made are displayed:

4.6. Full regression using graphic interface

Previously the regression script has been used.
Following an example showing how to proceed using the graphic interface of STM32CubeProgrammer.

Close Teraterm
Start STM32CubeProgrammer
Select the shield
Click on "Discover" -> the product state "Closed" is displayed
Browse the paths for the root key and the certificate, as indicated in the figure below
Click on continue -> the permission window is open
Select Full Regression
Click Execute -> A Debug Authentication Success message is displayed

Using STM32CubeProgrammer, you can verify that the flash is empty and that the device is back in "Open" state.

Note: it's a good habit to make a full regression after completing trials. Reminder that it's important if you have regenerated the root key, to not loose this key in ordrer to be able to make a regression or a debugger opening.