@verii/server-credentialagent 1.0.0-pre.1752076816

package/src/entities/keys/domains/validate-key.js

@@ -0,0 +1,62 @@
+/**
+ * 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 { all, includes, values, uniq } = require('lodash/fp');
+const newError = require('http-errors');
+const { KeyPurposes } = require('@verii/crypto');
+const {
+  KeyErrorMessages,
+  KeyAlgorithms,
+  KeyEncodings,
+} = require('./constants');
+
+const validKeyPurposes = values(KeyPurposes);
+
+const arePurposesRecognized = (purposes) => {
+  return all((purpose) => includes(purpose, validKeyPurposes), purposes);
+};
+
+const isAlgorithmRecognized = (algorithm) => {
+  return algorithm === KeyAlgorithms.SECP256K1;
+};
+
+const isEncodingRecognized = (encoding) => {
+  return encoding === KeyEncodings.HEX || encoding === KeyEncodings.JWK;
+};
+
+const hasDuplicatePurposes = (purposes) =>
+  !(uniq(purposes).length === purposes.length);
+
+const validateKey = (key) => {
+  const { purposes, algorithm, encoding } = key;
+  if (!arePurposesRecognized(purposes)) {
+    throw newError(400, KeyErrorMessages.UNRECOGNIZED_PURPOSE_DETECTED);
+  }
+  if (hasDuplicatePurposes(purposes)) {
+    throw newError(400, KeyErrorMessages.DUPLICATE_PURPOSE_DETECTED);
+  }
+  if (!isAlgorithmRecognized(algorithm)) {
+    throw newError(400, KeyErrorMessages.UNRECOGNIZED_ALGORITHM);
+  }
+  if (!isEncodingRecognized(encoding)) {
+    throw newError(400, KeyErrorMessages.UNRECOGNIZED_ENCODING);
+  }
+};
+
+module.exports = {
+  hasDuplicatePurposes,
+  validateKey,
+};

package/src/entities/keys/factories/index.js

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+
+module.exports = {
+  ...require('./key-factory'),
+};

package/src/entities/keys/factories/key-factory.js

@@ -0,0 +1,56 @@
+/**
+ * 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 { register } = require('@spencejs/spence-factories');
+const { KeyPurposes, generateKeyPair } = require('@verii/crypto');
+const { ObjectId } = require('mongodb');
+const { defaultRepoOptions, kmsRepo } = require('@verii/db-kms');
+const { initTenantFactory } = require('../../tenants');
+const { KeyAlgorithms, KeyEncodings } = require('../domains');
+const { agentKmsOptions } = require('../../../plugins/kms-plugin');
+
+const initKeysFactory = (app) => {
+  const initRepo = kmsRepo(app, { ...defaultRepoOptions, ...agentKmsOptions });
+
+  return register('key', async (overrides, { getOrBuild }) => {
+    const tenant = await getOrBuild('tenant', initTenantFactory(app));
+    const keyPair = await getOrBuild('keyPair', () =>
+      generateKeyPair({ format: 'jwk' })
+    );
+    return {
+      item: {
+        purposes: [
+          KeyPurposes.DLT_TRANSACTIONS,
+          KeyPurposes.ISSUING_METADATA,
+          KeyPurposes.EXCHANGES,
+        ],
+        algorithm: KeyAlgorithms.SECP256K1,
+        encoding: KeyEncodings.JWK,
+        kidFragment: '#velocity-key-1',
+        tenantId: new ObjectId(tenant._id),
+        key: keyPair.privateKey,
+        publicKey: keyPair.publicKey,
+        ...overrides(),
+      },
+      repo: initRepo({
+        tenant: { ...tenant, _id: new ObjectId(tenant._id) },
+        config: app.config,
+      }),
+    };
+  });
+};
+
+module.exports = { initKeysFactory };

package/src/entities/keys/index.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.
+ */
+
+// TODO If we create a keys entity package, most of the stuff in this directory should probably be moved to there
+module.exports = {
+  ...require('./factories'),
+  ...require('./domains'),
+  ...require('./orchestrators'),
+};

