@sphereon/ssi-sdk.credential-vcdm-jsonld-provider 0.33.1-feature.jose.vcdm.59

package/src/__tests__/context.loader.test.ts

@@ -0,0 +1,41 @@
+import { describe, expect, it } from 'vitest'
+import { ContextDoc } from '@veramo/credential-ld'
+
+import { LdContextLoader } from '../ld-context-loader'
+import { LdDefaultContexts } from '../ld-default-contexts'
+
+describe('credential-ld context loader', () => {
+  const customContext: Record<string, ContextDoc> = {
+    'https://example.com/custom/context': {
+      '@context': {
+        '@version': 1.1,
+        id: '@id',
+        type: '@type',
+        nothing: 'https://example.com/nothing',
+      },
+    },
+  }
+
+  it('should load custom context from record', async () => {
+    expect.assertions(2)
+    const loader = new LdContextLoader({ contextsPaths: [customContext] })
+    expect(loader.has('https://example.com/custom/context')).toBe(true)
+    await expect(loader.get('https://example.com/custom/context')).resolves.toEqual({
+      '@context': {
+        '@version': 1.1,
+        id: '@id',
+        type: '@type',
+        nothing: 'https://example.com/nothing',
+      },
+    })
+  })
+
+  it('should load context from default map', async () => {
+    expect.assertions(2)
+    const loader = new LdContextLoader({ contextsPaths: [LdDefaultContexts] })
+    expect(loader.has('https://www.w3.org/2018/credentials/v1')).toBe(true)
+
+    const credsContext = await loader.get('https://www.w3.org/2018/credentials/v1')
+    expect(credsContext['@context']).toBeDefined()
+  })
+})

package/src/__tests__/diwala.test.ts

