Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Explain revocation of unused but compromised keys (IDFGH-13688) #14563

Closed
wants to merge 1 commit into from

Conversation

Lupindakaas
Copy link
Contributor

@Lupindakaas Lupindakaas commented Sep 12, 2024

Description

This PR updates the Secure Boot V2 documentation to explain the revocation of unused but compromised keys.

Related

https://docs.espressif.com/projects/esp-idf/en/v5.2.2/esp32s3/security/secure-boot-v2.html#multiple-keys

Checklist

Before submitting a Pull Request, please ensure the following:

  • [ x] 🚨 This PR does not introduce breaking changes.
  • [ x] All CI checks (GH Actions) pass.
  • [ x] Documentation is updated as needed.
  • [x ] Tests are updated or added as necessary.
  • [ x] Code is well-commented, especially in complex areas.
  • [x ] Git history is clean — commits are squashed to the minimum necessary.

Copy link

github-actions bot commented Sep 12, 2024

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello Lupindakaas, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved, we synchronize it into our internal git repository.
4. In the internal git repository we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by 🚫 dangerJS against 39d0eac

@espressif-bot espressif-bot added the Status: Opened Issue is new label Sep 12, 2024
@github-actions github-actions bot changed the title docs: Explain revocation of unused but compromised keys docs: Explain revocation of unused but compromised keys (IDFGH-13688) Sep 12, 2024
Copy link
Collaborator

@AdityaHPatwardhan AdityaHPatwardhan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Lupindakaas thanks for the PR.
I have some nitpicks but overall changes look good to me.

docs/en/security/secure-boot-v2.rst Outdated Show resolved Hide resolved
docs/en/security/secure-boot-v2.rst Outdated Show resolved Hide resolved
@AdityaHPatwardhan
Copy link
Collaborator

AdityaHPatwardhan commented Sep 17, 2024

@Lupindakaas Thanks for your quick revert. LGTM
Can you please squash the commits into one?

@AdityaHPatwardhan
Copy link
Collaborator

sha=b5f0e5c6af639d41bee0c970bae982967bca08e9

@CLAassistant
Copy link

CLAassistant commented Sep 19, 2024

CLA assistant check
All committers have signed the CLA.

Explain the revocation of unused but compromised keys.

docs: Apply updates from code review

Add some nitpicks from AdityaHPatwardhan.

Co-authored-by: Aditya Patwardhan <aditya.patwardhan@espressif.com>
@Lupindakaas
Copy link
Contributor Author

@AdityaHPatwardhan Thanks for the review! I have (through many trials and trebulations) succesfully squashed the commits. Could you merge this PR? Have a nice day!

@AdityaHPatwardhan
Copy link
Collaborator

sha=39d0eacde403051f8ecaa220f2cf4ca597c3f844

@AdityaHPatwardhan AdityaHPatwardhan added the PR-Sync-Update Pull request sync fetch new changes label Sep 20, 2024
@espressif-bot espressif-bot added Status: Done Issue is done internally Resolution: NA Issue resolution is unavailable and removed Status: Opened Issue is new labels Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR-Sync-Merge Pull request sync as merge commit PR-Sync-Update Pull request sync fetch new changes Resolution: NA Issue resolution is unavailable Status: Done Issue is done internally
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants