python-tuf/examples/repository
Jussi Kukkonen a69ddf1f04 ngclient,tests,examples: Use new verify_delegate()
Avoid Metadata.verify_delegate() now that it's deprecated.

Note that this commit does not try to make any code cleanups
that are now possible: this is the minimal change to use the new
API.

Future improvements can make code in TrustedMetadataSet and
Updater slightly easier to read: as an example there's no need for
TrustedMetadataSet to actually store or expose actual Metadata in its
cache -- Signed is all that's needed.

Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>
2023-08-01 13:08:13 +02:00
..
_simplerepo.py ngclient,tests,examples: Use new verify_delegate() 2023-08-01 13:08:13 +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.