Skip to content

Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.

5.4 KB
Raw Blame
import { Knex } from "knex";

import { groupDALFactory } from "@app/ee/services/group/group-dal";
import { initializeHsmModule, isHsmActiveAndEnabled } from "@app/ee/services/hsm/hsm-fns";
import { hsmServiceFactory } from "@app/ee/services/hsm/hsm-service";
import { licenseDALFactory } from "@app/ee/services/license/license-dal";
import { licenseServiceFactory } from "@app/ee/services/license/license-service";
import { permissionDALFactory } from "@app/ee/services/permission/permission-dal";
import { permissionServiceFactory } from "@app/ee/services/permission/permission-service";
import { TKeyStoreFactory } from "@app/keystore/keystore";
import { BadRequestError } from "@app/lib/errors";
import { additionalPrivilegeDALFactory } from "@app/services/additional-privilege/additional-privilege-dal";
import { identityDALFactory } from "@app/services/identity/identity-dal";
import { internalKmsDALFactory } from "@app/services/kms/internal-kms-dal";
import { internalKmsKeyVersionDALFactory } from "@app/services/kms/internal-kms-key-version-dal";
import { kmsKekHistoryDALFactory } from "@app/services/kms/kms-kek-history-dal";
import { kmskeyDALFactory } from "@app/services/kms/kms-key-dal";
import { kmsLegacyEncryptionKeyDALFactory } from "@app/services/kms/kms-legacy-encryption-key-dal";
import { kmsRootConfigDALFactory } from "@app/services/kms/kms-root-config-dal";
import { kmsServiceFactory } from "@app/services/kms/kms-service";
import { RootKeyEncryptionStrategy } from "@app/services/kms/kms-types";
import { orgDALFactory } from "@app/services/org/org-dal";
import { projectDALFactory } from "@app/services/project/project-dal";
import { roleDALFactory } from "@app/services/role/role-dal";
import { secretFolderDALFactory } from "@app/services/secret-folder/secret-folder-dal";
import { serviceTokenDALFactory } from "@app/services/service-token/service-token-dal";
import { userDALFactory } from "@app/services/user/user-dal";

import { TMigrationEnvConfig } from "./env-config";

type TDependencies = {
  envConfig: TMigrationEnvConfig;
  db: Knex;
  keyStore: TKeyStoreFactory;
  skipHsmLicenseCheck?: boolean;
};

type THsmServiceDependencies = {
  envConfig: Pick<TMigrationEnvConfig, "HSM_PIN" | "HSM_SLOT" | "HSM_LIB_PATH" | "HSM_KEY_LABEL" | "isHsmConfigured">;
};

export const getMigrationHsmService = async ({ envConfig }: THsmServiceDependencies) => {
  const hsmModule = initializeHsmModule(envConfig);
  hsmModule.initialize();

  const hsmService = hsmServiceFactory({
    hsmModule: hsmModule.getModule(),
    envConfig
  });

  await hsmService.startService();

  return { hsmService };
};

export const getMigrationEncryptionServices = async ({
  envConfig,
  db,
  keyStore,
  skipHsmLicenseCheck = true
}: TDependencies) => {
  // ----- DAL dependencies -----
  const orgDAL = orgDALFactory(db);
  const licenseDAL = licenseDALFactory(db);
  const permissionDAL = permissionDALFactory(db);
  const projectDAL = projectDALFactory(db);
  const roleDAL = roleDALFactory(db);
  const userDAL = userDALFactory(db);
  const identityDAL = identityDALFactory(db);
  const serviceTokenDAL = serviceTokenDALFactory(db);
  const kmsRootConfigDAL = kmsRootConfigDALFactory(db);
  const kmsLegacyEncryptionKeyDAL = kmsLegacyEncryptionKeyDALFactory(db);
  const kmsKekHistoryDAL = kmsKekHistoryDALFactory(db);
  const kmsDAL = kmskeyDALFactory(db);
  const internalKmsDAL = internalKmsDALFactory(db);
  const internalKmsKeyVersionDAL = internalKmsKeyVersionDALFactory(db);
  const additionalPrivilegeDAL = additionalPrivilegeDALFactory(db);
  const groupDAL = groupDALFactory(db);
  const secretFolderDAL = secretFolderDALFactory(db);

  // ----- Service dependencies -----
  const permissionService = permissionServiceFactory({
    permissionDAL,
    serviceTokenDAL,
    projectDAL,
    keyStore,
    roleDAL,
    userDAL,
    identityDAL,
    additionalPrivilegeDAL,
    groupDAL,
    secretFolderDAL,
    orgDAL
  });

  const licenseService = licenseServiceFactory({
    permissionService,
    orgDAL,
    licenseDAL,
    keyStore,
    projectDAL,
    envConfig
  });

  // ----- HSM startup -----

  const { hsmService } = await getMigrationHsmService({ envConfig });

  const hsmStatus = await isHsmActiveAndEnabled({
    hsmService,
    kmsRootConfigDAL,
    licenseService: skipHsmLicenseCheck ? undefined : licenseService
  });

  // if the encryption strategy is software - user needs to provide an encryption key
  // if the encryption strategy is null AND the hsm is not configured - user needs to provide an encryption key
  const needsEncryptionKey =
    hsmStatus.rootKmsConfigEncryptionStrategy === RootKeyEncryptionStrategy.Software ||
    (hsmStatus.rootKmsConfigEncryptionStrategy === null && !hsmStatus.isHsmConfigured);

  if (needsEncryptionKey) {
    if (!envConfig.ROOT_ENCRYPTION_KEY && !envConfig.ENCRYPTION_KEY) {
      throw new BadRequestError({
        message:
          "Root KMS encryption strategy is set to software. Please set the ENCRYPTION_KEY environment variable and restart your deployment.\nYou can enable HSM encryption in the Server Console."
      });
    }
  }

  // ----- KMS startup -----

  const kmsService = kmsServiceFactory({
    kmsRootConfigDAL,
    kmsLegacyEncryptionKeyDAL,
    kmsKekHistoryDAL,
    kmsDAL,
    internalKmsDAL,
    internalKmsKeyVersionDAL,
    orgDAL,
    projectDAL,
    hsmService,
    keyStore,
    envConfig
  });

  await kmsService.startService(hsmStatus, { skipRotationState: true });

  return { kmsService, hsmService };
};