mirror of
https://github.com/theupdateframework/python-tuf
synced 2026-05-24 10:08:28 +00:00
ffe2c11fcf
It is a simple example of TUF ngclient implementation. This example contains a README.rst that is a tutorial/how-to-use this simple client using static test data from TUF repository. The code aims to be straightforward implementation, using basic concepts from Python and Command Line Interface. This is part of theupdateframework#1518 Signed-off-by: Kairo de Araujo <kdearaujo@vmware.com> |
||
|---|---|---|
| .. | ||
| 1.root.json | ||
| client_example.py | ||
| README.rst | ||
Python Client Example
#####################
Introduction
============
Python Client Example, using ``python-tuf``.
For information about installing ``python-tuf``, please refer to the
`Installation documentation <https://theupdateframework.readthedocs.io/en/latest/INSTALLATION.html>`_.
Preparing
=========
To have the example working in your machine, clone the ``python-tuf`` in your
system.
.. code:: console
$ git clone git@github.com:theupdateframework/python-tuf.git
Repository
==========
As this example demonstrates how to use the ``python-tuf`` to build a
client application, the repository will use static files.
The static files are available in the ``python-tuf`` repository, same as this.
The static repository files are in
``tests/repository_data/repository``.
Run the repository using the Python3 built-in HTTP module, and keep this
session running.
.. code:: console
$ python3 -m http.server -d tests/repository_data/repository
Serving HTTP on :: port 8000 (http://[::]:8000/) ...
Client Example
==============
The `source code is available entirely <./client_example.py>`_ in this
repository.
How to use the Client Example:
1. Initialize the Client
.. code:: console
$ ./client_example.py --init
This action is to create the client infrastructure properly.
This infrastructure consists in:
- Metadata repository
- Download folder for targets
- Bootstrap 1.root.json
2. Download the ``file1.txt``
.. code:: console
$ ./client_example.py download file1.txt
[INFO] Top-level metadata is refreshed.
[INFO] Target info gotten.
[INFO] File downloaded available in ./downloads/file2.txt.
3. Download a not available ``file_na.txt``
.. code:: console
$ ./client_example.py download file_na.txt
[INFO] Top-level metadata is refreshed.
[INFO] Target info gotten.
[ERROR] Target file not found.
4. Download again ``file1.txt``
.. code:: console
$ ./client_example.py download file1.txt
[INFO] Top-level metadata is refreshed.
[INFO] Target info gotten.
[INFO] File is already available in ./downloads/file1.txt.