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

Base proof properties on Data Integrity spec with restrictions #50

Merged
merged 2 commits into from
Feb 6, 2024

Conversation

Wind4Greg
Copy link
Collaborator

@Wind4Greg Wind4Greg commented Jan 5, 2024

This PR addresses issue #47. The issue is "Ensure created proof option is optional". However proof options originate in the Data Integrity specification and the created property is properly defined as optional there. Hence this PR points back to the Data Integrity spec for proof property definitions and only elaborates on those properties that have restricted or specially defined values.


Preview | Diff

Comment on lines -455 to -457
The `proofPurpose` property of the proof MUST be a string, and MUST
match the verification relationship expressed by the verification method
`controller`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think removing this is ok given that it is covered in:

https://w3c.github.io/vc-data-integrity/#retrieve-verification-method

I filed an issue about cleaning that up a bit here: https://github.com/w3c/vc-data-integrity/issues/236

I'll note that the current text calls this section:

"Section 4: Retrieving Cryptographic Material" instead of "Section 4: Retrieve Verification Method".

I'll also note that the signing section here has the same incorrect title (I'm not sure if some respec magic could keep these things up-to-date), but the way it's phrased there also implies one can get privateKeyBytes from a verification method, which isn't a thing. I think it's just trying to say one gets the private key bytes associated with the verification method identified by options.verificationMethod:

Let privateKeyBytes be the result of retrieving the private key bytes associated with the options.verificationMethod value as described in the Data Integrity [VC-DATA-INTEGRITY] specification, Section 4: Retrieving Cryptographic Material.

Referencing the algorithm should probably just be removed then and we could say:

Let privateKeyBytes be the result of retrieving the private key bytes associated with the verification method identified by the options.verificationMethod value.

But we should probably say: "...privateKeyBytes (or a signing interface enabling the use of the private key bytes) associated with...".

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @dlongley updated text per your suggestion.

Copy link
Member

@TallTed TallTed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@msporny msporny added the normative This item is a normative change. label Feb 4, 2024
@Wind4Greg
Copy link
Collaborator Author

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

@Wind4Greg Wind4Greg merged commit 6a96362 into w3c:main Feb 6, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
normative This item is a normative change.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants