Skip to content

Commit 70ea606

Browse files
committedDec 12, 2023
Updated esp_secure_cert_tool documentation for Flash Encryption related
use-case
1 parent ff3a51e commit 70ea606

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed
 

‎tools/README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,20 @@ The script can generate `cust_flash` as well as `nvs` type of `esp_secure_cert`
4141
4242
## Generate `esp_secure_cert` partition of type `cust_flash_tlv`:
4343

44-
This command shall generate a binary partition containing the PKI credentials stored in the TLV format.
44+
This command shall generate a binary partition containing the PKI credentials stored in the TLV format and flash it at the default offset of `0xD000`.
45+
4546
```
4647
configure_esp_secure_cert.py -p /* Serial port */ --keep_ds_data_on_host --efuse_key_id 1 --ca-cert cacert.pem --device-cert client.crt --private-key client.key --target_chip /* target chip */ --secure_cert_type cust_flash_tlv --configure_ds
4748
```
4849

50+
* When [Flash Encryption](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/security/flash-encryption.html) is enabled for the device, the option ``--skip_flash`` (explained below) can be used to prevent the flashing opereation and only save the `esp_secure_cert.bin` on the host machine. It can then be flashed on the target using below command:
51+
52+
```esptool.py -p /* Serial Port*/ write_flash 0xD000 esp_secure_cert.bin --encrypt```
53+
54+
More details regarding [esptool.py](https://docs.espressif.com/projects/esptool/en/latest/esp32/esptool/index.html#esptool-py) utility can be found [here](https://docs.espressif.com/projects/esptool/en/latest/esp32/esptool/index.html).
55+
56+
Note: This is only applicable for [Development mode](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/security/flash-encryption.html#flash-enc-development-mode) of Flash Encryption.
57+
4958
## Legacy partition formats:
5059

5160
1. Generate `esp_secure_cert` partition of type `cust_flash`:

0 commit comments

Comments
 (0)
Please sign in to comment.