Skip to content

Commit f56d526

Browse files
committed
README: Remove limitations
There may be ways to unsafely use the client library but situation should be significantly better now with ngclient: * metadata writing is safer, more atomic * non-root cached metadata is never trusted (so inconsistent cached repository is not a security issue) * the cache locations are now clearly application decisions (they are required Updater constructor args) Move the notice to Updater module documentation. Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>
1 parent a4d5cf4 commit f56d526

2 files changed

Lines changed: 4 additions & 6 deletions

File tree

README.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,12 +82,6 @@ Security Issues and Bugs
8282

8383
See [SECURITY.md](docs/SECURITY.md)
8484

85-
Limitations
86-
-----------
87-
88-
The reference implementation may behave unexpectedly when concurrently
89-
downloading the same target files with the same TUF client.
90-
9185
License
9286
-------
9387

tuf/ngclient/updater.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@
2828
* ``Updater.download_target()`` downloads a target file and ensures it is
2929
verified correct by the metadata.
3030
31+
Note that applications using ``Updater`` should be 'single instance'
32+
applications: running multiple instances that use the same cache directories at
33+
the same time is not supported.
34+
3135
A simple example of using the Updater to implement a Python TUF client that
3236
downloads target files is available in `examples/client_example
3337
<https://github.com/theupdateframework/python-tuf/tree/develop/examples/client_example>`_.

0 commit comments

Comments
 (0)