Skip to content

Commit

Permalink
Update of ED report from new reffy run
Browse files Browse the repository at this point in the history 
Using reffy commit 17.2.0.
  • Loading branch information
reffy-bot committed Aug 26, 2024
1 parent 526d84d commit 656b83c
Show file tree
Hide file tree
Showing 7 changed files with 223 additions and 196 deletions.
12 changes: 6 additions & 6 deletions ed/algorithms/vc-data-integrity.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
]
},
{
"html": "The following algorithm specifies how to incrementally add a proof to a proof\nset or proof chain starting with a secured document containing either a proof or\nproof set/chain. Required inputs are a <a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-secured-data-document\" class=\"internalDFN\" id=\"ref-for-dfn-secured-data-document-5\">secured data document</a>\n(<a data-link-type=\"dfn|abstract-op\" data-cite=\"infra\" data-cite-path=\"/\" data-cite-frag=\"ordered-map\" data-type=\"dfn\" href=\"https://infra.spec.whatwg.org/#ordered-map\">map</a> <var>securedDocument</var>), a <a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-cryptosuite\" class=\"internalDFN\" id=\"ref-for-dfn-cryptosuite-11\">cryptographic suite</a>\n(<var data-type=\"cryptosuite instance\">suite</var>), and a set of options (<a data-link-type=\"dfn|abstract-op\" data-cite=\"infra\" data-cite-path=\"/\" data-cite-frag=\"ordered-map\" data-type=\"dfn\" href=\"https://infra.spec.whatwg.org/#ordered-map\">map</a> <var>options</var>). Output\nis a new <a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-secured-data-document\" class=\"internalDFN\" id=\"ref-for-dfn-secured-data-document-6\">secured data document</a> (<a data-link-type=\"dfn|abstract-op\" data-cite=\"infra\" data-cite-path=\"/\" data-cite-frag=\"ordered-map\" data-type=\"dfn\" href=\"https://infra.spec.whatwg.org/#ordered-map\">map</a>). Whenever this algorithm\nencodes strings, it <em class=\"rfc2119\">MUST</em> use UTF-8 encoding.",
"html": "The following algorithm specifies how to incrementally add a proof to a proof\nset or proof chain starting with a secured document containing either a proof or\nproof set/chain. Required inputs are a <a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-secured-data-document\" class=\"internalDFN\" id=\"ref-for-dfn-secured-data-document-5\">secured data document</a> (<a data-link-type=\"dfn|abstract-op\" data-cite=\"infra\" data-cite-path=\"/\" data-cite-frag=\"ordered-map\" data-type=\"dfn\" href=\"https://infra.spec.whatwg.org/#ordered-map\">map</a>\n<var>securedDocument</var>), a <a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-cryptosuite\" class=\"internalDFN\" id=\"ref-for-dfn-cryptosuite-11\">cryptographic suite</a> (<a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-data-integrity-cryptographic-suite-instance\" class=\"internalDFN\" id=\"ref-for-dfn-data-integrity-cryptographic-suite-instance-4\">cryptosuite instance</a> <var>suite</var>), and a set of options (<a data-link-type=\"dfn|abstract-op\" data-cite=\"infra\" data-cite-path=\"/\" data-cite-frag=\"ordered-map\" data-type=\"dfn\" href=\"https://infra.spec.whatwg.org/#ordered-map\">map</a> <var>options</var>). Output is a new\n<a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-secured-data-document\" class=\"internalDFN\" id=\"ref-for-dfn-secured-data-document-6\">secured data document</a> (<a data-link-type=\"dfn|abstract-op\" data-cite=\"infra\" data-cite-path=\"/\" data-cite-frag=\"ordered-map\" data-type=\"dfn\" href=\"https://infra.spec.whatwg.org/#ordered-map\">map</a>). Whenever this algorithm encodes strings, it\n<em class=\"rfc2119\">MUST</em> use UTF-8 encoding.",
"rationale": ".algorithm",
"steps": [
{
Expand All @@ -90,7 +90,7 @@
"html": "Set <var>inputDocument</var>.<var>proof</var> to <var>matchingProofs</var>."
},
{
"html": "Run steps 1 through 6 of the algorithm in section <a href=\"https://w3c.github.io/vc-data-integrity/#add-proof\" data-matched-text=\"[[[#add-proof]]]\" class=\"sec-ref\"><bdi class=\"secno\">4.2 </bdi>Add Proof</a>, passing\n<var>inputDocument</var>, <var data-type=\"cryptosuite instance\">suite</var>, and <var>options</var>. If no exceptions are raised, append\nthe generated <var>proof</var> value to the <var>allProofs</var>; otherwise, raise the exception."
"html": "Run steps 1 through 6 of the algorithm in section <a href=\"https://w3c.github.io/vc-data-integrity/#add-proof\" data-matched-text=\"[[[#add-proof]]]\" class=\"sec-ref\"><bdi class=\"secno\">4.2 </bdi>Add Proof</a>, passing\n<var>inputDocument</var>, <var>suite</var>, and <var>options</var>. If no exceptions are raised, append\nthe generated <var>proof</var> value to the <var>allProofs</var>; otherwise, raise the exception."
},
{
"html": "Set <var>output</var>.<var>proof</var> to the value of <var>allProofs</var>."
Expand All @@ -101,7 +101,7 @@
]
},
{
"html": "When a step says \"an error <em class=\"rfc2119\">MUST</em> be raised\", it means that a <a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-verification-result\" class=\"internalDFN\" id=\"ref-for-dfn-verification-result-1\">verification result</a> <em class=\"rfc2119\">MUST</em> be returned with a <a data-link-type=\"dfn|abstract-op\" data-link-for=\"verification result\" data-xref-for=\"verification result\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-verified-0\" class=\"internalDFN\" id=\"ref-for-dfn-verified-0-3\">verified</a> of <code>false</code>\nand a non-empty <a data-link-type=\"dfn|abstract-op\" data-link-for=\"verification result\" data-xref-for=\"verification result\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-errors\" class=\"internalDFN\" id=\"ref-for-dfn-errors-1\">errors</a> list.",
"html": "When a step says \"an error <em class=\"rfc2119\">MUST</em> be raised\", it means that a <a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-verification-result\" class=\"internalDFN\" id=\"ref-for-dfn-verification-result-1\">verification result</a> <em class=\"rfc2119\">MUST</em> be returned with a <a data-link-type=\"dfn|abstract-op\" data-link-for=\"verification result\" data-xref-for=\"verification result\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-verified-0\" class=\"internalDFN\" id=\"ref-for-dfn-verified-0-3\">verified</a> value of\n<code>false</code> and a non-empty <a data-link-type=\"dfn|abstract-op\" data-link-for=\"verification result\" data-xref-for=\"verification result\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-errors\" class=\"internalDFN\" id=\"ref-for-dfn-errors-1\">errors</a> list.",
"rationale": ".algorithm",
"steps": [
{
Expand Down Expand Up @@ -129,12 +129,12 @@
"html": "Let <var>cryptosuiteVerificationResult</var> be the result of running the\n<var>cryptosuite</var>.<a data-link-type=\"dfn|abstract-op\" data-link-for=\"cryptosuite instance\" data-xref-for=\"cryptosuite instance\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-verifyproof\" class=\"internalDFN\" id=\"ref-for-dfn-verifyproof-1\">verifyProof</a> algorithm with\n<var data-type=\"map\">securedDocument</var> provided as input."
},
{
"html": "Return a <a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-verification-result\" class=\"internalDFN\" id=\"ref-for-dfn-verification-result-2\">verification result</a> with <a data-link-type=\"dfn|abstract-op\" data-link-for=\"struct\" data-xref-for=\"struct\" data-cite=\"infra\" data-cite-path=\"/\" data-cite-frag=\"struct-item\" data-type=\"dfn\" href=\"https://infra.spec.whatwg.org/#struct-item\">items</a>:\n <dl data-link-for=\"verification result\">\n <dt><a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-verified-0\" class=\"internalDFN\" id=\"ref-for-dfn-verified-0-4\">verified</a></dt>\n <dd><var>cryptosuiteVerificationResult</var>.<var>verified</var></dd>\n <dt><a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-verifieddocument-0\" class=\"internalDFN\" id=\"ref-for-dfn-verifieddocument-0-1\">verifiedDocument</a></dt>\n <dd><var>cryptosuiteVerificationResult</var>.<var>verifiedDocument</var></dd>\n <dt><a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-media-type\" class=\"internalDFN\" id=\"ref-for-dfn-media-type-1\">media type</a></dt>\n <dd><var>mediaType</var></dd>\n </dl>"
"html": "Return a <a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-verification-result\" class=\"internalDFN\" id=\"ref-for-dfn-verification-result-2\">verification result</a> with <a data-link-type=\"dfn|abstract-op\" data-link-for=\"struct\" data-xref-for=\"struct\" data-cite=\"infra\" data-cite-path=\"/\" data-cite-frag=\"struct-item\" data-type=\"dfn\" href=\"https://infra.spec.whatwg.org/#struct-item\">items</a>:\n <dl data-link-for=\"verification result\">\n <dt><a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-verified-0\" class=\"internalDFN\" id=\"ref-for-dfn-verified-0-4\">verified</a></dt>\n <dd><var>cryptosuiteVerificationResult</var>.<var>verified</var></dd>\n <dt><a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-verifieddocument-0\" class=\"internalDFN\" id=\"ref-for-dfn-verifieddocument-0-1\">verifiedDocument</a></dt>\n <dd><var>cryptosuiteVerificationResult</var>.<var>verifiedDocument</var></dd>\n <dt><a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-mediatype\" class=\"internalDFN\" id=\"ref-for-dfn-mediatype-1\">mediaType</a></dt>\n <dd><var>mediaType</var></dd>\n </dl>"
}
]
},
{
"html": "Required input is a\n<a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-secured-data-document\" class=\"internalDFN\" id=\"ref-for-dfn-secured-data-document-11\">secured data document</a> (<var>securedDocument</var>). A list of\n<a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-verification-result\" class=\"internalDFN\" id=\"ref-for-dfn-verification-result-3\">verification results</a> corresponding to each proof in <var>allProofs</var> is\ngenerated, and a single combined <a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-verification-result\" class=\"internalDFN\" id=\"ref-for-dfn-verification-result-4\">verification result</a> is returned as output.\nImplementations <em class=\"rfc2119\">MAY</em> return any of the other <a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-verification-result\" class=\"internalDFN\" id=\"ref-for-dfn-verification-result-5\">verification result</a>s and/or any\nother metadata alongside the combined <a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-verification-result\" class=\"internalDFN\" id=\"ref-for-dfn-verification-result-6\">verification result</a>.",
"html": "Required input is a <a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-secured-data-document\" class=\"internalDFN\" id=\"ref-for-dfn-secured-data-document-11\">secured data document</a> (<var>securedDocument</var>). A list of\n<a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-verification-result\" class=\"internalDFN\" id=\"ref-for-dfn-verification-result-3\">verification results</a> corresponding to each proof in <var>allProofs</var> is\ngenerated, and a single combined <a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-verification-result\" class=\"internalDFN\" id=\"ref-for-dfn-verification-result-4\">verification result</a> is returned as output.\nImplementations <em class=\"rfc2119\">MAY</em> return any of the other <a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-verification-result\" class=\"internalDFN\" id=\"ref-for-dfn-verification-result-5\">verification result</a>s and/or any\nother metadata alongside the combined <a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-verification-result\" class=\"internalDFN\" id=\"ref-for-dfn-verification-result-6\">verification result</a>.",
"rationale": ".algorithm",
"steps": [
{
Expand All @@ -151,7 +151,7 @@
"html": "Let <var>matchingProofs</var> be an empty list."
},
{
"html": "If <var>proof</var> contains a <code>previousProof</code> attribute and that attribute is a string,\nadd the element from <var>allProofs</var> with an <code>id</code> attribute matching <code>previousProof</code>\nto <code>matchingProofs</code>. If a proof with <code>id</code> does not exist in <var>allProofs</var>, an\nerror <em class=\"rfc2119\">MUST</em> be raised and <em class=\"rfc2119\">SHOULD</em> convey an error type of\n<a href=\"https://w3c.github.io/vc-data-integrity/#PROOF_VERIFICATION_ERROR\">PROOF_VERIFICATION_ERROR</a>. If the\n<code>previousProof</code> attribute is an array, add each element from <var>allProofs</var> with an\n<code>id</code> attribute that matches an element of that array. If any element of\n<code>previousProof</code> <a data-link-type=\"dfn|abstract-op\" data-cite=\"infra\" data-cite-path=\"/\" data-cite-frag=\"list\" data-type=\"dfn\" href=\"https://infra.spec.whatwg.org/#list\">list</a> has an <code>id</code> attribute that does not match the <code>id</code>\nattribute of any element of <var>allProofs</var>, an error <em class=\"rfc2119\">MUST</em> be raised and <em class=\"rfc2119\">SHOULD</em>\nconvey an error type of\n<a href=\"https://w3c.github.io/vc-data-integrity/#PROOF_VERIFICATION_ERROR\">PROOF_VERIFICATION_ERROR</a>."
"html": "If <var>proof</var> contains a <code>previousProof</code> attribute and that attribute is a\n<a data-link-type=\"dfn|abstract-op\" data-cite=\"infra\" data-cite-path=\"/\" data-cite-frag=\"string\" data-type=\"dfn\" href=\"https://infra.spec.whatwg.org/#string\">string</a>, add the element from <var>allProofs</var> with an <code>id</code> attribute matching\n<code>previousProof</code> to <code>matchingProofs</code>. If a proof with <code>id</code> does not exist in\n<var>allProofs</var>, an error <em class=\"rfc2119\">MUST</em> be raised and <em class=\"rfc2119\">SHOULD</em> convey an error type of\n<a href=\"https://w3c.github.io/vc-data-integrity/#PROOF_VERIFICATION_ERROR\">PROOF_VERIFICATION_ERROR</a>. If the\n<code>previousProof</code> attribute is a <a data-link-type=\"dfn|abstract-op\" data-cite=\"infra\" data-cite-path=\"/\" data-cite-frag=\"list\" data-type=\"dfn\" href=\"https://infra.spec.whatwg.org/#list\">list</a>, add each element from <var>allProofs</var> with an\n<code>id</code> attribute that matches an element of that <a data-link-type=\"dfn|abstract-op\" data-cite=\"infra\" data-cite-path=\"/\" data-cite-frag=\"list\" data-type=\"dfn\" href=\"https://infra.spec.whatwg.org/#list\">list</a>. If any element of\n<code>previousProof</code> <a data-link-type=\"dfn|abstract-op\" data-cite=\"infra\" data-cite-path=\"/\" data-cite-frag=\"list\" data-type=\"dfn\" href=\"https://infra.spec.whatwg.org/#list\">list</a> has an <code>id</code> attribute that does not match the <code>id</code>\nattribute of any element of <var>allProofs</var>, an error <em class=\"rfc2119\">MUST</em> be raised and <em class=\"rfc2119\">SHOULD</em>\nconvey an error type of\n<a href=\"https://w3c.github.io/vc-data-integrity/#PROOF_VERIFICATION_ERROR\">PROOF_VERIFICATION_ERROR</a>."
},
{
"html": "Let <var>inputDocument</var> be a copy of <var>securedDocument</var> with the proof value\nremoved and then set <var>inputDocument</var>.<var>proof</var> to <var>matchingProofs</var>."
Expand Down
25 changes: 22 additions & 3 deletions ed/dfns/vc-data-integrity.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -974,10 +974,10 @@
"definedIn": "dt"
},
{
"id": "dfn-media-type",
"href": "https://w3c.github.io/vc-data-integrity/#dfn-media-type",
"id": "dfn-mediatype",
"href": "https://w3c.github.io/vc-data-integrity/#dfn-mediatype",
"linkingText": [
"media type"
"mediaType"
],
"localLinkingText": [],
"type": "dfn",
Expand Down Expand Up @@ -1036,6 +1036,25 @@
},
"definedIn": "dt"
},
{
"id": "dfn-problemdetails",
"href": "https://w3c.github.io/vc-data-integrity/#dfn-problemdetails",
"linkingText": [
"ProblemDetails"
],
"localLinkingText": [],
"type": "dfn",
"for": [],
"access": "private",
"informative": false,
"heading": {
"id": "processing-errors",
"href": "https://w3c.github.io/vc-data-integrity/#processing-errors",
"title": "Processing Errors",
"number": "4.7"
},
"definedIn": "prose"
},
{
"id": "dfn-cryptographic-agility",
"href": "https://w3c.github.io/vc-data-integrity/#dfn-cryptographic-agility",
Expand Down
Loading

0 comments on commit 656b83c

Please sign in to comment.