Start implementing optional interactions feature.

Author: dlongley

CHANGELOG.md

@@ -1,5 +1,14 @@
 # bedrock-profile-http ChangeLog
 
+## 23.1.0 - 2024-mm-dd
+
+### Added
+- Add optional `interactions` feature, allowing an account to create
+  VC exchanges based on predefined workflows. Currently, these
+  exchanges do not store any VCs that might be received in any
+  particular profile's storage, however, this might change in the
+  future.
+
 ## 23.0.0 - 2023-10-12
 
 ### Changed

lib/config.js

@@ -1,5 +1,5 @@
 /*!
- * Copyright (c) 2020-2022 Digital Bazaar, Inc. All rights reserved.
+ * Copyright (c) 2020-2024 Digital Bazaar, Inc. All rights reserved.
  */
 import * as bedrock from '@bedrock/core';
 
@@ -47,3 +47,20 @@ const meterServiceName = `${namespace}.meterService`;
 cc(`${meterServiceName}.url`, () => `${bedrock.config.server.baseUri}/meters`);
 // ensure meter service config is overridden in deployments
 config.ensureConfigOverride.fields.push(meterServiceName);
+
+// optional interaction config
+config.interactions = {
+  enabled: false,
+  // optional named workflows for interactions
+  /* Spec:
+  {
+    <workflow name>: {
+      ...,
+      zcaps: {
+        createExchange: <zcap for creating an exchange>
+      }
+    }
+  }
+  */
+  workflows: {}
+};

lib/http.js

@@ -1,5 +1,5 @@
 /*!
- * Copyright (c) 2020-2022 Digital Bazaar, Inc. All rights reserved.
+ * Copyright (c) 2020-2024 Digital Bazaar, Inc. All rights reserved.
  */
 import * as bedrock from '@bedrock/core';
 import * as schemas from '../schemas/bedrock-profile-http.js';
@@ -17,6 +17,7 @@ const {config, util: {BedrockError}} = bedrock;
 let APP_ID;
 let EDV_METER_CREATION_ZCAP;
 let WEBKMS_METER_CREATION_ZCAP;
