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

package/contexts/security_context_v1.jsonld

@@ -0,0 +1,58 @@
+{
+  "@context": {
+    "@protected": true,
+    "id": "@id",
+    "type": "@type",
+
+    "alsoKnownAs": {
+      "@id": "https://www.w3.org/ns/activitystreams#alsoKnownAs",
+      "@type": "@id"
+    },
+    "assertionMethod": {
+      "@id": "https://w3id.org/security#assertionMethod",
+      "@type": "@id",
+      "@container": "@set"
+    },
+    "authentication": {
+      "@id": "https://w3id.org/security#authenticationMethod",
+      "@type": "@id",
+      "@container": "@set"
+    },
+    "capabilityDelegation": {
+      "@id": "https://w3id.org/security#capabilityDelegationMethod",
+      "@type": "@id",
+      "@container": "@set"
+    },
+    "capabilityInvocation": {
+      "@id": "https://w3id.org/security#capabilityInvocationMethod",
+      "@type": "@id",
+      "@container": "@set"
+    },
+    "controller": {
+      "@id": "https://w3id.org/security#controller",
+      "@type": "@id"
+    },
+    "keyAgreement": {
+      "@id": "https://w3id.org/security#keyAgreementMethod",
+      "@type": "@id",
+      "@container": "@set"
+    },
+    "service": {
+      "@id": "https://www.w3.org/ns/did#service",
+      "@type": "@id",
+      "@context": {
+        "@protected": true,
+        "id": "@id",
+        "type": "@type",
+        "serviceEndpoint": {
+          "@id": "https://www.w3.org/ns/did#serviceEndpoint",
+          "@type": "@id"
+        }
+      }
+    },
+    "verificationMethod": {
+      "@id": "https://w3id.org/security#verificationMethod",
+      "@type": "@id"
+    }
+  }
+}

package/contexts/socialmedia-v1.jsonld

@@ -0,0 +1,7 @@
+{
+  "@context": {
+      "@version": 1.1,
+      "@protected": true,
+      "VerifableSocialMediaPosting": "https://veramo.io/contexts/socialmedia#VerifableSocialMediaPosting"
+  }
+}

package/contexts/transmute_v1.jsonld

@@ -0,0 +1,21 @@
+{
+  "@context": [
+    {
+      "@version": 1.1
+    },
+    "https://www.w3.org/ns/did/v1",
+    {
+      "JsonWebKey2020": "https://w3id.org/security#JsonWebKey2020",
+      "Ed25519VerificationKey2018": "https://w3id.org/security#Ed25519VerificationKey2018",
+      "X25519KeyAgreementKey2019": "https://w3id.org/security#X25519KeyAgreementKey2019",
+
+      "publicKeyJwk": {
+        "@id": "https://w3id.org/security#publicKeyJwk",
+        "@type": "@json"
+      },
+      "publicKeyBase58": {
+        "@id": "https://w3id.org/security#publicKeyBase58"
+      }
+    }
+  ]
+}

package/contexts/w3_2018_credentials_v1.jsonld

