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.1.1.
  • Loading branch information
reffy-bot committed Jul 28, 2024
1 parent 54dec8c commit b936cc6
Show file tree
Hide file tree
Showing 12 changed files with 696 additions and 821 deletions.
18 changes: 9 additions & 9 deletions ed/algorithms/vc-data-integrity.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@
]
},
{
"html": "The following algorithm specifies how a digital proof can be added to an\n<a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-unsecured-data-document\" class=\"internalDFN\" id=\"ref-for-dfn-unsecured-data-document-2\">unsecured data document</a>, and can then be used to verify the output\ndocument's authenticity and integrity. Required inputs are an <a href=\"https://w3c.github.io/vc-data-integrity/#dfn-unsecured-data-document\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-unsecured-data-document-3\">unsecured data\ndocument</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> <var>unsecuredDocument</var>), 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-3\">cryptosuite instance</a>\n(<a data-link-type=\"dfn|abstract-op\" data-cite=\"infra\" data-cite-path=\"/\" data-cite-frag=\"struct\" data-type=\"dfn\" href=\"https://infra.spec.whatwg.org/#struct\">struct</a> <var>cryptosuite</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\na <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-3\">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>) or an error. Whenever this algorithm\nencodes strings, it <em class=\"rfc2119\">MUST</em> use UTF-8 encoding.",
"html": "The following algorithm specifies how a digital proof can be added to an <a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-input-document\" class=\"internalDFN\" id=\"ref-for-dfn-input-document-2\">input document</a>, and can then be used to verify the output document's authenticity\nand integrity. Required inputs are an <a data-link-type=\"dfn|abstract-op\" href=\"https://w3c.github.io/vc-data-integrity/#dfn-input-document\" class=\"internalDFN\" id=\"ref-for-dfn-input-document-3\">input 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>inputDocument</var>), 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-3\">cryptosuite instance</a> (<a data-link-type=\"dfn|abstract-op\" data-cite=\"infra\" data-cite-path=\"/\" data-cite-frag=\"struct\" data-type=\"dfn\" href=\"https://infra.spec.whatwg.org/#struct\">struct</a> <var>cryptosuite</var>), and a\nset 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 <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-3\">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>) or an error. Whenever this algorithm encodes strings, it <em class=\"rfc2119\">MUST</em> use\nUTF-8 encoding.",
"rationale": ".algorithm",
"steps": [
{
"html": "Let <var>proof</var> be the result of calling the <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-createproof\" class=\"internalDFN\" id=\"ref-for-dfn-createproof-1\">createProof</a>\nalgorithm specified in <var>cryptosuite</var>.<var>createProof</var> with <var>unsecuredDocument</var>\nand <var>options</var> passed as a parameters. If the algorithm produces an error,\nthe error <em class=\"rfc2119\">MUST</em> be propagated and <em class=\"rfc2119\">SHOULD</em> convey the error type."
"html": "Let <var>proof</var> be the result of calling the <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-createproof\" class=\"internalDFN\" id=\"ref-for-dfn-createproof-1\">createProof</a>\nalgorithm specified in <var>cryptosuite</var>.<var>createProof</var> with <var>inputDocument</var>\nand <var>options</var> passed as a parameters. If the algorithm produces an error,\nthe error <em class=\"rfc2119\">MUST</em> be propagated and <em class=\"rfc2119\">SHOULD</em> convey the error type."
},
{
"html": "If one or more of the <var>proof</var>.<var>type</var>, <var>proof</var>.<var>verificationMethod</var>, and\n<var>proof</var>.<var>proofPurpose</var> values is not set, 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_GENERATION_ERROR\">PROOF_GENERATION_ERROR</a>."
Expand All @@ -57,7 +57,7 @@
"html": "If <var>options</var> has a non-null <var>challenge</var> <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\">item</a>, it <em class=\"rfc2119\">MUST</em> be equal to\n<var>proof</var>.<var>challenge</var> or 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_GENERATION_ERROR\">PROOF_GENERATION_ERROR</a>."
},
{
"html": "Let <var>securedDataDocument</var> be a copy of <var>unsecuredDocument</var>."
"html": "Let <var>securedDataDocument</var> be a copy of <var>inputDocument</var>."
},
{
"html": "Set <var>securedDataDocument</var>.<var>proof</var> to the value of <var>proof</var>."
Expand All @@ -68,14 +68,14 @@
]
},
{
"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-7\">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>\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-6\">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.",
"rationale": ".algorithm",
"steps": [
{
"html": "Let <var>proof</var> be set to <var>securedDocument</var>.<var>proof</var>. Let\n<var>allProofs</var> be an empty list. If <var>proof</var> is a list, copy all\nthe elements of <var>proof</var> to <var>allProofs</var>. If <var>proof</var>\nis an object add a copy of that object to <var>allProofs</var>."
},
{
"html": "Let the <var>unsecuredDocument</var> be a copy of the <var>securedDocument</var>\nwith the <var>proof</var> attribute removed. Let <var>output</var> be a copy of\nthe <var>unsecuredDocument</var>."
"html": "Let the <var>inputDocument</var> be a copy of the <var>securedDocument</var>\nwith the <var>proof</var> attribute removed. Let <var>output</var> be a copy of\nthe <var>inputDocument</var>."
},
{
"html": "Let <var>matchingProofs</var> be an empty list."
Expand All @@ -87,10 +87,10 @@
"html": "If <var>options</var> has a <code>previousProof</code> <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\">item</a> that is an array, add each\nelement from <var>allProofs</var> with an <code>id</code> attribute that matches an element of that\narray. If any element of <code>previousProof</code> array has an <code>id</code> attribute that does\nnot match the <code>id</code> attribute of any element of <var>allProofs</var>, an error <em class=\"rfc2119\">MUST</em> be\nraised and <em class=\"rfc2119\">SHOULD</em> convey an error type of\n<a href=\"https://w3c.github.io/vc-data-integrity/#PROOF_GENERATION_ERROR\">PROOF_GENERATION_ERROR</a>."
},
{
"html": "Set <var>unsecuredDocument</var>.<var>proof</var> to <var>matchingProofs</var>."
"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>unsecuredDocument</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 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": "Set <var>output</var>.<var>proof</var> to the value of <var>allProofs</var>."
Expand Down Expand Up @@ -154,10 +154,10 @@
"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> array 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>unsecuredDocument</var> be a copy of <var>securedDocument</var> with the proof value\nremoved and then set <var>unsecuredDocument</var>.<var>proof</var> to <var>matchingProofs</var>."
"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>."
},
{
"html": "Run steps 4 through 8 of the algorithm in section <a href=\"https://w3c.github.io/vc-data-integrity/#verify-proof\" data-matched-text=\"[[[#verify-proof]]]\" class=\"sec-ref\"><bdi class=\"secno\">4.4 </bdi>Verify Proof</a> on\n<var>unsecuredDocument</var>; if no exceptions are raised, append <var>cryptosuiteVerificationResult</var>\nto <var>verificationResults</var>."
"html": "Run steps 4 through 8 of the algorithm in section <a href=\"https://w3c.github.io/vc-data-integrity/#verify-proof\" data-matched-text=\"[[[#verify-proof]]]\" class=\"sec-ref\"><bdi class=\"secno\">4.4 </bdi>Verify Proof</a> on\n<var>inputDocument</var>; if no exceptions are raised, append <var>cryptosuiteVerificationResult</var>\nto <var>verificationResults</var>."
}
]
},
Expand Down
Loading

0 comments on commit b936cc6

Please sign in to comment.