Remove add_restricted_paths from TUTORIAL.md and test_tutorial.py

add_restricted_paths was renamed to add_path; however, this function represents a problematic element of TUF that assumes that roles are have a single delegator and delegatee, and that one can refer to a role's expected keys without being concerned about any delegation metadata.... So this is being removed from the tutorial. In time, add_paths will either be removed or changed (to expect a delegator role and a delegatee role, not just a delegatee role). This comment does not do justice to the issue: please see TUF GitHub Issue #660: #660 Signed-off-by: Sebastien Awwad <sebastien.awwad@gmail.com>
theupdateframework · Aug 21, 2018 · defd12e · defd12e
1 parent f92e0c4
commit defd12e
Show file tree

Hide file tree

Showing 2 changed files with 0 additions and 5 deletions.
diff --git a/docs/TUTORIAL.md b/docs/TUTORIAL.md
@@ -608,8 +608,6 @@ to some role.
 >>> for delegation in repository.targets('unclaimed').delegations:
 ...   delegation.load_signing_key(private_unclaimed_key)
 
-# Delegated roles can be restricted to particular paths with add_restricted_paths().
->>> repository.targets('unclaimed').add_restricted_paths('repository/targets/myproject/*', 'django')
 ```
 
 ## How to Perform an Update ##

diff --git a/tests/test_tutorial.py b/tests/test_tutorial.py
@@ -300,9 +300,6 @@ def test_tutorial(self):
     for delegation in repository.targets('unclaimed').delegations:
       delegation.load_signing_key(private_unclaimed_key)
 
-    repository.targets('unclaimed').add_restricted_paths(
-        'repository/targets/myproject/*', 'django')
-
 
 
     # ----- Tutorial Section: How to Perform an Update