mirror of
https://github.com/theupdateframework/python-tuf
synced 2026-05-24 10:08:28 +00:00
42a797b4a1
Use black and isort to reformat new code in tuf/api/*, like so: ``` black --line-length 80 api isort --line-length 80 --profile black api ``` Besides downsizing the default line length to fit our Code Style Guide no extra configuration is required. Unified format according to black and isort will be enforced by CI/CD in a future commit. **Changes include:** - Use double quotes instead of single quotes where feasible - Re-wrap and re-indent long lines such as dict literals, function signatures and function calls, using hanging indent This will require an update in our Code Style Guide, which the benefits of using black seem worth. https://github.com/secure-systems-lab/code-style-guidelines/blob/master/python.md#indentation-and-line-continuation - Update vertical and horizontal spacing - Sort and wrap imports See black and isort docs for details: https://black.readthedocs.io/en/stable/the_black_code_style.html https://pycqa.github.io/isort/docs/configuration/black_compatibility/ NOTE: If desired I can split commits by change and/or configure git for this repo to ignore the corresponding revision(s) in git-blame. https://github.com/psf/black#migrating-your-code-style-without-ruining-git-blame Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
89 lines
2.9 KiB
Python
89 lines
2.9 KiB
Python
# Copyright New York University and the TUF contributors
|
|
# SPDX-License-Identifier: MIT OR Apache-2.0
|
|
|
|
"""TUF role metadata JSON serialization and deserialization.
|
|
|
|
This module provides concrete implementations to serialize and deserialize TUF
|
|
role metadata to and from the JSON wireline format for transportation, and
|
|
to serialize the 'signed' part of TUF role metadata to the OLPC Canonical JSON
|
|
format for signature generation and verification.
|
|
|
|
"""
|
|
import json
|
|
|
|
from securesystemslib.formats import encode_canonical
|
|
|
|
# pylint: disable=cyclic-import
|
|
# ... to allow de/serializing Metadata and Signed objects here, while also
|
|
# creating default de/serializers there (see metadata local scope imports).
|
|
# NOTE: A less desirable alternative would be to add more abstraction layers.
|
|
from tuf.api.metadata import Metadata, Signed
|
|
from tuf.api.serialization import (
|
|
DeserializationError,
|
|
MetadataDeserializer,
|
|
MetadataSerializer,
|
|
SerializationError,
|
|
SignedSerializer,
|
|
)
|
|
|
|
|
|
class JSONDeserializer(MetadataDeserializer):
|
|
"""Provides JSON to Metadata deserialize method. """
|
|
|
|
def deserialize(self, raw_data: bytes) -> Metadata:
|
|
"""Deserialize utf-8 encoded JSON bytes into Metadata object. """
|
|
try:
|
|
json_dict = json.loads(raw_data.decode("utf-8"))
|
|
metadata_obj = Metadata.from_dict(json_dict)
|
|
|
|
except Exception as e: # pylint: disable=broad-except
|
|
raise DeserializationError from e
|
|
|
|
return metadata_obj
|
|
|
|
|
|
class JSONSerializer(MetadataSerializer):
|
|
"""Provides Metadata to JSON serialize method.
|
|
|
|
Attributes:
|
|
compact: A boolean indicating if the JSON bytes generated in
|
|
'serialize' should be compact by excluding whitespace.
|
|
|
|
"""
|
|
|
|
def __init__(self, compact: bool = False) -> None:
|
|
self.compact = compact
|
|
|
|
def serialize(self, metadata_obj: Metadata) -> bytes:
|
|
"""Serialize Metadata object into utf-8 encoded JSON bytes. """
|
|
try:
|
|
indent = None if self.compact else 1
|
|
separators = (",", ":") if self.compact else (",", ": ")
|
|
json_bytes = json.dumps(
|
|
metadata_obj.to_dict(),
|
|
indent=indent,
|
|
separators=separators,
|
|
sort_keys=True,
|
|
).encode("utf-8")
|
|
|
|
except Exception as e: # pylint: disable=broad-except
|
|
raise SerializationError from e
|
|
|
|
return json_bytes
|
|
|
|
|
|
class CanonicalJSONSerializer(SignedSerializer):
|
|
"""Provides Signed to OLPC Canonical JSON serialize method. """
|
|
|
|
def serialize(self, signed_obj: Signed) -> bytes:
|
|
"""Serialize Signed object into utf-8 encoded OLPC Canonical JSON
|
|
bytes.
|
|
"""
|
|
try:
|
|
signed_dict = signed_obj.to_dict()
|
|
canonical_bytes = encode_canonical(signed_dict).encode("utf-8")
|
|
|
|
except Exception as e: # pylint: disable=broad-except
|
|
raise SerializationError from e
|
|
|
|
return canonical_bytes
|