06cdb21efd
at the very top of the README. and: - note that this implementation is intended to conform to version 1.0 of the TUF specification - draw some distinctions between the TUF design and this ref impl. - turn the older blurb about TUF into an About-TUF section - expand that blurb with a link to both an introduction in the repo and the TUF website - make the documentation links a bit more explicit - shuffle some graphical elements for better appeal - minor changes like extending some link text Signed-off-by: Sebastien Awwad <sebastien.awwad@gmail.com> |
||
|---|---|---|
| .github | ||
| docs | ||
| tests | ||
| tuf | ||
| .gitignore | ||
| .gitmodules | ||
| .pyup.yml | ||
| .travis.yml | ||
| appveyor.yml | ||
| ci-requirements.txt | ||
| dev-requirements.txt | ||
| LICENSE | ||
| LICENSE-MIT | ||
| MANIFEST.in | ||
| pylintrc | ||
| README.md | ||
| requirements.in | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
| tox.ini | ||
A Framework for Securing Software Update Systems
This repository is the reference implementation of The Update Framework (TUF). It is written in Python and intended to conform to version 1.0 of the TUF specification. This implementation is in use in production systems, but is also intended to be a readable guide and demonstration for those working on implementing TUF in their own languages, environments, or update systems.
About The Update Framework
The Update Framework (TUF) design helps developers maintain the security of a software update system, even against attackers that compromise the repository or signing keys. TUF provides a flexible specification defining functionality that developers can use in any software update system or re-implement to fit their needs.
TUF is hosted by the Linux Foundation as part of the Cloud Native Computing Foundation (CNCF) and its design is used in production by companies such as Cloudflare, DataDog, DigitalOcean, Docker, Flynn, IBM, Kolide, LEAP, Microsoft, RedHat, and VMware. A variant of TUF called Uptane is widely used to secure over-the-air updates in automobiles.
Please see the TUF Introduction and TUF's website for more information about TUF!
Documentation
- Introduction to TUF's Design
- The TUF Specification
- Getting Started with the TUF Reference Implementation
- Governance and Maintainers for the reference implementation
- Miscellaneous Docs
Contact
Please contact us via our mailing list. Questions, feedback, and suggestions are welcomed on this low volume mailing list.
We strive to make the specification easy to implement, so if you come across any inconsistencies or experience any difficulty, do let us know by sending an email, or by reporting an issue in the GitHub specification repo.
Security Issues and Bugs
Security issues can be reported by emailing jcappos@nyu.edu.
At a minimum, the report must contain the following:
- Description of the vulnerability.
- Steps to reproduce the issue.
Optionally, reports that are emailed can be encrypted with PGP. You should use PGP key fingerprint E9C0 59EC 0D32 64FA B35F 94AD 465B F9F6 F8EB 475A.
Please do not use the GitHub issue tracker to submit vulnerability reports. The issue tracker is intended for bug reports and to make feature requests. Major feature requests, such as design changes to the specification, should be proposed via a TUF Augmentation Proposal (TAP).
License
This work is dual-licensed and distributed under the (1) MIT License and (2) Apache License, Version 2.0. Please see LICENSE-MIT and LICENSE.
Acknowledgements
This project is managed by Prof. Justin Cappos and other members of the Secure Systems Lab at New York University. We appreciate the efforts of Konstantin Andrianov, Geremy Condra, Vladimir Diaz, Yuyu Zheng, Sebastien Awwad, and Justin Samuel who are among those who helped significantly with TUF's reference implementation. Contributors and maintainers are governed by the CNCF Community Code of Conduct.
This material is based upon work supported by the National Science Foundation under Grant Nos. CNS-1345049 and CNS-0959138. Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.