package/src/entities/keys/orchestrators/index.js

@@ -0,0 +1,3 @@
+module.exports = {
+  ...require('./validate-did-doc-keys'),
+};

package/src/entities/keys/orchestrators/validate-did-doc-keys.js

@@ -0,0 +1,69 @@
+const { each, map, omit, isEmpty, isString, some } = require('lodash/fp');
+const newError = require('http-errors');
+const { jwkFromSecp256k1Key } = require('@verii/jwt');
+const { extractVerificationMethod } = require('@verii/did-doc');
+const { validateKey, isMatchingPrivateKeyKid } = require('../domains');
+
+const validateDidDocKeys = async (didDoc, keys) => {
+  each(validateKey, keys);
+  const keysTransformed = transformKeys(keys);
+
+  each((key) => {
+    if (!extractVerificationMethod(didDoc, key.kidFragment)) {
+      throwErrorKidFragment(key.kidFragment);
+    }
+  }, keys);
+
+  const validations = await Promise.all(
+    map((key) => {
+      const kid = `${didDoc.id}${key.kidFragment}`;
+      return isMatchingPrivateKeyKid(didDoc, key.key, kid);
+    }, keysTransformed)
+  );
+
+  if (some((valid) => !valid, validations)) {
+    throwErrorPrivateKeyNotMatched();
+  }
+
+  return keysTransformed;
+};
+
+const transformKeys = map((key) => ({
+  ...omit(['key', 'hexKey', 'jwk'], key),
+  publicKey: transformPublicKeyToJwk(key?.publicKey),
+  key: transformKeyToJwk(key?.key ?? key?.hexKey ?? key?.jwk),
+}));
+
+const transformPublicKeyToJwk = (publicKey) => {
+  if (isEmpty(publicKey)) {
+    return undefined;
+  }
+
+  return isString(publicKey)
+    ? jwkFromSecp256k1Key(publicKey, false)
+    : publicKey;
+};
+
+const transformKeyToJwk = (privateKey) => {
+  if (isEmpty(privateKey)) {
+    throw newError(400, 'Private key not found', {
+      errorCode: 'private_key_not_found',
+    });
+  }
+
+  return isString(privateKey)
+    ? jwkFromSecp256k1Key(privateKey, true)
+    : privateKey;
+};
+
+const throwErrorKidFragment = (kidFragment) => {
+  throw newError(400, `kid fragment: ${kidFragment} not found on document`);
+};
+
+const throwErrorPrivateKeyNotMatched = () => {
+  throw newError(400, 'Private key not matched to document');
+};
+
+module.exports = {
+  validateDidDocKeys,
+};

package/src/entities/metadata-list-allocations/index.js

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+
+module.exports = {
+  ...require('./repos'),
+};

package/src/entities/metadata-list-allocations/repos/index.js

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+
+module.exports = {
+  metadataListAllocationPlugin: require('./repo'),
+};

package/src/entities/metadata-list-allocations/repos/repo.js

