@verii/server-credentialing-hub 2.0.0

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

@@ -0,0 +1,137 @@
+const newIssuerServiceSchema = {
+  title: 'new-issuer-service',
+  $id: 'new-issuer-service',
+  type: 'object',
+  description: 'The issuer service describes how issuer is setup',
+  additionalProperties: false,
+  required: ['velocityNetworkServiceId', 'termsUrl', 'authMethods', 'authMode'],
+  properties: {
+    velocityNetworkServiceId: {
+      type: 'string',
+      description: 'Velocity Network Service Id',
+    },
+    description: {
+      type: 'string',
+      description: 'Description field for the issuer flow',
+    },
+    termsUrl: {
+      type: 'string',
+      description:
+        'link to a online terms and coniditions 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: 'number',
+      default: 604800,
+    },
+    authMethods: {
+      type: 'array',
+      minItems: 1,
+      description:
+        // eslint-disable-next-line max-len
+        'the auth method indicates what authentication method(s) are supported for issuer. To use `preauth` requires the issuer to include a `vendorOriginContext` in the deep link. `verifiable_presentation` requires a `disclosureRequest` or `presentationDefinition` to be specified.\nIn the future an issuer will be able to use both methods in one disclosure\n`authMethods` is required with at least one entry ',
+      items: {
+        type: 'string',
+        enum: ['preauth', 'verifiable_presentation'],
+      },
+    },
+    authMode: {
+      enum: ['internal'],
+      description: 'the auth mode. Currently only `internal` is supported',
+    },
+    verifiablePresentationAuthRules: {
+      description:
+        // eslint-disable-next-line max-len
+        'verifiablePresentationAuthRules are the matcher rules that can be used to match an exchange with submitted presentation used for authentication. Required when the authMethods include `verifiable_presentation` and the authMode is `internal`',
+      type: 'array',
+      items: {
+        type: 'object',
+        required: ['path', 'rule', 'valueIndex'],
+        properties: {
+          path: {
+            type: 'array',
+            description: 'json path(s) to resolve in order',
+            items: {
+              type: 'string',
+            },
+          },
+          rule: {
+            type: 'string',
+            description: 'the rule to run. ONly pick is supported right ow',
+            enum: ['pick', 'equal'],
+          },
+          valueIndex: {
+            type: 'integer',
+            description:
+              'the index to use with in a data row in values. Value must return true when compared using ===',
+          },
+        },
+      },
+    },
+    challengesExpireIn: {
+      type: 'number',
+      default: 600,
+      description:
+        'how many seconds before challenges issued by this service expire. Default is 10 minutes',
+    },
+    credentialTypesAvailable: {
+      type: 'array',
+      description: 'the types of credentials available from this service',
+      items: {
+        type: 'string',
+      },
+    },
+    autoCleanPII: {
+      type: 'boolean',
+    },
+  },
+};
+
+module.exports = newIssuerServiceSchema;

package/src/controllers/operator/presentation-links/presentation-links-controller.js

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2026 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 { refreshPresentationLinks } = require('../../../entities/links');
+const { tenantLoaderPlugin } = require('../../../entities/tenants');
+
+const presentationLinksController = async (fastify) => {
+  fastify.register(tenantLoaderPlugin, { notFoundStatusCode: 400 }).post(
+    '/refresh',
+    {
+      schema: fastify.autoSchema({
+        body: {
+          type: 'object',
+          properties: {
+            tenantId: {
+              type: 'string',
+            },
+            serviceId: {
+              type: 'string',
+            },
+            depotId: {
+              type: 'string',
+            },
+          },
+          required: ['tenantId', 'serviceId'],
+        },
+        response: {
+          200: {
+            type: 'object',
+            properties: {
+              redirectUrl: {
+                type: 'string',
+                format: 'uri',
+              },
+              vnProtocolLink: {
+                type: 'string',
+                format: 'uri',
+              },
+              openid4vpProtocolLink: {
+                type: 'string',
+                format: 'uri',
+              },
+              requestId: {
+                type: 'string',
+              },
+            },
+            required: [
+              'redirectUrl',
+              'vnProtocolLink',
+              'openid4vpProtocolLink',
+              'requestId',
+            ],
+          },
+        },
+      }),
+    },
+    async (req) =>
+      refreshPresentationLinks(req.body.serviceId, req.body.depotId, req),
+  );
+};
+
+module.exports = presentationLinksController;

package/src/controllers/operator/presentations/presentations-controller.js

