Skip to main content

A secure updater framework for Python

Project description

TUF A Framework for Securing Software Update Systems

CI badge Conformance badge Coveralls badge Docs badge CII badge PyPI badge Scorecard badge


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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tuf-6.0.0.tar.gz (271.3 kB view details)

Uploaded Source

Built Distribution

tuf-6.0.0-py3-none-any.whl (54.8 kB view details)

Uploaded Python 3

File details

Details for the file tuf-6.0.0.tar.gz.

File metadata

  • Download URL: tuf-6.0.0.tar.gz
  • Upload date:
  • Size: 271.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tuf-6.0.0.tar.gz
Algorithm Hash digest
SHA256 9eed0f7888c5fff45dc62164ff243a05d47fb8a3208035eb268974287e0aee8d
MD5 5ab7a232a1e9ff879451612e29e7c1b8
BLAKE2b-256 25b5377a566dfa8286b2ca27ddbc792ab1645de0b6c65dd5bf03027b3bf8cc8f

See more details on using hashes here.

Provenance

The following attestation bundles were made for tuf-6.0.0.tar.gz:

Publisher: cd.yml on theupdateframework/python-tuf

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tuf-6.0.0-py3-none-any.whl.

File metadata

  • Download URL: tuf-6.0.0-py3-none-any.whl
  • Upload date:
  • Size: 54.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tuf-6.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 458f663a233d95cc76dde0e1a3d01796516a05ce2781fefafebe037f7729601a
MD5 f541cae6060bdc8c85e76fee4a10b49a
BLAKE2b-256 6b3d161ab4fec446048707cb13e8ba22220e05a6c4a6587d3631feeb5715037e

See more details on using hashes here.

Provenance

The following attestation bundles were made for tuf-6.0.0-py3-none-any.whl:

Publisher: cd.yml on theupdateframework/python-tuf

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page