theupdateframework / theupdateframework/specification

It is probably not helpful for Timestamp to list Snapshot's hash

Open
#28 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
405
Forks
59
Avg merge
3d 4h
Merged PRs (30d)
1

Description

Timestamp and Root are likely to be the two most-downloaded files on a repository. Currently, Timestamp lists information for Snapshot in a different way than Snapshot lists information for Targets and delegated targets files: timestamp lists the hash of snapshot in addition to the version number of snapshot. It is not clear that this is actually useful.

The costs to this are a few:

  • It adds size to the timestamp role file (one hash where timestamp would otherwise not contain hashes)
  • It makes the timestamp role file a little harder to read and understand.
  • It makes conceptually reconciling timestamp and snapshot definitions a bit harder for implementers / new folks.
  • It requires a bulkier and less intuitive programmatic representation (in formats.py and tuf_metadata_definitions.asn1).

Snapshot definition
Timestamp definition

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked Snapshot and Timestamp definitions in tuf-spec.md, then inspect formats.py and tuf_metadata_definitions.asn1 to understand the current representations. The work is done when the Timestamp definition and its programmatic representations no longer include Snapshot's hash, while the stated version information remains consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.