@veramo/credential-ld 3.1.1-next.8 → 3.1.2-next.101

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

@@ -0,0 +1,84 @@
+import {
+  createAgent,
+  CredentialPayload,
+  IDIDManager,
+  IIdentifier,
+  IKeyManager,
+  IResolver,
+  TAgent,
+} from '../../../core/src'
+import { CredentialIssuer, ICredentialIssuer } from '../../../credential-w3c/src'
+import { DIDManager, MemoryDIDStore } from '../../../did-manager/src'
+import { KeyManager, MemoryKeyStore, MemoryPrivateKeyStore } from '../../../key-manager/src'
+import { KeyManagementSystem } from '../../../kms-local/src'
+import { getDidKeyResolver, KeyDIDProvider } from '../../../did-provider-key/src'
+import { DIDResolverPlugin } from '../../../did-resolver/src'
+import { ContextDoc } from '../types'
+import { CredentialIssuerLD } from '../action-handler'
+import { LdDefaultContexts } from '../ld-default-contexts'
+import { VeramoEd25519Signature2018 } from '../suites/Ed25519Signature2018'
+import { Resolver } from 'did-resolver'
+
+const customContext: Record<string, ContextDoc> = {
+  'custom:example.context': {
+    '@context': {
+      nothing: 'custom:example.context#blank',
+    },
+  },
+}
+
+describe('credential-LD full flow', () => {
+  let didKeyIdentifier: IIdentifier
+  let agent: TAgent<IResolver & IKeyManager & IDIDManager & ICredentialIssuer>
+
+  beforeAll(async () => {
+    agent = createAgent({
+      plugins: [
+        new KeyManager({
+          store: new MemoryKeyStore(),
+          kms: {
+            local: new KeyManagementSystem(new MemoryPrivateKeyStore()),
+          },
+        }),
+        new DIDManager({
+          providers: {
+            'did:key': new KeyDIDProvider({ defaultKms: 'local' }),
+          },
+          store: new MemoryDIDStore(),
+          defaultProvider: 'did:key',
+        }),
+        new DIDResolverPlugin({
+          resolver: new Resolver({ ...getDidKeyResolver() }),
+        }),
+        new CredentialIssuer(),
+        new CredentialIssuerLD({
+          contextMaps: [LdDefaultContexts, customContext],
+          suites: [new VeramoEd25519Signature2018()],
+        }),
+      ],
+    })
+    didKeyIdentifier = await agent.didManagerCreate()
+  })
+
+  it('works with Ed25519Signature2018', async () => {
+    const credential: CredentialPayload = {
+      issuer: didKeyIdentifier.did,
+      '@context': ['custom:example.context'],
+      credentialSubject: {
+        nothing: 'else matters',
+      },
+    }
+    const verifiableCredential = await agent.createVerifiableCredential({
+      credential,
+      proofFormat: 'lds',
+    })
+
+    expect(verifiableCredential).toBeDefined()
+
+    const verified = await agent.verifyCredential({
+      credential: verifiableCredential,
+    })
+
+    expect(verified).toBe(true)
+  })
+})

package/src/action-handler.ts

@@ -183,7 +183,7 @@ export class CredentialIssuerLD implements IAgentPlugin {
     context: IRequiredContext,
   ): Promise<boolean> {
     const credential = args.credential
-    return this.ldCredentialModule.verifyCredential(credential, context)
+    return this.ldCredentialModule.verifyCredential(credential, args.fetchRemoteContexts || false, context)
   }
 
   /** {@inheritdoc ICredentialIssuerLD.verifyPresentationLD} */
