Add VerifiablePresentation Creation, Signing, and Verification #184

nitro-neal · 2024-01-10T17:50:09Z

Overview

Add VerifiablePresentation Creation, Signing, and Verification

Description

This provides functionalities to sign, verify, and create presentations, offering a concise API to work with JWT representations of verifiable presentations and ensuring that the signatures and claims within those JWTs can be validated.

Create VP Example:

    /**
     * Create a [VerifiablePresentation] based on the provided parameters.
     *
     * @param type The type of the presentation, as a [String].
     * @param holder The holder URI of the presentation, as a [String].
     * @param vcJwts The credentials used in the presentation, as a [String].
     * @param additionalData The presentation data, as a generic mapping [Map<String, Any>].
     * @return A [VerifiablePresentation] instance.
     *
     * Example:
     * ```
     *     val vp = VerifiablePresentation.create(
     *       vcJwts = vcJwts,
     *       holder = holderDid.uri,
     *       type = "PresentationSubmission",
     *       additionalData = mapOf("presentation_submission" to presentationSubmission)
     *     )
     * ```
     */

Sign VP Example:

val vpJwt = vp.sign(holderDid)

After signing this will create a vp that looks something like this:

eyJraWQiOiJkaWQ6a2V5OnpRM3NoYURtR0szdHlBRmpLY3BLZjRTRGUyNnZzcjJRV2JzaWpXckJpRXdpeEZTRDkjelEzc2hhRG1HSzN0eUFGaktjcEtmNFNEZTI2dnNyMlFXYnNpaldyQmlFd2l4RlNEOSIsInR5cCI6IkpXVCIsImFsZyI6IkVTMjU2SyJ9.eyJpc3MiOiJkaWQ6a2V5OnpRM3NoYURtR0szdHlBRmpLY3BLZjRTRGUyNnZzcjJRV2JzaWpXckJpRXdpeEZTRDkiLCJ2cCI6eyJAY29udGV4dCI6WyJodHRwczovL3d3dy53My5vcmcvMjAxOC9jcmVkZW50aWFscy92MSJdLCJ0eXBlIjpbIlZlcmlmaWFibGVQcmVzZW50YXRpb24iLCJQcmVzZW50YXRpb25TdWJtaXNzaW9uIl0sImlkIjoidXJuOnV1aWQ6ZTcyMjAxNjMtYWFmMy00MWFkLWJkYjUtZWM5NGZmODZiMzQ5IiwicHJlc2VudGF0aW9uX3N1Ym1pc3Npb24iOnsiaWQiOiJwcmVzZW50YXRpb25TdWJtaXNzaW9uSWQiLCJkZWZpbml0aW9uSWQiOiJkZWZpbml0aW9uSWQiLCJkZXNjcmlwdG9yTWFwIjpbeyJpZCI6ImRlc2NyaXB0b3JJZCIsImZvcm1hdCI6ImZvcm1hdCIsInBhdGgiOiJwYXRoIiwicGF0aE5lc3RlZCI6bnVsbH1dfSwidmVyaWZpYWJsZUNyZWRlbnRpYWwiOlsidmNqd3QxIiwidmNqd3QyIl0sImhvbGRlciI6ImRpZDprZXk6elEzc2hhRG1HSzN0eUFGaktjcEtmNFNEZTI2dnNyMlFXYnNpaldyQmlFd2l4RlNEOSJ9LCJpYXQiOjE3MDQ5MDczMTh9.9_l88r2RSN23-xW8XyT19K3mH8GCLIwWi50eECPUCtwRkZHrL4KLtvLFBx1w_SVnLrn98QWQ9jspxpIJtrgyeQ

codecov · 2024-01-10T17:50:55Z

Codecov Report

Merging #184 (bec2043) into main (06a879c) will increase coverage by 0.68%.
Report is 1 commits behind head on main.
The diff coverage is 83.14%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #184      +/-   ##
==========================================
+ Coverage   78.96%   79.65%   +0.68%     
==========================================
  Files          33       36       +3     
  Lines        1930     2079     +149     
  Branches      265      309      +44     
==========================================
+ Hits         1524     1656     +132     
- Misses        274      281       +7     
- Partials      132      142      +10

Components	Coverage Δ
credentials	`82.77% <83.14%> (+2.09%)`	⬆️
crypto	`38.07% <ø> (ø)`
dids	`89.59% <ø> (ø)`
common	`80.44% <ø> (ø)`

andresuribe87

Good stuff!

Would suggest increasing coverage for edge cases/errors.

credentials/src/main/kotlin/web5/sdk/credentials/VerifiablePresentation.kt

credentials/src/test/kotlin/web5/sdk/credentials/VerifiablePresentationTest.kt

…sentationTest.kt Co-authored-by: Andres Uribe <[email protected]>

decentralgabe · 2024-01-16T20:24:32Z

credentials/src/main/kotlin/web5/sdk/credentials/VerifiablePresentation.kt

