@verii/server-credentialing-hub 2.0.0

package/src/controllers/operator/relying-party-services/relying-party-services-controller.js

@@ -0,0 +1,202 @@
+/*
+ * Copyright 2024 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 { coerceArray } = require('@verii/common-functions');
+const { tenantLoaderPlugin } = require('../../../entities/tenants');
+const {
+  createServiceConfiguration,
+  updateServiceConfiguration,
+  deleteServiceConfiguration,
+  validateServiceConfiguration,
+  validateUpdateServiceConfiguration,
+} = require('../../../entities/service-configurations');
+const {
+  relyingPartyConfigurationSchema,
+  newRelyingPartyConfigurationSchema,
+} = require('./schemas');
+
+const REPO_NAME = 'relyingPartyServices';
+const createRelyingPartyServiceConfiguration = createServiceConfiguration(
+  REPO_NAME,
+  validateServiceConfiguration,
+);
+const updateRelyingPartyServiceConfiguration = updateServiceConfiguration(
+  REPO_NAME,
+  validateUpdateServiceConfiguration(validateServiceConfiguration),
+);
+const deleteRelyingPartyServiceConfiguration =
+  deleteServiceConfiguration(REPO_NAME);
+
+module.exports = async (fastify) => {
+  fastify
+    .addSchema(relyingPartyConfigurationSchema)
+    .addSchema(newRelyingPartyConfigurationSchema)
+    .register(tenantLoaderPlugin, { notFoundStatusCode: 400 })
+    .post(
+      '/create',
+      {
+        schema: fastify.autoSchema({
+          body: {
+            type: 'object',
+            properties: {
+              tenantId: {
+                type: 'string',
+              },
+              service: {
+                $ref: 'new-relying-party-service',
+              },
+            },
+            required: ['tenantId', 'service'],
+          },
+          response: {
+            200: {
+              type: 'object',
+              properties: {
+                service: { $ref: 'relying-party-service' },
+                requestId: { type: 'string' },
+              },
+              required: ['service', 'requestId'],
+            },
+          },
+        }),
+      },
+      async (req) => {
+        const service = await createRelyingPartyServiceConfiguration(
+          req.body.service,
+          req,
+        );
+        return { service };
+      },
+    )
+    .get(
+      '/get',
+      {
+        schema: fastify.autoSchema({
+          query: {
+            type: 'object',
+            properties: {
+              tenantId: {
+                type: 'string',
+              },
+              serviceId: {
+                anyOf: [
+                  { type: 'string' },
+                  {
+                    type: 'array',
+                    items: {
+                      type: 'string',
+                    },
+                  },
+                ],
+              },
+            },
+            required: ['tenantId'],
+          },
+          response: {
+            200: {
+              type: 'object',
+              properties: {
+                services: {
+                  type: 'array',
+                  items: {
+                    $ref: 'relying-party-service',
+                  },
+                },
+                requestId: { type: 'string' },
+              },
+              required: ['services', 'requestId'],
+            },
+          },
+        }),
+      },
+      async (req) => {
+        const { query, repos } = req;
+        const services = await repos.relyingPartyServices.findServices(
+          coerceArray(query.serviceId),
+        );
+        return { services };
+      },
+    )
+    .post(
+      '/update',
+      {
+        schema: fastify.autoSchema({
+          body: {
+            type: 'object',
+            properties: {
+              tenantId: {
+                type: 'string',
+              },
+              serviceId: {
+                type: 'string',
+              },
+              service: {
+                $ref: 'new-relying-party-service',
+              },
+            },
+            required: ['tenantId', 'serviceId', 'service'],
+          },
+          response: {
+            200: {
+              type: 'object',
+              properties: {
+                service: { $ref: 'relying-party-service' },
+                requestId: { type: 'string' },
+              },
+              required: ['service', 'requestId'],
+            },
+          },
+        }),
+      },
+      async (req) => {
+        const service = await updateRelyingPartyServiceConfiguration(
+          req.body.serviceId,
+          req.body.service,
+          req,
+        );
+        return { service };
+      },
+    )
+    .post(
+      '/delete',
+      {
+        schema: fastify.autoSchema({
+          body: {
+            type: 'object',
+            properties: {
+              tenantId: {
+                type: 'string',
+              },
+              serviceId: {
+                type: 'string',
+              },
+            },
+            required: ['tenantId', 'serviceId'],
+          },
+          response: {
+            200: {
+              type: 'object',
+              properties: {
+                requestId: { type: 'string' },
+              },
+            },
+          },
+        }),
+      },
+      async (req) =>
+        deleteRelyingPartyServiceConfiguration(req.body.serviceId, req),
+    );
+};

package/src/controllers/operator/relying-party-services/schemas/index.js

@@ -0,0 +1,7 @@
+const newRelyingPartyConfigurationSchema = require('./new-relying-party-service.schema');
+const relyingPartyConfigurationSchema = require('./relying-party-service.schema');
+
+module.exports = {
+  relyingPartyConfigurationSchema,
+  newRelyingPartyConfigurationSchema,
+};

package/src/controllers/operator/relying-party-services/schemas/new-relying-party-service.schema.js

@@ -0,0 +1,91 @@
+const newRelyingPartyServiceSchema = {
+  title: 'new-relying-party-service',
+  $id: 'new-relying-party-service',
+  type: 'object',
+  description: 'The relying-party service describes how issuer is setup',
+  additionalProperties: false,
+  required: ['mode', 'velocityNetworkServiceId', 'termsUrl'],
+  properties: {
+    mode: {
+      type: 'string',
+      enum: ['single', 'feed'],
+      default: 'single',
+      description: 'Single (default) deliveries or a feed',
+    },
+    velocityNetworkServiceId: {
+      type: 'string',
+      description: 'Velocity Network Service Id',
+    },
+    description: {
+      type: 'string',
+      description: 'Description field for the disclosure flow',
+    },
+    termsUrl: {
+      type: 'string',
+      description:
+        'link to a online terms and conditions for issuer or disclosure',
+      format: 'uri',
+    },
+    disclosureRequest: {
+      type: 'object',
+      description:
+        'Required if `identificationMethod` contains `verifiable_presentation`',
+      required: ['types', 'purpose', 'retentionPeriod'],
+      properties: {
+        types: {
+          type: 'array',
+          description: 'the set of types that are to be disclosed.',
+          minItems: 1,
+          items: {
+            type: 'object',
+            properties: {
+              type: {
+                type: 'string',
+                description: 'The credential type to be disclosed',
+              },
+            },
+          },
+        },
+        purpose: {
+          type: 'string',
+          description:
+            // eslint-disable-next-line max-len
+            'purpose is a summary of the description\n\n*required*, if the `configurationType` is `inspection` or the `identificationMode` is `verifiable_presentation`',
+        },
+        retentionPeriod: {
+          type: 'string',
+          description:
+            // eslint-disable-next-line max-len
+            '*required*, if the `configurationType` is `inspection` or the `identificationMode` is `verifiable_presentation`\n\nLength of time the disclosure agreement will last.  Duration can be any length of time.\n\nFollows the ISO 8601 standard on durations for time intervals.\n\nFormat:\n\nPxYxMxWxD\n\nWhere:\nx = an integer\nY = Years\nM = Months\nW = Weeks\nD = Days\n\nA valid format requires "P" plus at least one integer and time unit.\n\nExamples: \nP60D = 60 days\nP1Y30D = 1 year and 30 days.',
+          format: 'duration',
+        },
+      },
+    },
+    presentationDefinition: {
+      type: 'object',
+      description:
+        'A spec compliant presentation definition. https://identity.foundation/presentation-exchange/#presentation-definition',
+      additionalProperties: true,
+    },
+    deactivationDate: {
+      type: 'string',
+      format: 'date-time',
+      description:
+        'can be configured to deactivate at a predetermined time or to be deactivated on demand by setting this to now',
+    },
+    authTokensExpireIn: {
+      type: 'integer',
+      minimum: 1,
+      default: 604800,
+    },
+    presentationRequestsExpireIn: {
+      type: 'integer',
+      minimum: 1,
+      default: 600,
+      description:
+        'how many seconds before presentation requests issued by this service expire. Default is 10 minutes',
+    },
+  },
+};
+
+module.exports = newRelyingPartyServiceSchema;

package/src/controllers/operator/relying-party-services/schemas/relying-party-service.schema.js

@@ -0,0 +1,26 @@
+const { mutableEntitySchema } = require('@verii/common-schemas');
+const newRelyingPartyConfigurationSchema = require('./new-relying-party-service.schema');
+
+const relyingPartyServiceSchema = {
+  title: 'relying-party-service',
+  $id: 'relying-party-service',
+  description: 'The relying-party service',
+  type: 'object',
+  additionalProperties: false,
+  properties: {
+    genericRedirectUrl: {
+      type: 'string',
+      format: 'uri',
+      description:
+        'only returned if authMethod include `verifiable_presentation`',
+    },
+    ...mutableEntitySchema.properties,
+    ...newRelyingPartyConfigurationSchema.properties,
+  },
+  required: [
+    ...mutableEntitySchema.required,
+    ...newRelyingPartyConfigurationSchema.required,
+  ],
+};
+
+module.exports = relyingPartyServiceSchema;

package/src/controllers/operator/tenants/schemas/index.js

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2024 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 jwkSchema = require('./jwk.schema.json');
+const newTenantSchema = require('./new-tenant.schema.json');
+const tenantSchema = require('./tenant.schema.json');
+const newKeyMetadataSchema = require('./new-key-metadata.schema.json');
+const keyMetadataSchema = require('./key-metadata.schema.json');
+const secretKeySchema = require('./secret-key.schema.json');
+const newKeySchema = require('./new-key.schema.json');
+
+module.exports = {
+  jwkSchema,
+  newTenantSchema,
+  tenantSchema,
+  newKeyMetadataSchema,
+  keyMetadataSchema,
+  secretKeySchema,
+  newKeySchema,
+};

package/src/controllers/operator/tenants/schemas/jwk.schema.json

@@ -0,0 +1,56 @@
+{
+  "title": "jwk",
+  "$id": "jwk",
+  "description": "jwk schema",
+  "type": "object",
+  "required": [
+    "kty"
+  ],
+  "properties": {
+    "kty": {
+      "type": "string"
+    },
+    "use": {
+      "type": "string"
+    },
+    "key_ops": {
+      "type": "string"
+    },
+    "x5u": {
+      "type": "string"
+    },
+    "x5c": {
+      "type": "string"
+    },
+    "x5t": {
+      "type": "string"
+    },
+    "x5t#S256": {
+      "type": "string"
+    },
+    "alg": {
+      "type": "string"
+    },
+    "kid": {
+      "type": "string"
+    },
+    "exp": {
+      "type": "string"
+    },
+    "crv": {
+      "type": "string"
+    },
+    "y": {
+      "type": "string"
+    },
+    "x": {
+      "type": "string"
+    },
+    "n": {
+      "type": "string"
+    },
+    "e": {
+      "type": "string"
+    }
+  }
+}

package/src/controllers/operator/tenants/schemas/key-metadata.schema.json

@@ -0,0 +1,12 @@
+{
+  "$id": "key-metadata",
+  "title": "Key Metadata",
+  "allOf": [
+    {
+      "$ref": "new-key-metadata#"
+    },
+    {
+      "$ref": "immutable-entity#"
+    }
+  ]
+}

package/src/controllers/operator/tenants/schemas/new-key-metadata.schema.json

@@ -0,0 +1,42 @@
+{
+  "$id": "new-key-metadata",
+  "title": "New Key Metadata",
+  "type": "object",
+  "properties": {
+    "purposes": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "string",
+        "enum": [
+          "DLT_TRANSACTIONS",
+          "EXCHANGES",
+          "ISSUING_METADATA"
+        ]
+      }
+    },
+    "algorithm": {
+      "type": "string",
+      "enum": [
+        "SECP256K1"
+      ],
+      "default": "SECP256K1"
+    },
+    "encoding": {
+      "type": "string",
+      "enum": [
+        "hex",
+        "jwk"
+      ]
+    },
+    "kidFragment": {
+      "type": "string",
+      "pattern": "^#[A-Za-z0-9._:?=&%;-]+$"
+    }
+  },
+  "required": [
+    "purposes",
+    "encoding",
+    "kidFragment"
+  ]
+}

package/src/controllers/operator/tenants/schemas/new-key.schema.json

@@ -0,0 +1,12 @@
+{
+  "$id": "new-key",
+  "title": "New key",
+  "allOf": [
+    {
+      "$ref": "new-key-metadata#"
+    },
+    {
+      "$ref": "secret-key#"
+    }
+  ]
+}

package/src/controllers/operator/tenants/schemas/new-tenant.schema.json

@@ -0,0 +1,33 @@
+{
+  "title": "Tenant creation",
+  "$id": "new-tenant",
+  "type": "object",
+  "properties": {
+    "did": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:[A-Za-z0-9._:?=&%;-]+$"
+    },
+    "hostUrl": {
+      "type": "string",
+      "format": "uri"
+    },
+    "primaryAccount": {
+      "type": "string"
+    },
+    "caoDid": {
+      "type": "string"
+    },
+    "name": {
+      "type": "string"
+    },
+    "logo": {
+      "type": "string",
+      "format": "uri"
+    }
+  },
+  "required": [
+    "did",
+    "name",
+    "logo"
+  ]
+}

package/src/controllers/operator/tenants/schemas/secret-key.schema.json

@@ -0,0 +1,33 @@
+{
+  "title": "Secret key Value",
+  "$id": "secret-key",
+  "description": "A secret key",
+  "oneOf": [
+    {
+      "type": "object",
+      "properties": {
+        "key": {
+          "type": "string"
+        },
+        "encoding": {
+          "type": "string",
+          "enum": ["hex"]
+        }
+      },
+      "required": ["key"]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "jwk": {
+          "$ref": "jwk#"
+        },
+        "encoding": {
+          "type": "string",
+          "enum": ["jwk"]
+        }
+      },
+      "required": ["jwk"]
+    }
+  ]
+}

package/src/controllers/operator/tenants/schemas/tenant.schema.json

@@ -0,0 +1,44 @@
+{
+  "title": "Tenant",
+  "$id": "tenant",
+  "additionalProperties": false,
+  "allOf": [
+    {
+      "$ref": "mutable-entity#"
+    },
+    {
+      "$ref": "new-tenant#"
+    },
+    {
+      "type": "object",
+      "properties": {
+        "did": {
+          "type": "string",
+          "pattern": "^did:[a-z0-9]+:[A-Za-z0-9._:?=&%;-]+$"
+        },
+        "name": {
+          "type": "string",
+          "description": "did for the org"
+        },
+        "logo": {
+          "type": "string",
+          "format": "uri"
+        },
+        "description": {
+          "type": "string",
+          "description": "did for the org"
+        }
+      }
+    }
+  ],
+  "examples": [
+    {
+      "id": "5fsdflkdsfsdfsfwwerr",
+      "did": "did:ion:129031903190239123021312",
+      "name": "ACME Limited",
+      "logo": "http://example.com/logo.com",
+      "createdAt": "2019-08-24T14:15:22Z",
+      "updatedAt": "2019-08-24T14:15:22Z"
+    }
+  ]
+}