Verifiable Presentation Implementation #382

nitro-neal · 2024-01-19T20:28:12Z

This vp impl 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.

```ts
const vp = await VerifiablePresentation.create({
    type: 'PresentationSubmission',
    holder: 'did:ex:holder',
    vcJwts: vcJwts,
    additionalData: { 'presentation_submission': presentationSubmission }
  })
  
  const vpJwt = verifiablePresentation.sign({ did: myDid });
 
```

Example of a signed vp with a sample presentation_submission.


```

eyJ0eXAiOiJKV1QiLCJhbGciOiJFZERTQSIsImtpZCI6ImRpZDprZXk6ejZNa21ZYWlMRXBMNGJQRkNBZXJpTTV4MTNnQUZpRUNRd2VNeWlWeDE1YlVydHYyI3o2TWttWWFpTEVwTDRiUEZDQWVyaU01eDEzZ0FGaUVDUXdlTXlpVngxNWJVcnR2MiJ9.eyJ2cCI6eyJAY29udGV4dCI6WyJodHRwczovL3d3dy53My5vcmcvMjAxOC9jcmVkZW50aWFscy92MSJdLCJ0eXBlIjpbIlZlcmlmaWFibGVQcmVzZW50YXRpb24iLCJQcmVzZW50YXRpb25TdWJtaXNzaW9uIl0sImlkIjoidXJuOnV1aWQ6OWNmMmQzODUtZDdiYi00ZWU4LTgyOGEtYTViOTE3YzZhNmNiIiwiaG9sZGVyIjoiZGlkOmtleTp6Nk1rbVlhaUxFcEw0YlBGQ0FlcmlNNXgxM2dBRmlFQ1F3ZU15aVZ4MTViVXJ0djIiLCJ2ZXJpZmlhYmxlQ3JlZGVudGlhbCI6WyJleUpyYVdRaU9pSmthV1E2YTJWNU9ucFJNM05vWjBOcVZtWnVjbGR4T1V3M2NqRlJjM294Y21sUlVsZHZiM3BpZDJkS1lrcHRUR2R4UkZCMk9YTm5OR0lqZWxFemMyaG5RMnBXWm01eVYzRTVURGR5TVZGemVqRnlhVkZTVjI5dmVtSjNaMHBpU20xTVozRkVVSFk1YzJjMFlpSXNJblI1Y0NJNklrcFhWQ0lzSW1Gc1p5STZJa1ZUTWpVMlN5SjkuZXlKcGMzTWlPaUprYVdRNmEyVjVPbnBSTTNOb1owTnFWbVp1Y2xkeE9VdzNjakZSYzNveGNtbFJVbGR2YjNwaWQyZEtZa3B0VEdkeFJGQjJPWE5uTkdJaUxDSnpkV0lpT2lKa2FXUTZhMlY1T25wUk0zTm9kMlEwZVZWQlpsZG5aa2RGVW5GVmF6UTNlRWM1TlhGT1ZYTnBjMFEzTnpaS1RIVmFOM2w2T1c1UmFXb2lMQ0pwWVhRaU9qRTNNRFE1TVRnd09ETXNJblpqSWpwN0lrQmpiMjUwWlhoMElqcGJJbWgwZEhCek9pOHZkM2QzTG5jekxtOXlaeTh5TURFNEwyTnlaV1JsYm5ScFlXeHpMM1l4SWwwc0luUjVjR1VpT2xzaVZtVnlhV1pwWVdKc1pVTnlaV1JsYm5ScFlXd2lMQ0pUZEhKbFpYUkRjbVZrSWwwc0ltbGtJam9pZFhKdU9uVjFhV1E2TlRVMk9HUXlaVEV0WWpBME5TMDBNVFEzTFRreE5qVXRaVFUzWVRJeE1HTTJaR1ZsSWl3aWFYTnpkV1Z5SWpvaVpHbGtPbXRsZVRwNlVUTnphR2REYWxabWJuSlhjVGxNTjNJeFVYTjZNWEpwVVZKWGIyOTZZbmRuU21KS2JVeG5jVVJRZGpselp6UmlJaXdpYVhOemRXRnVZMlZFWVhSbElqb2lNakF5TkMwd01TMHhNRlF5TURveU1Ub3lNMW9pTENKamNtVmtaVzUwYVdGc1UzVmlhbVZqZENJNmV5SnBaQ0k2SW1ScFpEcHJaWGs2ZWxFemMyaDNaRFI1VlVGbVYyZG1SMFZTY1ZWck5EZDRSemsxY1U1VmMybHpSRGMzTmtwTWRWbzNlWG81YmxGcGFpSXNJbXh2WTJGc1VtVnpjR1ZqZENJNkltaHBaMmdpTENKc1pXZHBkQ0k2ZEhKMVpYMTlmUS5CeDBKclFFUldSTHBZZWczVG5mck9JbzR6ZXhvM3ExZXhQWi1FajZqMFQwWU9CVlphWjktUnFwaUFNLWZIS3JkR1V6VnlYcjc3cE9sN3lHZ3dJTzkwZyJdLCJwcmVzZW50YXRpb25fc3VibWlzc2lvbiI6eyJpZCI6InByZXNlbnRhdGlvblN1Ym1pc3Npb25JZCIsImRlZmluaXRpb25faWQiOiJkZWZpbml0aW9uSWQiLCJkZXNjcmlwdG9yX21hcCI6W3siaWQiOiJkZXNjcmlwdG9ySWQiLCJmb3JtYXQiOiJmb3JtYXQiLCJwYXRoIjoicGF0aCJ9XX19LCJpc3MiOiJkaWQ6a2V5Ono2TWttWWFpTEVwTDRiUEZDQWVyaU01eDEzZ0FGaUVDUXdlTXlpVngxNWJVcnR2MiIsInN1YiI6ImRpZDprZXk6ejZNa21ZYWlMRXBMNGJQRkNBZXJpTTV4MTNnQUZpRUNRd2VNeWlWeDE1YlVydHYyIn0.bEeGwEDTFSD3zaIWoStMOBv2RcWY7t1efTHkhb_xLE5d2px7JJOlY9wJmq4KxJF2HupDEUbQI0XuRIhzH0eZCA
```

