Skip to content

Commit 3962417

Browse files
author
Lukas Puehringer
committed
Rename TAP 3 metadata fields
`keys_for_delegations` --> `keys` (the keys field in root.json in reality also lists "keys for delegations", i.e. keys to delegate trust to other top-level roles, but is only called keys) `roleinfo` --> `roles` (keeping the name for delegated roles as it was before TAP3)
1 parent febda3d commit 3962417

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

tuf-spec.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -789,7 +789,7 @@ repo](https://github.com/theupdateframework/specification/issues).
789789
"version" : VERSION,
790790
"expires" : EXPIRES,
791791
"targets" : TARGETS,
792-
("keys_for_delegations" : {
792+
("keys" : {
793793
KEYID : KEY,
794794
... },
795795
"delegations" : [ DELEGATION, ... ])
@@ -827,10 +827,9 @@ repo](https://github.com/theupdateframework/specification/issues).
827827
TARGETPATH. The application may use this information to guide download
828828
decisions.
829829

830-
"keys_for_delegations" lists the public keys to verify signatures of
831-
delegated targets roles. Revocation and replacement of delegated targets
832-
roles keys is done by changing the keys in this field in the delegating
833-
role's metadata.
830+
"keys" lists the public keys to verify signatures of delegated targets
831+
roles. Revocation and replacement of delegated targets roles keys is done by
832+
changing the keys in this field in the delegating role's metadata.
834833

835834
"delegations" is a list of DELEGATION objects whose format is the following:
836835

@@ -840,7 +839,7 @@ repo](https://github.com/theupdateframework/specification/issues).
840839
"paths" : [ PATHPATTERN, ... ]),
841840
"terminating": TERMINATING,
842841
"min_roles_in_agreement" : NUM_ROLES,
843-
"roleinfo": [{
842+
"roles": [{
844843
"rolename": ROLENAME,
845844
"keyids": [ KEYID ],
846845
"threshold": THRESHOLD,
@@ -893,7 +892,7 @@ repo](https://github.com/theupdateframework/specification/issues).
893892

894893
NUM_ROLES is the minimum number of delegated targets roles that must be in
895894
agreement about targets hashes and lengths entrusted by the delegation. The
896-
delegated targets roles for a given delegation are listed in its "roleinfo"
895+
delegated targets roles for a given delegation are listed in its "roles"
897896
field.
898897

899898
ROLENAME is the name of the delegated targets role, e.g. "projects", KEYID
@@ -905,8 +904,8 @@ repo](https://github.com/theupdateframework/specification/issues).
905904
them in the order of their appearance in the "delegations" field. The
906905
first delegation is trusted over the second one, the second delegation is
907906
trusted over the third one, and so on. Likewise, in a multi-role delegation,
908-
if NUM_ROLES is less than or equal to half the number of roles in
909-
"roleinfo", different groups of roles may have different agreements
907+
if NUM_ROLES is less than or equal to half the number of roles in the
908+
"roles" field, different groups of roles may have different agreements
910909
on targets hashes or lengths. Such conflicts must be
911910
resolved by priorizing the first role in the list, that specifies target
912911
metadata agreed to by at least NUM_ROLES.
@@ -928,7 +927,7 @@ repo](https://github.com/theupdateframework/specification/issues).
928927
"signed": {
929928
"_type": "targets",
930929
"spec_version": "1.0.0",
931-
"keys_for_delegations": {
930+
"keys": {
932931
"f761033eb880143c52358d941d987ca5577675090e2215e856ba0099bc0ce4f6": {
933932
"keytype": "ed25519",
934933
"scheme": "ed25519",
@@ -945,7 +944,7 @@ repo](https://github.com/theupdateframework/specification/issues).
945944
],
946945
"terminating": true,
947946
"min_roles_in_agreement" : 1,
948-
"roleinfo": [
947+
"roles": [
949948
{
950949
"name": "project",
951950
"keyids": [
@@ -1259,9 +1258,9 @@ non-volatile storage as FILENAME.EXT.
12591258
of appearance.
12601259

12611260
* **4.4.2.1**. If the current delegation is a multi-role delegation,
1262-
recursively visit each role, and check that a defined threshold of
1263-
roles has signed exactly the same non-custom metadata (i.e., length and
1264-
hashes) about the target (or the lack of any such metadata).
1261+
recursively visit each role, and check that a defined minimum number of
1262+
roles agrees about non-custom metadata, i.e. length and hashes of the
1263+
target (or the lack of any such metadata).
12651264

12661265
* **4.4.2.2**. If the current delegation is a terminating delegation,
12671266
then jump to step 5.

0 commit comments

Comments
 (0)