Rework W3C DC API examples #254

marcoscaceres · 2024-09-10T00:04:28Z

As the W3C spec is changing a lot, it's best to not include any examples yet. That way, this spec can progress without locking in changes on the W3C side.

jogu · 2024-09-10T10:43:20Z

Are we expecting breaking changes to the Browser API, I thought it was fairly settled for now?

I'm not sure that removing the examples helps. The examples are non-normative and don't really show anything that's not already described in the normative text.

(We can actually update the examples relatively easily, both during any public review period for the 1.0 spec revision, and even after 1.0 is published by making an errata update, but if the normative text is likely to require changes as well that's a much bigger problem.)

jogu · 2024-09-10T11:06:12Z

Ah, I guess WICG/digital-credentials#165 may be the driver?

Although the 'providers' -> 'requests' change itself looks like it shouldn't break normative text in VP, It is slightly concerning that there are suggestions on that PR that would affect the normative text, like changing 'request' to 'query'.

samuelgoto · 2024-09-10T16:32:51Z

I'm concerned about this here: WICG/digital-credentials#164

RByers · 2024-09-10T19:10:06Z

Maybe leaving a link for where to see current examples would be better than just removing them? Eg. maybe they belong in this GitHub repo but in their own non-normative file for easier updating?

marcoscaceres · 2024-09-12T09:16:27Z

I don't think we should lock in this spec with the other at all. We might want to move things around and we haven't yet added the examples to the Digital Credentials Spec. Rest assured that we will add examples, but it might not happen in the accelerated timeframe OpenID4VP is currently on. We can add examples to a future version of OpenID4VP once the W3C Spec is a) in a working group, and b) we are confident on the design (e.g. the spec reaches CR on the W3C side). We don't have enough implementation experience yet to be confident we won't change more things - specially as the W3C spec hasn't been road tested with more request formats, which may change the underlying request model/structure.

openid-4-verifiable-presentations-1_0.md

Sakurann · 2024-09-18T00:12:22Z

openid-4-verifiable-presentations-1_0.md

