A Framework for Securing Software Update Systems

⚠️ This project is not ready for general-purpose use! ⚠️

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 written in Typescript. It is intended to conform to version 1.0 of the TUF specification.

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

• Introduction to TUF's Design
• The TUF Specification
• Developer documentation, including API reference
• Usage examples

Requirements

• node: ^14.17.0 || ^16.13.0 || >=18.0.0

License

This project is licensed under the terms of the MIT open source license. Please refer to MIT for the full terms.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Maintainers

tuf-js is maintained by @ejahnGithub and @bdehamer on the Package Security team at GitHub.