codesandbox · 2024-01-19T20:28:15Z

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders

Open Preview

github-actions · 2024-01-19T20:30:55Z

TBDocs Report

🛑 Errors: 0
⚠️ Warnings: 90

@web5/api

Project entry file: packages/api/src/index.ts

📄 File: ./packages/api/src/protocol.ts
⚠️ `extractor:typedoc:missing-reference`: ProtocolMetadata is referenced by Protocol._metadata but not included in the documentation.
⚠️ `extractor:typedoc:missing-docs`: Protocol._agent (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Protocol._metadata (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Protocol._protocolsConfigureMessage (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Protocol.send.__type.status (Property) does not have any documentation.

📄 File: ./packages/api/src/send-cache.ts
⚠️ `extractor:typedoc:missing-reference`: SendCache is referenced by Record._sendCache but not included in the documentation.

📄 File: ./packages/api/src/web5.ts
⚠️ `extractor:typedoc:missing-reference`: Web5Options is referenced by Web5.constructor.new Web5.options but not included in the documentation.
⚠️ `extractor:typedoc:missing-docs`: TechPreviewOptions.__type.dwnEndpoints (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Web5ConnectOptions.__type.connectedDid (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Web5.connect.__type.web5 (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Web5.connect.__type.did (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Web5.connectedDid (Property) does not have any documentation.

📄 File: ./packages/api/src/utils.ts
⚠️ `extractor:typedoc:missing-docs`: utils.dataToBlob.__type.dataBlob (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: utils.dataToBlob.__type.dataFormat (Property) does not have any documentation.

📄 File: ./packages/api/src/did-api.ts
⚠️ `extractor:typedoc:missing-docs`: DidApi.agent (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: DidApi.connectedDid (Property) does not have any documentation.

📄 File: ./packages/api/src/dwn-api.ts
⚠️ `extractor:typedoc:missing-docs`: ResponseStatus.__type.status (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ResponseStatus.__type.status.__type.code (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ResponseStatus.__type.status.__type.detail (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ProtocolsConfigureRequest.__type.message (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ProtocolsConfigureResponse.__type.protocol (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ProtocolsQueryReplyEntry.__type.descriptor (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ProtocolsQueryRequest.__type.from (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ProtocolsQueryRequest.__type.message (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ProtocolsQueryResponse.__type.protocols (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsCreateFromRequest.__type.author (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsCreateFromRequest.__type.data (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsCreateFromRequest.__type.message (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsCreateFromRequest.__type.record (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsDeleteRequest.__type.from (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsDeleteRequest.__type.message (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsQueryRequest.__type.message (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsQueryResponse.__type.records (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsReadRequest.__type.message (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsReadResponse.__type.record (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsWriteRequest.__type.data (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsWriteRequest.__type.message (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsWriteRequest.__type.store (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsWriteResponse.__type.record (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: DwnApi.agent (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: DwnApi.connectedDid (Property) does not have any documentation.

📄 File: ./packages/api/src/record.ts
⚠️ `extractor:typedoc:missing-docs`: RecordOptions.__type.author (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordOptions.__type.connectedDid (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordOptions.__type.encodedData (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordOptions.__type.data (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordOptions.__type.initialWrite (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordOptions.__type.protocolRole (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordOptions.__type.remoteOrigin (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordModel.__type.author (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordModel.__type.protocolRole (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordModel.__type.recordId (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordUpdateOptions.__type.data (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordUpdateOptions.__type.dataCid (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordUpdateOptions.__type.dataSize (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordUpdateOptions.__type.dateModified (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordUpdateOptions.__type.datePublished (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordUpdateOptions.__type.published (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordUpdateOptions.__type.protocolRole (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._sendCache (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._agent (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._connectedDid (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._encodedData (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._readableStream (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._remoteOrigin (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._author (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._attestation (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._authorization (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._contextId (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._descriptor (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._encryption (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._initialWrite (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._initialWriteStored (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._initialWriteSigned (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._recordId (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._protocolRole (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record.data.__type.then (CallSignature) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record.data.__type.catch (CallSignature) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record.processRecord (CallSignature) does not have any documentation.

📄 File: ./packages/api/src/vc-api.ts
⚠️ `extractor:typedoc:missing-docs`: VcApi.agent (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VcApi.connectedDid (Property) does not have any documentation.

🔀 Misc.
⚠️ `extractor:typedoc:invalid-link`: Failed to resolve link to "@web5/agent#Web5Agent" in comment for Web5ConnectOptions.__type.agent. You may have wanted "@web5/agent!Web5Agent"
⚠️ `extractor:typedoc:invalid-link`: Failed to resolve link to "@web5/user-agent#Web5UserAgent" in comment for Web5ConnectOptions.__type.agent. You may have wanted "@web5/user-agent!Web5UserAgent"
⚠️ `extractor:typedoc:invalid-link`: Failed to resolve link to "@web5/agent#AppDataStore" in comment for Web5ConnectOptions.__type.appData. You may have wanted "@web5/agent!AppDataStore"
⚠️ `extractor:typedoc:invalid-link`: Failed to resolve link to "@web5/agent#AppDataStore" in comment for Web5ConnectOptions.__type.appData. You may have wanted "@web5/agent!AppDataStore"
⚠️ `extractor:typedoc:invalid-link`: Failed to resolve link to "@web5/agent#Web5Agent" in comment for Web5.connect. You may have wanted "@web5/agent!Web5Agent"
⚠️ `extractor:typedoc:invalid-link`: Failed to resolve link to "@web5/user-agent#Web5UserAgent" in comment for Web5.connect. You may have wanted "@web5/user-agent!Web5UserAgent"

@web5/crypto

Project entry file: packages/crypto/src/index.ts

@web5/crypto-aws-kms

Project entry file: packages/crypto-aws-kms/src/index.ts

📄 File: ./packages/crypto-aws-kms/src/ecdsa.ts
⚠️ `extractor:typedoc:missing-docs`: EcdsaAlgorithm (Class) does not have any documentation.

📄 File: ./packages/crypto-aws-kms/src/key-manager.ts
⚠️ `extractor:typedoc:missing-docs`: AwsKeyManager (Class) does not have any documentation.

📄 File: ./packages/crypto-aws-kms/src/utils.ts
⚠️ `extractor:typedoc:missing-docs`: getKeySpec (CallSignature) does not have any documentation.

🔀 Misc.
⚠️ `extractor:typedoc:invalid-link`: Failed to resolve link to "@web5/crypto#Secp256k1.adjustSignatureToLowS \| here" in comment for EcdsaAlgorithm.sign. You may have wanted "@web5/crypto!Secp256k1.adjustSignatureToLowS \| here"

@web5/dids

Project entry file: packages/dids/src/index.ts

TBDocs Report Updated at 2024-02-14T18:38:37Z c803ac3

codecov · 2024-01-19T20:36:00Z

Codecov Report

Merging #382 (c803ac3) into main (69e5380) will decrease coverage by 0.01%.
The diff coverage is 94.26%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #382      +/-   ##
==========================================
- Coverage   93.33%   93.32%   -0.01%     
==========================================
  Files          78       79       +1     
  Lines       23528    23772     +244     
  Branches     1863     1886      +23     
==========================================
+ Hits        21959    22186     +227     
- Misses       1529     1546      +17     
  Partials       40       40

Components	Coverage Δ
agent	`88.72% <ø> (ø)`
api	`97.11% <ø> (-0.19%)`	⬇️
common	`98.67% <ø> (ø)`
credentials	`94.77% <94.26%> (-0.17%)`	⬇️
crypto	`93.76% <ø> (ø)`
dids	`97.53% <ø> (ø)`
identity-agent	`56.81% <ø> (ø)`
crypto-aws-kms	`100.00% <ø> (ø)`
proxy-agent	`58.43% <ø> (ø)`
user-agent	`55.22% <ø> (ø)`

angiejones

thanks for this, Neal! Makes dev experience so much better

* vp impl * update * merge updates and string check * bump version

vp impl

207003a

nitro-neal requested review from frankhinek, csuwildcat and mistermoe as code owners January 19, 2024 20:28

update

6c0127d

nitro-neal mentioned this pull request Jan 24, 2024

Refactor creation and signing of verifiable presentation for web5-js #351

Closed

angiejones approved these changes Jan 24, 2024

View reviewed changes

This was referenced Feb 5, 2024

Added Kotlin Shnips for PEX TBD54566975/developer.tbd.website#1199

Merged

VC workflow with Kotlin Code snippets TBD54566975/developer.tbd.website#1173

Closed

Add VerifiablePresentation.create() for JS TBD54566975/developer.tbd.website#1205

Closed

This was referenced Feb 12, 2024

Add VerifiablePresentation.verify() and Add VerifiablePresentation.sign() for JS TBD54566975/developer.tbd.website#1227

Closed

Kotlin validate submission pex TBD54566975/developer.tbd.website#1234

Merged

nitro-neal added 3 commits February 14, 2024 11:35

Merge branch 'main' into verifiable-presentation-impl

720eff6

merge updates and string check

2eef0b4

bump version

c803ac3

mistermoe approved these changes Feb 14, 2024

View reviewed changes

frankhinek approved these changes Feb 14, 2024

View reviewed changes

nitro-neal merged commit 7a975f7 into main Feb 15, 2024
33 of 34 checks passed

nitro-neal deleted the verifiable-presentation-impl branch February 15, 2024 01:13

finn-block pushed a commit that referenced this pull request Mar 19, 2024

Verifiable Presentation Implementation (#382)

8a4d5d7

* vp impl * update * merge updates and string check * bump version

finn-block pushed a commit that referenced this pull request Mar 19, 2024

Verifiable Presentation Implementation (#382)

be4e63a

* vp impl * update * merge updates and string check * bump version

finn-block pushed a commit that referenced this pull request Mar 19, 2024

Verifiable Presentation Implementation (#382)

9d976c1

* vp impl * update * merge updates and string check * bump version

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Verifiable Presentation Implementation #382

Verifiable Presentation Implementation #382

nitro-neal commented Jan 19, 2024

codesandbox bot commented Jan 19, 2024

github-actions bot commented Jan 19, 2024 •

edited

Loading

codecov bot commented Jan 19, 2024 •

edited

Loading

angiejones left a comment

Verifiable Presentation Implementation #382

Verifiable Presentation Implementation #382

Conversation

nitro-neal commented Jan 19, 2024

codesandbox bot commented Jan 19, 2024

Review or Edit in CodeSandbox

github-actions bot commented Jan 19, 2024 • edited Loading

@web5/api

@web5/crypto

@web5/crypto-aws-kms

@web5/dids

codecov bot commented Jan 19, 2024 • edited Loading

Codecov Report

angiejones left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 19, 2024 •

edited

Loading

codecov bot commented Jan 19, 2024 •

edited

Loading