@verii/server-credentialagent 1.0.0-pre.1752076816

package/test/combined/schemas/past-employment-position-with-uri-id.schema.js

@@ -0,0 +1,22 @@
+/**
+ * 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 schema = require('./past-employment-position.schema.json');
+
+module.exports = {
+  ...schema,
+  $id: `https://velocitynetwork.foundation/schemas/${schema.$id}`,
+};

package/test/combined/schemas/past-employment-position.schema.json

@@ -0,0 +1,148 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "PastEmploymentPosition",
+  "$id": "past-employment-position",
+  "type": "object",
+  "definitions": {
+    "DID": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:[A-Za-z0-9._:?=&%;-]+$"
+    },
+    "MultiLingualString": {
+      "type": "object",
+      "properties": {
+        "localized": {
+          "type": "object",
+          "propertyNames": {
+            "pattern": "^[a-z]{2}(_[A-Z]{2})?$"
+          },
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
+        "preferredLocale": {
+          "type": "object",
+          "properties": {
+            "country": {
+              "type": "string",
+              "pattern": "^[A-Z]{2}$"
+            },
+            "language": {
+              "type": "string",
+              "pattern": "^[a-z]{2}$"
+            }
+          }
+        }
+      },
+      "additionalProperties": false,
+      "required": ["localized"]
+    },
+    "Date": {
+      "type": "object",
+      "properties": {
+        "day": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 31
+        },
+        "month": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 12
+        },
+        "year": {
+          "type": "integer",
+          "minimum": 1950
+        }
+      },
+      "additionalProperties": false
+    },
+    "Location": {
+      "type": "object",
+      "properties": {
+        "countryCode": {
+          "type": "string",
+          "pattern": "^[A-Z]{2}$",
+          "description": "An uppercase two-letter country code as defined by [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)"
+        },
+        "regionCode": {
+          "type": "string",
+          "format": "regex",
+          "pattern": "^[A-Za-z0-9]{1,3}(-[A-Za-z0-9]{1,3})?$",
+          "description": "An uppercase region code as defined by [ISO-3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)"
+        }
+      }
+    },
+    "Alignment": {
+      "type": "object",
+      "properties": {
+        "targetName": {
+          "type": "string",
+          "description": "CCSS.ELA-Literacy.RST.11-12.3"
+        },
+        "targetUrl": {
+          "type": "string",
+          "format": "uri",
+          "description": "http://www.corestandards.org/ELA-Literacy/RST/11-12/3"
+        },
+        "targetDescription": {
+          "type": "string",
+          "description": "A description of the ELA ltieracy certification."
+        },
+        "targetCode": {
+          "type": "string",
+          "description": "CCSS.ELA-Literacy.RST.11-12.3"
+        },
+        "targetFramework": {
+          "type": "string",
+          "description": "Mozilla 21st Century Skills"
+        }
+      },
+      "required": ["targetName", "targetUrl"],
+      "additionalProperties": false
+    }
+  },
+  "properties": {
+    "type": {
+      "type": "string",
+      "default": "PastEmploymentPosition"
+    },
+    "company": {
+      "$ref": "#/definitions/DID"
+    },
+    "companyName": {
+      "$ref": "#/definitions/MultiLingualString"
+    },
+    "title": {
+      "$ref": "#/definitions/MultiLingualString"
+    },
+    "description": {
+      "$ref": "#/definitions/MultiLingualString"
+    },
+    "startMonthYear": {
+      "$ref": "#/definitions/Date"
+    },
+    "endMonthYear": {
+      "$ref": "#/definitions/Date"
+    },
+    "location": {
+      "$ref": "#/definitions/Location"
+    },
+    "locationName": {
+      "$ref": "#/definitions/MultiLingualString"
+    },
+    "alignment": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/Alignment"
+      }
+    }
+  },
+  "required": [
+    "company",
+    "companyName",
+    "title",
+    "startMonthYear",
+    "endMonthYear"
+  ]
+}

package/test/combined/schemas/will-always-validate.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "test-will-always-validate",
+  "type": "object",
+  "properties": {
+      "foo": {
+          "type": "string"
+      }
+  }
+}

package/test/combined/validate-cao-plugin.test.js

@@ -0,0 +1,155 @@
+/**
+ * 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 nock = require('nock');
+const { ServiceCategories } = require('@verii/organizations-registry');
+const {
+  validateCao,
+  validateCaoPlugin,
+} = require('../../src/plugins/validate-cao-plugin');
+const buildFastify = require('../operator/helpers/credentialagent-operator-build-fastify');
+
+describe('validate cao plugin test suite', () => {
+  let fastify;
+  let warnSpy;
+
+  beforeEach(async () => {
+    fastify = buildFastify();
+    await fastify.ready();
+    warnSpy = jest.spyOn(fastify.log, 'warn').mockImplementation(() => {});
+  });
+
+  afterEach(async () => {
+    await fastify.close();
+    warnSpy.mockRestore();
+  });
+
+  it('should warn if cao service does not exist', async () => {
+    nock('http://oracle.localhost.test')
+      .get('/api/v0.6/organizations/didtest/verified-profile')
+      .reply(200, {
+        credentialSubject: {
+          permittedVelocityServiceCategory: [ServiceCategories.Issuer],
+        },
+      });
+    await expect(() =>
+      validateCao.call({
+        ...fastify,
+        config: {
+          ...fastify.config,
+          caoDid: 'didtest',
+        },
+      })
+    ).rejects.toThrowError(
+      // eslint-disable-next-line max-len
+      'The provided CAO is not permitted to operator on the network. Make sure the organization exists on the registrar and is approved for Credential Agent Operation'
+    );
+  });
+
+  it('should warn if registrar failed', async () => {
+    nock('http://oracle.localhost.test')
+      .get('/api/v0.6/organizations/didtest/verified-profile')
+      .reply(400, {});
+    await expect(() =>
+      validateCao.call({
+        ...fastify,
+        config: {
+          ...fastify.config,
+          caoDid: 'didtest',
+        },
+      })
+    ).rejects.toThrowError(
+      // eslint-disable-next-line max-len
+      'The provided CAO is not permitted to operator on the network. Make sure the organization exists on the registrar and is approved for Credential Agent Operation'
+    );
+  });
+
+  it('should warn if register does not response', async () => {
+    await validateCao.call({
+      ...fastify,
+      config: {
+        ...fastify.config,
+        caoDid: 'didtest',
+      },
+    });
+    expect(warnSpy).toHaveBeenCalledTimes(1);
+    expect(warnSpy).toHaveBeenCalledWith(
+      'The registrar was not available for the request. Please check your firewall settings.'
+    );
+  });
+
+  it('should warn if CAO DID validation turned off', async () => {
+    await validateCao.call({
+      ...fastify,
+      config: {
+        ...fastify.config,
+        validateCaoDid: false,
+      },
+    });
+    expect(warnSpy).toHaveBeenCalledTimes(1);
+    expect(warnSpy).toHaveBeenCalledWith('CAO DID validation is turned off.');
+  });
+
+  it('should not warn for valid cao', async () => {
+    nock('http://oracle.localhost.test')
+      .get('/api/v0.6/organizations/didtest/verified-profile')
+      .reply(200, {
+        credentialSubject: {
+          permittedVelocityServiceCategory: [
+            ServiceCategories.CredentialAgentOperator,
+          ],
+        },
+      });
+    await validateCao.call({
+      ...fastify,
+      config: {
+        ...fastify.config,
+        caoDid: 'didtest',
+      },
+    });
+    expect(warnSpy).toHaveBeenCalledTimes(0);
+  });
+
+  it('should not add validation if is test env', async () => {
+    const mockAddHook = jest.fn();
+    validateCaoPlugin(
+      {
+        config: {
+          isTest: true,
+        },
+        addHook: mockAddHook,
+      },
+      {},
+      () => {}
+    );
+    expect(mockAddHook).toHaveBeenCalledTimes(0);
+  });
+
+  it('should add validation hook', async () => {
+    const mockAddHook = jest.fn();
+    validateCaoPlugin(
+      {
+        config: {
+          isTest: false,
+        },
+        addHook: mockAddHook,
+      },
+      {},
+      () => {}
+    );
+    expect(mockAddHook).toHaveBeenCalledTimes(1);
+  });
+});

package/test/get-push-delegate.test.js

@@ -0,0 +1,54 @@
+/**
+ * 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 {
+  getPushDelegate,
+} = require('../src/entities/push-delegate/get-push-delegate');
+
+describe('push delegate', () => {
+  describe('GetPushDelegate', () => {
+    it('should handle full push_delegate from request', async () => {
+      const baseQuery = {
+        push_url: 'random',
+        push_token: 'token',
+      };
+      const result = getPushDelegate(baseQuery);
+
+      expect(result).toEqual({
+        pushToken: baseQuery.push_token,
+        pushUrl: baseQuery.push_url,
+      });
+    });
+
+    it('should return undefined if push_delegate does not have push_token', async () => {
+      const baseQuery = {
+        push_url: 'url',
+      };
+      const result = getPushDelegate(baseQuery);
+
+      expect(result).toEqual(undefined);
+    });
+
+    it('should return undefined if push_delegate does not have push_url', async () => {
+      const baseQuery = {
+        push_token: 'token',
+      };
+      const result = getPushDelegate(baseQuery);
+
+      expect(result).toEqual(undefined);
+    });
+  });
+});

package/test/helpers/jwt-vc-expectation.js

@@ -0,0 +1,109 @@
+/*
+ * 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 {
+  castArray,
+  compact,
+  first,
+  isNil,
+  omitBy,
+  pick,
+  uniq,
+} = require('lodash/fp');
+const { ISO_DATETIME_FORMAT, DID_FORMAT } = require('@verii/test-regexes');
+const { VelocityRevocationListType } = require('@verii/vc-checks');
+
+const jwtVcExpectation = ({
+  tenant,
+  issuerService,
+  credential,
+  credentialId,
+  subjectId,
+  credentialSubjectContext = [],
+  credentialTypeMetadata,
+  issuer,
+  payload = {},
+}) => ({
+  header: {
+    alg: 'ES256K',
+    kid: `${credentialId}#key-1`,
+    typ: 'JWT',
+  },
+  payload: {
+    iat: expect.any(Number),
+    iss: tenant.did,
+    nbf: expect.any(Number),
+    jti: credentialId,
+    sub: subjectId,
+    ...payload,
+    vc: omitBy(isNil, {
+      ...pick(
+        [
+          'credentialSchema',
+          'contentHash',
+          'vnfProtocolVersion',
+          'replaces',
+          'relatedResource',
+        ],
+        credential.content
+      ),
+      '@context': uniq(
+        compact([
+          'https://www.w3.org/2018/credentials/v1',
+          ...credentialSubjectContext,
+          ...castArray(credential.content['@context']),
+          'https://lib.velocitynetwork.foundation/contexts/credential-extensions-2022.jsonld.json',
+        ])
+      ),
+      id: credentialId,
+      type: [
+        first(credential.content.type),
+        'VelocityNetworkLayer1Credential',
+        'VerifiableCredential',
+      ],
+      credentialSubject: {
+        ...credential.content.credentialSubject,
+        id: subjectId,
+      },
+      vnfProtocolVersion: 2,
+      issuer: issuer ?? {
+        id: expect.stringMatching(DID_FORMAT),
+      },
+      credentialSchema: {
+        id: credentialTypeMetadata[first(credential.content.type)].schemaUrl,
+        type: 'JsonSchemaValidator2018',
+      },
+      credentialStatus: {
+        id: expect.stringMatching(
+          '^ethereum:0x[0-9a-fA-F]+/getRevokedStatus\\?address=0x[0-9a-zA-F]+&listId=\\d+&index=\\d+$'
+        ),
+        type: VelocityRevocationListType,
+      },
+      refreshService: {
+        type: 'VelocityNetworkRefreshService2024',
+        id: `${tenant.did}${issuerService.velocityNetworkServiceId}`,
+      },
+      contentHash: {
+        type: 'VelocityContentHash2020',
+        value: credential.contentHash,
+      },
+      issuanceDate: expect.stringMatching(ISO_DATETIME_FORMAT),
+    }),
+  },
+});
+
+module.exports = { jwtVcExpectation };

package/test/holder/build-request-response-schema.test.js

@@ -0,0 +1,55 @@
+/*
+ * 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 { buildRequestResponseSchema } = require('../../src/entities');
+
+describe('build request response schema test suite', () => {
+  it('should build default schema if isProd true', async () => {
+    const schemaObject = buildRequestResponseSchema('presentation', {
+      isProd: true,
+    });
+    expect(schemaObject).toEqual({
+      type: 'object',
+      properties: { presentation_request: { type: 'string' } },
+      required: ['presentation_request'],
+    });
+  });
+  it('should build for dev env schemas if isProd false', async () => {
+    const schemaObject = buildRequestResponseSchema('presentation', {
+      isProd: false,
+    });
+    expect(schemaObject).toEqual({
+      oneOf: [
+        {
+          type: 'object',
+          properties: { presentation_request: { type: 'string' } },
+          required: ['presentation_request'],
+        },
+        {
+          type: 'object',
+          properties: {
+            presentation_request: {
+              type: 'object',
+              additionalProperties: true,
+            },
+          },
+          required: ['presentation_request'],
+        },
+      ],
+    });
+  });
+});