+        additionalData?.plus("verifiableCredential" to vcJwts) ?: mapOf("verifiableCredential" to vcJwts)
+
+      val vpDataModel = VpDataModel.builder()
+        .id(URI.create("urn:uuid:${UUID.randomUUID()}"))


are we following this id pattern everywhere?

yup its on the vc id too

decentralgabe · 2024-01-16T20:25:38Z

credentials/src/main/kotlin/web5/sdk/credentials/VerifiablePresentation.kt

+     * }
+     * ```
+     */
+    public fun verify(vpJwt: String) {


this might have some complexity. for example, I could make a presentation definition where I'm specifically requesting expired credentials. this check would fail, since JWT validation fails if the exp property is in the past

I don't think you need to worry about this now, but it may be worth adding a note

hmm good to think about..
we could just simply throw in an acceptExpired flag but we should find all the edge cases

decentralgabe · 2024-01-16T20:26:05Z

credentials/src/main/kotlin/web5/sdk/credentials/util/JwtUtil.kt

+import web5.sdk.dids.findAssertionMethodById
+import java.security.SignatureException
+
+private const val JsonWebKey2020 = "JsonWebKey2020"


this needs to be updated to JsonWebKey TBD54566975/web5-spec#73

yes I'll make another PR that does this, since we will need to update lots of test vectors too

decentralgabe · 2024-01-16T20:26:24Z

credentials/src/main/kotlin/web5/sdk/credentials/util/JwtUtil.kt

+    val didResolutionResult = DidResolvers.resolve(did.uri)
+    val assertionMethod = didResolutionResult.didDocument.findAssertionMethodById(assertionMethodId)
+
+    // TODO: ensure that publicKeyJwk is not null


todos with issue tags or add the require?

decentralgabe · 2024-01-16T20:26:39Z

credentials/src/main/kotlin/web5/sdk/credentials/util/JwtUtil.kt

+    val algorithm = publicKeyJwk.algorithm
+    val jwsAlgorithm = JWSAlgorithm.parse(algorithm.toString())
+
+    val kid = when (assertionMethod.id.isAbsolute) {


could this be a ternary statement?

decentralgabe · 2024-01-16T20:27:58Z

credentials/src/main/kotlin/web5/sdk/credentials/util/JwtUtil.kt

+      "Signature verification failed: Expected JWS header to contain alg and kid"
+    }
+
+    val verificationMethodId = jwt.header.keyID


noting that these can be different

for example we may have a key id as a JWK thumbprint but a verification method ID as did:example:abcd#key-1

decentralgabe

few not blocking comments, nice job!

nitro-neal · 2024-01-17T20:53:19Z

Added sign comments in its own issue - #190

add vp impl

286b11a

nitro-neal requested review from andresuribe87, mistermoe, tomdaffurn and phoebe-lew as code owners January 10, 2024 17:50

more unit tests

710dc06

andresuribe87 approved these changes Jan 10, 2024

View reviewed changes

nitro-neal and others added 2 commits January 10, 2024 14:09

Update credentials/src/test/kotlin/web5/sdk/credentials/VerifiablePre…

b29bffa

…sentationTest.kt Co-authored-by: Andres Uribe <[email protected]>

updates

bec2043

decentralgabe reviewed Jan 16, 2024

View reviewed changes

decentralgabe approved these changes Jan 16, 2024

View reviewed changes

nitro-neal mentioned this pull request Jan 17, 2024

JWT Sign and Verify updates #190

Closed

nitro-neal merged commit cebc961 into main Jan 17, 2024
6 of 8 checks passed

nitro-neal deleted the vp-impl branch January 17, 2024 20:53

nitro-neal mentioned this pull request Jan 18, 2024

Create Verifiable Presentation and Verifiable Presentation Signing #175

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add VerifiablePresentation Creation, Signing, and Verification #184

Add VerifiablePresentation Creation, Signing, and Verification #184

nitro-neal commented Jan 10, 2024

codecov bot commented Jan 10, 2024 •

edited

Loading

andresuribe87 left a comment

decentralgabe Jan 16, 2024

nitro-neal Jan 17, 2024

decentralgabe Jan 16, 2024

nitro-neal Jan 17, 2024

decentralgabe Jan 16, 2024

nitro-neal Jan 17, 2024

decentralgabe Jan 16, 2024

decentralgabe Jan 16, 2024

decentralgabe Jan 16, 2024

decentralgabe left a comment

nitro-neal commented Jan 17, 2024

Add VerifiablePresentation Creation, Signing, and Verification #184

Add VerifiablePresentation Creation, Signing, and Verification #184

Conversation

nitro-neal commented Jan 10, 2024

Overview

Description

codecov bot commented Jan 10, 2024 • edited Loading

Codecov Report

andresuribe87 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

decentralgabe left a comment

Choose a reason for hiding this comment

nitro-neal commented Jan 17, 2024

codecov bot commented Jan 10, 2024 •

edited

Loading