@bedrock/vc-delivery 5.0.0 → 5.0.1

package/lib/helpers.js

@@ -2,15 +2,15 @@
  * Copyright (c) 2022-2024 Digital Bazaar, Inc. All rights reserved.
  */
 import * as bedrock from '@bedrock/core';
+import * as vcjwt from './vcjwt.js';
 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';
 import {serviceAgents} from '@bedrock/service-agent';
 import {ZcapClient} from '@digitalbazaar/ezcap';
 
-const {config} = bedrock;
+const {config, util: {BedrockError}} = bedrock;
 
 export async function evaluateTemplate({
   workflow, exchange, typedTemplate
@@ -104,29 +104,66 @@ export function decodeLocalId({localId} = {}) {
   }));
 }
 
-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};
+export async function unenvelopeCredential({
+  envelopedCredential, format
+} = {}) {
+  const result = _getEnvelope({envelope: envelopedCredential, format});
+
+  // only supported format is VC-JWT at this time
+  const credential = vcjwt.decodeVCJWTCredential({jwt: result.envelope});
+  return {credential, ...result};
+}
+
+export async function unenvelopePresentation({
+  envelopedPresentation, format
+} = {}) {
+  const result = _getEnvelope({envelope: envelopedPresentation, format});
+
+  // only supported format is VC-JWT at this time
+  const presentation = vcjwt.decodeVCJWTPresentation({jwt: result.envelope});
+
+  // unenvelope any VCs in the presentation
+  let {verifiableCredential = []} = presentation;
+  if(!Array.isArray(verifiableCredential)) {
+    verifiableCredential = [verifiableCredential];
   }
-  throw new Error('Not implemented.');
+  if(verifiableCredential.length > 0) {
+    presentation.verifiableCredential = await Promise.all(
+      verifiableCredential.map(async vc => {
+        if(vc?.type !== 'EnvelopedVerifiableCredential') {
+          return vc;
+        }
+        const {credential} = await unenvelopeCredential({
+          envelopedCredential: vc
+        });
+        return credential;
+      }));
+  }
+  return {presentation, ...result};
 }
 
-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};
+function _getEnvelope({envelope, format}) {
+  const isString = typeof envelope === 'string';
+  if(isString) {
+    // supported formats
+    if(format === 'application/jwt' || format === 'jwt_vc_json-ld') {
+      format = 'application/jwt';
+    }
+  } else {
+    const {id} = envelope;
+    if(id?.startsWith('data:application/jwt,')) {
+      format = 'application/jwt';
+      envelope = id.slice('data:application/jwt,'.length);
+    }
+  }
+
+  if(format === 'application/jwt' && envelope !== undefined) {
+    return {envelope, format};
   }
-  throw new Error('Not implemented.');
+
+  throw new BedrockError(
+    `Unsupported credential or presentation envelope format "${format}".`, {
+      name: 'NotSupportedError',
+      details: {httpStatusCode: 400, public: true}
+    });
 }

package/lib/openId.js

@@ -6,7 +6,9 @@ import * as exchanges from './exchanges.js';
 import {
   compile, createValidateMiddleware as validate
 } from '@bedrock/validation';