@@ -0,0 +1,129 @@
+import { beforeAll, describe, expect, it } from 'vitest'
+import { createAgent, IDIDManager, IKeyManager, IResolver, TAgent, W3CVerifiableCredential } from '@veramo/core'
+import { DIDManager, MemoryDIDStore } from '@veramo/did-manager'
+import { getDidKeyResolver, SphereonKeyDidProvider } from '@sphereon/ssi-sdk-ext.did-provider-key'
+import { DIDResolverPlugin } from '@veramo/did-resolver'
+import { MemoryKeyStore, MemoryPrivateKeyStore } from '@veramo/key-manager'
+import { Resolver } from 'did-resolver'
+// @ts-ignore
+import nock from 'nock'
+import { CredentialProviderJsonld } from '../agent'
+import { LdDefaultContexts } from '../ld-default-contexts'
+import { SphereonEd25519Signature2018, SphereonEd25519Signature2020 } from '../suites'
+import { diwalaVC } from './fixtures/diwala'
+import { SphereonKeyManagementSystem } from '@sphereon/ssi-sdk-ext.kms-local'
+import { SphereonKeyManager } from '@sphereon/ssi-sdk-ext.key-manager'
+import { IVcdmCredentialPlugin, VcdmCredentialPlugin } from '@sphereon/ssi-sdk.credential-vcdm'
+
+//jest.setTimeout(100000)
+
+describe('Diwala issued VC', () => {
+  let agent: TAgent<IResolver & IKeyManager & IDIDManager & IVcdmCredentialPlugin>
+
+  const jsonld = new CredentialProviderJsonld({
+    contextMaps: [LdDefaultContexts],
+    suites: [new SphereonEd25519Signature2018(), new SphereonEd25519Signature2020()],
+  })
+  // //jest.setTimeout(1000000)
+  beforeAll(async () => {
+    agent = createAgent({
+      plugins: [
+        new SphereonKeyManager({
+          store: new MemoryKeyStore(),
+          kms: {
+            local: new SphereonKeyManagementSystem(new MemoryPrivateKeyStore()),
+          },
+        }),
+        new DIDManager({
+          providers: {
+            'did:key': new SphereonKeyDidProvider({ defaultKms: 'local' }),
+          },
+          store: new MemoryDIDStore(),
+          defaultProvider: 'did:key',
+        }),
+        new DIDResolverPlugin({
+          resolver: new Resolver({
+            ...getDidKeyResolver(),
+          }),
+        }),
+        new VcdmCredentialPlugin({ issuers: [jsonld] }),
+      ],
+    })
+  })
+
+  it('should be verified with Ed25519Signature2018', async () => {
+    const verifiableCredential: W3CVerifiableCredential = diwalaVC
+    expect(verifiableCredential).toBeDefined()
+    // console.log(verifiableCredential)
+
+    const verifiedCredential = await agent.verifyCredential({
+      credential: verifiableCredential,
+      fetchRemoteContexts: true,
+    })
+
+    expect(verifiedCredential).toMatchObject({
+      log: [
+        {
+          id: 'valid_signature',
+          valid: true,
+        },
+        {
+          id: 'issuer_did_resolves',
+          valid: true,
+        },
+        {
+          id: 'expiration',
+          valid: true,
+        },
+      ],
+      results: [
+        {
+          log: [
+            {
+              id: 'valid_signature',
+              valid: true,
+            },
+            {
+              id: 'issuer_did_resolves',
+              valid: true,
+            },
+            {
+              id: 'expiration',
+              valid: true,
+            },
+          ],
+          proof: {
+            '@context': ['https://www.w3.org/2018/credentials/v1', 'https://purl.imsglobal.org/spec/ob/v3p0/context.json'],
+            created: '2023-05-06T00:57:07Z',
+            jws: 'eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..d3MzWbyiG-gWH4LV15waD7UXXDC9-qKqJpx1g7tOeSrw7TdDeIrzzP9xr-e93ppWN0oYflp1xBxHZaUU2b2SCQ',
+            proofPurpose: 'assertionMethod',
+            type: 'Ed25519Signature2018',
+            verificationMethod: 'did:key:z6MkrzXCdarP1kaZcJb3pmNi295wfxerDrmTqPv5c6MkP2r9#z6MkrzXCdarP1kaZcJb3pmNi295wfxerDrmTqPv5c6MkP2r9',
+          },
+          purposeResult: {
+            controller: {
+              assertionMethod: ['did:key:z6MkrzXCdarP1kaZcJb3pmNi295wfxerDrmTqPv5c6MkP2r9#z6MkrzXCdarP1kaZcJb3pmNi295wfxerDrmTqPv5c6MkP2r9'],
+              id: 'did:key:z6MkrzXCdarP1kaZcJb3pmNi295wfxerDrmTqPv5c6MkP2r9',
+              verificationMethod: [
+                {
+                  controller: 'did:key:z6MkrzXCdarP1kaZcJb3pmNi295wfxerDrmTqPv5c6MkP2r9',
+                  id: 'did:key:z6MkrzXCdarP1kaZcJb3pmNi295wfxerDrmTqPv5c6MkP2r9#z6MkrzXCdarP1kaZcJb3pmNi295wfxerDrmTqPv5c6MkP2r9',
+                  type: 'Ed25519VerificationKey2020',
+                },
+              ],
+            },
+            valid: true,
+          },
+          verificationMethod: {
+            controller: 'did:key:z6MkrzXCdarP1kaZcJb3pmNi295wfxerDrmTqPv5c6MkP2r9',
+            id: 'did:key:z6MkrzXCdarP1kaZcJb3pmNi295wfxerDrmTqPv5c6MkP2r9#z6MkrzXCdarP1kaZcJb3pmNi295wfxerDrmTqPv5c6MkP2r9',
+            // publicKeyBase58: 'DYGA3LbwgD66VokM9CQsB3XwrPNzoyX79P19mpPjTp4m',
+            type: 'Ed25519VerificationKey2020',
+          },
+          verified: true,
+        },
+      ],
+      verified: true,
+    })
+  })
+})

package/src/__tests__/fixtures/diwala.ts