@@ -0,0 +1,174 @@
+/*
+ * 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 newError = require('http-errors');
+const {
+  w3cVcSchema,
+  newOfferRelatedResourceSchema,
+} = require('@verii/common-schemas');
+const { tenantLoaderPlugin } = require('../../../entities/tenants');
+const { verifyPresentation } = require('../../../entities/presentations');
+const {
+  basePresentationSchema,
+  credentialVerificationSchema,
+  presentationVerificationSchema,
+  presentationSchema,
+  w3cPresentationSchema,
+} = require('./schemas');
+
+module.exports = async (fastify) => {
+  fastify
+    .addSchema(newOfferRelatedResourceSchema)
+    .addSchema(w3cVcSchema)
+    .addSchema(credentialVerificationSchema)
+    .addSchema(presentationSchema)
+    .addSchema(presentationVerificationSchema)
+    .addSchema(w3cPresentationSchema)
+    .register(tenantLoaderPlugin, { notFoundStatusCode: 400 })
+    .get(
+      '/get',
+      {
+        schema: fastify.autoSchema({
+          query: {
+            type: 'object',
+            properties: {
+              tenantId: {
+                type: 'string',
+              },
+              depotId: {
+                type: 'string',
+              },
+              exchangeId: {
+                type: 'string',
+              },
+              presentationId: {
+                type: 'string',
+              },
+            },
+            required: ['tenantId'],
+          },
+          response: {
+            200: {
+              type: 'object',
+              properties: {
+                presentations: {
+                  type: 'array',
+                  items: { $ref: 'presentation#' },
+                },
+                requestId: {
+                  type: 'string',
+                },
+              },
+            },
+          },
+        }),
+      },
+      async (req) => {
+        const {
+          query: { presentationId, depotId, exchangeId },
+          repos,
+        } = req;
+        const presentations = await repos.presentations.search({
+          presentationIds: presentationId ? [presentationId] : [],
+          depotId,
+          exchangeId,
+        });
+
+        return { presentations };
+      },
+    )
+    .post(
+      '/verify',
+      {
+        schema: fastify.autoSchema({
+          body: {
+            type: 'object',
+            anyOf: [
+              {
+                type: 'object',
+                properties: {
+                  tenantId: {
+                    type: 'string',
+                  },
+                  presentationId: {
+                    type: 'string',
+                  },
+                },
+                required: ['tenantId', 'presentationId'],
+              },
+              {
+                type: 'object',
+                properties: {
+                  tenantId: {
+                    type: 'string',
+                  },
+                  format: {
+                    type: 'string',
+                    enum: ['JWT_VP'],
+                  },
+                  presentation: {
+                    type: 'string',
+                  },
+                },
+                required: ['tenantId', 'format', 'presentation'],
+              },
+            ],
+          },
+          response: {
+            200: {
+              type: 'object',
+              properties: {
+                ...basePresentationSchema.properties,
+                verification: {
+                  $ref: 'presentation-verification#',
+                },
+                requestId: {
+                  type: 'string',
+                },
+              },
+              required: [...basePresentationSchema.required],
+            },
+            402: {
+              $ref: 'error#',
+            },
+          },
+        }),
+      },
+      async (req) => {
+        if (req.body.presentation) {
+          return verifyPresentation(req.body.presentation, req);
+        }
+        if (req.body.presentationId) {
+          const presentationEntity = await req.repos.presentations.findById(
+            req.body.presentationId,
+          );
+
+          const verification = await verifyPresentation(
+            presentationEntity.presentation,
+            req,
+          );
+          await req.repos.presentations.addVerification(
+            presentationEntity._id,
+            verification.verification,
+          );
+          return verification;
+        }
+        throw newError.BadRequest('presentation verify request invalid', {
+          errorCode: 'presentation_verify_request_invalid',
+        });
+      },
+    );
+};

package/src/controllers/operator/presentations/schemas/base-presentation.schema.js

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2025 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 basePresentationSchema = {
+  $id: 'base-presentation',
+  title: 'base presentation',
+  type: 'object',
+  additionalProperties: false,
+  required: ['format', 'presentation'],
+  properties: {
+    format: {
+      enum: ['JWT_VP'],
+      description: `the format of the data contained in the presentation
+If the format is JWT_VP the presentation will be stored in a variable called presentation`,
+    },
+    presentation: {
+      type: 'string',
+      description: 'the presentation itself',
+    },
+    w3cPresentation: {
+      $ref: 'w3c-presentation#',
+    },
+  },
+};
+
+module.exports = { basePresentationSchema };

package/src/controllers/operator/presentations/schemas/credential-verification.schema.js

@@ -0,0 +1,83 @@
+/*
+ * Copyright 2025 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 credentialVerificationSchema = {
+  title: 'credential-verification',
+  $id: 'credential-verification',
+  type: 'object',
+  additionalProperties: false,
+  required: [
+    'verified',
+    'tamperCheck',
+    'trustedIssuerCheck',
+    'trustedHolderCheck',
+    'revocationCheck',
+    'expiryCheck',
+    'format',
+    'credential',
+    'w3cCredential',
+  ],
+  properties: {
+    format: {
+      enum: ['JWT_VC'],
+    },
+    credential: {
+      type: 'string',
+    },
+    w3cCredential: {
+      $ref: 'https://velocitycareerlabs.io/w3c-vc.schema.json',
+    },
+    verified: {
+      type: 'boolean',
+    },
+    tamperCheck: {
+      type: 'string',
+      enum: ['PASS', 'FAIL', 'UNCHECKED'],
+    },
+    trustedIssuerCheck: {
+      type: 'string',
+      enum: [
+        'PASS',
+        'FAIL',
+        'UNCHECKED',
+        'SELF_SIGNED',
+        'DATA_INTEGRITY_ERROR',
+      ],
+    },
+    trustedHolderCheck: {
+      type: 'string',
+      enum: ['PASS', 'FAIL', 'UNCHECKED', 'NOT_APPLICABLE'],
+    },
+    revocationCheck: {
+      type: 'string',
+      enum: [
+        'PASS',
+        'FAIL',
+        'UNCHECKED',
+        'DEPENDENCY_RESOLUTION_ERROR',
+        'NOT_APPLICABLE',
+      ],
+    },
+    expiryCheck: {
+      type: 'string',
+      enum: ['PASS', 'FAIL', 'UNCHECKED', 'NOT_APPLICABLE'],
+    },
+  },
+};
+
+module.exports = {
+  credentialVerificationSchema,
+};

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

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2025 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.
+ *
+ */
+module.exports = {
+  ...require('./base-presentation.schema'),
+  ...require('./credential-verification.schema'),
+  ...require('./presentation.schema'),
+  ...require('./presentation-verification.schema'),
+  ...require('./w3c-presentation'),
+};