-  // Handle errors and/or fallback to other invocation mechanisms
-}
-```
+The W3C Digital Credentials API [@!w3c.digital_credentials_api] contains an OpenID4VP Authorization Request, where every OpenID4VP Authorization Request parameter is represented as a top-level JavaScript object member.


where every OpenID4VP Authorization Request parameter is represented as a top-level JavaScript object member

Is this a new development in Digital Credentials API? How would this work for signed requests?

The change here is removing "request member", I think that's okay, it's removing the coupling between the two specs but it doesn't change how signed requests are handled.

is there any risk of this changing in the future? wouldn't this prevent passing multiple requests in an array? Would really prefer a text like The Verifier MAY send all the OpenID4VP request parameters to the W3C Digital Credentials API as defined in [@!w3c.digital_credentials_api]

It's best to say less. We don't know what the final API will look like.

Sakurann · 2024-09-18T00:13:47Z

openid-4-verifiable-presentations-1_0.md

@@ -1591,7 +1568,7 @@ Any OpenID4VP request compliant to this section of this specification can be use

 ### Unsigned Request {#unsigned_request}

-The Verifier MAY send all the OpenID4VP request parameters as members in the `request` member passed to the API. In this case, the Wallet will use the Verifier's origin as asserted by the user agent as the Verifer's Client Identifier.
+The Verifier MAY send all the OpenID4VP request parameters as members to the W3C Digital Credentials API [@!w3c.digital_credentials_api]. In this case, the Wallet will use the Verifier's origin as asserted by the user agent as the Verifer's Client Identifier.


Again, how does this work for signed request where all the parameters are within a signed JWT which contains all of the parameters?

This is in the "Unsigned request" section, this text won't affect signed requests.

i would prefer something like this:

Suggested change

The Verifier MAY send all the OpenID4VP request parameters as members to the W3C Digital Credentials API [@!w3c.digital_credentials_api]. In this case, the Wallet will use the Verifier's origin as asserted by the user agent as the Verifer's Client Identifier.

The Verifier MAY send all the OpenID4VP request parameters to the W3C Digital Credentials API as defined in [@!w3c.digital_credentials_api]. In this case, the Wallet will use the Verifier's origin as asserted by the user agent as the Verifer's Client Identifier.

Sakurann · 2024-09-18T00:23:46Z

Text in this PR does not sufficiently decouple openid4vp text and still makes it susceptible to any future breaking changes in the credentials API.

"Put openid4vp request parameters in an appropriate place as defined in digital credentials API; the openid4vp parameter is X for signed requests and Y for unsigned requests" is what I would expect.

Also very unsure about removing all of the examples. Will digital credentials API provide examples how to include openid4vp request there once it is stable? If not, we should keep some examples as of today in the spec.

If the text is generic enough, changing the examples later as digital credentials API evolves is possible.

openid-4-verifiable-presentations-1_0.md

As the W3C spec is changing a lot, it's best yet to not include any examples.

Co-authored-by: Kristina <52878547+Sakurann@users.noreply.github.com>

jogu

Thanks Marcos! Some small comments, could you update the PR title/first comment to reflect what is changing now too please?

openid-4-verifiable-presentations-1_0.md

Co-authored-by: Joseph Heenan <joseph@authlete.com>

samuelgoto

LGTM++

This would make it easier to decouple the OpenID4VP spec and the Digital Credentials API spec.

openid-4-verifiable-presentations-1_0.md

marcoscaceres · 2024-10-14T22:28:04Z

Hopefully better now... did this in a hurry at the ARF event last week.

diagrams/request_uri_mode_post_through_browser_api.md

diagrams/request_uri_mode_post_through_browser_api.plantuml

Co-authored-by: Giuseppe De Marco <giuseppe.demarco@teamdigitale.governo.it>

diagrams/request_uri_mode_post_through_browser_api.md

openid-4-verifiable-presentations-1_0.md

Sakurann · 2024-10-22T13:33:37Z

diagrams/request_uri_mode_post_through_browser_api.md

@@ -14,11 +14,7 @@ participant "App Platform" as ap
 participant "Wallet" as w

 u --> r : use
-activate r
-
-r -> wp: navigator.identity.get(\nprotocol="openid4vp",\nrequest="client_id, \nrequest_uri, request_uri_method=post, \npresentation_definition")


so isn't this better be something like

r -> wp: send OpenID4VP request over the W3C Digital Credentials API

Sakurann · 2024-10-22T13:33:55Z

diagrams/request_uri_mode_post_through_browser_api.plantuml

@@ -14,11 +14,7 @@ participant "App Platform" as ap
 participant "Wallet" as w

 u --> r : use
-activate r
-
-r -> wp: navigator.identity.get(\nprotocol="openid4vp",\nrequest="client_id, \nrequest_uri, request_uri_method=post, \npresentation_definition")


same as above. shouldn't this better be something like

r -> wp: send OpenID4VP request over the W3C Digital Credentials API

Sakurann · 2024-10-22T13:34:18Z

diagrams/signed_request_uri_through_browser_api.plantuml

@@ -19,7 +19,6 @@ activate r
 note over r,wp
    Note that the signed request object contains the Verifier's origin.
 end note
-r -> wp: navigator.identity.get(\nprotocol="openid4vp",\nrequest="client_id, request")


same as above. shouldn't this better be something like

r -> wp: send OpenID4VP request over the W3C Digital Credentials API

openid-4-verifiable-presentations-1_0.md

As agreed on WG call Co-authored-by: Kristina <52878547+Sakurann@users.noreply.github.com>

bc-pi · 2024-10-22T19:21:51Z

openid-4-verifiable-presentations-1_0.md

+  response_mode: "w3c_dc_api",
+  nonce: "n-0S6_WzA2Mj",
+  client_metadata: {...},
+  presentation_definition: {...}


or 🐶 #266 (comment) and now https://github.com/openid/OpenID4VP/pull/266/files#diff-3118c9756a1d7b361bb53af8bd9d65666476a27cfeeced56c47a5dccc38eac55R269 cc @danielfett

Suggested change

presentation_definition: {...}

dcql_query: {...}

Sakurann

approved per WG discussion yesterday

marcoscaceres requested a review from tlodderstedt September 10, 2024 00:05

Sakurann requested changes Sep 18, 2024

View reviewed changes

jogu added this to the Final 1.0 milestone Sep 24, 2024

jogu requested changes Sep 25, 2024

View reviewed changes

openid-4-verifiable-presentations-1_0.md Outdated Show resolved Hide resolved

marcoscaceres and others added 5 commits October 4, 2024 15:03

Remove W3C DC API examples

ab70539

As the W3C spec is changing a lot, it's best yet to not include any examples.

More corrections

d9b6ad6

Remove API usage from diagrams

c6b83bf

Remove another ref

1fb91d2

Bring back object

3b0d32c

marcoscaceres force-pushed the marcoscaceres-patch-1 branch from a3ed327 to 3b0d32c Compare October 4, 2024 05:13

Update openid-4-verifiable-presentations-1_0.md

b553f17

Co-authored-by: Kristina <52878547+Sakurann@users.noreply.github.com>

jogu reviewed Oct 4, 2024

View reviewed changes

openid-4-verifiable-presentations-1_0.md Outdated Show resolved Hide resolved

openid-4-verifiable-presentations-1_0.md Outdated Show resolved Hide resolved

openid-4-verifiable-presentations-1_0.md Outdated Show resolved Hide resolved

marcoscaceres and others added 3 commits October 15, 2024 09:09

Update openid-4-verifiable-presentations-1_0.md

48d663e

Co-authored-by: Joseph Heenan <joseph@authlete.com>

Update openid-4-verifiable-presentations-1_0.md

d5e002c

Co-authored-by: Joseph Heenan <joseph@authlete.com>

Update openid-4-verifiable-presentations-1_0.md

40c7121

samuelgoto approved these changes Oct 14, 2024

View reviewed changes

openid-4-verifiable-presentations-1_0.md Outdated Show resolved Hide resolved

marcoscaceres commented Oct 14, 2024

View reviewed changes

openid-4-verifiable-presentations-1_0.md Outdated Show resolved Hide resolved

Update openid-4-verifiable-presentations-1_0.md

a43ba26

marcoscaceres requested review from Sakurann and jogu October 14, 2024 22:27

jogu approved these changes Oct 15, 2024

View reviewed changes

OR13 approved these changes Oct 17, 2024

View reviewed changes

peppelinux reviewed Oct 21, 2024

View reviewed changes

diagrams/request_uri_mode_post_through_browser_api.md Outdated Show resolved Hide resolved

peppelinux reviewed Oct 21, 2024

View reviewed changes

diagrams/request_uri_mode_post_through_browser_api.md Outdated Show resolved Hide resolved

peppelinux reviewed Oct 21, 2024

View reviewed changes

diagrams/request_uri_mode_post_through_browser_api.plantuml Outdated Show resolved Hide resolved

peppelinux reviewed Oct 21, 2024

View reviewed changes

diagrams/request_uri_mode_post_through_browser_api.plantuml Outdated Show resolved Hide resolved

marcoscaceres and others added 4 commits October 22, 2024 13:56

Update diagrams/request_uri_mode_post_through_browser_api.md

d02dacc

Co-authored-by: Giuseppe De Marco <giuseppe.demarco@teamdigitale.governo.it>

Update diagrams/request_uri_mode_post_through_browser_api.md

2923c01

Co-authored-by: Giuseppe De Marco <giuseppe.demarco@teamdigitale.governo.it>

Update diagrams/request_uri_mode_post_through_browser_api.plantuml

3b71570

Co-authored-by: Giuseppe De Marco <giuseppe.demarco@teamdigitale.governo.it>

Update diagrams/request_uri_mode_post_through_browser_api.plantuml

bbe4564

Co-authored-by: Giuseppe De Marco <giuseppe.demarco@teamdigitale.governo.it>

Sakurann changed the title ~~Remove W3C DC API examples~~ Rework W3C DC API examples Oct 22, 2024

Sakurann reviewed Oct 22, 2024

View reviewed changes

diagrams/request_uri_mode_post_through_browser_api.md Show resolved Hide resolved

Sakurann reviewed Oct 22, 2024

View reviewed changes

openid-4-verifiable-presentations-1_0.md Outdated Show resolved Hide resolved

Sakurann reviewed Oct 22, 2024

View reviewed changes

openid-4-verifiable-presentations-1_0.md Outdated Show resolved Hide resolved

Apply Kristina's suggestions from code review

9e7f4ab

As agreed on WG call Co-authored-by: Kristina <52878547+Sakurann@users.noreply.github.com>

bc-pi reviewed Oct 22, 2024

View reviewed changes

Sakurann approved these changes Oct 23, 2024

View reviewed changes

Sakurann merged commit d979ac6 into main Oct 23, 2024
2 checks passed

Sakurann mentioned this pull request Dec 5, 2024

Update Appendix 1 to be consistent with the latest snapshot of the Digital Credentials API #264

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rework W3C DC API examples #254

Rework W3C DC API examples #254

marcoscaceres commented Sep 10, 2024 •

edited

Loading

jogu commented Sep 10, 2024 •

edited

Loading

jogu commented Sep 10, 2024

samuelgoto commented Sep 10, 2024

RByers commented Sep 10, 2024

marcoscaceres commented Sep 12, 2024

Sakurann Sep 18, 2024

jogu Sep 23, 2024

Sakurann Sep 26, 2024

marcoscaceres Oct 4, 2024

Sakurann Sep 18, 2024

jogu Sep 23, 2024

Sakurann Sep 26, 2024 •

edited

Loading

Sakurann commented Sep 18, 2024

jogu left a comment

samuelgoto left a comment

marcoscaceres commented Oct 14, 2024

Sakurann Oct 22, 2024

Sakurann Oct 22, 2024

Sakurann Oct 22, 2024

bc-pi Oct 22, 2024 •

edited

Loading

Sakurann left a comment

	The Verifier MAY send all the OpenID4VP request parameters as members to the W3C Digital Credentials API [@!w3c.digital_credentials_api]. In this case, the Wallet will use the Verifier's origin as asserted by the user agent as the Verifer's Client Identifier.
	The Verifier MAY send all the OpenID4VP request parameters to the W3C Digital Credentials API as defined in [@!w3c.digital_credentials_api]. In this case, the Wallet will use the Verifier's origin as asserted by the user agent as the Verifer's Client Identifier.

Rework W3C DC API examples #254

Rework W3C DC API examples #254

Conversation

marcoscaceres commented Sep 10, 2024 • edited Loading

jogu commented Sep 10, 2024 • edited Loading

jogu commented Sep 10, 2024

samuelgoto commented Sep 10, 2024

RByers commented Sep 10, 2024

marcoscaceres commented Sep 12, 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

Sakurann Sep 26, 2024 • edited Loading

Choose a reason for hiding this comment

Sakurann commented Sep 18, 2024

jogu left a comment

Choose a reason for hiding this comment

samuelgoto left a comment

Choose a reason for hiding this comment

marcoscaceres commented Oct 14, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bc-pi Oct 22, 2024 • edited Loading

Choose a reason for hiding this comment

Sakurann left a comment

Choose a reason for hiding this comment

marcoscaceres commented Sep 10, 2024 •

edited

Loading

jogu commented Sep 10, 2024 •

edited

Loading

Sakurann Sep 26, 2024 •

edited

Loading

bc-pi Oct 22, 2024 •

edited

Loading