Skip to content

Commit

Permalink
Clarify that CONSISTENT_SNAPSHOT is optional
Browse files Browse the repository at this point in the history
From chapter 7 in the spec (version 1.0.17):
"Finally, the root metadata should write the Boolean
"consistent_snapshot" attribute at the root level of its keys of
attributes.
If consistent snapshots are not written by the repository,
then the attribute may either be left unspecified or be set to the
False value. Otherwise, it must be set to the True value."

The above implies that there could be repositories with root metadata
without CONSISTENT_SNAPSHOT.
Clarify that, but phrase it to make it clear this should be included
in new implementations.

Signed-off-by: Martin Vrachev <[email protected]>
  • Loading branch information
MVrachev committed May 17, 2021
1 parent acac34e commit 7c0e7e9
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions tuf-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Title: The Update Framework Specification
Shortname: TUF
Status: LS
Abstract: A framework for securing software update systems.
Date: 2020-12-11
Date: 2021-05-17
Editor: Justin Cappos, NYU
Editor: Trishank Karthik Kuppusamy, Datadog
Editor: Joshua Lock, VMware
Expand All @@ -16,7 +16,7 @@ Boilerplate: copyright no, conformance no
Local Boilerplate: header yes
Markup Shorthands: css no, markdown yes
Metadata Include: This version off, Abstract off
Text Macro: VERSION 1.0.17
Text Macro: VERSION 1.0.18
</pre>

Note: We strive to make the specification easy to implement, so if you come
Expand Down Expand Up @@ -688,9 +688,11 @@ The "signed" portion of <a>root.json</a> is as follows:

: <dfn>CONSISTENT_SNAPSHOT</dfn>
::
A boolean indicating whether the repository supports
consistent snapshots. Section 7 goes into more detail on the consequences
of enabling this setting on a repository.
An optional boolean indicating whether the repository supports
consistent snapshots. This field is optional for backward compatibility with
old metadata that may exist without it. New implementations SHOULD included
it. Section 7 goes into more detail on the consequences of enabling
this setting on a repository.

: <dfn for="role">VERSION</dfn>
::
Expand Down

0 comments on commit 7c0e7e9

Please sign in to comment.