@bedrock/vc-delivery 4.7.0 → 5.0.0

package/lib/helpers.js

@@ -3,6 +3,7 @@
  */
 import * as bedrock from '@bedrock/core';
 import {decodeId, generateId} from 'bnid';
+import {decodeJwt} from 'jose';
 import {Ed25519Signature2020} from '@digitalbazaar/ed25519-signature-2020';
 import {httpsAgent} from '@bedrock/https-agent';
 import jsonata from 'jsonata';
@@ -102,3 +103,30 @@ export function decodeLocalId({localId} = {}) {
     expectedSize: 16
   }));
 }
+
+export async function unenvelopeCredential({envelopedCredential} = {}) {
+  let credential;
+  const {id} = envelopedCredential;
+  if(id?.startsWith('data:application/jwt,')) {
+    const format = 'application/jwt';
+    const jwt = id.slice('data:application/jwt,'.length);
+    const claimset = decodeJwt(jwt);
+    // FIXME: perform various field mappings as needed
+    console.log('VC-JWT claimset', credential);
+    return {credential: claimset.vc, format};
+  }
+  throw new Error('Not implemented.');
+}
+
+export async function unenvelopePresentation({envelopedPresentation} = {}) {
+  const {id} = envelopedPresentation;
+  if(id?.startsWith('data:application/jwt,')) {
+    const format = 'application/jwt';
+    const jwt = id.slice('data:application/jwt,'.length);
+    const claimset = decodeJwt(jwt);
+    // FIXME: perform various field mappings as needed
+    console.log('VC-JWT claimset', claimset);
+    return {presentation: claimset.vp, format};
+  }
+  throw new Error('Not implemented.');
+}

package/lib/openId.js

@@ -4,7 +4,7 @@
 import * as bedrock from '@bedrock/core';
 import * as exchanges from './exchanges.js';
 import {
-  compile, schemas, createValidateMiddleware as validate
+  compile, createValidateMiddleware as validate
 } from '@bedrock/validation';
 import {evaluateTemplate, getWorkflowIssuerInstances} from './helpers.js';
 import {importJWK, SignJWT} from 'jose';
@@ -13,7 +13,8 @@ import {
   openIdBatchCredentialBody,
   openIdCredentialBody,
   openIdTokenBody,
-  presentationSubmission as presentationSubmissionSchema
+  presentationSubmission as presentationSubmissionSchema,
+  verifiablePresentation as verifiablePresentationSchema
 } from '../schemas/bedrock-vc-workflow.js';
 import {verify, verifyDidProofJwt} from './verify.js';
 import {asyncHandler} from '@bedrock/express';
