theupdateframework / theupdateframework/python-tuf
doc: consider re-adding python-tuf attack protection demo
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.7k
- Forks
- 304
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 17
Description
Description of issue or feature request:
#1790 removes severely outdated ATTACKS.md, which demoed how python-tuf protects against the attacks TUF is designed for.
Such documentation, if up-to-date, still seems like a good source for better understanding the purpose and necessity of TUF and thus should be re-added.
Current behavior:
- no attack protection demo
Expected behavior:
- add attack protection demo for ngclient
(potential source of inspiration: https://github.com/theupdateframework/python-tuf/issues/1640)
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 historical ATTACKS.md and the ngclient entry point, then read issue #1640 for the suggested direction. Define an up-to-date attack-protection demo for ngclient and confirm that the resulting documentation explains the relevant TUF protections without relying on the removed outdated material.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, security
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100