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.

Sign up for GitHub

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

Jump to bottom

Introduce semantic versioning 2.0.0 and disambiguates spec versions #51

Merged
merged 6 commits into from
Sep 17, 2019
Merged

Introduce semantic versioning 2.0.0 and disambiguates spec versions #51

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9b595a9
Retire old tuf-spec.0.9.txt
lukpueh Sep 13, 2019
78fd456
Switch to semantic versioning 2.0.0 (semver.org)
lukpueh Sep 13, 2019
80326d1
Clarify that SPEC_VERSION is a semver string
lukpueh Sep 13, 2019
5e063a7
spec: 1.0.0: mention supported TAPs
SantiagoTorres Sep 13, 2019
52ef4f7
Update README.rst
JustinCappos Sep 17, 2019
f29d9ea
Update tuf-spec.md
JustinCappos Sep 17, 2019
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
7 changes: 6 additions & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
The Update Framework specification
----------------------------------

Latest: `version 1.0 <https://github.com/theupdateframework/specification/blob/master/tuf-spec.md>`_
Latest: `version 1.0.0 (Draft) <https://github.com/theupdateframework/specification/blob/master/tuf-spec.md>`_
JustinCappos marked this conversation as resolved.
Show resolved Hide resolved


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

Versioning
----------

The TUF specification uses `Semantic Versioning 2.0.0 <https://semver.org/>`_
for its version numbers.

Acknowledgements
----------------
Expand Down
0 tuf-spec.0.9.txt → historical/tuf-spec.0.9.txt
View file
Open in desktop
File renamed without changes.
26 changes: 23 additions & 3 deletions tuf-spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# <p align="center">The Update Framework Specification

Last modified: **19 June 2018**
Last modified: **13 September 2019**

Version: **1.0 (Draft)**
Version: **1.0.0 (Draft)**
JustinCappos marked this conversation as resolved.
Show resolved Hide resolved

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

- **1.5.4. TUF Augmentation Proposal support**

* This version (1.0.0) of the specification adheres to the following TAPS:

- [TAP 3](https://github.com/theupdateframework/taps/blob/master/tap3.md):
Multi Role Delegations
- [TAP 4](https://github.com/theupdateframework/taps/blob/master/tap4.md):
Multiple Repository Consensus on entrusted targets
- [TAP 6](https://github.com/theupdateframework/taps/blob/master/tap6.md):
Include specification version in metadata
- [TAP 9](https://github.com/theupdateframework/taps/blob/master/tap9.md):
Mandatory Metadata signing schemes
- [Tap 10](https://github.com/theupdateframework/taps/blob/master/tap10.md):
Remove native support for compressed metadata

Implementations compliant with this version (1.0.0) of the specification
must also comply with the TAPs mentioned above.

## **2. System overview**

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

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