util.py about python-tuf HOT 2 CLOSED

Note: This function has been renamed and affected modules modified (after reviewing util.py and test_util.py): akonst/tuf@d2a799f

file_in_confined_directories() determines if 'filepath' (first argument) is in at least one of the directories of 'confined_directories'. We are checking path strings, not actual files on the local file system.

tuf.util.file_in_confined_directories('a/b/target.jpg', ['a/'])
False
tuf.util.file_in_confined_directories('a/b/target.jpg', ['a/b/'])
True

We are not checking if two files are the same, only that the file's parent directory is in 'confined_paths'.
This function is provided to allow a soft of mixed selection of targets a client may download. The updater methods provided to the client include updater.all_targets(), updater.targets_of_role(), and updater.target(). If the client adds restricted directories to a mirror's 'confined_target_dirs' field, he could then do an updater.all_targets()
and only download targets from those listed in 'confined_target_dirs'. This might be a useful option for client code written by software updaters.

Let me know if my explanation is clear and the modified function correct. I updated some the test cases for this function.

from python-tuf.

Okay, looks good.

from python-tuf.