Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Latest commit

 

History

History
History
34 lines (24 loc) · 1.28 KB

File metadata and controls

34 lines (24 loc) · 1.28 KB
Copy raw file
Download raw file
Edit and raw actions

API Reference

TUF provides multiple APIs:

  • The low-level :doc:`tuf.api` provides access to a Metadata file abstraction that closely follows the TUF specification's document formats. This API handles de/serialization to and from files and makes it easier to access and modify metadata content safely. It is purely focused on individual pieces of Metadata and provides no concepts like "repository" or "update workflow".
  • The client update workflow is implemented in the :doc:`tuf.ngclient` module: It is a higher-level API that provides ways to query and download target files securely, while handling the TUF update workflow behind the scenes. ngclient is implemented on top of the Metadata API and can be used to implement various TUF clients with relatively little effort.

Code examples are available for client implementation using ngclient and a basic repository using Metadata API.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   tuf.api
   tuf.ngclient

Morty Proxy This is a proxified and sanitized view of the page, visit original site.