Refactor Credential Signing #401

nitro-neal · 2024-02-05T21:48:53Z

This change slightly refactors credential signing and verifying.

Instead of PortableDid we now use BearerDid

import { DidKey } from '@web5/dids';
const issuer: BearerDid = await DidKey.create();

const vcJwt = await vc.sign({ did: issuer });

This change also:

Changes jwt signing to use bearer did's signer function
Updates all unit tests to use BearerDid
Updates to the following versions
"@web5/common": "0.2.3",
"@web5/crypto": "0.4.0",
"@web5/dids": "0.4.0"

codesandbox · 2024-02-05T21:48:55Z

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders

Open Preview

github-actions · 2024-02-05T21:51:49Z

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-14T00:26:52Z 1e63970

codecov · 2024-02-06T20:25:30Z

Codecov Report

Merging #401 (1e63970) into main (299bcb0) will increase coverage by 0.00%.
Report is 1 commits behind head on main.
The diff coverage is 100.00%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #401   +/-   ##
=======================================
  Coverage   93.32%   93.33%           
=======================================
  Files          78       78           
  Lines       23573    23528   -45     
  Branches     1866     1863    -3     
=======================================
- Hits        21999    21959   -40     
+ Misses       1534     1529    -5     
  Partials       40       40

Components	Coverage Δ
agent	`88.72% <ø> (ø)`
api	`97.30% <ø> (ø)`
common	`98.67% <ø> (ø)`
credentials	`94.94% <100.00%> (+0.34%)`	⬆️
crypto	`93.76% <ø> (ø)`
dids	`97.53% <ø> (ø)`
identity-agent	`56.81% <ø> (ø)`
crypto-aws-kms	`100.00% <ø> (ø)`
proxy-agent	`58.43% <ø> (ø)`
user-agent	`55.22% <ø> (ø)`

nitro-neal · 2024-02-12T19:32:34Z

packages/credentials/package.json

-    "@web5/common": "0.2.2",
-    "@web5/crypto": "0.2.4",
-    "@web5/dids": "0.2.4"
+    "@web5/common": "0.2.3",


These are the latest versions right?

Yes -- 0.4.0 for both dids and crypto -- 0.2.3 for common.

nitro-neal · 2024-02-12T19:49:45Z

Should I bump the version of the credentials package to "version": "0.4.2", ?

Signed-off-by: Frank Hinek <[email protected]>

nitro-neal · 2024-02-13T22:48:47Z

packages/credentials/src/jwt.ts

-
-    const isSignatureValid = await signer.verify({
-      algorithm : signatureAlgorithm!,
+    const crypto = new CryptoApi();


Should we just have is initialized once at the top?

sounds good

packages/credentials/src/jwt.ts

frankhinek

Looks good other than a few changes noted above and updating the test

Co-authored-by: Frank Hinek <[email protected]>

mistermoe

cc: @angiejones

frankhinek · 2024-02-14T16:08:22Z

Should I bump the version of the credentials package to "version": "0.4.2", ?

Yes, we might as well publish a release today so that tbdex repos can use it.

* refactor cred signing * updates * fixing jwt test * updates * updates to latest did and crypto package * update package lock * spacing * update package lock * package lock builds * Simplify JWT verify by using CryptoApi from @web5/crypto Signed-off-by: Frank Hinek <[email protected]> * Update packages/credentials/src/jwt.ts Co-authored-by: Frank Hinek <[email protected]> * updates to alg checking --------- Signed-off-by: Frank Hinek <[email protected]> Co-authored-by: Frank Hinek <[email protected]>

refactor cred signing

1730ef1

nitro-neal added 3 commits February 6, 2024 13:27

updates

0c1337a

fixing jwt test

933b4aa

updates

a6b75b5

nitro-neal added 3 commits February 12, 2024 11:05

Merge branch 'main' into refactor-creds-signing

aacb0bc

updates to latest did and crypto package

894f0b9

update package lock

2d2a991

nitro-neal changed the title ~~refactor cred signing~~ Refactor Credential Signing Feb 12, 2024

nitro-neal commented Feb 12, 2024

View reviewed changes

nitro-neal added 3 commits February 12, 2024 13:38

spacing

9588b22

update package lock

6119b9b

package lock builds

512acb7

nitro-neal marked this pull request as ready for review February 12, 2024 19:52

nitro-neal requested review from frankhinek, csuwildcat and mistermoe as code owners February 12, 2024 19:52

Simplify JWT verify by using CryptoApi from @web5/crypto

655395d

Signed-off-by: Frank Hinek <[email protected]>

nitro-neal commented Feb 13, 2024

View reviewed changes

frankhinek reviewed Feb 13, 2024

View reviewed changes

packages/credentials/src/jwt.ts Outdated Show resolved Hide resolved

frankhinek approved these changes Feb 13, 2024

View reviewed changes

nitro-neal and others added 2 commits February 13, 2024 17:18

Update packages/credentials/src/jwt.ts

d91fe6d

Co-authored-by: Frank Hinek <[email protected]>

updates to alg checking

1e63970

mistermoe approved these changes Feb 14, 2024

View reviewed changes

nitro-neal merged commit 69e5380 into main Feb 14, 2024
33 of 34 checks passed

nitro-neal deleted the refactor-creds-signing branch February 14, 2024 17:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor Credential Signing #401

Refactor Credential Signing #401

nitro-neal commented Feb 5, 2024 •

edited

Loading

codesandbox bot commented Feb 5, 2024

github-actions bot commented Feb 5, 2024 •

edited

Loading

codecov bot commented Feb 6, 2024 •

edited

Loading

nitro-neal Feb 12, 2024

frankhinek Feb 13, 2024

nitro-neal commented Feb 12, 2024

nitro-neal Feb 13, 2024

frankhinek Feb 13, 2024

frankhinek left a comment

mistermoe left a comment

frankhinek commented Feb 14, 2024

Refactor Credential Signing #401

Refactor Credential Signing #401

Conversation

nitro-neal commented Feb 5, 2024 • edited Loading

codesandbox bot commented Feb 5, 2024

Review or Edit in CodeSandbox

github-actions bot commented Feb 5, 2024 • edited Loading

@web5/api

@web5/crypto

@web5/crypto-aws-kms

@web5/dids

codecov bot commented Feb 6, 2024 • edited Loading

Codecov Report

nitro-neal Feb 12, 2024

Choose a reason for hiding this comment

frankhinek Feb 13, 2024

Choose a reason for hiding this comment

nitro-neal commented Feb 12, 2024

nitro-neal Feb 13, 2024

Choose a reason for hiding this comment

frankhinek Feb 13, 2024

Choose a reason for hiding this comment

frankhinek left a comment

Choose a reason for hiding this comment

mistermoe left a comment

Choose a reason for hiding this comment

frankhinek commented Feb 14, 2024

nitro-neal commented Feb 5, 2024 •

edited

Loading

github-actions bot commented Feb 5, 2024 •

edited

Loading

codecov bot commented Feb 6, 2024 •

edited

Loading