Skip to content

Commit af3d86d

Browse files
umbynossebromero
andauthored
Apply suggestions from code review
Co-authored-by: Sebastian Romero <s.romero.zh@gmail.com>
1 parent 49c15cf commit af3d86d

File tree

1 file changed

+6
-6
lines changed
  • content/hardware/04.pro/boards/portenta-h7/tutorials/secure-boot

1 file changed

+6
-6
lines changed

content/hardware/04.pro/boards/portenta-h7/tutorials/secure-boot/secure-boot.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This short tutorial will guide the user through enabling the secure boot on the
1818
## Hardware & Software Required
1919
- [Portenta H7](https://store.arduino.cc/portenta-h7)
2020
- Arduino IDE 1.8.19+ or Arduino IDE 2.0.0-rc5+ (https://www.arduino.cc/en/software)
21-
- [Arduino Mbed OS Portenta Boards](https://github.com/arduino/ArduinoCore-mbed) version 3.0.0+
21+
- [Arduino Core for mbed enabled devices](https://github.com/arduino/ArduinoCore-mbed) version 3.0.0+
2222
- [imgtool](https://github.com/arduino/imgtool-packing/releases/latest) (optional)
2323

2424
## Instructions
@@ -32,9 +32,9 @@ Once The bootloader has been updated to MCUboot, it's possible to use [secure bo
3232
If no operation is performed the default security keys are used.
3333
These keys are embedded in the example sketch `STM32H747_updateBootloader` which can be found in **Files > Examples > STM32H747_System > STM32H747_updateBootloader**. A private 256bit [ECDSA](https://en.wikipedia.org/wiki/Elliptic_Curve_Digital_Signature_Algorithm) key is used for the encryption (`ecdsa-p256-encrypt-key.h`), while a public key is used for the signing (`ecdsa-p256-signing-key.h`). These two keys are the ones the bootloader uses to verify if a sketch is valid or not, before starting it for the first time. The default private keys used after compiling a sketch to sign and encrypt it are located in `Arduino15/packages/arduino/hardware/mbed_portenta/<version>/libraries/MCUboot/default_keys/`.
3434

35-
### 1. Generate Custom Cecurity Keys
35+
### 1. Generate Custom Security Keys
3636
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).
37-
This can be done with [**imgtool**](https://github.com/arduino/imgtool-packing/releases/latest). You can download and install it directly from the release section.
37+
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).
3838

3939
***`imgtool` is already installed by the mbed platform and can be found in the `%LOCALAPPDATA%\Arduino15\packages\arduino\tools\imgtool` directory on Windows, in `~/.arduino15/packages/arduino/tools/imgtool` on Linux and in `~/Library/Arduino15/packages/arduino/tools/imgtool` on macOS.***
4040

@@ -45,10 +45,10 @@ imgtool keygen --key my-encrypt-keyfile.pem -t ecdsa-p256
4545
```
4646
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.
4747

48-
Remember to **save the keys on a secure location** and not to lose them.
48+
Remember to **save the keys and keep them in a secure location** and not to lose them.
4949

5050
### 2. Upload the Custom Keys to the Board
51-
Once the keys have been generated they have to be uploaded on the Portenta. This procedure has to be done only once, because it's persistent. To extract the public\private key and encode it in to a "C" byte array inside a `.h` header file you can use:
51+
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's persistent. To extract the public\private key and encode it in to a "C" byte array inside a `.h` header file you can use:
5252
```
5353
imgtool getpriv -k my-encrypt-keyfile.pem > ecsda-p256-encrypt-key.h
5454
imgtool getpub -k my-sign-keyfile.pem > ecsda-p256-signing-key.h
@@ -68,4 +68,4 @@ arduino-cli compile -b arduino:mbed_portenta:envie_m7 --board-options security=s
6868
```
6969

7070
## Learn More
71-
If you want to implement secure boot for your platform [this](https://arduino.github.io/arduino-cli/latest/guides/secure-boot/) should be helpful.
71+
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/).

0 commit comments

Comments
 (0)