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

specification has new version #1763

Closed
github-actions bot opened this issue Jan 11, 2022 · 9 comments · Fixed by #1825
Closed

specification has new version #1763

github-actions bot opened this issue Jan 11, 2022 · 9 comments · Fixed by #1825
Assignees
Labels
1.0.0 blockers To be addressed before 1.0.0 release
Milestone

Comments

@github-actions
Copy link

It seems specification (https://github.com/theupdateframework/specification/blob/master/tuf-spec.md) has new version.
Please review the version.

@jku jku added the 1.0.0 blockers To be addressed before 1.0.0 release label Jan 11, 2022
@joshuagl
Copy link
Member

Changes were some cleanup in theupdateframework/specification#195 (diff) and removing ambiguous text related to updating root metadata after an update fails in theupdateframework/specification#196 (diff).

@jku
Copy link
Member

jku commented Jan 11, 2022

Note that this is the first time the CI check ran: Metadata API currently states support for v1.0.19 (vs spec v1.0.28 ) so there's likely more to verify.

This does imply the issue message should list the version numbers :)

@kairoaraujo
Copy link
Collaborator

I thought to have the version numbers, but if we don't thread the issue and a new version of the spec is released, it becomes outdated. The idea was to have a generic issue.

I'm thinking about some options:

  • Add version number in the title, so one issue every time we have a new spec
  • Add a comment with the version if the comment does not exist (maybe a bit tricky)

More suggestions?

@jku
Copy link
Member

jku commented Jan 11, 2022

eh, maybe we let it be and see how it works for a while 🤷

@jku
Copy link
Member

jku commented Jan 12, 2022

Looking at the commits these need review:

  • c43045a (tag: v1.0.28) Remove ambiguity in update root after a failed attempt
  • d7bc72e (tag: v1.0.27) A round of clean-up/clarifications
  • 107be15 (tag: v1.0.26) Clean up "Writing consistent snapshots" section
  • 2585a4e (tag: v1.0.25) Explain why we check hashes before signatures
  • 8dafd00 (tag: v1.0.24) Clarify optional attributes
  • 57f636e (tag: v1.0.23) Add guidance about unknown fields
  • adeaea4 Remove outdated terminology from description of ROLE
  • 7544c41 Remove redundant MUST statement in "Update the root role"
  • c7809e8 Require keyid uniqueness in metadata signatures list
  • 6fffd36 Clarify PATHPATTERN wildcards are glob-like
  • 4d69ee9 Require role name uniqueness in delegations

EDIT: all reviewed: the one issue is in the next comment

@jku
Copy link
Member

jku commented Jan 12, 2022

8dafd00 (tag: v1.0.24) Clarify optional attributes

This contains

The "path_hash_prefixes" and "paths" attributes are OPTIONAL, if used, exactly one of them should be set.

Metadata API requires exactly one of them.

Specification does not explain what should happen if neither field is set (I've previously thought it meant that everything is delegated but I think was persuaded against this in python-tuf before the spec change... not sure how this mess happened)

@jku
Copy link
Member

jku commented Jan 18, 2022

@jku jku added this to the sprint 16 milestone Jan 26, 2022
@MVrachev
Copy link
Collaborator

MVrachev commented Feb 2, 2022

We discussed with @kairoaraujo that I will take this issue while he is focused on working on Warehouse related stuff.

@MVrachev MVrachev assigned MVrachev and unassigned kairoaraujo Feb 2, 2022
@MVrachev
Copy link
Collaborator

MVrachev commented Feb 4, 2022

Looking at the commits these need review:

  • c43045a (tag: v1.0.28) Remove ambiguity in update root after a failed attempt
  • d7bc72e (tag: v1.0.27) A round of clean-up/clarifications
  • 107be15 (tag: v1.0.26) Clean up "Writing consistent snapshots" section
  • 2585a4e (tag: v1.0.25) Explain why we check hashes before signatures
  • 8dafd00 (tag: v1.0.24) Clarify optional attributes
  • 57f636e (tag: v1.0.23) Add guidance about unknown fields
  • adeaea4 Remove outdated terminology from description of ROLE
  • 7544c41 Remove redundant MUST statement in "Update the root role"
  • c7809e8 Require keyid uniqueness in metadata signatures list
  • 6fffd36 Clarify PATHPATTERN wildcards are glob-like
  • 4d69ee9 Require role name uniqueness in delegations

EDIT: all reviewed: the one issue is in the next comment

I looked into all changes between our current version 1.0.19 and the current version of the specification 1.0.28 and I agree with Jussi that the only one not fully resolved is:
8dafd00 (tag: v1.0.24) Clarify optional attributes.

It doesn't make sense to have a target file without paths or path_hash_prefixes, so our `python-tuf requirement to have at least one of them set makes sense.

Both with @jku we agreed that we can easily loosen this requirement if when solving theupdateframework/specification#200 it's decided that both of them can be omitted, but for now we decided it's better to stick to our current requirement to have one of them set.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.0.0 blockers To be addressed before 1.0.0 release
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants