JSON-LD Signature Support (#525)

* feat(utils): add `@veramo/utils` package * feat(core): add common type definitions for credentials and presentations * feat(credential-ld) add `@veramo/credential-ld` packages * feat(credential-ld): added EcdsaSecp256k1RecoverySignature2020 and Ed25519Signature2018 credential signature and verification. * feat(credential-ld): added presentation creation and verification. * fix(credential-w3c): delegate `lds` proof types to `@veramo/credential-ld` if available. * fix(data-store): fixed save operation for LD credentials * feat(did-provider-key): fixed did:key dependencies, supporting only ed25519 x25519 and secp256k1 for now. * feat(credential-ld): included credential context from transmute library * refactor(credential-ld): simplify `CredentialIssuerLD` plugin initialization API * feat(credential-ld): proper mapping from local database keys to DID document verificationMethods * feat(cli): update default config to use `CredentialIssuerLD` module * feat(credential-w3c): autoselect presentation audience if it's a managed DID, for verification * feat(cli): add CLI methods to verify credentials and presentations Co-authored-by: Simonas Karuzas <simonas@not.cat> Co-authored-by: Mircea Nistor <mirceanis@gmail.com> fixes #273 fixes #756 relates to #586 relates to #588
decentralized-identity · Nov 24, 2021 · 18c2226 · 18c2226
1 parent 5b414d7
commit 18c2226
Show file tree

Hide file tree

Showing 145 changed files with 6,406 additions and 1,730 deletions.
diff --git a/.prettierignore b/.prettierignore
@@ -1,6 +1,6 @@
 coverage
 examples
-build/**/*
+**/build
 docs
 report
 *.json

diff --git a/__tests__/initial.migration.test.ts b/__tests__/initial.migration.test.ts
@@ -3,33 +3,40 @@
  * TypeORM migrations were available (before Veramo 3.0.0)
  */
 
-import { createAgent, TAgent, IDIDManager, IResolver, IKeyManager, IDataStore } from '../packages/core/src'
+import {
+  createAgent,
+  IDataStore,
+  IDIDManager,
+  IKeyManager,
+  IResolver,
+  TAgent,
+  VerifiableCredential,
+} from '../packages/core/src'
 import { DIDResolverPlugin } from '../packages/did-resolver/src'
 import { EthrDIDProvider } from '../packages/did-provider-ethr/src'
 import { WebDIDProvider } from '../packages/did-provider-web/src'
-import { KeyDIDProvider } from '../packages/did-provider-key/src'
+import { getDidKeyResolver, KeyDIDProvider } from '../packages/did-provider-key/src'
 import { DIDComm, IDIDComm } from '../packages/did-comm/src'
 import { KeyManagementSystem, SecretBox } from '../packages/kms-local/src'
 import {
-  Entities,
-  IDataStoreORM,
   DataStore,
   DataStoreORM,
-  KeyStore,
   DIDStore,
+  Entities,
+  IDataStoreORM,
+  KeyStore,
   migrations,
   PrivateKeyStore,
 } from '../packages/data-store/src'
-import { getDidKeyResolver } from '../packages/did-provider-key/src'
 import { KeyManager } from '../packages/key-manager/src'
 import { DIDManager } from '../packages/did-manager/src'
 import { FakeDidProvider, FakeDidResolver } from './utils/fake-did'
 
-import { createConnection, Connection, ConnectionOptions } from 'typeorm'
+import { Connection, ConnectionOptions, createConnection } from 'typeorm'
 import { Resolver } from 'did-resolver'
 import { getResolver as ethrDidResolver } from 'ethr-did-resolver'
 import { getResolver as webDidResolver } from 'web-did-resolver'
-import fs from 'fs'
+import * as fs from 'fs'
 
 jest.setTimeout(30000)
 
@@ -196,10 +203,11 @@ describe('database initial migration tests', () => {
       })
 
       it('reads a presentation by hash', async () => {
-        const cred = await agent.dataStoreGetVerifiablePresentation({
+        const presentation = await agent.dataStoreGetVerifiablePresentation({
           hash: '4cfe965596a0d343ff2cc02afd32068bced34caa2b1e7e3f253b23e420de106b58a613f06f55d9d9cbbdbe0b0f051a45d44404020b123c58f0ee48bdaeafdc90',
         })
-        expect(cred?.verifiableCredential?.[0]?.credentialSubject?.name).toEqual('Alice')
+        const cred0: VerifiableCredential = presentation?.verifiableCredential?.[0] as VerifiableCredential
+        expect(cred0.credentialSubject?.name).toEqual('Alice')
       })
 
       it('reads existing messages', async () => {

diff --git a/__tests__/localAgent.test.ts b/__tests__/localAgent.test.ts
@@ -1,63 +1,68 @@
 /**
  * This runs a suite of ./shared tests using an agent configured for local operations,
  * using a SQLite db for storage of credentials, presentations, messages as well as keys and DIDs.
- * 
+ *
  * This suite also runs a ganache local blockchain to run through some examples of DIDComm using did:ethr identifiers.
  */
 
 import {
   createAgent,
-  TAgent,
+  IAgentOptions,
+  IDataStore,
   IDIDManager,
-  IResolver,
   IKeyManager,
-  IDataStore,
   IMessageHandler,
-  IAgentOptions,
+  IResolver,
+  TAgent,
 } from '../packages/core/src'
 import { MessageHandler } from '../packages/message-handler/src'
 import { KeyManager } from '../packages/key-manager/src'
-import { DIDManager, AliasDiscoveryProvider } from '../packages/did-manager/src'
+import { AliasDiscoveryProvider, DIDManager } from '../packages/did-manager/src'
 import { DIDResolverPlugin } from '../packages/did-resolver/src'
 import { JwtMessageHandler } from '../packages/did-jwt/src'
 import { CredentialIssuer, ICredentialIssuer, W3cMessageHandler } from '../packages/credential-w3c/src'
+import {
+  CredentialIssuerLD,
+  ICredentialIssuerLD,
+  LdDefaultContexts,
+  VeramoEcdsaSecp256k1RecoverySignature2020,
+  VeramoEd25519Signature2018,
+} from '../packages/credential-ld/src'
 import { EthrDIDProvider } from '../packages/did-provider-ethr/src'
 import { WebDIDProvider } from '../packages/did-provider-web/src'
-import { KeyDIDProvider } from '../packages/did-provider-key/src'
-import { DIDComm, DIDCommMessageHandler, IDIDComm, DIDCommHttpTransport } from '../packages/did-comm/src'
+import { getDidKeyResolver, KeyDIDProvider } from '../packages/did-provider-key/src'
+import { DIDComm, DIDCommHttpTransport, DIDCommMessageHandler, IDIDComm } from '../packages/did-comm/src'
 import {
-  SelectiveDisclosure,
   ISelectiveDisclosure,
   SdrMessageHandler,
+  SelectiveDisclosure,
 } from '../packages/selective-disclosure/src'
 import { KeyManagementSystem, SecretBox } from '../packages/kms-local/src'
-import { IDIDDiscovery, DIDDiscovery } from '../packages/did-discovery/src'
-import { getDidKeyResolver } from '../packages/did-provider-key/src'
+import { DIDDiscovery, IDIDDiscovery } from '../packages/did-discovery/src'
 
 import {
-  Entities,
-  KeyStore,
-  DIDStore,
-  IDataStoreORM,
   DataStore,
   DataStoreORM,
-  ProfileDiscoveryProvider,
-  PrivateKeyStore,
+  DIDStore,
+  Entities,
+  IDataStoreORM,
+  KeyStore,
   migrations,
+  PrivateKeyStore,
+  ProfileDiscoveryProvider,
 } from '../packages/data-store/src'
-import { createConnection, Connection } from 'typeorm'
-
 import { FakeDidProvider, FakeDidResolver } from './utils/fake-did'
+
+import { Connection, createConnection } from 'typeorm'
 import { createGanacheProvider } from './utils/ganache-provider'
 import { Resolver } from 'did-resolver'
 import { getResolver as ethrDidResolver } from 'ethr-did-resolver'
 import { getResolver as webDidResolver } from 'web-did-resolver'
-import fs from 'fs'
-
-jest.setTimeout(30000)
-
+import { contexts as credential_contexts } from '@transmute/credentials-context'
+import * as fs from 'fs'
 // Shared tests
-import verifiableData from './shared/verifiableData'
+import verifiableDataJWT from './shared/verifiableDataJWT'
+import verifiableDataLD from './shared/verifiableDataLD'
 import handleSdrMessage from './shared/handleSdrMessage'
 import resolveDid from './shared/resolveDid'
 import webDidFlow from './shared/webDidFlow'
@@ -71,6 +76,8 @@ import didDiscovery from './shared/didDiscovery'
 import dbInitOptions from './shared/dbInitOptions'
 import didCommWithEthrDidFlow from './shared/didCommWithEthrDidFlow'
 
+jest.setTimeout(30000)
+
 const infuraProjectId = '3586660d179141e3801c3895de1c2eba'
 const secretKey = '29739248cad1bd1a0fc4d9b75cd4d2990de535baf5caadfdf8d8f86664aa830c'
 
@@ -83,14 +90,16 @@ let agent: TAgent<
     IMessageHandler &
     IDIDComm &
     ICredentialIssuer &
+    ICredentialIssuerLD &
     ISelectiveDisclosure &
     IDIDDiscovery
 >
 let dbConnection: Promise<Connection>
 let databaseFile: string
 
 const setup = async (options?: IAgentOptions): Promise<boolean> => {
-  databaseFile = options?.context?.databaseFile || `./tmp/local-database-${Math.random().toPrecision(5)}.sqlite`
+  databaseFile =
+    options?.context?.databaseFile || `./tmp/local-database-${Math.random().toPrecision(5)}.sqlite`
   dbConnection = createConnection({
     name: options?.context?.['dbName'] || 'test',
     type: 'sqlite',
@@ -115,6 +124,7 @@ const setup = async (options?: IAgentOptions): Promise<boolean> => {
       IMessageHandler &
       IDIDComm &
       ICredentialIssuer &
+      ICredentialIssuerLD &
       ISelectiveDisclosure &
       IDIDDiscovery
   >({
@@ -198,6 +208,10 @@ const setup = async (options?: IAgentOptions): Promise<boolean> => {
       }),
       new DIDComm([new DIDCommHttpTransport()]),
       new CredentialIssuer(),
+      new CredentialIssuerLD({
+        contextMaps: [LdDefaultContexts, credential_contexts as any],
+        suites: [new VeramoEcdsaSecp256k1RecoverySignature2020(), new VeramoEd25519Signature2018()],
+      }),
       new SelectiveDisclosure(),
       new DIDDiscovery({
         providers: [new AliasDiscoveryProvider(), new ProfileDiscoveryProvider()],
@@ -228,7 +242,8 @@ const getAgent = () => agent
 const testContext = { getAgent, setup, tearDown }
 
 describe('Local integration tests', () => {
-  verifiableData(testContext)
+  verifiableDataJWT(testContext)
+  verifiableDataLD(testContext)
   handleSdrMessage(testContext)
   resolveDid(testContext)
   webDidFlow(testContext)

diff --git a/__tests__/localMemoryStoreAgent.test.ts b/__tests__/localMemoryStoreAgent.test.ts
@@ -1,48 +1,53 @@
 /**
  * This runs a suite of ./shared tests using an agent configured for local operations,
  * using a SQLite db for storage of credentials and an in-memory store for keys and DIDs.
- * 
+ *
  */
 import {
   createAgent,
-  TAgent,
+  IAgentOptions,
+  IDataStore,
   IDIDManager,
-  IResolver,
   IKeyManager,
-  IDataStore,
   IMessageHandler,
-  IAgentOptions,
+  IResolver,
+  TAgent,
 } from '../packages/core/src'
 import { MessageHandler } from '../packages/message-handler/src'
 import { KeyManager, MemoryKeyStore, MemoryPrivateKeyStore } from '../packages/key-manager/src'
 import { DIDManager, MemoryDIDStore } from '../packages/did-manager/src'
-import { createConnection, Connection } from 'typeorm'
+import { Connection, createConnection } from 'typeorm'
 import { DIDResolverPlugin } from '../packages/did-resolver/src'
 import { JwtMessageHandler } from '../packages/did-jwt/src'
 import { CredentialIssuer, ICredentialIssuer, W3cMessageHandler } from '../packages/credential-w3c/src'
+import {
+  CredentialIssuerLD,
+  ICredentialIssuerLD,
+  LdDefaultContexts,
+  VeramoEcdsaSecp256k1RecoverySignature2020,
+  VeramoEd25519Signature2018,
+} from '../packages/credential-ld/src'
 import { EthrDIDProvider } from '../packages/did-provider-ethr/src'
 import { WebDIDProvider } from '../packages/did-provider-web/src'
-import { KeyDIDProvider } from '../packages/did-provider-key/src'
+import { getDidKeyResolver, KeyDIDProvider } from '../packages/did-provider-key/src'
 import { DIDComm, DIDCommMessageHandler, IDIDComm } from '../packages/did-comm/src'
 import {
-  SelectiveDisclosure,
   ISelectiveDisclosure,
   SdrMessageHandler,
+  SelectiveDisclosure,
 } from '../packages/selective-disclosure/src'
 import { KeyManagementSystem } from '../packages/kms-local/src'
-import { Entities, IDataStoreORM, DataStore, DataStoreORM, migrations } from '../packages/data-store/src'
-import { getDidKeyResolver } from '../packages/did-provider-key/src'
+import { DataStore, DataStoreORM, Entities, IDataStoreORM, migrations } from '../packages/data-store/src'
 import { FakeDidProvider, FakeDidResolver } from './utils/fake-did'
 
 import { Resolver } from 'did-resolver'
 import { getResolver as ethrDidResolver } from 'ethr-did-resolver'
 import { getResolver as webDidResolver } from 'web-did-resolver'
-import fs from 'fs'
-
-jest.setTimeout(30000)
-
+import { contexts as credential_contexts } from '@transmute/credentials-context'
+import * as fs from 'fs'
 // Shared tests
-import verifiableData from './shared/verifiableData'
+import verifiableDataJWT from './shared/verifiableDataJWT'
+import verifiableDataLD from './shared/verifiableDataLD'
 import handleSdrMessage from './shared/handleSdrMessage'
 import resolveDid from './shared/resolveDid'
 import webDidFlow from './shared/webDidFlow'
@@ -53,6 +58,8 @@ import didManager from './shared/didManager'
 import didCommPacking from './shared/didCommPacking'
 import messageHandler from './shared/messageHandler'
 
+jest.setTimeout(30000)
+
 const databaseFile = `./tmp/local-database2-${Math.random().toPrecision(5)}.sqlite`
 const infuraProjectId = '3586660d179141e3801c3895de1c2eba'
 
@@ -65,6 +72,7 @@ let agent: TAgent<
     IMessageHandler &
     IDIDComm &
     ICredentialIssuer &
+    ICredentialIssuerLD &
     ISelectiveDisclosure
 >
 let dbConnection: Promise<Connection>
@@ -76,7 +84,7 @@ const setup = async (options?: IAgentOptions): Promise<boolean> => {
     database: databaseFile,
     synchronize: false,
     migrations: migrations,
-    migrationsRun:true,
+    migrationsRun: true,
     logging: false,
     entities: Entities,
   })
@@ -90,6 +98,7 @@ const setup = async (options?: IAgentOptions): Promise<boolean> => {
       IMessageHandler &
       IDIDComm &
       ICredentialIssuer &
+      ICredentialIssuerLD &
       ISelectiveDisclosure
   >({
     ...options,
@@ -156,6 +165,10 @@ const setup = async (options?: IAgentOptions): Promise<boolean> => {
       }),
       new DIDComm(),
       new CredentialIssuer(),
+      new CredentialIssuerLD({
+        contextMaps: [LdDefaultContexts, credential_contexts as any],
+        suites: [new VeramoEcdsaSecp256k1RecoverySignature2020(), new VeramoEd25519Signature2018()],
+      }),
       new SelectiveDisclosure(),
       ...(options?.plugins || []),
     ],
@@ -170,7 +183,7 @@ const tearDown = async (): Promise<boolean> => {
   } catch (e) {
     // nop
   }
-  try{
+  try {
     fs.unlinkSync(databaseFile)
   } catch (e) {
     //nop
@@ -183,7 +196,8 @@ const getAgent = () => agent
 const testContext = { getAgent, setup, tearDown }
 
 describe('Local in-memory integration tests', () => {
-  verifiableData(testContext)
+  verifiableDataJWT(testContext)
+  verifiableDataLD(testContext)
   handleSdrMessage(testContext)
   resolveDid(testContext)
   webDidFlow(testContext)