@bedrock/vc-delivery 7.13.0 → 7.13.2

package/lib/ExchangeProcessor.js

@@ -31,20 +31,22 @@ export class ExchangeProcessor {
    * @param {object} options.workflow - The workflow.
    * @param {object} options.exchangeRecord - The exchange record.
    * @param {Function} [options.prepareStep] - The `prepareStep` handler.
-   * @param {Function} [options.inputRequired] - The `inputRequired` handler.
+   * @param {Function} [options.isStepComplete] - The `isStepComplete` handler.
    * @param {Function} [options.issue] - The `issue` handler.
+   * @param {Function} [options.inputRequired] - The `inputRequired` handler.
    * @param {Function} [options.verify] - The `verify` handler.
    *
    * @returns {ExchangeProcessor} An `ExchangeProcessor` instance.
    */
   constructor({
-    workflow, exchangeRecord, prepareStep, inputRequired,
+    workflow, exchangeRecord, prepareStep, inputRequired, isStepComplete,
     issue, verify
   } = {}) {
     this.workflow = workflow;
     this.exchangeRecord = exchangeRecord;
     this.prepareStep = prepareStep?.bind(this);
     this.inputRequired = inputRequired?.bind(this);
+    this.isStepComplete = isStepComplete?.bind(this);
     this.issue = issue ?? defaultIssue.bind(this);
     this.verify = verify ?? defaultVerify.bind(this);
   }
@@ -229,7 +231,9 @@ export class ExchangeProcessor {
   async _tryProcess({
     receivedPresentation, receivedPresentationRequest, retryState
   } = {}) {
-    const {workflow, exchangeRecord, prepareStep, inputRequired} = this;
+    const {
+      workflow, exchangeRecord, prepareStep, inputRequired, isStepComplete
+    } = this;
     const {exchange, meta} = exchangeRecord;
 
     // initialize exchange results
@@ -423,38 +427,52 @@ export class ExchangeProcessor {
         // FIXME: implement
         //if(response?.verifiablePresentation) {}
 
-        // 4.12. If `step.redirectUrl` is set:
-        if(step.redirectUrl) {
-          // 4.12.1. If `response` is `null` then set it to an empty object.
-          if(!response) {
-            response = {};
+        // 4.12. Call subalgorithm `isStepComplete`, passing `workflow`,
+        // `exchange`, `step`, `receivedPresentation`, and
+        // `receivedPresentationRequest` to perform any protocol-specific
+        // behavior to determine if the step is complete. Set `stepComplete`
+        // to the result of `isStepComplete`, defaulting to `true`.
+        const stepComplete = await isStepComplete?.({
+          workflow, exchange, step,
+          receivedPresentation, receivedPresentationRequest
+        }) ?? true;
+
+        // 4.13. If `stepComplete` is `true`:
+        if(stepComplete) {
+          // 4.13.1. If `step.redirectUrl` is set:
+          if(step.redirectUrl) {
+            // 4.13.1.1. If `response` is `null` then set it to an empty object.
+            if(!response) {
+              response = {};
+            }
+            // 4.13.1.2. Set `response.redirectUrl` to `step.redirectUrl`.
+            response.redirectUrl = step.redirectUrl;
           }
-          // 4.12.2. Set `response.redirectUrl` to `step.redirectUrl`.
-          response.redirectUrl = step.redirectUrl;
-        }
 
-        // 4.13. If `step.nextStep` is not set then set `exchange.state` to
-        // `complete`.
-        if(!step.nextStep) {
-          exchange.state = 'complete';
-        } else {
-          // 4.14. Otherwise, delete `exchange.variables.results[step.nextStep]`
-          // if it exists, and set `exchange.step` to `step.nextStep`.
-          delete exchange.variables.results[step.nextStep];
-          exchange.step = step.nextStep;
+          // 4.13.2. If `step.nextStep` is not set then set `exchange.state` to
+          // `complete`.
+          if(!step.nextStep) {
+            exchange.state = 'complete';
+          } else {
+            // 4.13.3. Otherwise, delete
+            // `exchange.variables.results[step.nextStep]` if it exists, and
+            // set `exchange.step` to `step.nextStep`.
+            delete exchange.variables.results[step.nextStep];
+            exchange.step = step.nextStep;
+          }
         }
 
-        // 4.15. Save the exchange (and call any non-blocking callback in
+        // 4.14. Save the exchange (and call any non-blocking callback in
         // the step).
         await _updateExchange({workflow, exchange, meta, step});
 
-        // 4.16. If `exchange.state` is `complete`, return `response` if it is
+        // 4.15. If `exchange.state` is `complete`, return `response` if it is
         // not `null`, otherwise return an empty object.
         if(exchange.state === 'complete') {
           return response ?? {};
         }
 
-        // 4.17. Set `receivedPresentation` to `null`.
+        // 4.16. Set `receivedPresentation` to `null`.
         receivedPresentation = null;
       }
     } catch(e) {
@@ -489,14 +507,6 @@ async function _getStep({workflow, exchange}) {
     workflow, exchange, stepName: currentStep
   });
 
-  // if next step is the same as the current step, throw an error
-  if(step.nextStep === currentStep) {
-    throw new BedrockError('Cyclical step detected.', {
-      name: 'DataError',
-      details: {httpStatusCode: 500, public: true}
-    });
-  }
-
   // if `step.nextStep` and `step.redirectUrl` and are both set, throw an error
   if(step.nextStep && step.redirectUrl) {
     throw new BedrockError(
@@ -547,10 +557,11 @@ async function _createVerifiablePresentationRequest({
   }
   response.verifiablePresentationRequest.challenge = challenge;
 
-  // 4. Set `exchange.variables.results[exchange.step]` to an object with the
-  // property `responsePresentationRequest` set to
-  // `response.verifiablePresentationRequest`.
+  // 4. Set `exchange.variables.results[exchange.step]` to an object, if it
+  // does not already exist, and set the property `responsePresentationRequest`
+  // to `response.verifiablePresentationRequest`.
   exchange.variables.results[exchange.step] = {
+    ...exchange.variables.results[exchange.step],
     responsePresentationRequest: response.verifiablePresentationRequest
   };
 }

package/lib/oid4/oid4vci.js

@@ -430,6 +430,9 @@ async function _processExchange({
   const exchangeProcessor = new ExchangeProcessor({
     workflow, exchangeRecord,
     async prepareStep({exchange, step}) {
+      // FIXME: handle OID4VCI 1.0+ credential request
+
+      // FIXME: OID4VCI Draft 13:
       // validate body against expected credential requests
       const {openId: {expectedCredentialRequests}} = exchange;
       let credentialRequests;
@@ -437,7 +440,7 @@ async function _processExchange({
         ({credential_requests: credentialRequests} = req.body);
       } else {
         if(expectedCredentialRequests.length > 1) {
-          // FIXME: batch endpoint has been removed in OID4VCI 1.0; if used,
+          // FIXME: batch endpoint has been removed in OID4VCI 1.0+; if used,
           // then it is for a legacy OID4VCI draft 13 request, so this should
           // be reworked
           throw new Error('batch_credential_endpoint must be used');
@@ -457,9 +460,15 @@ async function _processExchange({
 
       // check to see if step supports OID4VP during OID4VCI
       if(step.openId) {
-        // if there is no `presentationSubmission`, request one
+        // FIXME: either OID4VCI 1.1+ w/IAE (interactive authz endpoint) or
+        // OID4VCI-1.0/draft13+OID4VP will have received VP results which will
+        // be stored with this step; OID4VCI 1.0- does not have IAE so if this
+        // call is made, presume such a client and return an error with the
+        // OID4VP request, OID4VCI 1.1+ clients will know to use IAE instead
+
+        // if there is no verified presentation yet, request one
         const {results} = exchange.variables;
-        if(!results[exchange.step]?.openId?.presentationSubmission) {
+        if(!results[exchange.step]?.verifyPresentationResults?.verified) {
           // note: only the "default" `clientProfileId` is supported at this
           // time because there isn't presently a defined way to specify
           // alternatives
@@ -520,6 +529,16 @@ async function _processExchange({
         workflow, exchange, step, issueRequestsParams,
         verifiablePresentation, format
       });
+    },
+    isStepComplete({exchange}) {
+      // FIXME: check step's current `openId` results to see which issue
+      // requests have been processed; if any still exist, then the step is not
+      // yet complete
+      const {results} = exchange.variables;
+      if(!results[exchange.step]?.openId) {
+        // FIXME: implement
+      }
+      return true;
     }
   });
   const response = await exchangeProcessor.process();

package/lib/oid4/oid4vp.js

@@ -175,7 +175,7 @@ export async function processAuthorizationResponse({req, clientProfileId}) {
     },
     inputRequired({step}) {
       // indicate input always required to avoid automatically advancing
-      // to the next step, but clear `step.verifiablePresentationRequest`
+      // to issuance, but clear `step.verifiablePresentationRequest`
       // to avoid overwriting previous value
       delete step.verifiablePresentationRequest;
       return true;

package/package.json

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

package/schemas/bedrock-vc-workflow.js

@@ -715,6 +715,8 @@ export function useExchangeBody() {
     type: 'object',
     additionalProperties: false,
     properties: {
+      referenceId: {type: 'string'},
+      verifiablePresentationRequest: {type: 'object'},
       verifiablePresentation: {
         anyOf: [
           envelopedVerifiablePresentation,