# <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/)
[](https://api.securityscorecards.dev/projects/github.com/theupdateframework/python-tuf)
----------------------------
[The Update Framework (TUF)](https://theupdateframework.io/) 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](https://theupdateframework.github.io/specification/latest/).
Python-TUF provides the following 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.
* `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](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 [TUF's website](https://theupdateframework.com/) for more information about TUF!
Documentation
-------------
* [Introduction to TUF's Design](https://theupdateframework.io/overview/)
* [The TUF Specification](https://theupdateframework.github.io/specification/latest/)
* [Developer documentation](https://theupdateframework.readthedocs.io/), including
[API reference](
https://theupdateframework.readthedocs.io/en/latest/api/api-reference.html)
* [Usage examples](https://github.com/theupdateframework/python-tuf/tree/develop/examples/)
* [Governance](https://github.com/theupdateframework/python-tuf/blob/develop/docs/GOVERNANCE.md)
and [Maintainers](https://github.com/theupdateframework/python-tuf/blob/develop/docs/MAINTAINERS.txt)
for the reference implementation
* [Miscellaneous Docs](https://github.com/theupdateframework/python-tuf/tree/develop/docs)
* [Python-TUF development blog](https://theupdateframework.github.io/python-tuf/)
Contact
-------
Questions, feedback, and suggestions are welcomed on our low volume [mailing
list](https://groups.google.com/forum/?fromgroups#!forum/theupdateframework) or
the [#tuf](https://cloud-native.slack.com/archives/C8NMD3QJ3) channel on [CNCF
Slack](https://slack.cncf.io/).
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
------------------------
See [SECURITY.md](docs/SECURITY.md)
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](https://github.com/theupdateframework/python-tuf/blob/develop/LICENSE-MIT)
and [LICENSE](https://github.com/theupdateframework/python-tuf/blob/develop/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 all
[maintainers and emeritus
maintainers](https://github.com/theupdateframework/python-tuf/blob/develop/docs/MAINTAINERS.txt),
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](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.
Raw data
{
"_id": null,
"home_page": null,
"name": "tuf",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "authentication, compromise, key, revocation, secure, update, updater",
"author": null,
"author_email": "theupdateframework@googlegroups.com",
"download_url": "https://files.pythonhosted.org/packages/1e/4a/7405036c92b86229ec722dfa882bf999ac7241c7bd3cc8e9e6ceae75e73b/tuf-4.0.0.tar.gz",
"platform": null,
"description": "# <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\n\n\n[](https://coveralls.io/r/theupdateframework/python-tuf?branch=develop)\n[](https://theupdateframework.readthedocs.io/)\n[](https://bestpractices.coreinfrastructure.org/projects/1351)\n[](https://pypi.org/project/tuf/)\n[](https://api.securityscorecards.dev/projects/github.com/theupdateframework/python-tuf)\n\n----------------------------\n[The Update Framework (TUF)](https://theupdateframework.io/) is a framework for\nsecure content delivery and updates. It protects against various types of\nsupply chain attacks and provides resilience to compromise. This repository is a\n**reference implementation** written in Python. It is intended to conform to\nversion 1.0 of the [TUF\nspecification](https://theupdateframework.github.io/specification/latest/).\n\nPython-TUF provides the following APIs:\n * [`tuf.api.metadata`](https://theupdateframework.readthedocs.io/en/latest/api/tuf.api.html),\n a \"low-level\" API, designed to provide easy and safe access to TUF\n metadata and to handle (de)serialization from/to files.\n * [`tuf.ngclient`](https://theupdateframework.readthedocs.io/en/latest/api/tuf.ngclient.html),\n a client implementation built on top of the metadata API.\n * `tuf.repository`, a repository library also built on top of the metadata\n API. This module is currently not considered part of python-tuf stable API.\n\nThe reference implementation strives to be a readable guide and demonstration\nfor those working on implementing TUF in their own languages, environments, or\nupdate systems.\n\n\nAbout The Update Framework\n--------------------------\nThe Update Framework (TUF) design helps developers maintain the security of a\nsoftware update system, even against attackers that compromise the repository\nor signing keys.\nTUF provides a flexible\n[specification](https://github.com/theupdateframework/specification/blob/master/tuf-spec.md)\ndefining functionality that developers can use in any software update system or\nre-implement to fit their needs.\n\nTUF is hosted by the [Linux Foundation](https://www.linuxfoundation.org/) as\npart of the [Cloud Native Computing Foundation](https://www.cncf.io/) (CNCF)\nand its design is [used in production](https://theupdateframework.io/adoptions/)\nby various tech companies and open source organizations. A variant of TUF\ncalled [Uptane](https://uptane.github.io/) is used to secure over-the-air\nupdates in automobiles.\n\nPlease see [TUF's website](https://theupdateframework.com/) for more information about TUF!\n\n\nDocumentation\n-------------\n* [Introduction to TUF's Design](https://theupdateframework.io/overview/)\n* [The TUF Specification](https://theupdateframework.github.io/specification/latest/)\n* [Developer documentation](https://theupdateframework.readthedocs.io/), including\n [API reference](\n https://theupdateframework.readthedocs.io/en/latest/api/api-reference.html)\n* [Usage examples](https://github.com/theupdateframework/python-tuf/tree/develop/examples/)\n* [Governance](https://github.com/theupdateframework/python-tuf/blob/develop/docs/GOVERNANCE.md)\nand [Maintainers](https://github.com/theupdateframework/python-tuf/blob/develop/docs/MAINTAINERS.txt)\nfor the reference implementation\n* [Miscellaneous Docs](https://github.com/theupdateframework/python-tuf/tree/develop/docs)\n* [Python-TUF development blog](https://theupdateframework.github.io/python-tuf/)\n\n\nContact\n-------\nQuestions, feedback, and suggestions are welcomed on our low volume [mailing\nlist](https://groups.google.com/forum/?fromgroups#!forum/theupdateframework) or\nthe [#tuf](https://cloud-native.slack.com/archives/C8NMD3QJ3) channel on [CNCF\nSlack](https://slack.cncf.io/).\n\nWe strive to make the specification easy to implement, so if you come across\nany inconsistencies or experience any difficulty, do let us know by sending an\nemail, or by reporting an issue in the GitHub [specification\nrepo](https://github.com/theupdateframework/specification/issues).\n\nSecurity Issues and Bugs\n------------------------\n\nSee [SECURITY.md](docs/SECURITY.md)\n\nLicense\n-------\n\nThis work is [dual-licensed](https://en.wikipedia.org/wiki/Multi-licensing) and\ndistributed under the (1) MIT License and (2) Apache License, Version 2.0.\nPlease see [LICENSE-MIT](https://github.com/theupdateframework/python-tuf/blob/develop/LICENSE-MIT)\nand [LICENSE](https://github.com/theupdateframework/python-tuf/blob/develop/LICENSE).\n\n\nAcknowledgements\n----------------\n\nThis project is hosted by the Linux Foundation under the Cloud Native Computing\nFoundation. TUF's early development was managed by members of the [Secure\nSystems Lab](https://ssl.engineering.nyu.edu/) at [New York\nUniversity](https://engineering.nyu.edu/). We appreciate the efforts of all\n[maintainers and emeritus\nmaintainers](https://github.com/theupdateframework/python-tuf/blob/develop/docs/MAINTAINERS.txt),\nas well as the contributors Konstantin Andrianov, Kairo de Araujo, Ivana\nAtanasova, Geremy Condra, Zane Fisher, Pankhuri Goyal, Justin Samuel, Tian\nTian, Martin Vrachev and Yuyu Zheng who are among those who helped\nsignificantly with TUF's reference implementation. Maintainers and Contributors\nare governed by the [CNCF Community Code of\nConduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).\n\nThis material is based upon work supported by the National Science Foundation\nunder Grant Nos. CNS-1345049 and CNS-0959138. Any opinions, findings, and\nconclusions or recommendations expressed in this material are those of the\nauthor(s) and do not necessarily reflect the views of the National Science\nFoundation.\n",
"bugtrack_url": null,
"license": "MIT OR Apache-2.0",
"summary": "A secure updater framework for Python",
"version": "4.0.0",
"project_urls": {
"Documentation": "https://theupdateframework.readthedocs.io/en/stable/",
"Homepage": "https://www.updateframework.com",
"Issues": "https://github.com/theupdateframework/python-tuf/issues",
"Source": "https://github.com/theupdateframework/python-tuf"
},
"split_keywords": [
"authentication",
" compromise",
" key",
" revocation",
" secure",
" update",
" updater"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "26a6d4ddae5226c61062e2b675a0fa568d6f8f34a033addae3b4053523d62711",
"md5": "8d57e76a1a439308d77df18a5a386424",
"sha256": "a22ab5fa6daf910b3052929fdce42ccad8a300e5e85715daaff9592aed980f7a"
},
"downloads": -1,
"filename": "tuf-4.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8d57e76a1a439308d77df18a5a386424",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 50652,
"upload_time": "2024-04-04T08:38:57",
"upload_time_iso_8601": "2024-04-04T08:38:57.826009Z",
"url": "https://files.pythonhosted.org/packages/26/a6/d4ddae5226c61062e2b675a0fa568d6f8f34a033addae3b4053523d62711/tuf-4.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1e4a7405036c92b86229ec722dfa882bf999ac7241c7bd3cc8e9e6ceae75e73b",
"md5": "2acdc0500ca8b9518dbbb390f814df78",
"sha256": "87df89e5e50b0bf85ec84b7aabdac41a54cddaa8c6ce85ac5fae38ea786a12f6"
},
"downloads": -1,
"filename": "tuf-4.0.0.tar.gz",
"has_sig": false,
"md5_digest": "2acdc0500ca8b9518dbbb390f814df78",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 270142,
"upload_time": "2024-04-04T08:39:00",
"upload_time_iso_8601": "2024-04-04T08:39:00.356877Z",
"url": "https://files.pythonhosted.org/packages/1e/4a/7405036c92b86229ec722dfa882bf999ac7241c7bd3cc8e9e6ceae75e73b/tuf-4.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 08:39:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "theupdateframework",
"github_project": "python-tuf",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "tuf"
}
JSON