package/src/controllers/operator/presentations/schemas/presentation-verification.schema.js

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2025 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 presentationVerificationSchema = {
+  title: 'presentation-verification',
+  $id: 'presentation-verification',
+  type: 'object',
+  required: ['verified', 'tamperCheck'],
+  properties: {
+    verified: {
+      type: 'boolean',
+    },
+    tamperCheck: {
+      enum: ['PASS', 'FAIL'],
+    },
+    credentials: {
+      type: 'array',
+      items: {
+        $ref: 'credential-verification#',
+      },
+    },
+    createdAt: {
+      type: 'string',
+      format: 'date-time',
+    },
+  },
+};
+
+module.exports = { presentationVerificationSchema };

package/src/controllers/operator/presentations/schemas/presentation.schema.js

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2025 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 { mutableEntitySchema } = require('@verii/common-schemas');
+const { basePresentationSchema } = require('./base-presentation.schema');
+
+const presentationSchema = {
+  $id: 'presentation',
+  type: 'object',
+  properties: {
+    ...mutableEntitySchema.properties,
+    ...basePresentationSchema.properties,
+    depotId: {
+      type: 'string',
+      description: 'The depot associated with this user',
+    },
+    exchangeId: {
+      type: 'string',
+      description:
+        "The exchangeId associated with this presentation's reception",
+    },
+    verifications: {
+      type: 'array',
+      items: {
+        $ref: 'presentation-verification#',
+      },
+      default: [],
+    },
+  },
+  required: [
+    ...mutableEntitySchema.required,
+    ...basePresentationSchema.required,
+    'depotId',
+    'exchangeId',
+  ],
+};
+
+module.exports = {
+  presentationSchema,
+};

package/src/controllers/operator/presentations/schemas/w3c-presentation.js

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2025 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 w3cPresentationSchema = {
+  title: 'w3c presentation',
+  $id: 'w3c-presentation',
+  type: 'object',
+  additionalProperties: true,
+  properties: {
+    id: {
+      type: 'string',
+    },
+    type: {
+      type: 'array',
+      description: 'The JSON-LD type of the credential.',
+      items: {
+        type: 'string',
+      },
+      minItems: 1,
+    },
+    verifiableCredential: {
+      type: 'array',
+      items: {
+        oneOf: [
+          {
+            $ref: 'https://velocitycareerlabs.io/w3c-vc.schema.json',
+          },
+          {
+            type: 'string',
+          },
+        ],
+      },
+    },
+  },
+};
+
+module.exports = {
+  w3cPresentationSchema,
+};