openid / openid/OpenID4VCI

text around encryption of deferred responses could be clearer

Open Beginner friendly
#732 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

certification
Dominant language
No language data
Stars
125
Forks
41
PR merge metrics
No merged PRs in 30d

Description

https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#section-9.2 says:

If the Client requested an encrypted response by including the credential_response_encryption object in the request, the Credential Issuer MUST encode the information in the Deferred Credential Response as specified by Section 10, using the parameters from the credential_response_encryption object. Note that this is done regardless of the content.

I read the part I bolded as meaning that deferred responses MUST be encrypted, regardless of whether it's "here is the credential" or "credential is not ready yet". At least I can't figure out what else that sentence could be trying to say.

I traced the added text back to https://github.com/openid/OpenID4VCI/pull/505 but I can't see that there was any significant discussion of that text (other than a grammar change I suggested).

The same text is present in https://openid.github.io/OpenID4VCI/openid-4-verifiable-credential-issuance-1_0-wg-draft.html#section-8.3

I'd suggest changing both instances of "Note that this is done regardless of the content." to something like:

Note that this is done for all HTTP 2xx responses.

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

Compare the wording in Section 9.2 of the published OpenID4VCI specification with Section 8.3 of the WG draft, and trace both instances of the sentence quoted in the issue. Update the two instances to clarify that encryption applies to all HTTP 2xx responses, then verify the surrounding references and rendered text.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.