mirror of
https://github.com/theupdateframework/python-tuf
synced 2026-05-24 10:08:28 +00:00
1ea497abae
* ngclient and Metadata API are production ready: start with them, then mention legacy * link to API reference instead of code * link to examples instead of (legacy) getting started document Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
140 lines
6.7 KiB
Markdown
140 lines
6.7 KiB
Markdown
# <img src="https://cdn.rawgit.com/theupdateframework/artwork/3a649fa6/tuf-logo.svg" height="100" valign="middle" alt="TUF"/> A Framework for Securing Software Update Systems
|
|
|
|
|
|
[](https://coveralls.io/r/theupdateframework/python-tuf?branch=develop)
|
|
[](https://theupdateframework.readthedocs.io/)
|
|
[](https://bestpractices.coreinfrastructure.org/projects/1351)
|
|
[](https://pypi.org/project/tuf/)
|
|
|
|
----------------------------
|
|
*__IMPORTANT NOTICE:__ A stable 1.0.0 release of the modern implementation only
|
|
is scheduled for January 2022. Please see the [*1.0.0
|
|
announcement*](docs/1.0.0-ANNOUNCEMENT.md) page for more details about the release
|
|
and the deprecation of the legacy implementation, including migration
|
|
instructions.*
|
|
|
|
----------------------------
|
|
This repository is the **reference implementation** of
|
|
[The Update Framework (TUF)](https://theupdateframework.github.io/).
|
|
It is written in Python and intended to conform to version 1.0 of the
|
|
[TUF specification](https://theupdateframework.github.io/specification/latest/).
|
|
|
|
Python-TUF provides two APIs:
|
|
* [`tuf.api.metadata`](https://theupdateframework.readthedocs.io/en/latest/api/tuf.api.html),
|
|
a "low-level" API, designed to provide easy and safe access to TUF
|
|
metadata and to handle (de)serialization from/to files.
|
|
* [`tuf.ngclient`](https://theupdateframework.readthedocs.io/en/latest/api/tuf.ngclient.html),
|
|
a client implementation built on top of the metadata API.
|
|
|
|
High-level support for implementing
|
|
[repository operations](https://theupdateframework.github.io/specification/latest/#repository-operations)
|
|
is planned but not yet provided: see [1.0.0 plans](docs/1.0.0-ANNOUNCEMENT.md).
|
|
|
|
In addition to these APIs the project also provides a *legacy
|
|
implementation* with `tuf.client` implementing the client workflow and
|
|
`tuf.repository_tool` providing a high-level interface for repository
|
|
operations. The legacy implementation is going to be
|
|
[deprecated](docs/1.0.0-ANNOUNCEMENT.md) in the near future.
|
|
|
|
The reference implementation strives 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](https://github.com/theupdateframework/specification/blob/master/tuf-spec.md)
|
|
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](https://www.linuxfoundation.org/) as
|
|
part of the [Cloud Native Computing Foundation](https://www.cncf.io/) (CNCF)
|
|
and its design is [used in production](https://theupdateframework.io/adoptions/)
|
|
by various tech companies and open source organizations. A variant of TUF
|
|
called [Uptane](https://uptane.github.io/) is used to secure over-the-air
|
|
updates in automobiles.
|
|
|
|
Please see the [TUF Introduction](docs/OVERVIEW.rst) and
|
|
[TUF's website](https://theupdateframework.com/) for more information about TUF!
|
|
|
|
|
|
Documentation
|
|
-------------
|
|
* [Introduction to TUF's Design](docs/OVERVIEW.rst)
|
|
* [The TUF Specification](https://theupdateframework.github.io/specification/latest/)
|
|
* Examples: [client](examples/client_example) and [repository](examples/repo_example)
|
|
* [API Reference](https://theupdateframework.readthedocs.io/)
|
|
* [Governance](docs/GOVERNANCE.md) and [Maintainers](docs/MAINTAINERS.txt)
|
|
for the reference implementation
|
|
* [Miscellaneous Docs](docs/)
|
|
|
|
|
|
Contact
|
|
-------
|
|
Please contact us via our [mailing
|
|
list](https://groups.google.com/forum/?fromgroups#!forum/theupdateframework).
|
|
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](https://github.com/theupdateframework/specification/issues).
|
|
|
|
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](docs/TAP.rst) (TAP).
|
|
|
|
Limitations
|
|
-----------
|
|
|
|
The reference implementation may behave unexpectedly when concurrently
|
|
downloading the same target files with the same TUF client.
|
|
|
|
License
|
|
-------
|
|
|
|
This work is [dual-licensed](https://en.wikipedia.org/wiki/Multi-licensing) and
|
|
distributed under the (1) MIT License and (2) Apache License, Version 2.0.
|
|
Please see [LICENSE-MIT](LICENSE-MIT) and [LICENSE](LICENSE).
|
|
|
|
|
|
Acknowledgements
|
|
----------------
|
|
|
|
This project is hosted by the Linux Foundation under the Cloud Native Computing
|
|
Foundation. TUF's early development was managed by
|
|
members of the [Secure Systems Lab](https://ssl.engineering.nyu.edu/) at [New
|
|
York University](https://engineering.nyu.edu/). We appreciate the efforts of
|
|
Konstantin Andrianov, Geremy Condra, Vladimir Diaz, Yuyu Zheng, Sebastien Awwad,
|
|
Santiago Torres-Arias, Trishank Kuppusamy, Zane Fisher, Pankhuri Goyal, Tian Tian,
|
|
Konstantin Andrianov, and Justin Samuel who are among those who helped significantly
|
|
with TUF's reference implementation. [Contributors](https://github.com/theupdateframework/python-tuf/blob/develop/docs/AUTHORS.txt)
|
|
and
|
|
[maintainers](https://github.com/theupdateframework/python-tuf/blob/develop/docs/MAINTAINERS.txt)
|
|
are governed by the [CNCF Community Code of
|
|
Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
|
|
|
|
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.
|