You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/hardware/04.pro/boards/portenta-h7/tutorials/secure-boot/secure-boot.md
+42-10Lines changed: 42 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,12 +4,11 @@ description: 'Learn how to use secure boot on the Arduino Portenta H7.'
4
4
difficulty: beginner
5
5
tags:
6
6
- Secure Boot
7
-
author: 'Umberto Baldi'
7
+
author: 'Umberto Baldi & Christopher Méndez'
8
8
hardware:
9
9
- hardware/04.pro/boards/portenta-h7
10
10
11
11
software:
12
-
- ide-v1
13
12
- ide-v2
14
13
- cli
15
14
---
@@ -35,6 +34,27 @@ In order to enable the secure boot, you must **update** the bootloader on your P
35
34
36
35
Once the bootloader has been updated, it is possible to use [secure boot](https://www.keyfactor.com/blog/what-is-secure-boot-its-where-iot-security-starts/) to have an additional layer of security.
37
36
37
+
### Format the QSPI Flash
38
+
39
+
First, before enabling the secure boot feature on your Portenta H7, you might need to format the QSPI flash memory.
40
+
41
+
For this, navigate to **File > Examples > STM32H747_System > QSPIFormat** and follow the steps below:
42
+
43
+

44
+
45
+
- Upload the **QSPIFormat** example to your Portenta H7.
46
+
- Open the Arduino IDE Serial Monitor.
47
+
- Follow the steps shown in the Serial Monitor.
48
+
49
+
You will be asked for:
50
+
51
+
- Permission to proceed and **erase** the QSPI flash. Type `Y` in the Serial Monitor and press enter.
52
+
- Once done, you will be asked to **restore** the WiFi firmware. Type `Y` in the Serial Monitor and press enter.
53
+
- Select between **LitteFS** or **FatFS** to format user partition. Type `Y` for LittleFS or `No` for FatFS.
54
+
- Wait for the process to be done. It should say something like "It is now secure to reboot or disconnect the board".
55
+
56
+
Now you are ready to jump to the following step to enable the secure boot.
57
+
38
58
### Use Default Security Keys
39
59
40
60
Upload the `enableSecurity` example sketch that can be found under **File > Examples > MCUboot** in the IDE upper menu.
@@ -60,7 +80,8 @@ From that point on, you must configure your future sketches **Security setting**
60
80
61
81
***Not configuring this setting will cause the bootloader not to run the compiled sketch because it is not trusted.***
62
82
63
-
### 1. Generate Custom Security Keys
83
+
### Generate Custom Security Keys
84
+
64
85
The default keys provided with the mbed platform are obviously only intended for development purposes. In a production environment it is strongly recommended to generate a new key pair (public and private key).
65
86
This can be done with **imgtool**. You can download and install it directly from the [release section](https://github.com/arduino/imgtool-packing/releases/latest).
66
87
@@ -72,17 +93,17 @@ The tool can be found in:
72
93
-`~/.arduino15/packages/arduino/tools/imgtool` on Linux.
73
94
-`~/Library/Arduino15/packages/arduino/tools/imgtool` on macOS.
74
95
75
-
To generate the new keys you can use this command line:
96
+
To **generate** the new keys you can use this command line:
This command line will generate two private PEM encoded security keys and save them in the current directory with `my-sign-keyfile.pem` and `my-encrypt-keyfile.pem` names. The algorithm used to generate the keys is ECDSA 256bit.
82
103
83
-
Remember to **save the keys and keep them in a secure location** and not to lose them.
104
+
***Remember to __save the keys and keep them in a secure location__ and not to lose them.***
84
105
85
-
### 2. Upload the Custom Keys to the Board
106
+
### Upload the Custom Keys to the Board
86
107
Once the keys have been generated, they have to be uploaded to the Portenta H7. This procedure has to be done only once, because it is persistent. To extract the public\private key and encode it in to a "C" byte array inside a `.h` header file you can use:
87
108
88
109
```bash
@@ -94,16 +115,27 @@ Now you have to replace the keys inside the `enableSecurity` sketch found under
94
115
95
116
To do so, just save the sketch to another location and replace the `ecsda-p256-encrypt-priv-key.h` and `ecsda-p256-signing-pub-key.h` files with the newly generated ones and then upload the sketch again.
96
117
97
-
***NOTE: In case the keys are compromised, this process can be performed again with a new set of keys, but any firmware signed with the previous pair will no longer work.***
118
+
***__NOTE:__ In case the keys are compromised, this process can be performed again with a new set of keys, but any firmware signed with the previous pair will no longer work.***
98
119
99
-
### 3. Use the Custom Keys when Compiling
120
+
### Use the Custom Keys when Compiling
100
121
Since the default keys have been changed in favour of custom generated ones, the new ones have to be used when compiling and uploading a sketch, because the compiled sketch is signed and encrypted using such keys.
101
122
102
-
To override the security keys used during the compilation, you have to use the Arduino CLI and specify the keys with:
123
+
To override the security keys used during the compilation, we recommend using the **Arduino CLI** and specify the keys with:
If you want to implement secure boot for your platform, have a look at [this article](https://arduino.github.io/arduino-cli/latest/guides/secure-boot/).
141
+
If you want to implement secure boot for your platform, take a look at [this article](https://arduino.github.io/arduino-cli/latest/guides/secure-boot/).
0 commit comments