@@ -0,0 +1,237 @@
+{
+  "@context": {
+    "@version": 1.1,
+    "@protected": true,
+
+    "id": "@id",
+    "type": "@type",
+
+    "VerifiableCredential": {
+      "@id": "https://www.w3.org/2018/credentials#VerifiableCredential",
+      "@context": {
+        "@version": 1.1,
+        "@protected": true,
+
+        "id": "@id",
+        "type": "@type",
+
+        "cred": "https://www.w3.org/2018/credentials#",
+        "sec": "https://w3id.org/security#",
+        "xsd": "http://www.w3.org/2001/XMLSchema#",
+
+        "credentialSchema": {
+          "@id": "cred:credentialSchema",
+          "@type": "@id",
+          "@context": {
+            "@version": 1.1,
+            "@protected": true,
+
+            "id": "@id",
+            "type": "@type",
+
+            "cred": "https://www.w3.org/2018/credentials#",
+
+            "JsonSchemaValidator2018": "cred:JsonSchemaValidator2018"
+          }
+        },
+        "credentialStatus": {"@id": "cred:credentialStatus", "@type": "@id"},
+        "credentialSubject": {"@id": "cred:credentialSubject", "@type": "@id"},
+        "evidence": {"@id": "cred:evidence", "@type": "@id"},
+        "expirationDate": {"@id": "cred:expirationDate", "@type": "xsd:dateTime"},
+        "holder": {"@id": "cred:holder", "@type": "@id"},
+        "issued": {"@id": "cred:issued", "@type": "xsd:dateTime"},
+        "issuer": {"@id": "cred:issuer", "@type": "@id"},
+        "issuanceDate": {"@id": "cred:issuanceDate", "@type": "xsd:dateTime"},
+        "proof": {"@id": "sec:proof", "@type": "@id", "@container": "@graph"},
+        "refreshService": {
+          "@id": "cred:refreshService",
+          "@type": "@id",
+          "@context": {
+            "@version": 1.1,
+            "@protected": true,
+
+            "id": "@id",
+            "type": "@type",
+
+            "cred": "https://www.w3.org/2018/credentials#",
+
+            "ManualRefreshService2018": "cred:ManualRefreshService2018"
+          }
+        },
+        "termsOfUse": {"@id": "cred:termsOfUse", "@type": "@id"},
+        "validFrom": {"@id": "cred:validFrom", "@type": "xsd:dateTime"},
+        "validUntil": {"@id": "cred:validUntil", "@type": "xsd:dateTime"}
+      }
+    },
+
+    "VerifiablePresentation": {
+      "@id": "https://www.w3.org/2018/credentials#VerifiablePresentation",
+      "@context": {
+        "@version": 1.1,
+        "@protected": true,
+
+        "id": "@id",
+        "type": "@type",
+
+        "cred": "https://www.w3.org/2018/credentials#",
+        "sec": "https://w3id.org/security#",
+
+        "holder": {"@id": "cred:holder", "@type": "@id"},
+        "proof": {"@id": "sec:proof", "@type": "@id", "@container": "@graph"},
+        "verifiableCredential": {"@id": "cred:verifiableCredential", "@type": "@id", "@container": "@graph"}
+      }
+    },
+
+    "EcdsaSecp256k1Signature2019": {
+      "@id": "https://w3id.org/security#EcdsaSecp256k1Signature2019",
+      "@context": {
+        "@version": 1.1,
+        "@protected": true,
+
+        "id": "@id",
+        "type": "@type",
+
+        "sec": "https://w3id.org/security#",
+        "xsd": "http://www.w3.org/2001/XMLSchema#",
+
+        "challenge": "sec:challenge",
+        "created": {"@id": "http://purl.org/dc/terms/created", "@type": "xsd:dateTime"},
+        "domain": "sec:domain",
+        "expires": {"@id": "sec:expiration", "@type": "xsd:dateTime"},
+        "jws": "sec:jws",
+        "nonce": "sec:nonce",
+        "proofPurpose": {
+          "@id": "sec:proofPurpose",
+          "@type": "@vocab",
+          "@context": {
+            "@version": 1.1,
+            "@protected": true,
+
+            "id": "@id",
+            "type": "@type",
+
+            "sec": "https://w3id.org/security#",
+
+            "assertionMethod": {"@id": "sec:assertionMethod", "@type": "@id", "@container": "@set"},
+            "authentication": {"@id": "sec:authenticationMethod", "@type": "@id", "@container": "@set"}
+          }
+        },
+        "proofValue": "sec:proofValue",
+        "verificationMethod": {"@id": "sec:verificationMethod", "@type": "@id"}
+      }
+    },
+
+    "EcdsaSecp256r1Signature2019": {
+      "@id": "https://w3id.org/security#EcdsaSecp256r1Signature2019",
+      "@context": {
+        "@version": 1.1,
+        "@protected": true,
+
+        "id": "@id",
+        "type": "@type",
+
+        "sec": "https://w3id.org/security#",
+        "xsd": "http://www.w3.org/2001/XMLSchema#",
+
+        "challenge": "sec:challenge",
+        "created": {"@id": "http://purl.org/dc/terms/created", "@type": "xsd:dateTime"},
+        "domain": "sec:domain",
+        "expires": {"@id": "sec:expiration", "@type": "xsd:dateTime"},
+        "jws": "sec:jws",
+        "nonce": "sec:nonce",
+        "proofPurpose": {
+          "@id": "sec:proofPurpose",
+          "@type": "@vocab",
+          "@context": {
+            "@version": 1.1,
+            "@protected": true,
+
+            "id": "@id",
+            "type": "@type",
+
+            "sec": "https://w3id.org/security#",
+
+            "assertionMethod": {"@id": "sec:assertionMethod", "@type": "@id", "@container": "@set"},
+            "authentication": {"@id": "sec:authenticationMethod", "@type": "@id", "@container": "@set"}
+          }
+        },
+        "proofValue": "sec:proofValue",
+        "verificationMethod": {"@id": "sec:verificationMethod", "@type": "@id"}
+      }
+    },
+
+    "Ed25519Signature2018": {
+      "@id": "https://w3id.org/security#Ed25519Signature2018",
+      "@context": {
+        "@version": 1.1,
+        "@protected": true,
+
+        "id": "@id",
+        "type": "@type",
+
+        "sec": "https://w3id.org/security#",
+        "xsd": "http://www.w3.org/2001/XMLSchema#",
+
+        "challenge": "sec:challenge",
+        "created": {"@id": "http://purl.org/dc/terms/created", "@type": "xsd:dateTime"},
+        "domain": "sec:domain",
+        "expires": {"@id": "sec:expiration", "@type": "xsd:dateTime"},
+        "jws": "sec:jws",
+        "nonce": "sec:nonce",
+        "proofPurpose": {
+          "@id": "sec:proofPurpose",
+          "@type": "@vocab",
+          "@context": {
+            "@version": 1.1,
+            "@protected": true,
+
+            "id": "@id",
+            "type": "@type",
+
+            "sec": "https://w3id.org/security#",
+
+            "assertionMethod": {"@id": "sec:assertionMethod", "@type": "@id", "@container": "@set"},
+            "authentication": {"@id": "sec:authenticationMethod", "@type": "@id", "@container": "@set"}
+          }
+        },
+        "proofValue": "sec:proofValue",
+        "verificationMethod": {"@id": "sec:verificationMethod", "@type": "@id"}
+      }
+    },
+
+    "RsaSignature2018": {
+      "@id": "https://w3id.org/security#RsaSignature2018",
+      "@context": {
+        "@version": 1.1,
+        "@protected": true,
+
+        "challenge": "sec:challenge",
+        "created": {"@id": "http://purl.org/dc/terms/created", "@type": "xsd:dateTime"},
+        "domain": "sec:domain",
+        "expires": {"@id": "sec:expiration", "@type": "xsd:dateTime"},
+        "jws": "sec:jws",
+        "nonce": "sec:nonce",
+        "proofPurpose": {
+          "@id": "sec:proofPurpose",
+          "@type": "@vocab",
+          "@context": {
+            "@version": 1.1,
+            "@protected": true,
+
+            "id": "@id",
+            "type": "@type",
+
+            "sec": "https://w3id.org/security#",
+
+            "assertionMethod": {"@id": "sec:assertionMethod", "@type": "@id", "@container": "@set"},
+            "authentication": {"@id": "sec:authenticationMethod", "@type": "@id", "@container": "@set"}
+          }
+        },
+        "proofValue": "sec:proofValue",
+        "verificationMethod": {"@id": "sec:verificationMethod", "@type": "@id"}
+      }
+    },
+
+    "proof": {"@id": "https://w3id.org/security#proof", "@type": "@id", "@container": "@graph"}
+  }
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@veramo/credential-ld",
   "description": "Veramo plugin for working with W3C JSON-LD Verifiable Credentials & Presentations.",
-  "version": "3.1.1-next.8+18c2226e",
+  "version": "3.1.2-next.30+ea7641e4",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "scripts": {
@@ -14,27 +14,28 @@
     }
   },
   "dependencies": {
-    "@transmute/credentials-context": "^0.7.0-unstable.26",
-    "@transmute/ed25519-signature-2018": "^0.7.0-unstable.27",
+    "@transmute/credentials-context": "^0.7.0-unstable.34",
+    "@transmute/ed25519-signature-2018": "^0.7.0-unstable.34",
     "@transmute/lds-ecdsa-secp256k1-recovery2020": "^0.0.7",
-    "@veramo/core": "^3.1.1-next.8+18c2226e",
-    "@veramo/did-resolver": "^3.1.1-next.8+18c2226e",
-    "@veramo/utils": "^3.1.1-next.8+18c2226e",
-    "debug": "^4.1.1",
-    "did-resolver": "3.1.3",
+    "@veramo/core": "^3.1.2-next.30+ea7641e4",
+    "@veramo/did-resolver": "^3.1.2-next.30+ea7641e4",
+    "@veramo/utils": "^3.1.2-next.30+ea7641e4",
+    "debug": "^4.3.3",
+    "did-resolver": "^3.1.5",
     "jsonld": "^5.2.0",
-    "jsonld-signatures": "^9.0.2",
-    "uint8arrays": "^2.1.3",
+    "jsonld-signatures": "^9.3.1",
+    "uint8arrays": "^3.0.0",
     "vc-js": "^0.6.4"
   },
   "devDependencies": {
     "@types/debug": "4.1.7",
-    "borc": "^3.0.0",
-    "typescript": "4.4.4"
+    "borc": "3.0.0",
+    "typescript": "4.5.4"
   },
   "files": [
     "build/**/*",
     "src/**/*",
+    "contexts/**/*.jsonld",
     "plugin.schema.json",
     "README.md",
     "LICENSE"
@@ -46,5 +47,5 @@
   "author": "Mircea Nistor <mircea.nistor@mesh.xyz>",
   "license": "Apache-2.0",
   "keywords": [],
-  "gitHead": "18c2226e375925446be8c1d15cd5bab4387b8d79"
+  "gitHead": "ea7641e4e21da0fc02535848c40ff81e644c069e"
 }

