From 6f94aa165308c5c1f5a99b3ba40c5960dfcb61b2 Mon Sep 17 00:00:00 2001 From: Lukas Puehringer Date: Mon, 16 Mar 2020 10:25:53 +0100 Subject: [PATCH 1/2] Remove link to outdated client docs in tutorial Remove link to incomplete and severely outdated client_setup_and_repository_example.md in client section of TUTORIAL.md. Instead we should link (or move the entire client tutorial part) to tuf/client/README.md, which is more comprehensive and less outdated than above document (see #808). Signed-off-by: Lukas Puehringer --- docs/TUTORIAL.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/TUTORIAL.md b/docs/TUTORIAL.md index 6057935cf0..8efea6e3fb 100644 --- a/docs/TUTORIAL.md +++ b/docs/TUTORIAL.md @@ -672,10 +672,6 @@ Adding a verification key that has already been used. [repeated 32x] ## How to Perform an Update ## -Documentation for setting up a TUF client and performing an update is -available [here](../tuf/client_setup_and_repository_example.md). The documentation -there is provided here for convenience. - The following [repository tool](../tuf/repository_tool.py) function creates a directory structure that a client downloading new software using TUF (via [tuf/client/updater.py](../tuf/client/updater.py)) expects. The `root.json` metadata file must exist, and From 7816000abc9fb3f9d7ac8daa61f58bbc7d219d1d Mon Sep 17 00:00:00 2001 From: Lukas Puehringer Date: Mon, 16 Mar 2020 10:31:29 +0100 Subject: [PATCH 2/2] Remove incomplete and outdated client doc An up-to-date version of the minimal client usage instructions from client_setup_and_repository_example.md can be found in the main TUF tutorial. More comprehensive documentation of the tuf client can be found in tuf/client/README.md, which also needs a revision. Signed-off-by: Lukas Puehringer --- tuf/client_setup_and_repository_example.md | 43 ---------------------- 1 file changed, 43 deletions(-) delete mode 100644 tuf/client_setup_and_repository_example.md diff --git a/tuf/client_setup_and_repository_example.md b/tuf/client_setup_and_repository_example.md deleted file mode 100644 index 67121e2530..0000000000 --- a/tuf/client_setup_and_repository_example.md +++ /dev/null @@ -1,43 +0,0 @@ -## Client Setup ## - -The following [repository tool](README.md) function creates a directory -structure that a client downloading new software using TUF (via tuf/client/updater.py) -expects. The `root.json` metadata file must exist, and also the directories that hold -the metadata files downloaded from a repository. Software updaters integrating with -TUF may use this directory to store TUF updates saved on the client side. - -```python ->>> from tuf.repository_tool import * ->>> create_tuf_client_directory("/path/to/repository/", "/path/to/client/") -``` - -`create_tuf_client_directory()` moves metadata from `/path/to/repository/metadata` -to `/path/to/client/`. The repository in `/path/to/repository/` may be the repository -example created in the repository tool [README](README.md). - - -## Test TUF Locally ## -Run the local TUF repository server. -```Bash -$ cd "/path/to/repository/"; python -m SimpleHTTPServer 8001 -``` - -Retrieve targets from the TUF repository and save them to `/path/to/client/`. The -`basic_client.py` module is available in `tuf/client/`. -In a different command-line prompt . . . -```Bash -$ cd "/path/to/client/" -$ ls -metadata/ - -$ basic_client.py --repo http://localhost:8001 -$ ls . targets/ targets/django/ -.: -metadata targets tuf.log - -targets/: -django file1.txt file2.txt - -targets/django/: -file4.txt -```