openid / openid/OpenID4VP

Facilitating Submission of Referenced Claims with Integrity Support using multipart/form-data

Open
#75 17 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

make sure there is an extension point
Dominant language
Shell
Stars
112
Forks
38
Avg merge
12d 19h
Merged PRs (30d)
4

Description

Problem Statement

Certain scenarios necessitate the inclusion of sizable file-based claims within credentials, to be presented during verification. Examples of such claims include scanned documents, subject portraits conforming to ISO 18013-5, and various biometric records.

Verifiers may demand such claims to support situations where legacy processes intersect with digital credential procedures. This is especially relevant for Biometrics-based Holder Binding, as outlined in the OIDC4VP terminology section.

The current definition of OIDC4VP allows for the presentation of these claims within the VP token, either through a redirect call or encoded as application/x-www-form-urlencoded when Response Mode is set to direct_post. However, these options pose challenges when handling large-sized claims, a concern addressed in multiple discussions (see references below).

Proposal

To address the challenge of managing large claims, I propose enabling the content type multipart/form-data for the submission of Authorization Response in the direct_post Response Mode.

By doing so, various mechanisms can be employed to efficiently reference and submit files from verifiable credentials. Different parts of the multipart content can be utilized for the presentation_submission, vp_token, and additional evidence, ensuring referential integrity extracted from credentials in the vp_token using hashlinks, SRI, or other means. The filenames of each part can be linked to identifiers in the credentials.

This would enable a convenient and efficient to manage claims consisting in large sized files both in issuance and presentation, facilitating different means to retrieve and store such files.

References

"credentialSubject": {
  "id": "did:example:ebfeb1f712ebc6f1c276e12ec21",
  "image": {
    "id": "https://university.example.org/images/58473",
    "digestSRI": "sha384-ZfAwuJmMgoX3s86L7x9XSPi3AEbiz6S/5SyGHJPCxWHs5NEth/c5S9QoS1zZft+J",
    "mediaType": "application/svg+xml",
  },
  ...
}
"attachments": [
	{
		"desc": "Front of id document",
		"digest": {
		"alg": "sha-256",
		"value": "qC1zE5AfxylOFLrCnOIURXJUvnZwSFe5uUj8t6hdQVM="
	},
	"url": "https://example.com/attachments/pGL9yz4hZQ",
	"access_token": "ksj3n283dke",
	"expires_in": 30
	}
]

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No repository files or tests are named. Start by reviewing the direct_post response-mode definition alongside RFC 7578 and the linked OIDC, W3C, and integrity references. Done would require an agreed, interoperable specification for multipart parts, referenced claims, and integrity binding, with corresponding updates identified for this repository.

Written by the indexing model from the issue text.

Assessment

Domain
api, security
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.