"""Script for generating new metadata files.""" # Copyright New York University and the TUF contributors # SPDX-License-Identifier: MIT OR Apache-2.0 from __future__ import annotations import os import sys from datetime import datetime, timezone from cryptography.hazmat.primitives.asymmetric.ed25519 import Ed25519PrivateKey from securesystemslib.signer import CryptoSigner, Signer, SSlibKey from tests import utils from tuf.api.metadata import Metadata, Root, Snapshot, Targets, Timestamp from tuf.api.serialization.json import JSONSerializer # Hardcode keys and expiry time to achieve reproducibility. public_values: list[str] = [ "b11d2ff132c033a657318c74c39526476c56de7556c776f11070842dbc4ac14c", "250f9ae3d1d3d5c419a73cfb4a470c01de1d5d3d61a3825416b5f5d6b88f4a30", "82380623abb9666d4bf274b1a02577469445a972e5650d270101faa5107b19c8", "0e6738fc1ac6fb4de680b4be99ecbcd99b030f3963f291277eef67bb9bd123e9", ] private_values: list[bytes] = [ bytes.fromhex( "510e5e04d7a364af850533856eacdf65d30cc0f8803ecd5fdc0acc56ca2aa91c" ), bytes.fromhex( "e6645b00312c8a257782e3e61e85bafda4317ad072c52251ef933d480c387abd" ), bytes.fromhex( "cd13dd2180334b24c19b32aaf27f7e375a614d7ba0777220d5c2290bb2f9b868" ), bytes.fromhex( "7e2e751145d1b22f6e40d4ba2aa47158207acfd3c003f1cbd5a08141dfc22a15" ), ] keyids: list[str] = [ "5822582e7072996c1eef1cec24b61115d364987faa486659fe3d3dce8dae2aba", "09d440e3725cec247dcb8703b646a87dd2a4d75343e8095c036c32795eefe3b9", "3458204ed467519c19a5316eb278b5608472a1bbf15850ebfb462d5315e4f86d", "2be5c21e3614f9f178fb49c4a34d0c18ffac30abd14ced917c60a52c8d8094b7", ] signers: list[Signer] = [] for index in range(len(keyids)): key = SSlibKey( keyids[index], "ed25519", "ed25519", {"public": public_values[index]}, ) private_key = Ed25519PrivateKey.from_private_bytes(private_values[index]) signers.append(CryptoSigner(private_key, key)) EXPIRY = datetime(2050, 1, 1, tzinfo=timezone.utc) SERIALIZER = JSONSerializer() def verify_generation(md: Metadata, path: str) -> None: """Verify that newly generated file equals the locally stored one. Args: md: Newly generated metadata object. path: Path to the locally stored metadata file. """ with open(path, "rb") as f: static_md_bytes = f.read() md_bytes = md.to_bytes(SERIALIZER) if static_md_bytes != md_bytes: raise ValueError( f"Generated data != local data at {path}. Generate a new " "metadata with 'python generated_data/generate_md.py'" ) def generate_all_files(dump: bool = False) -> None: """Generate a new repository or verify that output has not changed. Args: dump: If True, new files are generated. If False, existing files are compared to generated files and an exception is raised if there are differences. """ md_root = Metadata(Root(expires=EXPIRY)) md_timestamp = Metadata(Timestamp(expires=EXPIRY)) md_snapshot = Metadata(Snapshot(expires=EXPIRY)) md_targets = Metadata(Targets(expires=EXPIRY)) md_root.signed.add_key(signers[0].public_key, "root") md_root.signed.add_key(signers[1].public_key, "timestamp") md_root.signed.add_key(signers[2].public_key, "snapshot") md_root.signed.add_key(signers[3].public_key, "targets") for i, md in enumerate([md_root, md_timestamp, md_snapshot, md_targets]): assert isinstance(md, Metadata) md.sign(signers[i]) path = os.path.join( utils.TESTS_DIR, "generated_data", "ed25519_metadata", f"{md.signed.type}_with_ed25519.json", ) if dump: md.to_file(path, SERIALIZER) else: verify_generation(md, path) if __name__ == "__main__": utils.configure_test_logging(sys.argv) # To generate a new set of metadata files this script is supposed to be run # from the "tests" folder. generate_all_files(dump=True)