Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add transaction_data #197

Merged
merged 32 commits into from
Oct 21, 2024
Merged
Changes from 6 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
b2f69ec
add transaction_data
Jun 18, 2024
7d47e4b
add error codes
Jun 18, 2024
1f15ab3
update correct reference.
Sakurann Aug 8, 2024
76380c6
rename response parameter to tx_data_hashes
Sakurann Aug 13, 2024
351bf76
Apply editorial suggestions from code review
Sakurann Aug 22, 2024
923aabd
renaming to requested_credential_ids
Sakurann Aug 22, 2024
cc55aa3
reflect WG feedback
Sakurann Sep 11, 2024
681677f
change tx_data_hashes to transaction_data_hashes
Sakurann Sep 11, 2024
bd9b35b
fix transaction_data_hashes parameters in the kb jwt
Sakurann Sep 11, 2024
6d871c8
add transaction_data_hashes_alg
Sep 11, 2024
8e5792f
add a change log
Sep 11, 2024
dab521c
add credential being issued to be used for transaction data text
Sep 11, 2024
2e29da5
Merge branch 'main' into transaction_data
Sakurann Sep 11, 2024
0acd29a
add examples
Sep 11, 2024
159617f
Merge branch 'main' into transaction_data
Sakurann Oct 3, 2024
27d541b
Merge branch 'main' into transaction_data
Sakurann Oct 10, 2024
3672f78
clarify transaction data is not ignored when not recognized
Oct 10, 2024
9f39e70
add e.g. and Apply suggestions from code review
Sakurann Oct 10, 2024
fd86bb6
Apply suggestions from Joseph's code review
Sakurann Oct 15, 2024
4c5542d
change IANA reference
Sakurann Oct 15, 2024
98e9108
Clarify that the wallet must use only one of the credentials if there…
Sakurann Oct 15, 2024
425fa60
Apply suggestions from Christian's code review
Sakurann Oct 17, 2024
2d39362
clarify the processing rules
Sakurann Oct 18, 2024
6b3418e
IANA.Hash.Algorithms
Sakurann Oct 18, 2024
28733aa
Merge branch 'main' into transaction_data
jogu Oct 18, 2024
1d902fc
Fix compile error with vp_query ref (with Kristina's permission)
jogu Oct 18, 2024
466ba1d
Fix compile error with IANA.Hash.Algorithms reference
jogu Oct 18, 2024
352a6e8
Apply suggestions from Paul's code review
Sakurann Oct 21, 2024
be9f30b
minor nit
Sakurann Oct 21, 2024
5419a0e
add transaction data content example
Oct 21, 2024
2517679
Apply suggestions from final code review
Sakurann Oct 21, 2024
c2e593c
Remove #vp_query reference so spec compiles
jogu Oct 21, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 27 additions & 3 deletions openid-4-verifiable-presentations-1_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,13 @@ A public key to be used by the Wallet as an input to the key agreement to encryp
: OPTIONAL. A string determining the HTTP method to be used when the `request_uri` parameter is included in the same request. Two case-sensitive valid values are defined in this specification: `get` and `post`. If `request_uri_method` value is `get`, the Wallet MUST send the request to retrieve the Request Object using the HTTP GET method, i.e., as defined in [@RFC9101]. If `request_uri_method` value is `post`, a supporting Wallet MUST send the request using the HTTP POST method as detailed in (#request_uri_method_post). If the `request_uri_method` parameter is not present, the Wallet MUST process the `request_uri` parameter as defined in [@RFC9101]. Wallets not supporting the `post` method will send a GET request to the request URI (default behavior as defined in [@RFC9101]). `request_uri_method` parameter MUST NOT be present if a `request_uri` parameter is not present.

If the Verifier set the `request_uri_method` parameter value to `post` and there is no other means to convey its capabilities to the Wallet, it SHOULD add the `client_metadata` parameter to the Authorization Request.
This enables the Wallet to assess the Verifier's capabilities, allowing it to transmit only the relevant capabilities through the `wallet_metadata` parameter in the Request URI POST request. If the Verifier uses the `client_id_scheme` parameter in the Request Object, it MUST also add the same `client_id_scheme` value in the Authorization Request.
This enables the Wallet to assess the Verifier's capabilities, allowing it to transmit only the relevant capabilities through the `wallet_metadata` parameter in the Request URI POST request. If the Verifier uses the `client_id_scheme` parameter in the Request Object, it MUST also add the same `client_id_scheme` value in the Authorization Request.
Sakurann marked this conversation as resolved.
Show resolved Hide resolved

`transaction_data`:
Sakurann marked this conversation as resolved.
Show resolved Hide resolved
: OPTIONAL. Array of strings, where each string is a Base64url encoded object that contains a typed parameter set with details about the transaction that the Verifier is requesting the End-User to authorize. See (#transaction_data) for details. The Wallet MUST refuse to process any unknown transaction data type or transaction data not conforming to the respective type definition. Each object consists of the following parameters:
Sakurann marked this conversation as resolved.
Show resolved Hide resolved
Sakurann marked this conversation as resolved.
Show resolved Hide resolved

* `type`: REQUIRED. String that is the Identifier of the transaction data type and determines the allowable contents of the object that contains it. The specific values are out of scope of this specification. It is RECOMMENDED to use collision-resistant names for `type` values.
Sakurann marked this conversation as resolved.
Show resolved Hide resolved
* `requested_credential_ids`: REQUIRED. Array of strings each pointing to an Input Descriptor that identifies a request for a Credential that the Verifier is requesting transaction data in a particular object to be bound to.
Sakurann marked this conversation as resolved.
Show resolved Hide resolved

The following additional considerations are given for pre-existing Authorization Request parameters:

Expand Down Expand Up @@ -433,7 +439,7 @@ When the Verifier is sending a Request Object as defined in [@!RFC9101], the `au

Note: "https://self-issued.me/v2" is a symbolic string and can be used as an `aud` Claim value even when this specification is used standalone, without SIOPv2.

## Verifier Metadata Management {#client_metadata_management}
## Verifier Metadata Management (Client Identifier schemes) {#client_metadata_management}

The `client_id_scheme` enables deployments of this specification to use different mechanisms to obtain and validate metadata of the Verifier beyond the scope of [@!RFC6749]. The term `client_id_scheme` is used since the Verifier is acting as an OAuth 2.0 Client.

Expand Down Expand Up @@ -746,7 +752,15 @@ The following is a non-normative example of the payload of the JWT used in the e

<{{examples/response/jarm_jwt_vc_json_body.json}}

## Error Response
## Transaction Data {#transaction_data}

The transaction data mechanism enables a binding between the user's identification/authentication and the user’s authorization, for example to complete a payment transaction, or to sign specific document(s) using QES (Qualified Electronic Signatures). This is achieved by signing the transaction data used for user authorization with the user-controlled key used for proof of possession of the Credential being presented as a means for user identification/authentication.

The Wallet that received `transaction_data` parameter in the request, MUST include in the response a `tx_data_hashes` parameter defined below:
Sakurann marked this conversation as resolved.
Show resolved Hide resolved
Sakurann marked this conversation as resolved.
Show resolved Hide resolved
Sakurann marked this conversation as resolved.
Show resolved Hide resolved

* `tx_data_hashes`: Array of hashes, where each hash is calculated using a hash function over the strings received in the `transaction_data` request parameter. Each hash value ensures the integrity of, and maps to, the respective transaction data object. Where in the response this parameter is included is defined by each Credential Format Profile, but it has to be included in the mechanism used for the proof of possession of the Credential that is signed using the user-controlled key.
Sakurann marked this conversation as resolved.
Show resolved Hide resolved
Sakurann marked this conversation as resolved.
Show resolved Hide resolved

## Error Response {#error_response}
Sakurann marked this conversation as resolved.
Show resolved Hide resolved

The error response follows the rules as defined in [@!RFC6749], with the following additional clarifications:

Expand Down Expand Up @@ -791,6 +805,14 @@ This document also defines the following additional error codes and error descri

- The value of the `request_uri_method` request parameter is neither `get` nor `post` (case-sensitive).

`invalid_transaction_data`:

- any of the following is true for at least one object in the transaction_data structure:
Sakurann marked this conversation as resolved.
Show resolved Hide resolved
- contains an unknown transaction data type value,
Sakurann marked this conversation as resolved.
Show resolved Hide resolved
- is an object of known type but containing unknown fields,
- contains fields of the wrong type for the transaction data type,
- contains fields with invalid values for the transaction data type, or
- is missing required fields for the transaction data type.
Sakurann marked this conversation as resolved.
Show resolved Hide resolved

## VP Token Validation

Expand Down Expand Up @@ -1749,6 +1771,8 @@ Setting `limit_disclosure` property defined in [@!DIF.PresentationExchange] to `

A non-normative example of the Authorization Response would look the same as in the examples of other Credential formats in this Annex.

The `transaction_data` response parameter defined in (#transaction_data) MUST be included in the Key Binding JWT as a top level claim.
Sakurann marked this conversation as resolved.
Show resolved Hide resolved

The following is a non-normative example of the content of the `presentation_submission` parameter:

<{{examples/response/ps_sd_jwt_vc.json}}
Expand Down