@@ -84,7 +85,7 @@ export async function createRoutes({
 
   // create validators for x-www-form-urlencoded parsed data
   const validatePresentation = compile(
-    {schema: schemas.verifiablePresentation()});
+    {schema: verifiablePresentationSchema()});
   const validatePresentationSubmission = compile(
     {schema: presentationSubmissionSchema});
 
@@ -916,6 +917,22 @@ async function _processAuthorizationResponse({
   const {authorizationRequest, step} = arRequest;
   ({exchange} = arRequest);
 
+  // FIXME: if the VP is enveloped, remove the envelope to validate or
+  // run validation code after verification if necessary
+
+  // FIXME: check the VP against the presentation submission if requested
+  // FIXME: check the VP against "trustedIssuer" in VPR, if provided
+  const {presentationSchema} = step;
+  if(presentationSchema) {
+    // validate the received VP
+    const {jsonSchema: schema} = presentationSchema;
+    const validate = compile({schema});
+    const {valid, error} = validate(presentation);
+    if(!valid) {
+      throw error;
+    }
+  }
+
   // verify the received VP
   const {verifiablePresentationRequest} = await oid4vp.toVpr(
     {authorizationRequest});
@@ -928,9 +945,6 @@ async function _processAuthorizationResponse({
     expectedChallenge: authorizationRequest.nonce
   });
 
-  // FIXME: check the VP against the presentation submission if requested
-  // FIXME: check the VP against "trustedIssuer" in VPR, if provided
-
   // store VP results in variables associated with current step
   const currentStep = exchange.step;
   if(!exchange.variables.results) {

package/lib/vcapi.js

@@ -4,6 +4,7 @@
 import * as bedrock from '@bedrock/core';
 import * as exchanges from './exchanges.js';
 import {createChallenge as _createChallenge, verify} from './verify.js';
+import {compile} from '@bedrock/validation';
 import {evaluateTemplate} from './helpers.js';
 import {issue} from './issue.js';
 import {klona} from 'klona';
@@ -95,6 +96,20 @@ export async function processExchange({req, res, workflow, exchange}) {
         return;
       }
 
+      // FIXME: if the VP is enveloped, remove the envelope to validate or
+      // run validation code after verification if necessary
+
+      const {presentationSchema} = step;
+      if(presentationSchema) {
+        // validate the received VP
+        const {jsonSchema: schema} = presentationSchema;
+        const validate = compile({schema});
+        const {valid, error} = validate(receivedPresentation);
+        if(!valid) {
+          throw error;
+        }
+      }
+
       // verify the received VP
       const expectedChallenge = isInitialStep ? exchange.id : undefined;
       const {allowUnprotectedPresentation = false} = step;

package/lib/verify.js

@@ -2,6 +2,7 @@
  * Copyright (c) 2022-2024 Digital Bazaar, Inc. All rights reserved.
  */
 import * as bedrock from '@bedrock/core';
+import * as EcdsaMultikey from '@digitalbazaar/ecdsa-multikey';
 import * as Ed25519Multikey from '@digitalbazaar/ed25519-multikey';
 import {importJWK, jwtVerify} from 'jose';
 import {didIo} from '@bedrock/did-io';
@@ -9,6 +10,10 @@ import {getZcapClient} from './helpers.js';
 
 const {util: {BedrockError}} = bedrock;
 
+// supported JWT algs
+const ECDSA_ALGS = ['ES256', 'ES384'];
+const EDDSA_ALGS = ['Ed25519', 'EdDSA'];
+
 export async function createChallenge({workflow} = {}) {
   // create zcap client for creating challenges
   const {zcapClient, zcaps} = await getZcapClient({workflow});
@@ -134,23 +139,50 @@ export async function verifyDidProofJwt({workflow, exchange, jwt} = {}) {
   const audience = exchangeId;
 
   let issuer;
-  const resolveKey = async protectedHeader => {
-    const vm = await didIo.get({url: protectedHeader.kid});
+  // `resolveKey` is passed `protectedHeader`
+  const resolveKey = async ({alg, kid}) => {
+    const isEcdsa = ECDSA_ALGS.includes(alg);
+    const isEddsa = !isEcdsa && EDDSA_ALGS.includes(alg);
+    if(!(isEcdsa || isEddsa)) {
+      throw new BedrockError(
+        `Unsupported JWT "alg": "${alg}".`, {
+          name: 'DataError',
+          details: {
+            httpStatusCode: 400,
+            public: true
+          }
+        });
+    }
+
+    const vm = await didIo.get({url: kid});
     // `vm.controller` must be the issuer of the DID JWT; also ensure that
     // the specified controller authorized `vm` for the purpose of
     // authentication
     issuer = vm.controller;
     const didDoc = await didIo.get({url: issuer});
-    if(!(didDoc?.authentication?.some(e => e === vm.id || e.id === vm.id))) {
+    let match = didDoc?.authentication?.find?.(
+      e => e === vm.id || e.id === vm.id);
+    if(typeof match === 'string') {
+      match = didDoc?.verificationMethod?.find?.(e => e.id === vm.id);
+    }
+    if(!(match && Array.isArray(match.controller) ?
+      match.controller.includes(vm.controller) :
+      match.controller === vm.controller)) {
       throw new BedrockError(
         `Verification method controller "${issuer}" did not authorize ` +
         `verification method "${vm.id}" for the purpose of "authentication".`,
         {name: 'NotAllowedError'});
     }
-    // FIXME: support other key types
-    const keyPair = await Ed25519Multikey.from(vm);
-    const jwk = await Ed25519Multikey.toJwk({keyPair});
-    jwk.alg = 'EdDSA';
+    let jwk;
+    if(isEcdsa) {
+      const keyPair = await EcdsaMultikey.from(vm);
+      jwk = await EcdsaMultikey.toJwk({keyPair});
+      jwk.alg = alg;
+    } else {
+      const keyPair = await Ed25519Multikey.from(vm);
+      jwk = await Ed25519Multikey.toJwk({keyPair});
+      jwk.alg = 'EdDSA';
+    }
     return importJWK(jwk);
   };
 
@@ -186,7 +218,7 @@ export async function verifyDidProofJwt({workflow, exchange, jwt} = {}) {
   }
 
   // check `iss` claim
-  if(!(verifyResult?.payload?.iss === issuer)) {
+  if(!(issuer && verifyResult?.payload?.iss === issuer)) {
     throw new BedrockError('DID proof JWT validation failed.', {
       name: 'NotAllowedError',
       details: {
@@ -200,7 +232,7 @@ export async function verifyDidProofJwt({workflow, exchange, jwt} = {}) {
   }
 
   // check `nonce` claim
-  if(!(verifyResult?.payload?.nonce === exchange.id)) {
+  if(verifyResult?.payload?.nonce !== exchange.id) {
     throw new BedrockError('DID proof JWT validation failed.', {
       name: 'NotAllowedError',
       details: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrock/vc-delivery",
-  "version": "4.7.0",
+  "version": "5.0.0",
   "type": "module",
   "description": "Bedrock Verifiable Credential Delivery",
   "main": "./lib/index.js",
@@ -9,7 +9,7 @@
     "schemas/**/*.js"
   ],
   "scripts": {
-    "lint": "eslint ."
+    "lint": "eslint --ext .cjs,.js ."
   },
   "repository": {
     "type": "git",
@@ -35,41 +35,40 @@
   },
   "homepage": "https://github.com/digitalbazaar/bedrock-vc-delivery",
   "dependencies": {
+    "@digitalbazaar/ecdsa-multikey": "^1.7.0",
     "@digitalbazaar/ed25519-multikey": "^1.1.0",
-    "@digitalbazaar/ed25519-signature-2020": "^5.2.0",
-    "@digitalbazaar/ezcap": "^4.0.0",
-    "@digitalbazaar/oid4-client": "^3.1.0",
-    "@digitalbazaar/vc": "^6.0.1",
+    "@digitalbazaar/ed25519-signature-2020": "^5.4.0",
+    "@digitalbazaar/ezcap": "^4.1.0",
+    "@digitalbazaar/oid4-client": "^3.4.1",
+    "@digitalbazaar/vc": "^7.0.0",
     "assert-plus": "^1.0.0",
     "bnid": "^3.0.0",
-    "body-parser": "^1.20.1",
+    "body-parser": "^1.20.2",
     "cors": "^2.8.5",
-    "jose": "^4.10.4",
-    "jsonata": "^2.0.3",
-    "klona": "^2.0.5"
+    "jose": "^5.6.3",
+    "jsonata": "^2.0.5",
+    "klona": "^2.0.6"
   },
   "peerDependencies": {
     "@bedrock/app-identity": "4.0.0",
-    "@bedrock/core": "^6.0.1",
-    "@bedrock/did-io": "^10.0.0",
-    "@bedrock/express": "^8.0.0",
-    "@bedrock/https-agent": "^4.0.0",
-    "@bedrock/mongodb": "^10.0.0",
-    "@bedrock/oauth2-verifier": "^2.0.0",
-    "@bedrock/service-agent": "^8.0.0",
-    "@bedrock/service-core": "^9.0.0",
+    "@bedrock/core": "^6.1.3",
+    "@bedrock/did-io": "^10.3.1",
+    "@bedrock/express": "^8.3.1",
+    "@bedrock/https-agent": "^4.1.0",
+    "@bedrock/mongodb": "^10.2.0",
+    "@bedrock/oauth2-verifier": "^2.1.0",
+    "@bedrock/service-agent": "^9.0.2",
+    "@bedrock/service-core": "^10.0.0",
     "@bedrock/validation": "^7.1.0"
   },
   "directories": {
     "lib": "./lib"
   },
   "devDependencies": {
-    "eslint": "^8.41.0",
-    "eslint-config-digitalbazaar": "^5.0.1",
-    "eslint-plugin-jsdoc": "^46.3.0",
-    "eslint-plugin-unicorn": "^47.0.0",
-    "jsdoc": "^4.0.2",
-    "jsdoc-to-markdown": "^8.0.0"
+    "eslint": "^8.57.0",
+    "eslint-config-digitalbazaar": "^5.2.0",
+    "eslint-plugin-jsdoc": "^48.11.0",
+    "eslint-plugin-unicorn": "^55.0.0"
   },
   "engines": {
     "node": ">=18"

package/schemas/bedrock-vc-workflow.js

@@ -4,6 +4,144 @@
 import {MAX_ISSUER_INSTANCES} from '../lib/constants.js';
 import {schemas} from '@bedrock/validation';
 
+const VC_CONTEXT_1 = 'https://www.w3.org/2018/credentials/v1';
+const VC_CONTEXT_2 = 'https://www.w3.org/ns/credentials/v2';
+
+const vcContext = {
+  type: 'array',
+  minItems: 1,
+  // the first context must be the VC context
+  items: [{
+    oneOf: [{
+      const: VC_CONTEXT_1
+    }, {
+      const: VC_CONTEXT_2
+    }]
+  }],
+  // additional contexts maybe strings or objects
+  additionalItems: {
+    anyOf: [{type: 'string'}, {type: 'object'}]
+  }
+};
+
+function idOrObjectWithId() {
+  return {
+    title: 'identifier or an object with an id',
+    anyOf: [
+      schemas.identifier(),
+      {
+        type: 'object',
+        required: ['id'],
+        additionalProperties: true,
+        properties: {id: schemas.identifier()}
+      }
+    ]
+  };
+}
+
+function verifiableCredential() {
+  return {
+    title: 'Verifiable Credential',
+    type: 'object',
+    required: [
+      '@context',
+      'credentialSubject',
+      'issuer',
+      'type'
+    ],
+    additionalProperties: true,
+    properties: {
+      '@context': vcContext,
+      credentialSubject: {
+        anyOf: [
+          {type: 'object'},
+          {type: 'array', minItems: 1, items: {type: 'object'}}
+        ]
+      },
+      id: {
+        type: 'string'
+      },
+      issuer: idOrObjectWithId(),
+      type: {
+        type: 'array',
+        minItems: 1,
+        // this first type must be VerifiableCredential
+        items: [
+          {const: 'VerifiableCredential'},
+        ],
+        // additional types must be strings
+        additionalItems: {
+          type: 'string'
+        }
+      },
+      proof: schemas.proof()
+    }
+  };
+}
+
+const envelopedVerifiableCredential = {
+  title: 'Enveloped Verifiable Credential',
+  type: 'object',
+  additionalProperties: true,
+  properties: {
+    '@context': {
+      const: VC_CONTEXT_2
+    },
+    id: {
+      type: 'string'
+    },
+    type: {
+      const: 'EnvelopedVerifiableCredential'
+    }
+  },
+  required: [
+    '@context',
+    'id',
+    'type'
+  ]
+};
+
+export function verifiablePresentation() {
+  return {
+    title: 'Verifiable Presentation',
+    type: 'object',
+    required: ['@context', 'type'],
+    additionalProperties: true,
+    properties: {
+      '@context': vcContext,
+      id: {
+        type: 'string'
+      },
+      type: {
+        type: 'array',
+        minItems: 1,
+        // this first type must be VerifiablePresentation
+        items: [
+          {const: 'VerifiablePresentation'},
+        ],
+        // additional types must be strings
+        additionalItems: {
+          type: 'string'
+        }
+      },
+      verifiableCredential: {
+        anyOf: [
+          verifiableCredential(),
+          envelopedVerifiableCredential, {
+            type: 'array',
+            minItems: 1,
+            items: {
+              anyOf: [verifiableCredential(), envelopedVerifiableCredential]
+            }
+          }
+        ]
+      },
+      holder: idOrObjectWithId(),
+      proof: schemas.proof()
+    }
+  };
+}
+
 const credentialDefinition = {
   title: 'OID4VCI Verifiable Credential Definition',
   type: 'object',
@@ -19,7 +157,7 @@ const credentialDefinition = {
     },
     type: {
       type: 'array',
-      minItems: 2,
+      minItems: 1,
       item: {
         type: 'string'
       }
@@ -27,7 +165,7 @@ const credentialDefinition = {
     // allow `types` to be flexible for OID4VCI draft 20 implementers
     types: {
       type: 'array',
-      minItems: 2,
+      minItems: 1,
       item: {
         type: 'string'
       }
@@ -228,6 +366,19 @@ const step = {
     verifiablePresentationRequest: {
       type: 'object'
     },
+    presentationSchema: {
+      type: 'object',
+      required: ['type', 'jsonSchema'],
+      additionalProperties: false,
+      properties: {
+        type: {
+          type: 'string'
+        },
+        jsonSchema: {
+          type: 'object'
+        }
+      }
+    },
     jwtDidProofRequest: {
       type: 'object',
       additionalProperties: false,
@@ -314,7 +465,7 @@ export function useExchangeBody() {
     type: 'object',
     additionalProperties: false,
     properties: {
-      verifiablePresentation: schemas.verifiablePresentation()
+      verifiablePresentation: verifiablePresentation()
     }
   };
 }