Skip to content

Commit

Permalink
Validate spec_version during initialization
Browse files Browse the repository at this point in the history
Even though version strings like "2.0.0-rc.2" or "1.0.0-beta" are
valid strings in semantic versioning format, in TUF we never needed
to add letters for our specification number.

That's why I validate that: spec_version is a . separated string
and when split it has a length of 3 and that each of the
three elements is a number.

Also, I check that the given spec_version is supported against
the tuf code spec version.

Signed-off-by: Martin Vrachev <[email protected]>
  • Loading branch information
MVrachev committed Jun 14, 2021
1 parent 3bc5ad7 commit 24a39c2
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 12 deletions.
12 changes: 0 additions & 12 deletions tuf/api/__init__.py
Original file line number Diff line number Diff line change
@@ -1,12 +0,0 @@
"""TUF new API
This package contains all modules related to the TUF refactoring effort.
"""
# This reference implementation produces metadata intended to conform to
# version 1.0.0 of the TUF specification, and is expected to consume metadata
# conforming to version 1.0.0 of the TUF specification.
# All downloaded metadata must be equal to our supported major version of 1.
# For example, "1.4.3" and "1.0.0" are supported. "2.0.0" is not supported.
# See https://github.com/theupdateframework/specification
SPECIFICATION_VERSION = ["1", "0", "0"]
14 changes: 14 additions & 0 deletions tuf/api/metadata.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@
# and currently, we are above 1000 lines by a small margin.
# pylint: disable=C0302

# We aim to support SPECIFICATION_VERSION and require the input metadata
# files to have the same major version (the first number) as ours.
SPECIFICATION_VERSION = ["1", "0", "19"]


class Metadata:
"""A container for signed TUF metadata.
Expand Down Expand Up @@ -290,6 +294,16 @@ def __init__(
expires: datetime,
unrecognized_fields: Optional[Mapping[str, Any]] = None,
) -> None:
spec_list = spec_version.split(".")
if (
len(spec_list) != 3
or not all(el.isdigit() for el in spec_list)
or spec_list[0] != SPECIFICATION_VERSION[0]
):
raise ValueError(
f"Unsupported spec_version, got {spec_list}, "
f"supported {'.'.join(SPECIFICATION_VERSION)}"
)
self.spec_version = spec_version
self.expires = expires

Expand Down

0 comments on commit 24a39c2

Please sign in to comment.