@@ -192,7 +192,13 @@ export class CredentialIssuerLD implements IAgentPlugin {
     context: IRequiredContext,
   ): Promise<boolean> {
     const presentation = args.presentation
-    return this.ldCredentialModule.verifyPresentation(presentation, args.challenge, args.domain, context)
+    return this.ldCredentialModule.verifyPresentation(
+      presentation,
+      args.challenge,
+      args.domain,
+      args.fetchRemoteContexts || false,
+      context,
+    )
   }
 
   private async findSigningKeyWithId(

package/src/ld-context-loader.ts

@@ -1,19 +1,20 @@
 /**
- * The LdContextLoader is initialized with a List of Map<string, ContextDoc>
+ * The LdContextLoader is initialized with a List of Map<string, ContextDoc | Promise<ContextDoc>>
  * that it unifies into a single Map to provide to the documentLoader within
  * the w3c credential module.
  */
-import { OrPromise, RecordLike } from '@veramo/utils'
+import { isIterable, OrPromise, RecordLike } from '@veramo/utils'
 import { ContextDoc } from './types'
 
 export class LdContextLoader {
-  private contexts: Record<string, OrPromise<ContextDoc>>
+  private readonly contexts: Record<string, OrPromise<ContextDoc>>
 
   constructor(options: { contextsPaths: RecordLike<OrPromise<ContextDoc>>[] }) {
     this.contexts = {}
-    // generate-plugin-schema is failing unless we use the cast to `any[]`
-    Array.from(options.contextsPaths as any[], (mapItem) => {
-      for (const [key, value] of mapItem) {
+    Array.from(options.contextsPaths, (mapItem) => {
+      const map = isIterable(mapItem) ? mapItem : Object.entries(mapItem)
+      // generate-plugin-schema is failing unless we use the cast to `any[]`
+      for (const [key, value] of map as any[]) {
         this.contexts[key] = value
       }
     })

package/src/ld-credential-module.ts

@@ -7,6 +7,7 @@ import {
   VerifiableCredential,
   VerifiablePresentation,
 } from '@veramo/core'
+import fetch from 'cross-fetch'
 import Debug from 'debug'
 import { extendContextLoader, purposes } from 'jsonld-signatures'
 import * as vc from 'vc-js'
@@ -34,7 +35,7 @@ export class LdCredentialModule {
     this.ldSuiteLoader = options.ldSuiteLoader
   }
 
-  getDocumentLoader(context: IAgentContext<IResolver>) {
+  getDocumentLoader(context: IAgentContext<IResolver>, attemptToFetchContexts: boolean = false) {
     return extendContextLoader(async (url: string) => {
       // console.log(`resolving context for: ${url}`)
 
@@ -65,10 +66,29 @@ export class LdCredentialModule {
           documentUrl: url,
           document: contextDoc,
         }
+      } else {
+        if (attemptToFetchContexts) {
+          // attempt to fetch the remote context!!!! MEGA FAIL for JSON-LD.
+          debug('WARNING: attempting to fetch the doc directly for ', url)
+          try {
+            const response = await fetch(url)
+            if (response.status === 200) {
+              const document = await response.json()
+              return {
+                contextUrl: null,
+                documentUrl: url,
+                document,
+              }
+            }
+          } catch (e) {
+            debug('WARNING: unable to fetch the doc or interpret it as JSON', e)
+          }
+        }
       }
 
-      debug('WARNING: Possible unknown context/identifier for', url)
-      console.log(`WARNING: Possible unknown context/identifier for: ${url}`)
+      debug(
+        `WARNING: Possible unknown context/identifier for ${url} \n falling back to default documentLoader`,
+      )
 
       return vc.defaultDocumentLoader(url)
     })
@@ -122,14 +142,26 @@ export class LdCredentialModule {
 
   async verifyCredential(
     credential: VerifiableCredential,
+    fetchRemoteContexts: boolean = false,
     context: IAgentContext<IResolver>,
   ): Promise<boolean> {
+    const checkStatusFn =
+      typeof context.agent.checkCredentialStatus === 'function'
+        ? async ({ credential }: any) => {
+            const result = await context.agent.checkCredentialStatus({
+              credential,
+            })
+            return { verified: !result.revoked }
+          }
+        : void 0
+
     const result = await vc.verifyCredential({
       credential,
       suite: this.ldSuiteLoader.getAllSignatureSuites().map((x) => x.getSuiteForVerification()),
-      documentLoader: this.getDocumentLoader(context),
+      documentLoader: this.getDocumentLoader(context, fetchRemoteContexts),
       purpose: new AssertionProofPurpose(),
       compactProof: false,
+      checkStatus: checkStatusFn,
     })
 
     if (result.verified) return true
@@ -146,12 +178,13 @@ export class LdCredentialModule {
     presentation: VerifiablePresentation,
     challenge: string | undefined,
     domain: string | undefined,
+    fetchRemoteContexts: boolean = false,
     context: IAgentContext<IResolver>,
   ): Promise<boolean> {
     const result = await vc.verify({
       presentation,
       suite: this.ldSuiteLoader.getAllSignatureSuites().map((x) => x.getSuiteForVerification()),
-      documentLoader: this.getDocumentLoader(context),
+      documentLoader: this.getDocumentLoader(context, fetchRemoteContexts),
       challenge,
       domain,
       purpose: new AssertionProofPurpose(),

package/src/ld-default-contexts.ts

@@ -1,21 +1,25 @@
-import * as fs from 'fs'
-import * as path from 'path'
+import { ContextDoc } from './types'
 
-function _read(_path: string) {
-  return JSON.parse(fs.readFileSync(path.join(__dirname, '../contexts', _path), { encoding: 'utf8' }))
+async function _read(_path: string): Promise<ContextDoc> {
+  return await import('../contexts/' + _path);
 }
 
+/**
+ * Provides a hardcoded map of common context definitions
+ */
 export const LdDefaultContexts = new Map([
-  ['https://veramo.io/contexts/socialmedia/v1', _read('socialmedia-v1.jsonld')],
-  ['https://veramo.io/contexts/kyc/v1', _read('kyc-v1.jsonld')],
-  ['https://veramo.io/contexts/profile/v1', _read('profile-v1.jsonld')],
-  ['https://www.w3.org/ns/did/v1', _read('security_context_v1.jsonld')],
-  ['https://w3id.org/did/v0.11', _read('did_v0.11.jsonld')],
-  ['https://ns.did.ai/transmute/v1', _read('transmute_v1.jsonld')],
+  ['https://www.w3.org/2018/credentials/v1', _read('w3_2018_credentials_v1.json')],
+  ['https://www.w3.org/ns/did/v1', _read('security_context_v1.json')],
+  ['https://w3id.org/did/v0.11', _read('did_v0.11.json')],
+
+  ['https://veramo.io/contexts/socialmedia/v1', _read('socialmedia-v1.json')],
+  ['https://veramo.io/contexts/kyc/v1', _read('kyc-v1.json')],
+  ['https://veramo.io/contexts/profile/v1', _read('profile-v1.json')],
+  ['https://ns.did.ai/transmute/v1', _read('transmute_v1.json')],
   [
     'https://identity.foundation/EcdsaSecp256k1RecoverySignature2020/lds-ecdsa-secp256k1-recovery2020-0.0.jsonld',
-    _read('lds-ecdsa-secp256k1-recovery2020-0.0.jsonld'),
+    _read('lds-ecdsa-secp256k1-recovery2020-0.0.json'),
   ],
-  ['https://w3id.org/security/suites/ed25519-2018/v1', _read('ed25519-signature-2018-v1.jsonld')],
-  ['https://w3id.org/security/suites/x25519-2019/v1', _read('X25519KeyAgreementKey2019.jsonld')],
+  ['https://w3id.org/security/suites/ed25519-2018/v1', _read('ed25519-signature-2018-v1.json')],
+  ['https://w3id.org/security/suites/x25519-2019/v1', _read('X25519KeyAgreementKey2019.json')],
 ])

package/src/types.ts

@@ -161,6 +161,13 @@ export interface IVerifyCredentialLDArgs {
    *
    */
   credential: VerifiableCredential
+
+  /**
+   * Set this to true if you want the '@context' URLs to be fetched in case they are not pre-loaded.
+   *
+   * @default false
+   */
+  fetchRemoteContexts?: boolean
 }
 
 /**
@@ -189,6 +196,13 @@ export interface IVerifyPresentationLDArgs {
    * Optional (only for JWT) string domain parameter to verify the verifiable presentation against
    */
   domain?: string
+
+  /**
+   * Set this to true if you want the '@context' URLs to be fetched in case they are not pre-loaded.
+   *
+   * @default false
+   */
+  fetchRemoteContexts?: boolean
 }
 
 /**