@verii/server-credentialagent 1.0.0-pre.1752076816

package/src/config/operator-config.js

@@ -0,0 +1,64 @@
+/**
+ * Copyright 2023 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const env = require('env-var');
+const { merge } = require('lodash/fp');
+const { coreConfig } = require('./core-config');
+
+const operatorSwaggerConfig = {
+  swaggerInfo: merge(coreConfig.swaggerInfo, {
+    info: {
+      title: 'Credential Agent Operator Openapi',
+      description: 'APIs for operators',
+    },
+    tags: [
+      { name: 'tenants', description: 'Operator tenants' },
+      { name: 'disclosures', description: 'Operator disclosures' },
+      {
+        name: 'users',
+        description: 'Operator authenticated users',
+      },
+      {
+        name: 'credentials',
+        description: 'Operator issued credentials',
+      },
+      {
+        name: 'offer-exchanges',
+        description: 'Operator issuing exchanges & offers',
+      },
+      {
+        name: 'verification',
+        description: 'Operator presentation verification',
+      },
+    ],
+  }),
+};
+
+const operatorConfig = {
+  ...coreConfig,
+  ...operatorSwaggerConfig,
+  adminUserName: env
+    .get('ADMIN_USER_NAME')
+    .required(!coreConfig.isTest)
+    .asString(),
+  vcApiEnabled: env.get('VC_API_ENABLED').default('false').asBool(),
+  vendorCredentialsIncludeIssuedClaim: env
+    .get('VENDOR_CREDENTIALS_INCLUDE_ISSUED_CLAIM')
+    .default('false')
+    .asBool(),
+};
+
+module.exports = { operatorConfig };

package/src/controllers/autoload-holder-api-controllers.js

@@ -0,0 +1,30 @@
+/**
+ * Copyright 2023 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const AutoLoad = require('@fastify/autoload');
+const path = require('path');
+
+const autoloadHolderApiControllers = async (fastify) =>
+  fastify.register(AutoLoad, {
+    dir: path.join(__dirname, 'holder'),
+    indexPattern: /^.*controller(\.ts|\.js|\.cjs|\.mjs)$/,
+    ignorePattern: /^.*index(\.ts|\.js|\.cjs|\.mjs)$/,
+    autoHooks: true,
+    cascadeHooks: true,
+    options: { prefix: '/api/holder/v0.6/org/:tenantId' },
+  });
+
+module.exports = { autoloadHolderApiControllers };

package/src/controllers/autoload-operator-api-controllers.js

@@ -0,0 +1,31 @@
+/**
+ * Copyright 2023 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const AutoLoad = require('@fastify/autoload');
+const path = require('path');
+
+const autoloadOperatorApiControllers = async (fastify) =>
+  fastify.register(AutoLoad, {
+    dir: path.join(__dirname, 'operator'),
+    scriptPattern: /.*dont-match-scripts.*(\.ts|\.js|\.cjs|\.mjs)$/,
+    indexPattern: /^.*controller-v0.8(\.ts|\.js|\.cjs|\.mjs)$/,
+    routeParams: true,
+    autoHooks: true,
+    cascadeHooks: true,
+    options: { prefix: '/operator-api/v0.8' },
+  });
+
+module.exports = { autoloadOperatorApiControllers };

package/src/controllers/autoload-root-api-controller.js

@@ -0,0 +1,30 @@
+/**
+ * Copyright 2023 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const AutoLoad = require('@fastify/autoload');
+const path = require('path');
+
+const autoloadRootApiController = async (fastify) =>
+  fastify.register(AutoLoad, {
+    dir: path.join(__dirname, 'root'),
+    indexPattern: /^.*controller(\.ts|\.js|\.cjs|\.mjs)$/,
+    ignorePattern: /^.*index(\.ts|\.js|\.cjs|\.mjs)$/,
+    autoHooks: true,
+    cascadeHooks: true,
+    options: { prefix: '/' },
+  });
+
+module.exports = { autoloadRootApiController };

package/src/controllers/autoload-saasoperator-api-controllers.js

@@ -0,0 +1,31 @@
+/**
+ * Copyright 2023 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const AutoLoad = require('@fastify/autoload');
+const path = require('path');
+
+const autoloadSaasoperatorApiControllers = async (fastify) =>
+  fastify.register(AutoLoad, {
+    dir: path.join(__dirname, 'saasoperator'),
+    scriptPattern: /.*dont-match-scripts.*(\.ts|\.js|\.cjs|\.mjs)$/,
+    indexPattern: /^.*controller(\.ts|\.js|\.cjs|\.mjs)$/,
+    routeParams: true,
+    autoHooks: true,
+    cascadeHooks: true,
+    options: { prefix: '/' },
+  });
+
+module.exports = { autoloadSaasoperatorApiControllers };

package/src/controllers/holder/autohooks.js

@@ -0,0 +1,55 @@
+/**
+ * Copyright 2023 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const {
+  tenantLoaderPlugin,
+  kmsPlugin,
+  groupLoaderPlugin,
+  ensureTenantPrimaryAddressPlugin,
+} = require('../../plugins');
+
+module.exports = async (fastify) =>
+  fastify
+    .register(tenantLoaderPlugin)
+    .register(ensureTenantPrimaryAddressPlugin)
+    .register(kmsPlugin)
+    .register(groupLoaderPlugin)
+    .decorateRequest('vendorFetch', null)
+    .decorateRequest('universalResolverFetch', null)
+    .decorateRequest('registrarFetch', null)
+    .decorateRequest('fetch', null)
+    .decorateRequest('libFetch', null)
+    .addHook('preValidation', async (req) => {
+      req.vendorFetch = fastify.baseVendorFetch(req);
+    })
+    .addHook('preValidation', async (req) => {
+      req.universalResolverFetch = fastify.baseUniversalResolverFetch(req);
+    })
+    .addHook('preValidation', async (req) => {
+      req.registrarFetch = fastify.baseRegistrarFetch(req);
+    })
+    .addHook('preValidation', async (req) => {
+      req.fetch = fastify.baseFetch(req);
+    })
+    .addHook('preValidation', async (req) => {
+      req.libFetch = fastify.baseLibFetch(req);
+    })
+    .autoSchemaPreset({
+      params: {
+        type: 'object',
+        properties: { organizationDID: { type: 'string' } },
+      },
+    });

package/src/controllers/holder/get-exchange-progress/autohooks.js

@@ -0,0 +1,27 @@
+/**
+ * Copyright 2023 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const {
+  exchangeLoaderPlugin,
+  verifyAccessTokenPlugin,
+} = require('../../../plugins');
+
+module.exports = async (fastify) => {
+  fastify
+    .register(exchangeLoaderPlugin)
+    .register(verifyAccessTokenPlugin, { user: true })
+    .autoSchemaPreset({ security: [{ bearerAuth: [] }] });
+};

package/src/controllers/holder/get-exchange-progress/controller.js

@@ -0,0 +1,50 @@
+/**
+ * Copyright 2023 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const { buildExchangeProgress } = require('../../../entities');
+
+const getExchangeProgressController = async (fastify) => {
+  fastify.get(
+    '/',
+    {
+      schema: fastify.autoSchema({
+        tags: ['common'],
+        querystring: {
+          type: 'object',
+          properties: {
+            exchange_id: { type: 'string' },
+          },
+          required: ['exchange_id'],
+        },
+        response: {
+          200: {
+            type: 'object',
+            properties: {
+              id: { type: 'string' },
+              type: { type: 'string' },
+              disclosureComplete: { type: 'boolean' },
+              exchangeComplete: { type: 'boolean' },
+              exchangeError: { type: 'string' },
+            },
+          },
+        },
+      }),
+    },
+    async ({ exchange }) => buildExchangeProgress(exchange)
+  );
+};
+
+module.exports = getExchangeProgressController;

package/src/controllers/holder/inspect/autohooks.js

@@ -0,0 +1,35 @@
+/**
+ * Copyright 2023 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const { exchangeErrorHandlerPlugin } = require('../../../plugins');
+const {
+  presentationSubmissionSchema,
+  siopPresentationSubmissionSchema,
+  velocityPresentationSubmissionSchema,
+  velocityPresentationSubmissionResponseSchema,
+  holderDisclosureSchema,
+} = require('./schemas');
+
+module.exports = async (fastify) => {
+  fastify
+    .register(exchangeErrorHandlerPlugin)
+    .addSchema(holderDisclosureSchema)
+    .addSchema(presentationSubmissionSchema)
+    .addSchema(siopPresentationSubmissionSchema)
+    .addSchema(velocityPresentationSubmissionSchema)
+    .addSchema(velocityPresentationSubmissionResponseSchema)
+    .autoSchemaPreset({ tags: ['presentations'] });
+};

package/src/controllers/holder/inspect/get-presentation-request/controller.js

@@ -0,0 +1,100 @@
+/**
+ * Copyright 2023 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const { omitBy, isNil } = require('lodash/fp');
+const {
+  getPushDelegate,
+} = require('../../../../entities/push-delegate/get-push-delegate');
+const {
+  ExchangeTypes,
+  ExchangeProtocols,
+  buildRequestResponseSchema,
+  createPresentationRequest,
+  signExchangeResponse,
+} = require('../../../../entities');
+const {
+  ensureDisclosureConfigurationTypePlugin,
+  ensureDisclosureActivePlugin,
+} = require('../../../../plugins');
+
+const controller = async (fastify) => {
+  fastify.register(ensureDisclosureConfigurationTypePlugin);
+  fastify.register(ensureDisclosureActivePlugin);
+  fastify.get(
+    '/',
+    {
+      schema: fastify.autoSchema({
+        querystring: {
+          type: 'object',
+          properties: {
+            id: { type: 'string' },
+            format: { type: 'string', enum: ['json'] },
+          },
+          required: ['id'],
+        },
+        params: {
+          type: 'object',
+          properties: {
+            'push_delegate.push_token': { type: 'string' },
+            'push_delegate.push_url': { type: 'string' },
+          },
+        },
+        response: {
+          200: buildRequestResponseSchema('presentation', fastify.config),
+        },
+      }),
+    },
+    async (req) => {
+      const {
+        repos,
+        query,
+        config: { isProd },
+      } = req;
+      const disclosure = await repos.disclosures.findById(query.id);
+
+      const pushDelegate = getPushDelegate(query.push_delegate, req);
+
+      const exchange = await repos.exchanges.insertWithInitialState(
+        omitBy(isNil, {
+          type: ExchangeTypes.DISCLOSURE,
+          pushDelegate,
+          disclosureId: disclosure._id,
+          protocolMetadata: {
+            protocol: ExchangeProtocols.VNF_API,
+          },
+        })
+      );
+      // eslint-disable-next-line better-mutation/no-mutation
+      req.exchange = exchange; // exchange is added onto the request for the exchange error handler
+
+      const presentationRequest = await createPresentationRequest(
+        disclosure,
+        exchange,
+        req
+      );
+
+      // eslint-disable-next-line camelcase
+      return {
+        presentation_request:
+          !isProd && req.query.format === 'json'
+            ? presentationRequest
+            : await signExchangeResponse(presentationRequest, {}, req),
+      };
+    }
+  );
+};
+
+module.exports = controller;

package/src/controllers/holder/inspect/schemas/holder-disclosure.schema.json

@@ -0,0 +1,73 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://velocitycareerlabs.io/holder-disclosure.schema.json",
+  "type": "object",
+  "additionalProperties": false,
+  "description": "The disclosure request made by an inspector on the velocity newtwork. It describes credential types wanted and (in the future) predicate information as well as terms and conditions for usage of the data",
+  "allOf": [
+    { "$ref": "mutable-entity#"},
+    {
+    "properties": {
+      "description": {
+        "type": "string",
+        "description": "Description field for this disclosure"
+      },
+      "types": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "description": "The credential type to be disclosed"
+            }
+          }
+        },
+        "description": "To be expanded. Predicates will be added and associated with each credential type. Enables expression of expressions that limit the kinds of credential requested",
+        "minItems": 1
+      },
+      "organization": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "DID of the inspecting organization"
+          },
+          "logo": {
+            "type": "string",
+            "format": "uri",
+            "description": "URL to a logo"
+          },
+          "name": {
+            "type": "string",
+            "description": "name of the inspecting organization"
+          },
+          "description": {
+            "type": "string",
+            "description": "description of the inspecting organization"
+          }
+        }
+      },
+      "purpose": {
+        "type": "string",
+        "description": "purpose is a summary of the description"
+      },
+      "duration": {
+        "type": "string",
+        "description": "duration can be a number of days (5d), weeks (12w), months (6m) or years (7y)"
+      },
+      "termsUrl": {
+        "type": "string"
+      }
+    }
+  }],
+  "required": [
+    "id",
+    "types",
+    "organization",
+    "purpose",
+    "duration",
+    "createdAt",
+    "updatedAt"
+  ]
+}

package/src/controllers/holder/inspect/schemas/index.js

@@ -0,0 +1,33 @@
+/**
+ * Copyright 2023 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const presentationRequestSchema = require('./presentation-request.schema.json');
+const presentationSubmissionSchema = require('./presentation-submission.schema.json');
+const siopPresentationSubmissionSchema = require('./siop-presentation-submission.schema.json');
+const velocityPresentationSubmissionSchema = require('./velocity-presentation-submission.schema.json');
+const velocityPresentationSubmissionResponseSchema = require('./velocity-presentation-submission.response.200.schema.json');
+const holderDisclosureSchema = require('./holder-disclosure.schema.json');
+const presentationDefinitionV1Schema = require('./presentation-definition.v1.schema.json');
+
+module.exports = {
+  holderDisclosureSchema,
+  presentationRequestSchema,
+  presentationSubmissionSchema,
+  siopPresentationSubmissionSchema,
+  velocityPresentationSubmissionSchema,
+  velocityPresentationSubmissionResponseSchema,
+  presentationDefinitionV1Schema,
+};