Elgato_dark/python-tuf
1
0
Fork 0
mirror of https://github.com/theupdateframework/python-tuf synced 2026-05-24 10:08:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add docstrings in Updater

Browse source 
Add some missing docstrings in updater.py

Signed-off-by: Teodora Sechkova <tsechkova@vmware.com>
This commit is contained in:
Teodora Sechkova 2021-05-21 13:04:23 +03:00
parent b49d841673
commit e54ed249f5
1 changed files with 21 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
tuf/ngclient/updater.py
View file

@ -1,10 +1,7 @@
# Copyright 2020, New York University and the TUF contributors
# SPDX-License-Identifier: MIT OR Apache-2.0
"""TUF client 1.0.0 draft
TODO
"""TUF client workflow implementation.
"""
import fnmatch
@ -34,9 +31,8 @@
# Classes
class Updater:
"""
Provides a class that can download target files securely.
TODO
An implemetation of the TUF client workflow.
Provides a public API for integration in client applications.
"""
def __init__(
@ -218,7 +214,7 @@ def download_target(
def _download_metadata(
self, rolename: str, length: int, version: Optional[int] = None
) -> bytes:
"""download a metadata file and return it as bytes"""
"""Download a metadata file and return it as bytes"""
if version is None:
filename = f"{rolename}.json"
else:
@ -325,7 +321,9 @@ def _load_targets(self, role: str, parent_role: str) -> None:
def _preorder_depth_first_walk(self, target_filepath) -> Dict:
"""
TODO
Interrogates the tree of target delegations in order of appearance
(which implicitly order trustworthiness), and returns the matching
target found in the most trusted role.
"""
target = None
@ -518,7 +516,12 @@ def _visit_child_role(child_role: Dict, target_filepath: str) -> str:
def _check_file_length(file_object, trusted_file_length):
"""
TODO
Given a file_object, checks whether its length matches
trusted_file_length.
Raises:
DownloadLengthMismatchError: File length does not match
expected length.
"""
file_object.seek(0, 2)
observed_length = file_object.tell()
@ -532,7 +535,11 @@ def _check_file_length(file_object, trusted_file_length):
def _check_hashes_obj(file_object, trusted_hashes):
"""
TODO
Given a file_object, checks whether its hash matches
trusted_hashes.
Raises:
BadHashError: Hashes do not match
"""
for algorithm, trusted_hash in trusted_hashes.items():
digest_object = sslib_hash.digest_fileobject(file_object, algorithm)
@ -550,10 +557,10 @@ def _check_hashes_obj(file_object, trusted_hashes):
def _get_filepath_hash(target_filepath, hash_function="sha256"):
"""
TODO
Calculate the hash of the filepath to determine which bin to find the
target.
"""
# Calculate the hash of the filepath to determine which bin to find the
# target. The client currently assumes the repository (i.e., repository
# The client currently assumes the repository (i.e., repository
# tool) uses 'hash_function' to generate hashes and UTF-8.
digest_object = sslib_hash.digest(hash_function)
encoded_target_filepath = target_filepath.encode("utf-8")