-import {evaluateTemplate, getWorkflowIssuerInstances} from './helpers.js';
+import {
+  evaluateTemplate, getWorkflowIssuerInstances, unenvelopePresentation
+} from './helpers.js';
 import {importJWK, SignJWT} from 'jose';
 import {
   openIdAuthorizationResponseBody,
@@ -57,6 +59,8 @@ instantiating a new authorization server instance per VC exchange. */
 const PRE_AUTH_GRANT_TYPE =
   'urn:ietf:params:oauth:grant-type:pre-authorized_code';
 
+const VC_CONTEXT_2 = 'https://www.w3.org/ns/credentials/v2';
+
 // creates OID4VCI Authorization Server + Credential Delivery Server
 // endpoints for each individual exchange
 export async function createRoutes({
@@ -379,14 +383,33 @@ export async function createRoutes({
       const {vp_token, presentation_submission} = req.body;
 
       // JSON parse and validate `vp_token` and `presentation_submission`
-      const presentation = _jsonParse(vp_token, 'vp_token');
+      let presentation = _jsonParse(vp_token, 'vp_token');
       const presentationSubmission = _jsonParse(
         presentation_submission, 'presentation_submission');
       _validate(validatePresentationSubmission, presentationSubmission);
-      _validate(validatePresentation, presentation);
-
-      const result = await _processAuthorizationResponse(
-        {req, presentation, presentationSubmission});
+      let envelope;
+      if(typeof presentation === 'string') {
+        // handle enveloped presentation
+        const {
+          envelope: raw, presentation: contents, format
+        } = await unenvelopePresentation({
+          envelopedPresentation: presentation,
+          // FIXME: check presentationSubmission for VP format
+          format: 'jwt_vc_json-ld'
+        });
+        _validate(validatePresentation, contents);
+        presentation = {
+          '@context': VC_CONTEXT_2,
+          id: `data:${format},${raw}`,
+          type: 'EnvelopedVerifiablePresentation'
+        };
+        envelope = {raw, contents, format};
+      } else {
+        _validate(validatePresentation, presentation);
+      }
+      const result = await _processAuthorizationResponse({
+        req, presentation, envelope, presentationSubmission
+      });
       res.json(result);
     }));
 
@@ -906,7 +929,7 @@ function _matchCredentialRequest(expected, cr) {
 }
 
 async function _processAuthorizationResponse({
-  req, presentation, presentationSubmission
+  req, presentation, envelope, presentationSubmission
 }) {
   const {config: workflow} = req.serviceObject;
   const exchangeRecord = await req.getExchange();
@@ -917,17 +940,17 @@ 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
+    // if the VP is enveloped, validate the contents of the envelope
+    const toValidate = envelope ? envelope.contents : presentation;
+
+    // validate the received VP / envelope contents
     const {jsonSchema: schema} = presentationSchema;
     const validate = compile({schema});
-    const {valid, error} = validate(presentation);
+    const {valid, error} = validate(toValidate);
     if(!valid) {
       throw error;
     }
@@ -937,20 +960,21 @@ async function _processAuthorizationResponse({
   const {verifiablePresentationRequest} = await oid4vp.toVpr(
     {authorizationRequest});
   const {allowUnprotectedPresentation = false} = step;
-  const {verificationMethod} = await verify({
+  const verifyResult = await verify({
     workflow,
     verifiablePresentationRequest,
     presentation,
     allowUnprotectedPresentation,
     expectedChallenge: authorizationRequest.nonce
   });
+  const {verificationMethod} = verifyResult;
 
   // store VP results in variables associated with current step
   const currentStep = exchange.step;
   if(!exchange.variables.results) {
     exchange.variables.results = {};
   }
-  exchange.variables.results[currentStep] = {
+  const results = {
     // common use case of DID Authentication; provide `did` for ease
     // of use in template
     did: verificationMethod?.controller || null,
@@ -961,6 +985,13 @@ async function _processAuthorizationResponse({
       presentationSubmission
     }
   };
+  if(envelope) {
+    // normalize VP from inside envelope to `verifiablePresentation`
+    results.envelopedPresentation = presentation;
+    results.verifiablePresentation = verifyResult
+      .presentationResult.presentation;
+  }
+  exchange.variables.results[currentStep] = results;
   exchange.sequence++;
 
   // if there is something to issue, update exchange, do not complete it

package/lib/vcapi.js

@@ -4,8 +4,8 @@
 import * as bedrock from '@bedrock/core';
 import * as exchanges from './exchanges.js';
 import {createChallenge as _createChallenge, verify} from './verify.js';
+import {evaluateTemplate, unenvelopePresentation} from './helpers.js';
 import {compile} from '@bedrock/validation';
-import {evaluateTemplate} from './helpers.js';
 import {issue} from './issue.js';
 import {klona} from 'klona';
 import {logger} from './logger.js';
@@ -96,15 +96,22 @@ 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) {
+        // if the VP is enveloped, get the presentation from the envelope
+        let presentation;
+        if(receivedPresentation?.type === 'EnvelopedVerifiablePresentation') {
+          ({presentation} = await unenvelopePresentation({
+            envelopedPresentation: receivedPresentation
+          }));
+        } else {
+          presentation = receivedPresentation;
+        }
+
         // validate the received VP
         const {jsonSchema: schema} = presentationSchema;
         const validate = compile({schema});
-        const {valid, error} = validate(receivedPresentation);
+        const {valid, error} = validate(presentation);
         if(!valid) {
           throw error;
         }

package/lib/vcjwt.js

@@ -0,0 +1,375 @@
+/*!
+ * Copyright (c) 2022-2024 Digital Bazaar, Inc. All rights reserved.
+ */
+import * as bedrock from '@bedrock/core';
+import {decodeJwt} from 'jose';
+
+const {util: {BedrockError}} = bedrock;
+
+const VC_CONTEXT_1 = 'https://www.w3.org/2018/credentials/v1';
+const VC_CONTEXT_2 = 'https://www.w3.org/ns/credentials/v2';
+
+export function decodeVCJWTCredential({jwt} = {}) {
+  const payload = decodeJwt(jwt);
+
+  /* Example:
+  {
+    "alg": <signer.algorithm>,
+    "kid": <signer.id>
+  }.
+  {
+    "iss": <verifiableCredential.issuer>,
+    "jti": <verifiableCredential.id>
+    "sub": <verifiableCredential.credentialSubject>
+    "nbf": <verifiableCredential.[issuanceDate | validFrom]>
+    "exp": <verifiableCredential.[expirationDate | validUntil]>
+    "vc": <verifiableCredential>
+  }
+  */
+  const {vc} = payload;
+  if(!(vc && typeof vc === 'object')) {
+    throw new BedrockError('JWT validation failed.', {
+      name: 'DataError',
+      details: {
+        httpStatusCode: 400,
+        public: true,
+        code: 'ERR_JWT_CLAIM_VALIDATION_FAILED',
+        reason: 'missing or unexpected "vc" claim value.',
+        claim: 'vc'
+      }
+    });
+  }
+
+  let {'@context': context = []} = vc;
+  if(!Array.isArray(context)) {
+    context = [context];
+  }
+  const isVersion1 = context.includes(VC_CONTEXT_1);
+  const isVersion2 = context.includes(VC_CONTEXT_2);
+  if(!(isVersion1 ^ isVersion2)) {
+    throw new BedrockError(
+      'Verifiable credential is neither version "1.x" nor "2.x".', {
+        name: 'DataError',
+        details: {
+          httpStatusCode: 400,
+          public: true
+        }
+      });
+  }
+
+  const credential = {...vc};
+  const {iss, jti, sub, nbf, exp} = payload;
+
+  // inject `issuer` value
+  if(vc.issuer === undefined) {
+    vc.issuer = iss;
+  } else if(vc.issuer && typeof vc.issuer === 'object' &&
+    vc.issuer.id === undefined) {
+    vc.issuer = {id: iss, ...vc.issuer};
+  } else if(iss !== vc.issuer && iss !== vc.issuer?.id) {
+    throw new BedrockError(
+      'VC-JWT "iss" claim does not equal nor does it exclusively ' +
+      'provide verifiable credential "issuer" / "issuer.id".', {
+        name: 'DataError',
+        details: {
+          httpStatusCode: 400,
+          public: true
+        }
+      });
+  }
+
+  if(jti !== undefined && jti !== vc.id) {
+    // inject `id` value
+    if(vc.id === undefined) {
+      vc.id = jti;
+    } else {
+      throw new BedrockError(
+        'VC-JWT "jti" claim does not equal nor does it exclusively ' +
+        'provide verifiable credential "id".', {
+          name: 'DataError',
+          details: {
+            httpStatusCode: 400,
+            public: true
+          }
+        });
+    }
+  }
+
+  if(sub !== undefined && sub !== vc.credentialSubject?.id) {
+    // inject `credentialSubject.id` value
+    if(!vc.credentialSubject) {
+      throw new BedrockError(
+        'Verifiable credential has no "credentialSubject".', {
+          name: 'DataError',
+          details: {
+            httpStatusCode: 400,
+            public: true
+          }
+        });
+    }
+    if(Array.isArray(vc.credentialSubject)) {
+      throw new BedrockError(
+        'Verifiable credential has multiple credential subjects, which is ' +
+        'not supported in VC-JWT.', {
+          name: 'DataError',
+          details: {
+            httpStatusCode: 400,
+            public: true
+          }
+        });
+    }
+    if(vc.credentialSubject?.id === undefined) {
+      vc.credentialSubject = {id: sub, ...vc.credentialSubject};
+    } else {
+      throw new BedrockError(
+        'VC-JWT "sub" claim does not equal nor does it exclusively ' +
+        'provide verifiable credential "credentialSubject.id".', {
+          name: 'DataError',
+          details: {
+            httpStatusCode: 400,
+            public: true
+          }
+        });
+    }
+  }
+
+  if(nbf === undefined && isVersion1) {
+    throw new BedrockError('JWT validation failed.', {
+      name: 'DataError',
+      details: {
+        httpStatusCode: 400,
+        public: true,
+        code: 'ERR_JWT_CLAIM_VALIDATION_FAILED',
+        reason: 'missing "nbf" claim value.',
+        claim: 'nbf'
+      }
+    });
+  }
+
+  if(nbf !== undefined) {
+    // fuzzy convert `nbf` into `issuanceDate` / `validFrom`, only require
+    // second-level precision
+    const dateString = new Date(nbf * 1000).toISOString().slice(0, -5);
+    const dateProperty = isVersion1 ? 'issuanceDate' : 'validFrom';
+    // inject dateProperty value
+    if(vc[dateProperty] === undefined) {
+      vc[dateProperty] = dateString + 'Z';
+    } else if(!(vc[dateProperty].startsWith(dateString) &&
+      vc[dateProperty].endsWith('Z'))) {
+      throw new BedrockError(
+        'VC-JWT "nbf" claim does not equal nor does it exclusively provide ' +
+        `verifiable credential "${dateProperty}".`, {
+          name: 'DataError',
+          details: {
+            httpStatusCode: 400,
+            public: true
+          }
+        });
+    }
+  }
+
+  if(exp !== undefined) {
+    // fuzzy convert `exp` into `expirationDate` / `validUntil`, only require
+    // second-level precision
+    const dateString = new Date(exp * 1000).toISOString().slice(0, -5);
+    const dateProperty = isVersion1 ? 'expirationDate' : 'validUntil';
+    // inject dateProperty value
+    if(vc[dateProperty] === undefined) {
+      vc[dateProperty] = dateString + 'Z';
+    } else if(!(vc[dateProperty].startsWith(dateString) &&
+      vc[dateProperty].endsWith('Z'))) {
+      throw new BedrockError(
+        'VC-JWT "exp" claim does not equal nor does it exclusively provide ' +
+        `verifiable credential "${dateProperty}".`, {
+          name: 'DataError',
+          details: {
+            httpStatusCode: 400,
+            public: true
+          }
+        });
+    }
+  }
+
+  return credential;
+}
+
+export function decodeVCJWTPresentation({jwt, challenge} = {}) {
+  /* Example:
+  {
+    "alg": <signer.algorithm>,
+    "kid": <signer.id>
+  }.
+  {
+    "iss": <verifiablePresentation.holder>,
+    "aud": <verifiablePresentation.domain>,
+    "nonce": <verifiablePresentation.nonce>,
+    "jti": <verifiablePresentation.id>
+    "nbf": <verifiablePresentation.[validFrom]>
+    "exp": <verifiablePresentation.[validUntil]>
+    "vp": <verifiablePresentation>
+  }
+  */
+  const payload = decodeJwt(jwt);
+
+  const {vp} = payload;
+  if(!(vp && typeof vp === 'object')) {
+    throw new BedrockError('JWT validation failed.', {
+      name: 'DataError',
+      details: {
+        httpStatusCode: 400,
+        public: true,
+        code: 'ERR_JWT_CLAIM_VALIDATION_FAILED',
+        reason: 'missing or unexpected "vp" claim value.',
+        claim: 'vp'
+      }
+    });
+  }
+
+  let {'@context': context = []} = vp;
+  if(!Array.isArray(context)) {
+    context = [context];
+  }
+  const isVersion1 = context.includes(VC_CONTEXT_1);
+  const isVersion2 = context.includes(VC_CONTEXT_2);
+  if(!(isVersion1 ^ isVersion2)) {
+    throw new BedrockError(
+      'Verifiable presentation is not either version "1.x" or "2.x".', {
+        name: 'DataError',
+        details: {
+          httpStatusCode: 400,
+          public: true
+        }
+      });
+  }
+
+  const presentation = {...vp};
+  const {iss, nonce, jti, nbf, exp} = payload;
+
+  // inject `holder` value
+  if(vp.holder === undefined) {
+    vp.holder = iss;
+  } else if(vp.holder && typeof vp.holder === 'object' &&
+    vp.holder.id === undefined) {
+    vp.holder = {id: iss, ...vp.holder};
+  } else if(iss !== vp.holder && iss !== vp.holder?.id) {
+    throw new BedrockError(
+      'VC-JWT "iss" claim does not equal nor does it exclusively ' +
+      'provide verifiable presentation "holder" / "holder.id".', {
+        name: 'DataError',
+        details: {
+          httpStatusCode: 400,
+          public: true
+        }
+      });
+  }
+
+  if(jti !== undefined && jti !== vp.id) {
+    // inject `id` value
+    if(vp.id === undefined) {
+      vp.id = jti;
+    } else {
+      throw new BedrockError(
+        'VC-JWT "jti" claim does not equal nor does it exclusively ' +
+        'provide verifiable presentation "id".', {
+          name: 'DataError',
+          details: {
+            httpStatusCode: 400,
+            public: true
+          }
+        });
+    }
+  }
+
+  // version 1.x VPs do not support `validFrom`/`validUntil`
+  if(nbf !== undefined && isVersion2) {
+    // fuzzy convert `nbf` into `validFrom`, only require
+    // second-level precision
+    const dateString = new Date(nbf * 1000).toISOString().slice(0, -5);
+
+    // inject `validFrom` value
+    if(vp.validFrom === undefined) {
+      vp.validFrom = dateString + 'Z';
+    } else if(!(vp.validFrom?.startsWith(dateString) &&
+      vp.validFrom.endsWith('Z'))) {
+      throw new BedrockError(
+        'VC-JWT "nbf" claim does not equal nor does it exclusively provide ' +
+        'verifiable presentation "validFrom".', {
+          name: 'DataError',
+          details: {
+            httpStatusCode: 400,
+            public: true
+          }
+        });
+    }
+  }
+  if(exp !== undefined && isVersion2) {
+    // fuzzy convert `exp` into `validUntil`, only require
+    // second-level precision
+    const dateString = new Date(exp * 1000).toISOString().slice(0, -5);
+
+    // inject `validUntil` value
+    if(vp.validUntil === undefined) {
+      vp.validUntil = dateString + 'Z';
+    } else if(!(vp.validUntil?.startsWith(dateString) &&
+      vp.validUntil?.endsWith('Z'))) {
+      throw new BedrockError(
+        'VC-JWT "exp" claim does not equal nor does it exclusively provide ' +
+        'verifiable presentation "validUntil".', {
+          name: 'DataError',
+          details: {
+            httpStatusCode: 400,
+            public: true
+          }
+        });
+    }
+  }
+
+  if(challenge !== undefined && nonce !== challenge) {
+    throw new BedrockError('JWT validation failed.', {
+      name: 'DataError',
+      details: {
+        httpStatusCode: 400,
+        public: true,
+        code: 'ERR_JWT_CLAIM_VALIDATION_FAILED',
+        reason: 'missing or unexpected "nonce" claim value.',
+        claim: 'nonce'
+      }
+    });
+  }
+
+  // do some validation on `verifiableCredential`
+  let {verifiableCredential = []} = presentation;
+  if(!Array.isArray(verifiableCredential)) {
+    verifiableCredential = [verifiableCredential];
+  }
+
+  // ensure version 2 VPs only have objects in `verifiableCredential`
+  const hasVCJWTs = verifiableCredential.some(vc => typeof vc !== 'object');
+  if(isVersion2 && hasVCJWTs) {
+    throw new BedrockError(
+      'Version 2.x verifiable presentations must only use objects in the ' +
+      '"verifiableCredential" field.', {
+        name: 'DataError',
+        details: {
+          httpStatusCode: 400,
+          public: true
+        }
+      });
+  }
+
+  // transform any VC-JWT VCs to enveloped VCs
+  if(presentation.verifiableCredential && hasVCJWTs) {
+    presentation.verifiableCredential = verifiableCredential.map(vc => {
+      if(typeof vc !== 'string') {
+        return vc;
+      }
+      return {
+        '@context': VC_CONTEXT_2,
+        id: `data:application/jwt,${vc}`,
+        type: 'EnvelopedVerifiableCredential',
+      };
+    });
+  }
+
+  return presentation;
+}

package/lib/verify.js

@@ -87,9 +87,13 @@ export async function verify({
 
     // generate useful error to return to client
     const {name, errors, message} = cause.data.error;
+    const causeError = _stripStacktrace({...cause.data.error});
+    delete causeError.errors;
     const error = new BedrockError(message ?? 'Verification error.', {
-      name: name === 'VerificationError' ? 'DataError' : 'OperationError',
+      name: (name === 'VerificationError' || name === 'DataError') ?
+        'DataError' : 'OperationError',
       details: {
+        error: causeError,
         verified,
         credentialResults,
         presentationResult,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrock/vc-delivery",
-  "version": "5.0.0",
+  "version": "5.0.1",
   "type": "module",
   "description": "Bedrock Verifiable Credential Delivery",
   "main": "./lib/index.js",

package/schemas/bedrock-vc-workflow.js

@@ -303,7 +303,7 @@ const vcFormats = {
 const issuerInstance = {
   title: 'Issuer Instance',
   type: 'object',
-  required: ['zcapReferenceIds'],
+  required: ['supportedFormats', 'zcapReferenceIds'],
   additionalProperties: false,
   properties: {
     id: {