+let WORKFLOWS_MAP;
 let ZCAP_CLIENT;
 
 bedrock.events.on('bedrock.init', () => {
@@ -31,13 +32,37 @@ bedrock.events.on('bedrock.init', () => {
   });
 
   const cfg = bedrock.config['profile-http'];
+
   const {edvMeterCreationZcap, webKmsMeterCreationZcap} = cfg;
   if(edvMeterCreationZcap) {
     EDV_METER_CREATION_ZCAP = JSON.parse(edvMeterCreationZcap);
   }
   if(webKmsMeterCreationZcap) {
     WEBKMS_METER_CREATION_ZCAP = JSON.parse(webKmsMeterCreationZcap);
   }
+
+  // parse workflow configs when interactions are enabled
+  const {interactions} = cfg;
+  if(interactions?.enabled) {
+    const {workflows = {}} = interactions;
+    WORKFLOWS_MAP = new Map();
+    for(const workflowName in workflows) {
+      const workflow = {
+        name: workflowName,
+        zcaps: new Map()
+      };
+      const {zcaps} = workflows[workflowName];
+      for(const zcapName in zcaps) {
+        const zcap = zcaps[zcapName];
+        workflow.zcaps.set(zcapName, JSON.parse(zcap));
+      }
+      if(!workflow.zcaps.has('createExchange')) {
+        throw new TypeError(
+          '"bedrock.config.profile-http.interactions.workflows" must each ' +
+          'have "zcaps.createExchange".');
+      }
+    }
+  }
 });
 
 bedrock.events.on('bedrock-express.configure.routes', app => {
@@ -47,6 +72,7 @@ bedrock.events.on('bedrock-express.configure.routes', app => {
   const profileAgentsPath = '/profile-agents';
   const profileAgentPath = `${profileAgentsPath}/:profileAgentId`;
   const routes = {
+    interactions: `/interactions`,
     profiles: basePath,
     profileAgents: `${profileAgentsPath}`,
     profileAgent: `${profileAgentPath}`,
@@ -402,6 +428,52 @@ bedrock.events.on('bedrock-express.configure.routes', app => {
 
       res.status(204).end();
     }));
+
+  // optional interactions feature
+  const {interactions} = cfg;
+  if(interactions?.enabled) {
+    // create an interaction to exchange VCs
+    app.post(
+      routes.interactions,
+      ensureAuthenticated,
+      validate({bodySchema: schemas.createInteraction}),
+      asyncHandler(async (req, res) => {
+        const {id: accountId} = req.user.account || {};
+        const {workflowName, exchange: {variables}} = req.body;
+
+        const workflow = WORKFLOWS_MAP.get(workflowName);
+        if(!workflow) {
+          throw new BedrockError(`Workflow "${workflowName}" not found.`, {
+            name: 'NotFoundError',
+            details: {
+              httpStatusCode: 404,
+              public: true
+            }
+          });
+        }
+
+        // create exchange with given variables
+        const exchange = {
+          // 15 minute expiry in seconds
+          ttl: 60 * 15,
+          // template variables
+          variables: {
+            ...variables,
+            accountId
+          }
+        };
+        const capability = workflow.zcaps.get('createExchange');
+        const response = await ZCAP_CLIENT.write({json: exchange, capability});
+        const exchangeId = response.headers.get('location');
+        // reuse `localExchangeId` as interaction ID
+        const localExchangeId = exchangeId.slice(exchangeId.lastIndexOf('/'));
+        const id = `${config.server.baseUri}/${routes.interactions}` +
+          localExchangeId;
+        res.json({id, exchangeId});
+      }));
+
+    // FIXME: implement GET `/interactions/<localExchangeId>`
+  }
 });
 
 // return select properties in the profileAgent record which does NOT include

schemas/bedrock-profile-http.js

@@ -1,5 +1,5 @@
 /*!
- * Copyright (c) 2020-2022 Digital Bazaar, Inc. All rights reserved.
+ * Copyright (c) 2020-2024 Digital Bazaar, Inc. All rights reserved.
  */
 const account = {
   title: 'Account',
@@ -162,10 +162,47 @@ const delegateCapability = {
   }
 };
 
+const createInteraction = {
+  title: 'Create Interaction',
+  type: 'object',
+  required: ['workflowId', 'exchange'],
+  additionalProperties: false,
+  properties: {
+    workflowName: {
+      type: 'string'
+    },
+    exchange: {
+      type: 'object',
+      required: ['variables'],
+      variables: {
+        type: 'object',
+        additionalProperties: false,
+        oneOf: [{
+          required: ['verifiablePresentation']
+        }, {
+          required: ['verifiablePresentationRequest']
+        }],
+        properties: {
+          allowUnprotectedPresentation: {
+            type: 'boolean'
+          },
+          verifiablePresentation: {
+            type: 'object'
+          },
+          verifiablePresentationRequest: {
+            type: 'object'
+          }
+        }
+      }
+    }
+  }
+};
+
 export {
   profileAgent,
   profileAgents,
   accountQuery,
   delegateCapability,
+  createInteraction,
   zcaps
 };

test/mocha/10-api.js

@@ -1,5 +1,5 @@
 /*!
- * Copyright (c) 2020-2022 Digital Bazaar, Inc. All rights reserved.
+ * Copyright (c) 2020-2024 Digital Bazaar, Inc. All rights reserved.
  */
 import * as helpers from './helpers.js';
 import {config} from '@bedrock/core';

test/package.json

@@ -36,6 +36,7 @@
     "@bedrock/ssm-mongodb": "^10.1.0",
     "@bedrock/test": "^8.0.5",
     "@bedrock/validation": "^7.1.0",
+    "@bedrock/vc-verifier": "digitalbazaar/bedrock-vc-verifier#update-vc-2.0",
     "@bedrock/veres-one-context": "^15.0.0",
     "@bedrock/zcap-storage": "^8.0.0",
     "@digitalbazaar/zcap": "^9.0.0",