Add sections on Processing Model and Context Validation #291

msporny · 2024-07-21T21:03:03Z

This PR attempts to address issue #288 by adding sections on Processing Model and Context Validation.

index.html

dlongley · 2024-07-21T21:12:48Z

index.html

+optionally, for the context values that do not exist in |approvedContexts|,
+remove the |contextValue| from the `@context` property values. Set
+|result|.|document| to the result of running the
+<a data-cite="JSON-LD11-API#compaction-algorithm">
+JSON-LD Compaction Algorithm</a> with the modified |inputDocument| as input.


This will need the same adjustments as VC data model PR 1535.

Done in 0f234e8 ... which drastically changed the algorithm given @TallTed's changes. The previous algorithm didn't work for multiply nested documents w/ multiple contexts. The update attempts to address that use case. Please check my work @dlongley @davidlehn... I think I got all the corner cases, but need more eyes on it.

index.html

TallTed · 2024-07-22T15:22:21Z

index.html

+a status ([=boolean=] |status|)
+          </li>
+          <li>
+a validated document ([=map=] |document|)


Do any errors prevent return of a validated document? That is, is a validated document always returned in the map, regardless of errors?

No, errors will result in an undefined value for document, which is noted in the algorithm below.

TallTed · 2024-07-22T15:42:53Z

index.html

+        </ol>
+
+        <p>
+The purpose of the algorithm above is to ensure that a consuming application has


This explanation (all paragraphs of it) would be better presented before the algorithm it discusses, than following it. Making this relocation will mandate some rephrasing. It might be worthwhile to put this description into <h4>Context Validation Description</h4> (or similar title) followed by <h4>Context Validation Algorithm</h4>, both being within <h3>Context Validation</h4>.

Fixed in 3107ccb (without creating more sections, just moved some text around).

@msporny — 3107ccb is a good start. I think lines 2312 through 2353 (using the line numbers visible at that commit) should also be moved to ~2245 (preceding the list of algorithm inputs) or possibly ~2264 (following the list of algorithm outputs). After that move, some further rephrasing may be appropriate. (Also note that there are change suggestions in flight on these sections, which I think should be made before the relocation, so the line numbers referenced here may also change before the relocation happens.)

index.html

iherman · 2024-07-23T11:20:49Z

index.html

