Skip to main content

A secure updater framework for Python

Project description

TUF A Framework for Securing Software Update Systems

Build Coveralls CII PyPI


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 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 the TUF Introduction and TUF's website for more information about TUF!

Documentation

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).

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 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 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 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.

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-0.17.0.tar.gz (2.8 MB view details)

Uploaded Source

Built Distribution

tuf-0.17.0-py2.py3-none-any.whl (161.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: tuf-0.17.0.tar.gz
  • Upload date:
  • Size: 2.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.8.5

File hashes

Hashes for tuf-0.17.0.tar.gz
Algorithm Hash digest
SHA256 14cc855b42aaa047e19bc8f78eeb4c28e92126b7aecd1491142382d27110d0db
MD5 a9109fb75b2f8315424adc4b48b239b6
BLAKE2b-256 3a7dd1cadc8c68cdfe035412ca11a2fa3105a0a3fd18e4212053cf8f67bdd02a

See more details on using hashes here.

File details

Details for the file tuf-0.17.0-py2.py3-none-any.whl.

File metadata

  • Download URL: tuf-0.17.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 161.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.8.5

File hashes

Hashes for tuf-0.17.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3b52c4eb1abd21551dd61dcb5f90a54d55073b3794acdd6276d1d2466a7b1602
MD5 120e0256a7c42c0ec32acdebd33dcfd5
BLAKE2b-256 c0d1df1de0b216ff44f80c0e25db103766a782a3b796564d8db2ac9bed699d7c

See more details on using hashes here.

Supported by

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