package/plugin.schema.json

@@ -326,6 +326,11 @@
             "credential": {
               "$ref": "#/components/schemas/VerifiableCredential",
               "description": "The json payload of the Credential according to the\n {@link  https://www.w3.org/TR/vc-data-model/#credentials | canonical model } \n\nThe signer of the Credential is chosen based on the `issuer.id` property of the `credential`"
+            },
+            "fetchRemoteContexts": {
+              "type": "boolean",
+              "description": "Set this to true if you want the '@context' URLs to be fetched in case they are not pre-loaded.",
+              "default": false
             }
           },
           "required": [
@@ -347,6 +352,11 @@
             "domain": {
               "type": "string",
               "description": "Optional (only for JWT) string domain parameter to verify the verifiable presentation against"
+            },
+            "fetchRemoteContexts": {
+              "type": "boolean",
+              "description": "Set this to true if you want the '@context' URLs to be fetched in case they are not pre-loaded.",
+              "default": false
             }
           },
           "required": [

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

@@ -0,0 +1,39 @@
+import { ContextDoc } from '../types'
+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('loads 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('loads 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__/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,7 @@ 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,27 @@ 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,12 +140,13 @@ export class LdCredentialModule {
 
   async verifyCredential(
     credential: VerifiableCredential,
+    fetchRemoteContexts: boolean = false,
     context: IAgentContext<IResolver>,
   ): Promise<boolean> {
     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,
     })
@@ -146,12 +165,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(),