@@ -0,0 +1,43 @@
+export const diwalaVC = {
+  '@context': ['https://www.w3.org/2018/credentials/v1', 'https://purl.imsglobal.org/spec/ob/v3p0/context.json'],
+  id: 'urn:uuid:04331fea-f92b-4fb5-9e04-838c9b39d154',
+  type: ['VerifiableCredential', 'OpenBadgeCredential'],
+  name: 'JFF x vc-edu PlugFest 2 Interoperability',
+  issuer: {
+    type: ['Profile'],
+    id: 'did:key:z6MkrzXCdarP1kaZcJb3pmNi295wfxerDrmTqPv5c6MkP2r9',
+    name: 'Jobs for the Future (JFF)',
+    url: 'https://www.jff.org/',
+    image: {
+      id: 'https://w3c-ccg.github.io/vc-ed/plugfest-1-2022/images/JFF_LogoLockup.png',
+      type: 'Image',
+    },
+  },
+  issuanceDate: '2023-05-06T00:57:07Z',
+  credentialSubject: {
+    type: ['AchievementSubject'],
+    id: 'did:key:z6MkrwRmStZZMf4mEkot8VnjtDX6VSfWyHeCj9nceCV3HyE9',
+    achievement: {
+      id: 'urn:uuid:94cc8fcf-b1be-481e-9105-682c37a307af',
+      type: ['Achievement'],
+      name: 'Diwala issued JFF x vc-edu PlugFest 2 Interoperability',
+      description:
+        'This credential solution supports the use of OBv3 and w3c Verifiable Credentials and is interoperable with at least two other solutions.  This was demonstrated successfully during JFF x vc-edu PlugFest 2.',
+      criteria: {
+        narrative:
+          'Solutions providers earned this badge by demonstrating interoperability between multiple providers based on the OBv3 candidate final standard, with some additional required fields. Credential issuers earning this badge successfully issued a credential into at least two wallets.  Wallet implementers earning this badge successfully displayed credentials issued by at least two different credential issuers.',
+      },
+      image: {
+        id: 'https://w3c-ccg.github.io/vc-ed/plugfest-2-2022/images/JFF-VC-EDU-PLUGFEST2-badge-image.png',
+        type: 'Image',
+      },
+    },
+  },
+  proof: {
+    type: 'Ed25519Signature2018',
+    created: '2023-05-06T00:57:07Z',
+    verificationMethod: 'did:key:z6MkrzXCdarP1kaZcJb3pmNi295wfxerDrmTqPv5c6MkP2r9#z6MkrzXCdarP1kaZcJb3pmNi295wfxerDrmTqPv5c6MkP2r9',
+    proofPurpose: 'assertionMethod',
+    jws: 'eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..d3MzWbyiG-gWH4LV15waD7UXXDC9-qKqJpx1g7tOeSrw7TdDeIrzzP9xr-e93ppWN0oYflp1xBxHZaUU2b2SCQ',
+  },
+}

package/src/__tests__/issue-verify-flow-statuslist.test.ts