+This section contains an algorithm that applications MUST run after running the
+algorithm in Section [[[#verify-proof]]] or Section
+[[[#verify-proof-sets-and-chains]]], when validating a [=conforming secured
+document=]. This algorithm takes a document ([=map=] |inputDocument|) and a set


What is the reason for this order? Instinctively, my choice would be to first check whether the document is all right in terms of JSON-LD, ie, run the context validation, before running it through the validating steps (that may also involve running RDFC on the RDF graphs generated by the JSON-LD processing).

(Note if the order is reversed, it also has to be updated in the new processing model section.)

Fixed in 3107ccb.

TallTed · 2024-07-23T17:21:19Z

There's a lot of repeated text, here and in w3c/vc-data-model#1535, which needs similar if not identical changes (which suggestions from myself and others do not currently reflect), possibly being adjusted to be said in one place, and referenced in the other.

msporny · 2024-07-24T21:14:09Z

@TallTed wrote:

There's a lot of repeated text, here and in w3c/vc-data-model#1535, which needs similar if not identical changes (which suggestions from myself and others do not currently reflect), possibly being adjusted to be said in one place, and referenced in the other.

See the reasoning here: w3c/vc-data-model#1535 (comment)

Co-authored-by: Dave Longley <dlongley@digitalbazaar.com> Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>

Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>

dlongley · 2024-07-25T15:04:59Z

index.html

+and expresses them using the `@context` property.
+          </li>
+          <li>
+Selects a cryptography suite that meets the needs of the use case, such as


Suggested change

Selects a cryptography suite that meets the needs of the use case, such as

Selects one or more cryptography suites that meet the needs of the use case, such as

dlongley · 2024-07-25T15:13:28Z

index.html

+          <li>
+zero or more warnings ([=list=] of [=ProblemDetails=] |warnings|)
+          </li>


This isn't used in the algorithm.

Suggested change

<li>

zero or more warnings ([=list=] of [=ProblemDetails=] |warnings|)

</li>

Yes, but it's left in there so that implementations can add warnings if they would like (and there is a standards interface for them doing so. I'll add some text to note that implementations MAY add additional warnings/errors.

Fixed in 04584e7.

index.html

TallTed · 2024-07-25T20:57:01Z

index.html

+        <p>
+Yet another valid approach would be for a transmitting application to
+<a data-cite="JSON-LD11-API#compaction-algorithm">compact</a> a document to
+exactly what a receiving application requests, omitting additional


How does a receiving application request (a) specific context(s)?

Fixed by explaining that it can happen via the query protocol.

index.html

Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>

msporny · 2024-07-27T18:14:39Z

Normative, multiple reviews, changes requested and made, no objections, merging.

dlongley · 2024-07-28T18:58:31Z

index.html

+which might be undefined.
+          </li>
+          <li>
+If |contextValue| does not deeply equal |expectedContext|, then if any subtree in


Slight mixup here in the grammar fixes, this step should read "or if" not "then if".

msporny added 2 commits July 21, 2024 16:42

Add section on processing model.

efb8bc8

Add section on context validation.

cd16659

msporny added CR1 This item was processed during the first Candidate Recommendation phase. normative This issue or PR will trigger the need for another Candidate Recommendation Snapshot labels Jul 21, 2024

msporny requested review from BigBlueHat, davidlehn, dlongley, longpd, iherman, dmitrizagidulin, TallTed, decentralgabe and brentzundel July 21, 2024 21:03

msporny requested a review from Wind4Greg as a code owner July 21, 2024 21:03

msporny mentioned this pull request Jul 21, 2024

Clarify the processing model #288

Closed

dlongley reviewed Jul 21, 2024

View reviewed changes

msporny mentioned this pull request Jul 21, 2024

Multiple significant security vulnerabilities in the design of data integrity #272

Closed

Wind4Greg approved these changes Jul 22, 2024

View reviewed changes

decentralgabe approved these changes Jul 22, 2024

View reviewed changes

TallTed suggested changes Jul 22, 2024

View reviewed changes

longpd approved these changes Jul 22, 2024

View reviewed changes

iherman reviewed Jul 23, 2024

View reviewed changes

iherman mentioned this pull request Jul 23, 2024

Add section on Context Validation. w3c/vc-data-model#1535

Merged

msporny and others added 4 commits July 24, 2024 17:18

Fix grammar and flow in context validation.

f30bd01

Co-authored-by: Dave Longley <dlongley@digitalbazaar.com> Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>

Modify algorithm layout in context validation.

7a55f79

Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>

Move explanation of purpose to top of context validation algorithm.

3107ccb

Fix context validation algorithm to work for subtrees.

0f234e8

iherman self-requested a review July 25, 2024 06:42

iherman approved these changes Jul 25, 2024

View reviewed changes

dlongley suggested changes Jul 25, 2024

View reviewed changes

TallTed suggested changes Jul 25, 2024

View reviewed changes

msporny and others added 7 commits July 27, 2024 13:12

Simplify context validation algorithm.

5108969

Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>

Fix grammar and flow in Processing Model section.

9426f7f

Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>

Fix grammar in context validation section.

6ddbd7b

Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>

Fix grammar/flow in explanation of context validation.

334d1de

Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>

Add section to elaborate on Validating Contexts.

cb43db3

Note that implementations may provide additional warnings/errors.

04584e7

Clarify that equivalent algorithms for validation are allowed.

ce3848c

msporny merged commit 0eb5396 into main Jul 27, 2024
1 check passed

msporny deleted the msporny-processing-model branch July 27, 2024 18:14

dlongley reviewed Jul 28, 2024

View reviewed changes

dlongley mentioned this pull request Jul 28, 2024

Typo in context validation algorithm step from grammar adjustment needs fixing #299

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add sections on Processing Model and Context Validation #291

Add sections on Processing Model and Context Validation #291

msporny commented Jul 21, 2024 •

edited by pr-preview bot

Loading

dlongley Jul 21, 2024

msporny Jul 24, 2024 •

edited

Loading

TallTed Jul 22, 2024

msporny Jul 24, 2024 •

edited

Loading

TallTed Jul 22, 2024

msporny Jul 24, 2024

TallTed Jul 25, 2024

iherman Jul 23, 2024

msporny Jul 24, 2024

TallTed commented Jul 23, 2024

msporny commented Jul 24, 2024

dlongley Jul 25, 2024

dlongley Jul 25, 2024

msporny Jul 27, 2024

msporny Jul 27, 2024

TallTed Jul 25, 2024

msporny Jul 27, 2024

msporny commented Jul 27, 2024

dlongley Jul 28, 2024

	Selects a cryptography suite that meets the needs of the use case, such as
	Selects one or more cryptography suites that meet the needs of the use case, such as

	<li>
	zero or more warnings ([=list=] of [=ProblemDetails=] \|warnings\|)
	</li>

Add sections on Processing Model and Context Validation #291

Add sections on Processing Model and Context Validation #291

Conversation

msporny commented Jul 21, 2024 • edited by pr-preview bot Loading

Choose a reason for hiding this comment

msporny Jul 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

msporny Jul 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TallTed commented Jul 23, 2024

msporny commented Jul 24, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

msporny commented Jul 27, 2024

Choose a reason for hiding this comment

msporny commented Jul 21, 2024 •

edited by pr-preview bot

Loading

msporny Jul 24, 2024 •

edited

Loading

msporny Jul 24, 2024 •

edited

Loading