Skip to content

Commit

Permalink
Merge branch 'espressif:master' into release/v4
Browse files Browse the repository at this point in the history
  • Loading branch information
Jason2866 authored Feb 14, 2023
2 parents 40eb6d7 + 238cb8e commit 924d216
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug-report-no-hw.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Bug report - no ESP chip involved
description: Report bugs or crashes which don't use any attached hardware
labels: ["bug"]
labels: ['Type: Bug']
body:
- type: input
id: os
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Feature request
description: Suggest an idea for this project
labels: ["enhancement"]
labels: ['Type: Feature Request']
body:
- type: markdown
attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/issue-with-hw.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Issue report - ESP chip operation fails (can't flash, can't connect, etc.)
description: Report a problem working with attached hardware
labels: ["operation-failure"]
labels: ['Type: Bug']
body:
- type: markdown
attributes:
Expand Down
6 changes: 3 additions & 3 deletions docs/en/espsecure/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,20 @@ Refer to `Signing using an External HSM <https://docs.espressif.com/projects/esp

The following command should be used to get an image signed using an external HSM. ::

python espsecure.py sign_data --version 2 --hsm --hsm_config <hsm_config_file> --output <signed_image> <datafile>
python espsecure.py sign_data --version 2 --hsm --hsm-config <hsm_config_file> --output <signed_image> <datafile>

The above command first extracts the public key from the HSM, generates a signature for an image using the HSM, and then creates a signature block and appends it to the image to generate a signed image.

If the public key is not stored in the external HSM, you can specify the ``--pub-key`` argument to supply the public key. ::

python espsecure.py sign_data --version 2 --hsm --hsm_config <hsm_config_file> --pub-key <public_key> --output <signed_image> <datafile>
python espsecure.py sign_data --version 2 --hsm --hsm-config <hsm_config_file> --pub-key <public_key> --output <signed_image> <datafile>

Verifying the Signed Image
~~~~~~~~~~~~~~~~~~~~~~~~~~

Once the signed image is generated, we can verify it using the following command: ::

python espsecure.py verify_signature --version 2 --hsm --hsm_config <hsm_config_file> <signed_image>
python espsecure.py verify_signature --version 2 --hsm --hsm-config <hsm_config_file> <signed_image>

If the public key is not stored in the external HSM, you can specify the ``--keyfile`` argument to supply the public key. ::

Expand Down

0 comments on commit 924d216

Please sign in to comment.