Skip to content

Commit 9f14855

Browse files
authored
Merge pull request #51 from theupdateframework/disambiguate-spec-versions
Introduce semantic versioning 2.0.0 and disambiguates spec versions
2 parents 6d33b3e + f29d9ea commit 9f14855

File tree

3 files changed

+29
-4
lines changed

3 files changed

+29
-4
lines changed

README.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
The Update Framework specification
22
----------------------------------
33

4-
Latest: `version 1.0 <https://github.com/theupdateframework/specification/blob/master/tuf-spec.md>`_
4+
Latest: `version 1.0.0 <https://github.com/theupdateframework/specification/blob/master/tuf-spec.md>`_
55

66

77
Contact
@@ -27,6 +27,11 @@ Please see `LICENSE-MIT.txt
2727
and `LICENSE-APACHE.txt
2828
<https://github.com/theupdateframework/specification/blob/master/LICENSE-APACHE.txt>`_.
2929

30+
Versioning
31+
----------
32+
33+
The TUF specification uses `Semantic Versioning 2.0.0 <https://semver.org/>`_
34+
for its version numbers.
3035

3136
Acknowledgements
3237
----------------
File renamed without changes.

tuf-spec.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# <p align="center">The Update Framework Specification
22

3-
Last modified: **19 June 2018**
3+
Last modified: **13 September 2019**
44

5-
Version: **1.0 (Draft)**
5+
Version: **1.0.0**
66

77
We strive to make the specification easy to implement, so if you come across
88
any inconsistencies or experience any difficulty, do let us know by sending an
@@ -210,6 +210,24 @@ repo](https://github.com/theupdateframework/specification/issues).
210210
* The root of trust must not rely on external PKI. That is, no authority will
211211
be derived from keys outside of the framework.
212212

213+
- **1.5.4. TUF Augmentation Proposal support**
214+
215+
* This version (1.0.0) of the specification adheres to the following TAPS:
216+
217+
- [TAP 3](https://github.com/theupdateframework/taps/blob/master/tap3.md):
218+
Multi Role Delegations
219+
- [TAP 4](https://github.com/theupdateframework/taps/blob/master/tap4.md):
220+
Multiple Repository Consensus on entrusted targets
221+
- [TAP 6](https://github.com/theupdateframework/taps/blob/master/tap6.md):
222+
Include specification version in metadata
223+
- [TAP 9](https://github.com/theupdateframework/taps/blob/master/tap9.md):
224+
Mandatory Metadata signing schemes
225+
- [Tap 10](https://github.com/theupdateframework/taps/blob/master/tap10.md):
226+
Remove native support for compressed metadata
227+
228+
Implementations compliant with this version (1.0.0) of the specification
229+
must also comply with the TAPs mentioned above.
230+
213231
## **2. System overview**
214232

215233
The framework ultimately provides a secure method of obtaining trusted
@@ -582,7 +600,9 @@ repo](https://github.com/theupdateframework/specification/issues).
582600
, ... }
583601
}
584602

585-
SPEC_VERSION is the version number of the specification. Metadata is
603+
SPEC_VERSION is a string that contains the version number of the TUF
604+
specification. Its format follows the [Semantic Versioning 2.0.0
605+
(semver)](https://semver.org/spec/v2.0.0.html) specification. Metadata is
586606
written according to version "spec_version" of the specification, and
587607
clients MUST verify that "spec_version" matches the expected version number.
588608
Adopters are free to determine what is considered a match (e.g., the version

0 commit comments

Comments
 (0)