python-tuf/tuf/ngclient/config.py
Fridolin Pokorny 5d347b8707
Fix pydocstyle D400: first line should end with a period
Signed-off-by: Fridolin Pokorny <fridolin.pokorny@datadoghq.com>
2023-01-26 15:33:09 +01:00

35 lines
1.3 KiB
Python

# 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:
"""Used to store ``Updater`` configuration.
Args:
max_root_rotations: Maximum number of root rotations.
max_delegations: Maximum number of delegations.
root_max_length: Maxmimum length of a root metadata file.
timestamp_max_length: Maximum length of a timestamp metadata file.
snapshot_max_length: Maximum length of a snapshot metadata file.
targets_max_length: Maximum length of a targets metadata file.
prefix_targets_with_hash: When `consistent snapshots
<https://theupdateframework.github.io/specification/latest/#consistent-snapshots>`_
are used, target download URLs are formed by prefixing the filename
with a hash digest of file content by default. This can be
overridden by setting ``prefix_targets_with_hash`` to ``False``.
"""
max_root_rotations: int = 32
max_delegations: int = 32
root_max_length: int = 512000 # bytes
timestamp_max_length: int = 16384 # bytes
snapshot_max_length: int = 2000000 # bytes
targets_max_length: int = 5000000 # bytes
prefix_targets_with_hash: bool = True