Skip to content

Commit

Permalink
docs: Explain revocation of unused but compromised keys
Browse files Browse the repository at this point in the history
This PR updates the Secure Boot V2 documentation to explain the revocation of unused but compromised keys.
  • Loading branch information
Lupindakaas authored Sep 12, 2024
1 parent 59e1838 commit 72be1f2
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/en/security/secure-boot-v2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -610,6 +610,7 @@ Secure Boot Best Practices
--------------

* Keys are processed in a linear order, i.e., key #0, key #1, key #2.
* After revoking a key, all remaining unrevoked keys can be used to sign applications. I.e, if key #1 gets revoked, both keys #0 and key #2 can still be used to sign firmwares.
* Applications should be signed with only one key at a time, to minimize the exposure of unused private keys.
* The bootloader can be signed with multiple keys from the factory.

Expand All @@ -634,6 +635,11 @@ Secure Boot Best Practices

* A similar approach can also be used to physically re-flash with a new key. For physical re-flashing, the bootloader content can also be changed at the same time.

.. note::

It can be necessary to revoke a key that isn't currently being used. For example: if the running application is still signed with key #0, but key #1 becomes compromised, you should revoke this key using this approach.
The new OTA update should still be signed with key #0, but the API `esp_ota_revoke_secure_boot_public_key(SECURE_BOOT_PUBLIC_KEY_INDEX_[N])` can be used to revoke the key #N. Afterwards all remaining unrevoked keys can be used to sign future applications.


.. _secure-boot-v2-aggressive-key-revocation:

Expand Down

0 comments on commit 72be1f2

Please sign in to comment.