@@ -0,0 +1,94 @@
+import { describe, expect, it, beforeAll } from 'vitest'
+import { IdentifierResolution, IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution'
+import { createNewStatusList } from '@sphereon/ssi-sdk.vc-status-list'
+import { StatusListType } from '@sphereon/ssi-types'
+import { createAgent, IDIDManager, IIdentifier, IKeyManager, IResolver, TAgent } from '@veramo/core'
+import { DIDManager, MemoryDIDStore } from '@veramo/did-manager'
+import { getDidKeyResolver, SphereonKeyDidProvider } from '@sphereon/ssi-sdk-ext.did-provider-key'
+import { DIDResolverPlugin } from '@veramo/did-resolver'
+import { MemoryKeyStore, MemoryPrivateKeyStore } from '@veramo/key-manager'
+import { Resolver } from 'did-resolver'
+import { CredentialProviderJsonld } from '../agent'
+import { LdDefaultContexts } from '../ld-default-contexts'
+import { SphereonEd25519Signature2018, SphereonEd25519Signature2020 } from '../suites'
+
+
+import { bedrijfsInformatieV1, exampleV1 } from './mocks'
+import { ContextDoc, IVcdmCredentialPlugin, VcdmCredentialPlugin } from '@sphereon/ssi-sdk.credential-vcdm'
+import { SphereonKeyManager } from '@sphereon/ssi-sdk-ext.key-manager'
+import { SphereonKeyManagementSystem } from '@sphereon/ssi-sdk-ext.kms-local'
+
+//jest.setTimeout(100000)
+
+const customContext = new Map<string, ContextDoc>([
+  [`https://www.w3.org/2018/credentials/examples/v1`, exampleV1],
+  ['https://sphereon-opensource.github.io/vc-contexts/myc/bedrijfsinformatie-v1.jsonld', bedrijfsInformatieV1],
+])
+
+describe('credential-LD full flow', () => {
+  let didKeyIdentifier: IIdentifier
+  let agent: TAgent<IResolver & IKeyManager & IDIDManager & IVcdmCredentialPlugin & IIdentifierResolution>
+
+  const jsonld = new CredentialProviderJsonld({
+    contextMaps: [LdDefaultContexts, customContext],
+    suites: [new SphereonEd25519Signature2018(), new SphereonEd25519Signature2020()],
+  })
+
+  beforeAll(async () => {
+    agent = createAgent({
+      plugins: [
+        new SphereonKeyManager({
+          store: new MemoryKeyStore(),
+          kms: {
+            local: new SphereonKeyManagementSystem(new MemoryPrivateKeyStore()),
+          },
+        }),
+        new DIDManager({
+          providers: {
+            'did:key': new SphereonKeyDidProvider({ defaultKms: 'local' }),
+          },
+          store: new MemoryDIDStore(),
+          defaultProvider: 'did:key',
+        }),
+        new DIDResolverPlugin({
+          resolver: new Resolver({
+            ...getDidKeyResolver(),
+          }),
+        }),
+        new IdentifierResolution({}),
+        new VcdmCredentialPlugin({issuers: [jsonld]})
+
+      ],
+    })
+    didKeyIdentifier = await agent.didManagerCreate({ options: { type: 'Ed25519' } })
+    console.log(JSON.stringify(didKeyIdentifier, null, 2))
+  })
+
+  it('create a new status list', async () => {
+    const statusList = await createNewStatusList(
+      {
+        type: StatusListType.StatusList2021,
+        proofFormat: 'lds',
+        id: 'http://localhost:9543/list1',
+        issuer: didKeyIdentifier.did,
+        length: 99999,
+        correlationId: '1234',
+        statusList2021: {
+          statusPurpose: 'revocation',
+          indexingDirection: 'rightToLeft',
+        },
+      },
+      { agent },
+    )
+    expect(statusList).toBeDefined()
+    expect(statusList.id).toEqual('http://localhost:9543/list1')
+    expect(statusList.encodedList).toBeDefined()
+    expect(statusList.issuer).toEqual(didKeyIdentifier.did)
+    expect(statusList.length).toEqual(99999)
+    expect(statusList.statusList2021).toBeTruthy()
+    expect(statusList.statusList2021!.indexingDirection).toEqual('rightToLeft')
+    expect(statusList.statusList2021!.statusPurpose).toEqual('revocation')
+    expect(statusList.proofFormat).toEqual('lds')
+    expect(statusList.statusListCredential).toBeDefined()
+  })
+})

package/src/__tests__/issue-verify-flow-vcdm2.test.ts

@@ -0,0 +1,268 @@
+import { beforeAll, describe, expect, it } from 'vitest'
+import { getDidKeyResolver, SphereonKeyDidProvider } from '@sphereon/ssi-sdk-ext.did-provider-key'
+import { IdentifierResolution, IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution'
+import { SphereonKeyManager } from '@sphereon/ssi-sdk-ext.key-manager'
+import { SphereonKeyManagementSystem } from '@sphereon/ssi-sdk-ext.kms-local'
+import { createAgent, CredentialPayload, IDIDManager, IIdentifier, IKeyManager, IResolver, PresentationPayload, TAgent } from '@veramo/core'
+import { DIDManager, MemoryDIDStore } from '@veramo/did-manager'
+import { DIDResolverPlugin } from '@veramo/did-resolver'
+import { MemoryKeyStore, MemoryPrivateKeyStore } from '@veramo/key-manager'
+import { Resolver } from 'did-resolver'
+import { CredentialProviderJsonld } from '../agent'
+import { LdDefaultContexts } from '../ld-default-contexts'
+import { SphereonEd25519Signature2020 } from '../suites'
+
+import { bedrijfsInformatieV1, exampleV1 } from './mocks'
+import { ContextDoc, IVcdmCredentialPlugin, VcdmCredentialPlugin } from '@sphereon/ssi-sdk.credential-vcdm'
+import { ControllerProofPurpose } from '../enums'
+
+const customContext = new Map<string, ContextDoc>([
+  [`https://www.w3.org/2018/credentials/examples/v1`, exampleV1],
+  ['https://sphereon-opensource.github.io/vc-contexts/myc/bedrijfsinformatie-v1.jsonld', bedrijfsInformatieV1],
+])
+
+describe('credential-LD full flow with VCDM2', () => {
+  let didKeyIdentifier: IIdentifier
+  let agent: TAgent<IResolver & IKeyManager & IDIDManager & IIdentifierResolution & IVcdmCredentialPlugin>
+  const jsonld = new CredentialProviderJsonld({
+    contextMaps: [LdDefaultContexts],
+    suites: [new SphereonEd25519Signature2020()],
+  })
+  // //jest.setTimeout(1000000)
+  beforeAll(async () => {
+    agent = createAgent({
+      plugins: [
+        new SphereonKeyManager({
+          store: new MemoryKeyStore(),
+          kms: {
+            local: new SphereonKeyManagementSystem(new MemoryPrivateKeyStore()),
+          },
+        }),
+        new IdentifierResolution({ crypto: global.crypto }),
+        new DIDManager({
+          providers: {
+            'did:key': new SphereonKeyDidProvider({ defaultKms: 'local' }),
+          },
+          store: new MemoryDIDStore(),
+          defaultProvider: 'did:key',
+        }),
+        new DIDResolverPlugin({
+          resolver: new Resolver({
+            ...getDidKeyResolver(),
+          }),
+        }),
+        new VcdmCredentialPlugin({ issuers: [jsonld] }),
+      ],
+    })
+    didKeyIdentifier = await agent.didManagerCreate({ provider: 'did:key', options: { type: 'Ed25519' } })
+    console.log('didKeyIdentifier', didKeyIdentifier.did)
+  })
+
+  it('should work with Ed25519Signature2020', async () => {
+    const credentialPayload: CredentialPayload = {
+      issuer: didKeyIdentifier.did,
+      type: ['VerifiableCredential', 'AlumniCredential'],
+      '@context': ['https://www.w3.org/ns/credentials/v2', 'https://www.w3.org/ns/credentials/examples/v2'],
+      issuanceDate: '2020-08-19T21:41:50Z',
+      credentialSubject: {
+        id: didKeyIdentifier.did,
+        mySubjectProperty: 'mySubjectValue',
+      },
+    }
+    const verifiableCredential = await agent.createVerifiableCredential({
+      credential: credentialPayload,
+      proofFormat: 'lds',
+      fetchRemoteContexts: true,
+    })
+    console.log(JSON.stringify(verifiableCredential, null, 2))
+
+    expect(verifiableCredential).toBeDefined()
+
+    const verifiedCredential = await agent.verifyCredential({
+      credential: verifiableCredential,
+      fetchRemoteContexts: true,
+    })
+
+    console.log(JSON.stringify(verifiedCredential, null, 2))
+
+    expect(verifiedCredential).toMatchObject({
+      log: [
+        {
+          id: 'valid_signature',
+          valid: true,
+        },
+        {
+          id: 'issuer_did_resolves',
+          valid: true,
+        },
+        {
+          id: 'expiration',
+          valid: true,
+        },
+      ],
+      results: [
+        {
+          log: [
+            {
+              id: 'valid_signature',
+              valid: true,
+            },
+            {
+              id: 'issuer_did_resolves',
+              valid: true,
+            },
+            {
+              id: 'expiration',
+              valid: true,
+            },
+          ],
+          proof: {
+            '@context': [
+              'https://www.w3.org/ns/credentials/v2',
+              'https://www.w3.org/ns/credentials/examples/v2',
+              'https://w3id.org/security/suites/ed25519-2020/v1',
+            ],
+            proofPurpose: 'assertionMethod',
+            type: 'Ed25519Signature2020',
+          },
+          purposeResult: {
+            controller: {
+              '@context': [
+                'https://www.w3.org/ns/did/v1',
+                'https://w3id.org/security/suites/ed25519-2020/v1',
+                'https://w3id.org/security/suites/x25519-2020/v1',
+              ],
+            },
+            valid: true,
+          },
+          verificationMethod: {
+            '@context': [
+              'https://www.w3.org/ns/did/v1',
+              'https://w3id.org/security/suites/ed25519-2020/v1',
+              'https://w3id.org/security/suites/x25519-2020/v1',
+            ],
+            type: 'Ed25519VerificationKey2020',
+          },
+          verified: true,
+        },
+      ],
+      verified: true,
+    })
+
+    const presentationPayload: PresentationPayload = {
+      holder: didKeyIdentifier.did,
+
+      verifiableCredential: [verifiableCredential],
+    }
+    const verifiablePresentation = await agent.createVerifiablePresentation({
+      keyRef: didKeyIdentifier.controllerKeyId,
+      proofFormat: 'lds',
+      presentation: presentationPayload,
+      // We are overriding the purpose since the DID in this test does not have an authentication proof purpose
+      purpose: new ControllerProofPurpose({ term: 'verificationMethod' }),
+    })
+
+    expect(verifiablePresentation).toBeDefined()
+
+    const verifiedPresentation = await agent.verifyPresentation({
+      presentation: verifiablePresentation,
+      fetchRemoteContexts: true,
+      // We are overriding the purpose since the DID in this test does not have an authentication proof purpose
+      presentationPurpose: new ControllerProofPurpose({ term: 'verificationMethod' }),
+    })
+
+    expect(verifiedPresentation).toMatchObject({
+      credentialResults: [
+        {
+          log: [
+            {
+              id: 'valid_signature',
+              valid: true,
+            },
+            {
+              id: 'issuer_did_resolves',
+              valid: true,
+            },
+            {
+              id: 'expiration',
+              valid: true,
+            },
+          ],
+          results: [
+            {
+              log: [
+                {
+                  id: 'valid_signature',
+                  valid: true,
+                },
+                {
+                  id: 'issuer_did_resolves',
+                  valid: true,
+                },
+                {
+                  id: 'expiration',
+                  valid: true,
+                },
+              ],
+              proof: {
+                '@context': [
+                  'https://www.w3.org/ns/credentials/v2',
+                  'https://www.w3.org/ns/credentials/examples/v2',
+                  'https://w3id.org/security/suites/ed25519-2020/v1',
+                ],
+                proofPurpose: 'assertionMethod',
+                type: 'Ed25519Signature2020',
+              },
+              purposeResult: {
+                valid: true,
+              },
+              verificationMethod: {
+                '@context': [
+                  'https://www.w3.org/ns/did/v1',
+                  'https://w3id.org/security/suites/ed25519-2020/v1',
+                  'https://w3id.org/security/suites/x25519-2020/v1',
+                ],
+
+                type: 'Ed25519VerificationKey2020',
+              },
+              verified: true,
+            },
+          ],
+          verified: true,
+        },
+      ],
+      presentationResult: {
+        results: [
+          {
+            proof: {
+              '@context': ['https://www.w3.org/ns/credentials/v2', 'https://w3id.org/security/suites/ed25519-2020/v1'],
+              proofPurpose: 'verificationMethod',
+              type: 'Ed25519Signature2020',
+            },
+            purposeResult: {
+              controller: {
+                '@context': [
+                  'https://www.w3.org/ns/did/v1',
+                  'https://w3id.org/security/suites/ed25519-2020/v1',
+                  'https://w3id.org/security/suites/x25519-2020/v1',
+                ],
+              },
+              valid: true,
+            },
+            verificationMethod: {
+              '@context': [
+                'https://www.w3.org/ns/did/v1',
+                'https://w3id.org/security/suites/ed25519-2020/v1',
+                'https://w3id.org/security/suites/x25519-2020/v1',
+              ],
+              type: 'Ed25519VerificationKey2020',
+            },
+            verified: true,
+          },
+        ],
+        verified: true,
+      },
+      verified: true,
+    })
+  })
+})