Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make metadata signatures ordered by keyid #1217

Merged
merged 1 commit into from
Nov 23, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions tests/test_repository_tool.py
Original file line number Diff line number Diff line change
Expand Up @@ -716,6 +716,34 @@ def list_folder(self, filepath):
tuf.formats.check_signable_object_format(role_signable)


def test_signature_order(self):
"""Test signatures are added to metadata in alphabetical order. """
# Create empty repo dir and init default repo in memory
repo_dir = tempfile.mkdtemp(dir=self.temporary_directory)
repo = repo_tool.create_new_repository(repo_dir)

# Dedicate any two existing test keys as root signing keys
for key_name in ["targets_key", "snapshot_key"]:
repo.root.load_signing_key(
repo_tool.import_ed25519_privatekey_from_file(
os.path.join("repository_data", "keystore", key_name),
"password"))

# Write root metadata with two signatures
repo.write("root")

# Load signed and written json metadata back into memory
root_metadata_path = os.path.join(
repo_dir, repo_tool.METADATA_STAGED_DIRECTORY_NAME, "root.json")
root_metadata = securesystemslib.util.load_json_file(root_metadata_path)

# Assert signatures are ordered alphabetically (by signing key keyid)
self.assertListEqual(
[sig["keyid"] for sig in root_metadata["signatures"]],
[
"59a4df8af818e9ed7abe0764c0b47b4240952aa0d179b5b78346c470ac30278d",
"65171251a9aff5a8b3143a813481cb07f6e0de4eb197c767837fe4491b739093"
])



Expand Down
2 changes: 1 addition & 1 deletion tuf/repository_lib.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ def _generate_and_write_metadata(rolename, metadata_filename,
roleinfo = tuf.roledb.get_roleinfo(rolename, repository_name)
previous_keyids = roleinfo.get('previous_keyids', [])
previous_threshold = roleinfo.get('previous_threshold', 1)
signing_keyids = list(set(roleinfo['signing_keyids']))
signing_keyids = sorted(set(roleinfo['signing_keyids']))

# Generate the appropriate role metadata for 'rolename'.
if rolename == 'root':
Expand Down