Add client config module

Add a config module containing a dataclass
UpdaterConfig with all client settings.
Initialize updater with default settings
if no other condig is provided.

Signed-off-by: Teodora Sechkova <[email protected]>

Author: sechkova

tuf/ngclient/__init__.py

@@ -4,5 +4,6 @@
 """TUF client public API
 """
 
+from tuf.ngclient.config import UpdaterConfig
 from tuf.ngclient.fetcher import FetcherInterface
 from tuf.ngclient.updater import Updater

tuf/ngclient/config.py

@@ -0,0 +1,17 @@
+# Copyright 2021, New York University and the TUF contributors
+# SPDX-License-Identifier: MIT OR Apache-2.0
+
+"""Configuration options for Updater class
+"""
+
+from dataclasses import dataclass
+
+
+@dataclass
+class UpdaterConfig:
+    MAX_ROOT_ROTATIONS: int = 32
+    MAX_DELEGATIONS: int = 32
+    DEFAULT_ROOT_MAX_LENGTH: int = 512000  # bytes
+    DEFAULT_TIMESTAMP_MAX_LENGTH: int = 16384  # bytes
+    DEFAULT_SNAPSHOT_MAX_LENGTH: int = 2000000  # bytes
+    DEFAULT_TARGETS_MAX_LENGTH: int = 5000000  # bytes

tuf/ngclient/updater.py

@@ -20,16 +20,9 @@
     requests_fetcher,
     trusted_metadata_set,
 )
+from tuf.ngclient.config import UpdaterConfig
 from tuf.ngclient.fetcher import FetcherInterface
 
-# Globals
-MAX_ROOT_ROTATIONS = 32
-MAX_DELEGATIONS = 32
-DEFAULT_ROOT_MAX_LENGTH = 512000  # bytes
-DEFAULT_TIMESTAMP_MAX_LENGTH = 16384  # bytes
-DEFAULT_SNAPSHOT_MAX_LENGTH = 2000000  # bytes
-DEFAULT_TARGETS_MAX_LENGTH = 5000000  # bytes
-
 logger = logging.getLogger(__name__)
 
 # Classes
@@ -45,6 +38,7 @@ def __init__(
         metadata_base_url: str,
         target_base_url: Optional[str] = None,
         fetcher: Optional[FetcherInterface] = None,
+        config: Optional[UpdaterConfig] = None,
     ):
         """
         Args:
@@ -76,6 +70,11 @@ def __init__(
         else:
             self._fetcher = fetcher
 
+        if config is None:
+            self.config = UpdaterConfig()
+        else:
+            self.config = config
+
     def refresh(self) -> None:
         """
         This method downloads, verifies, and loads metadata for the top-level
@@ -248,12 +247,12 @@ def _load_root(self) -> None:
 
         # Update the root role
         lower_bound = self._trusted_set.root.signed.version + 1
-        upper_bound = lower_bound + MAX_ROOT_ROTATIONS
+        upper_bound = lower_bound + self.config.MAX_ROOT_ROTATIONS
 
         for next_version in range(lower_bound, upper_bound):
             try:
                 data = self._download_metadata(
-                    "root", DEFAULT_ROOT_MAX_LENGTH, next_version
+                    "root", self.config.DEFAULT_ROOT_MAX_LENGTH, next_version
                 )
                 self._trusted_set.update_root(data)
                 self._persist_metadata("root", data)
@@ -278,7 +277,7 @@ def _load_timestamp(self) -> None:
 
         # Load from remote (whether local load succeeded or not)
         data = self._download_metadata(
-            "timestamp", DEFAULT_TIMESTAMP_MAX_LENGTH
+            "timestamp", self.config.DEFAULT_TIMESTAMP_MAX_LENGTH
         )
         self._trusted_set.update_timestamp(data)
         self._persist_metadata("timestamp", data)
@@ -294,7 +293,7 @@ def _load_snapshot(self) -> None:
             logger.debug("Failed to load local snapshot %s", e)
 
             metainfo = self._trusted_set.timestamp.signed.meta["snapshot.json"]
-            length = metainfo.length or DEFAULT_SNAPSHOT_MAX_LENGTH
+            length = metainfo.length or self.config.DEFAULT_SNAPSHOT_MAX_LENGTH
             version = None
             if self._trusted_set.root.signed.consistent_snapshot:
                 version = metainfo.version
@@ -314,7 +313,7 @@ def _load_targets(self, role: str, parent_role: str) -> None:
             logger.debug("Failed to load local %s: %s", role, e)
 
             metainfo = self._trusted_set.snapshot.signed.meta[f"{role}.json"]
-            length = metainfo.length or DEFAULT_TARGETS_MAX_LENGTH
+            length = metainfo.length or self.config.DEFAULT_TARGETS_MAX_LENGTH
             version = None
             if self._trusted_set.root.signed.consistent_snapshot:
                 version = metainfo.version
@@ -333,7 +332,7 @@ def _preorder_depth_first_walk(self, target_filepath) -> Dict:
         target = None
         role_names = [("targets", "root")]
         visited_role_names = set()
-        number_of_delegations = MAX_DELEGATIONS
+        number_of_delegations = self.config.MAX_DELEGATIONS
 
         # Preorder depth-first traversal of the graph of target delegations.
         while (
@@ -414,7 +413,7 @@ def _preorder_depth_first_walk(self, target_filepath) -> Dict:
         ):
             msg = (
                 f"{len(role_names)} roles left to visit, but allowed to ",
-                f"visit at most {MAX_DELEGATIONS} delegations.",
+                f"visit at most {self.config.MAX_DELEGATIONS} delegations.",
             )
             logger.debug(msg)