theupdateframework / theupdateframework/python-tuf
Add an FAQ and/or high-level overview of how to integrate TUF
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.7k
- Forks
- 304
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 17
Description
We are often asked the same questions regarding delegations, how to organize TUF metadata, key management, etc. There should be an FAQ page for these sorts of questions.
The Survivable Key Compromise paper provides an overview of TUF's design, and the specification and other documents available here capture most of what it contains. However, the integration side of things is not adequately explained outside of the Diplomat and Mercury papers. The PEP 458 document is also a good resource for how to integrate TUF with an existing software updater and community repository.
We should provide a condensed, high-level document that contains the information in the papers and documents that have been written since the Survivable Key Compromise paper.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the Survivable Key Compromise, Diplomat, and Mercury papers, along with the PEP 458 document and existing TUF specification materials. Organize their integration guidance into a condensed FAQ or high-level overview covering delegations, metadata organization, and key management; done means the recurring integration questions are explained in one accessible document.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, security
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100