Python reference implementation of The Update Framework (TUF)
Find a file
Michał Górny ee27bcccc1 tests: Use freezegun for time mocking to fix pypy3 compatibility
Use freezegun for time mocking instead of manually patching the datetime
module, as it provides a more streamlined solution that works both
on CPython and on PyPy.  Unfortunately, due to differences between
the C datetime extension used by CPython, and the pure Python version
of datetime (used by PyPy, and as a fallback on CPython), there does not
seem to be a trivial way to mock time that would work with both
versions.

Fixes #2708

Signed-off-by: Michał Górny <mgorny@gentoo.org>
2024-10-09 14:01:09 +02:00
.github build(deps): bump pypa/gh-action-pypi-publish (#2706) 2024-09-30 16:24:52 +03:00
docs docs: include kairoaraujo info in MAINTAINERS.txt 2024-09-24 08:15:39 +02:00
examples Update basic_repo.py 2024-05-29 13:03:25 +05:30
requirements tests: Use freezegun for time mocking to fix pypy3 compatibility 2024-10-09 14:01:09 +02:00
tests tests: Use freezegun for time mocking to fix pypy3 compatibility 2024-10-09 14:01:09 +02:00
tuf ngclient: Increase default max_root_rotations 2024-07-17 11:50:43 +03:00
.gitattributes gitattributes: Fix diff hunk headers 2024-02-21 13:12:57 +02:00
.gitignore gitignore: fix directory patterns 2022-03-09 11:54:15 +00:00
.readthedocs.yaml enable python 3.12 2023-12-02 23:28:34 -05:00
LICENSE Move license files to root directory 2018-02-05 10:27:04 -05:00
LICENSE-MIT Remove license from Thandy files that are no longer present 2021-06-29 12:15:07 -04:00
pyproject.toml Add a conformance test workflow 2024-07-10 16:15:36 +03:00
README.md README: Fix scorecard image url as well 2024-07-09 09:27:25 +03:00
tox.ini Add a conformance test workflow 2024-07-10 16:15:36 +03:00
verify_release lint: Enable pygrep-hooks 2024-05-06 09:19:19 +03:00

TUF A Framework for Securing Software Update Systems

Build Coveralls Docs CII PyPI OpenSSF Scorecard


The Update Framework (TUF) is a framework for secure content delivery and updates. It protects against various types of supply chain attacks and provides resilience to compromise. This repository is a reference implementation written in Python. It is intended to conform to version 1.0 of the TUF specification.

Python-TUF provides the following APIs:

  • tuf.api.metadata, a "low-level" API, designed to provide easy and safe access to TUF metadata and to handle (de)serialization from/to files.
  • tuf.ngclient, a client implementation built on top of the metadata API.
  • tuf.repository, a repository library also built on top of the metadata API. This module is currently not considered part of python-tuf stable API.

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 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 various tech companies and open source organizations. A variant of TUF called Uptane is used to secure over-the-air updates in automobiles.

Please see TUF's website for more information about TUF!

Documentation

Contact

Questions, feedback, and suggestions are welcomed on our low volume mailing list or the #tuf channel on CNCF Slack.

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

See SECURITY.md

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 hosted by the Linux Foundation under the Cloud Native Computing Foundation. TUF's early development was managed by members of the Secure Systems Lab at New York University. We appreciate the efforts of all maintainers and emeritus maintainers, as well as the contributors Konstantin Andrianov, Kairo de Araujo, Ivana Atanasova, Geremy Condra, Zane Fisher, Pankhuri Goyal, Justin Samuel, Tian Tian, Martin Vrachev and Yuyu Zheng who are among those who helped significantly with TUF's reference implementation. Maintainers and Contributors 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.