File: README.md

package info (click to toggle)
python-tuf 6.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,300 kB
  • sloc: python: 7,738; makefile: 8
file content (25 lines) | stat: -rw-r--r-- 1,053 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# TUF Repository Application Example

:warning: 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](../uploader/). 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

```console
./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](../client/README.md) uses this address by default.