DOC: Verifiable Credential Data Integrity (VC-DI) Credentials in Aries Cloud Agent Python (ACA-Py) #2947 #3110
Conversation
Signed-off-by: supersonicwisd1 <supersonicwisdom@gmail.com>
Signed-off-by: supersonicwisd1 <supersonicwisdom@gmail.com>
Signed-off-by: supersonicwisd1 <supersonicwisdom@gmail.com>
Signed-off-by: supersonicwisd1 <supersonicwisdom@gmail.com>
There was a problem hiding this comment.
My 2 main comments are about the proof representation being incorrect, please use proofValue instead of jws per the Data Integrity sepcification.
The second has to do with using @vocab in the context. If one must do so it's recommended to use the https://www.w3.org/ns/credentials/examples/v2 url instead of inline vocab. However the pyld library doesn't support remote @vocab parsing so we have to do it inline. I would make it clear in the text that @vocab SHOULD NOT be used outside of demonstration/examples, and encourage implementers to define their own terms.
The vc-api endpoints are also available for these sort of demonstration.
| { | ||
| "@vocab": "https://www.w3.org/ns/credentials/issuer-dependent#" | ||
| } |
There was a problem hiding this comment.
I would include note about avoiding @vocab outside of development and/or examples, and implementers should define their own terms in a context file they provide.
There was a problem hiding this comment.
For this specific example, { "name": "https://schema.org/name" } instead of { "@vocab": "https://www.w3.org/ns/credentials/issuer-dependent#" } would also be a better solution to defining the attribute, however @vocab is fine for examples.
There was a problem hiding this comment.
do you mean something like this
..
"@context": [
"https://www.w3.org/2018/credentials/v1",
"https://w3id.org/security/data-integrity/v2",
"@vocab": "https://www.w3.org/ns/credentials/issuer-dependent#"
]
..There was a problem hiding this comment.
no, leave as is this will work, I would just put a note since using @vocab is considered a bad practice outside of demonstrations and development. Implementers are encouraged to write their own context or use community available contexts. The existing w3c documentation outlines this here:
https://github.com/hyperledger/aries-cloudagent-python/blob/main/docs/features/JsonLdCredentials.md#json-ld-context
docs/features/W3cCredentials.md
Outdated
| 2. **Select Credential type** | ||
| The ability to choose the credential type (indy, vc_di) to be issued. The credential type is used to determine the schema for the credential data. | ||
|
|
||
| The format to change credential can be seen in the ["Demo Instruction"](https://github.com/sarthakvijayvergiya/aries-cloudagent-python/blob/whatscookin/feat/vc-di-proof/docs/demo/README.md) |
There was a problem hiding this comment.
This link should point to the aca-py github page, could this be a relative path?
docs/features/W3cCredentials.md
Outdated
| { | ||
| "auto_issue": true, | ||
| "auto_remove": false, | ||
| "comment": "Issuing a test credential", | ||
| "credential_preview": { | ||
| "@type": "https://didcomm.org/issue-credential/2.0/credential-preview", | ||
| "attributes": [ | ||
| {"name": "name", "value": "John Doe"} | ||
| ] | ||
| }, | ||
| "trace": false | ||
| } |
There was a problem hiding this comment.
don't we need to include a filter for issue-credential 2.0?
There was a problem hiding this comment.
Great one picking this out. I have included filter
docs/features/W3cCredentials.md
Outdated
| "created": "2023-01-01T00:00:00Z", | ||
| "proofPurpose": "assertionMethod", | ||
| "verificationMethod": "did:key:z6MkqG......#z6MkqG......", | ||
| "jws": "eyJhbGciOiJFZERTQSJ9..." |
There was a problem hiding this comment.
Same as above, jws is an invalid signature format here, it needs to be proofValue with a multibase representation of the signature.
docs/features/W3cCredentials.md
Outdated
| "created": "2023-01-01T00:00:00Z", | ||
| "proofPurpose": "assertionMethod", | ||
| "verificationMethod": "did:key:z6MkqG......#z6MkqG......", | ||
| "jws": "eyJhbGciOiJFZERTQSJ9..." |
There was a problem hiding this comment.
jws is not used in data integrity proofs, please use proofValue with a multibase representation of the proof:
https://w3c.github.io/vc-di-eddsa/#example-signed-credential-1
There was a problem hiding this comment.
Thanks, this have been updated
docs/features/W3cCredentials.md
Outdated
| </details> | ||
|
|
||
| 2. **Send the Verification Request:** | ||
| Use the `/verifier-credential/2.0/verify` endpoint. |
There was a problem hiding this comment.
I don't think this endpoint exists.
Signed-off-by: supersonicwisd1 <supersonicwisdom@gmail.com>
Signed-off-by: supersonicwisd1 <supersonicwisdom@gmail.com>
|
Please update this PR to the latest so we can merge this. Thanks. |
|
No description provided.