python-tuf/examples/repository
Jussi Kukkonen f60fb4abc8 Metadata API: Tweak get_root_verification_result args
Change the "other" argument to optional "previous" and
handle the None case in code.

Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>
2024-02-05 13:51:28 +02:00
..
_simplerepo.py Metadata API: Tweak get_root_verification_result args 2024-02-05 13:51:28 +02:00
README.md examples: Add missing link in repository README 2023-02-08 10:53:59 +02:00
repo examples: Implement the upload API 2023-02-02 16:25:43 +02:00

TUF Repository Application Example

⚠️ This example uses the repository module which is not considered part of the python-tuf stable API quite yet.

This TUF Repository Application Example has the following features:

  • Initializes a completely new repository on startup
  • Stores everything (metadata, targets, signing keys) in-memory
  • Serves metadata and targets on localhost (default port 8001)
  • Simulates a live repository by automatically adding a new target file every 10 seconds.
  • Exposes a small API for the uploader tool example. API POST endpoints are:
    • /api/role/<ROLE>: For uploading new delegated targets metadata. Payload is new version of ROLEs metadata
    • /api/delegation/<ROLE>: For modifying or creating a delegation for ROLE. Payload is a dict with one keyid:Key pair

Usage

./repo

Your repository is now running and is accessible on localhost, See e.g. http://127.0.0.1:8001/metadata/1.root.json. The client example uses this address by default.