@@ -0,0 +1,40 @@
+/**
+ * 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 {
+  repoFactory,
+  autoboxIdsExtension,
+} = require('@spencejs/spence-mongo-repos');
+const { multitenantExtension } = require('@verii/spencer-mongo-extensions');
+
+module.exports = (app, options, next = () => {}) => {
+  next();
+  return repoFactory(
+    {
+      name: 'metadataListAllocations',
+      entityName: 'metadataListAllocation',
+      defaultProjection: {
+        _id: 1,
+        currentListId: 1,
+        freeIndexes: 1,
+        createdAt: 1,
+        updatedAt: 1,
+      },
+      extensions: [autoboxIdsExtension, multitenantExtension()],
+    },
+    app
+  );
+};

package/src/entities/notifications/domains/index.js

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+
+module.exports = {
+  ...require('./notification-types'),
+};

package/src/entities/notifications/domains/notification-types.js

@@ -0,0 +1,25 @@
+/**
+ * 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 NotificationTypes = {
+  NEW_OFFER_READY: 'NewOffersReady',
+  NO_OFFERS_FOUND: 'NoOffersFound',
+  PRESENTATION_VERIFIFED: 'PresentationVerified',
+};
+
+module.exports = {
+  NotificationTypes,
+};

package/src/entities/notifications/index.js

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+
+module.exports = {
+  ...require('./domains'),
+};

package/src/entities/offers/domains/build-clean-pii-filter.js

@@ -0,0 +1,35 @@
+const { isEmpty } = require('lodash/fp');
+const { ObjectId } = require('mongodb');
+
+const buildCleanPiiFilter = (filter = {}) => {
+  const mongoFilter = {};
+
+  if (!isEmpty(filter.vendorUserId)) {
+    mongoFilter['credentialSubject.vendorUserId'] = filter.vendorUserId;
+  }
+
+  if (!isEmpty(filter.disclosureId)) {
+    mongoFilter.disclosureId = new ObjectId(filter.disclosureId);
+  }
+
+  if (!isEmpty(filter.createdBefore)) {
+    mongoFilter.createdAt = { $lte: new Date(filter.createdBefore) };
+  }
+
+  if (filter.finalized === true) {
+    mongoFilter.$or = [
+      {
+        rejectedAt: { $exists: true },
+      },
+      {
+        consentedAt: { $exists: true },
+      },
+    ];
+  }
+
+  return mongoFilter;
+};
+
+module.exports = {
+  buildCleanPiiFilter,
+};

package/src/entities/offers/domains/build-deeplink-url.js

@@ -0,0 +1,120 @@
+/**
+ * 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 { flow, includes } = require('lodash/fp');
+const {
+  appendSearchParamArray,
+  appendSearchParam,
+} = require('@verii/common-functions');
+const { VendorEndpointCategory } = require('../../disclosures');
+
+const createPresentationRequestUrl = (
+  suffix,
+  { tenant, config: { hostUrl } }
+) => new URL(`${hostUrl}/api/holder/v0.6/org/${tenant.did}/${suffix}`);
+
+const createDeepLinkUrl = (suffix, { config: { deepLinkProtocol } }) =>
+  new URL(`${deepLinkProtocol}${suffix}`);
+
+const buildDisclosureRequestDeepLink = (
+  disclosure,
+  vendorOriginContext,
+  context
+) => {
+  if (includes(disclosure.vendorEndpoint, VendorEndpointCategory.ISSUING)) {
+    return buildIssuingDeepLink(
+      disclosure._id,
+      null,
+      null,
+      vendorOriginContext,
+      context
+    );
+  }
+
+  return buildPresentationRequestDeepLink(
+    disclosure._id,
+    vendorOriginContext,
+    context
+  );
+};
+
+const buildPresentationRequestDeepLink = (
+  disclosureId,
+  vendorOriginContext,
+  context
+) => {
+  const presentationRequestUrl = flow(appendSearchParam('id', disclosureId))(
+    createPresentationRequestUrl('inspect/get-presentation-request', context)
+  );
+
+  const deepLink = generateDeepLink(
+    {
+      requestUri: presentationRequestUrl.href,
+      vendorOriginContext,
+      inspectorDid: context.tenant.did,
+    },
+    'inspect',
+    context
+  );
+
+  return deepLink.toString();
+};
+
+const buildIssuingDeepLink = (
+  disclosureId,
+  exchangeId,
+  types,
+  vendorOriginContext,
+  context
+) => {
+  const credentialManifestUrl = flow(
+    appendSearchParam('id', disclosureId),
+    appendSearchParam('exchange_id', exchangeId),
+    appendSearchParamArray('credential_types', types)
+  )(createPresentationRequestUrl('issue/get-credential-manifest', context));
+
+  const deepLink = generateDeepLink(
+    {
+      requestUri: credentialManifestUrl.href,
+      vendorOriginContext,
+      issuerDid: context.tenant.did,
+    },
+    'issue',
+    context
+  );
+
+  return deepLink.toString();
+};
+
+const generateDeepLink = (
+  { requestUri, vendorOriginContext, inspectorDid, issuerDid },
+  type,
+  context
+) =>
+  flow(
+    appendSearchParam('request_uri', requestUri),
+    appendSearchParam('inspectorDid', inspectorDid),
+    appendSearchParam('issuerDid', issuerDid),
+    appendSearchParam('vendorOriginContext', vendorOriginContext)
+  )(createDeepLinkUrl(type, context));
+
+module.exports = {
+  buildIssuingDeepLink,
+  buildPresentationRequestDeepLink,
+  buildDisclosureRequestDeepLink,
+  generateDeepLink,
+  createDeepLinkUrl,
+};

package/src/entities/offers/domains/build-offer.js

@@ -0,0 +1,88 @@
+/**
+ * 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 { pick, mapValues, flow, isEmpty, map, isObject } = require('lodash/fp');
+
+const { hashOffer } = require('@verii/velocity-issuing');
+const { generateLinkCode } = require('./generate-link-code');
+
+const buildOffer = (offer, credentialRefsMap, { tenant, exchange }) => {
+  const { relatedResource, replaces } = flow(
+    pick(['relatedResource', 'replaces']),
+    mapValues(map(buildRelatedResource(credentialRefsMap)))
+  )(offer);
+
+  const linkedCredentials = buildLinkedCredentials(
+    offer.linkedCredentials,
+    credentialRefsMap
+  );
+
+  const { linkCode, linkCodeCommitment } = generateLinkCode();
+  const issuer =
+    offer.issuer != null && isObject(offer.issuer)
+      ? {
+          id: tenant.did,
+          ...offer.issuer,
+        }
+      : { id: tenant.did };
+
+  return {
+    ...offer,
+    issuer,
+    exchangeId: exchange._id,
+    contentHash: {
+      type: 'VelocityContentHash2020',
+      value: hashOffer(offer),
+    },
+    linkCode,
+    linkCodeCommitment,
+    linkedCredentials,
+    relatedResource,
+    replaces,
+  };
+};
+
+const buildRelatedResource = (offersMap) => (resource) => {
+  const offer = offersMap[resource.id];
+  if (isEmpty(offer)) return resource;
+  return {
+    ...resource,
+    digestSRI: offer?.digestSRI,
+    hint: offer.type,
+  };
+};
+
+const buildLinkedCredentials = (linkedCredentialList, credentialRefsMap) => {
+  if (isEmpty(linkedCredentialList)) {
+    return undefined;
+  }
+
+  return map((linkedCredential) => {
+    const credentialRef =
+      credentialRefsMap[linkedCredential.linkedCredentialId];
+    if (credentialRef == null) {
+      return {
+        ...linkedCredential,
+        invalidAt: new Date(),
+        invalidReason: `Revoked offer ${linkedCredential.linkedCredentialId} not found`,
+      };
+    }
+
+    return { ...linkedCredential, linkCode: credentialRef.linkCode };
+  }, linkedCredentialList);
+};
+
+module.exports = { buildOffer };

package/src/entities/offers/domains/build-qr-code-url.js

@@ -0,0 +1,37 @@
+/**
+ * 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 { appendSearchParam } = require('@verii/common-functions');
+
+const getDisclosureQrCodeUri = (
+  { did, disclosureId, vendorOriginContext },
+  { config: { hostUrl } }
+) =>
+  appendSearchParam(
+    'vendorOriginContext',
+    vendorOriginContext
+  )(
+    new URL(
+      `${hostUrl}/operator-api/v0.8/tenants/${did}/disclosures/${disclosureId}/qrcode.png`
+    )
+  ).toString();
+
+const getExchnageQrCodeUri = ({ did, exchangeId }, { config: { hostUrl } }) =>
+  new URL(
+    `${hostUrl}/operator-api/v0.8/tenants/${did}/exchanges/${exchangeId}/qrcode.png`
+  ).toString();
+
+module.exports = { getDisclosureQrCodeUri, getExchnageQrCodeUri };