feat(secrey-sync): Hashicorp Vault Secret Sync (and minor app connection fixes)

backend/src/services/secret-sync/hc-vault/hc-vault-sync-constants.ts

@@ -0,0 +1,10 @@
+import { AppConnection } from "@app/services/app-connection/app-connection-enums";
+import { SecretSync } from "@app/services/secret-sync/secret-sync-enums";
+import { TSecretSyncListItem } from "@app/services/secret-sync/secret-sync-types";
+
+export const HC_VAULT_SYNC_LIST_OPTION: TSecretSyncListItem = {
+  name: "Hashicorp Vault",
+  destination: SecretSync.HCVault,
+  connection: AppConnection.HCVault,
+  canImportSecrets: true
+};

backend/src/services/secret-sync/hc-vault/hc-vault-sync-fns.ts

@@ -0,0 +1,126 @@
+import { request } from "@app/lib/config/request";
+import { removeTrailingSlash } from "@app/lib/fn";
+import { getHCVaultAccessToken } from "@app/services/app-connection/hc-vault";
+import {
+  THCVaultListVariables,
+  THCVaultListVariablesResponse,
+  THCVaultSyncWithCredentials,
+  TPostHCVaultVariable
+} from "@app/services/secret-sync/hc-vault/hc-vault-sync-types";
+import { SecretSyncError } from "@app/services/secret-sync/secret-sync-errors";
+import { TSecretMap } from "@app/services/secret-sync/secret-sync-types";
+
+const listHCVaultVariables = async ({ instanceUrl, mount, accessToken, path }: THCVaultListVariables) => {
+  const { data } = await request.get<THCVaultListVariablesResponse>(
+    `${instanceUrl}/v1/${removeTrailingSlash(mount)}/data/${path}`,
+    {
+      headers: {
+        "X-Vault-Token": accessToken
+      }
+    }
+  );
+
+  return data.data.data;
+};
+
+// Hashicorp Vault updates all variables in one batch. This is to respect their versioning
+const updateHCVaultVariables = async ({ path, instanceUrl, accessToken, mount, data }: TPostHCVaultVariable) =>
+  request.post(
+    `${instanceUrl}/v1/${removeTrailingSlash(mount)}/data/${path}`,
+    {
+      data
+    },
+    {
+      headers: {
+        "X-Vault-Token": accessToken,
+        "Content-Type": "application/json"
+      }
+    }
+  );
+
+export const HCVaultSyncFns = {
+  syncSecrets: async (secretSync: THCVaultSyncWithCredentials, secretMap: TSecretMap) => {
+    const {
+      connection,
+      destinationConfig: { mount, path },
+      syncOptions: { disableSecretDeletion }
+    } = secretSync;
+
+    const accessToken = await getHCVaultAccessToken(connection);
+    const { instanceUrl } = connection.credentials;
+
+    const variables = await listHCVaultVariables({ instanceUrl, accessToken, mount, path });
+    let tainted = false;
+
+    for await (const entry of Object.entries(secretMap)) {
+      const [key, { value }] = entry;
+      if (value !== variables[key]) {
+        variables[key] = value;
+        tainted = true;
+      }
+    }
+
+    if (disableSecretDeletion) return;
+
+    for await (const [key] of Object.entries(variables)) {
+      if (!(key in secretMap)) {
+        delete variables[key];
+        tainted = true;
+      }
+    }
+
+    // Only update variables if there was a change detected
+    if (!tainted) return;
+
+    try {
+      await updateHCVaultVariables({ accessToken, instanceUrl, mount, path, data: variables });
+    } catch (error) {
+      throw new SecretSyncError({
+        error
+      });
+    }
+  },
+  removeSecrets: async (secretSync: THCVaultSyncWithCredentials, secretMap: TSecretMap) => {
+    const {
+      connection,
+      destinationConfig: { mount, path }
+    } = secretSync;
+
+    const accessToken = await getHCVaultAccessToken(connection);
+    const { instanceUrl } = connection.credentials;
+
+    const variables = await listHCVaultVariables({ instanceUrl, accessToken, mount, path });
+
+    for await (const [key] of Object.entries(variables)) {
+      if (key in secretMap) {
+        delete variables[key];
+      }
+    }
+
+    try {
+      await updateHCVaultVariables({ accessToken, instanceUrl, mount, path, data: variables });
+    } catch (error) {
+      throw new SecretSyncError({
+        error
+      });
+    }
+  },
+  getSecrets: async (secretSync: THCVaultSyncWithCredentials) => {
+    const {
+      connection,
+      destinationConfig: { mount, path }
+    } = secretSync;
+
+    const accessToken = await getHCVaultAccessToken(connection);
+    const { instanceUrl } = connection.credentials;
+
+    const variables = await listHCVaultVariables({
+      instanceUrl,
+      accessToken,
+      mount,
+      path
+    });
+
+    return Object.fromEntries(Object.entries(variables).map(([key, value]) => [key, { value }]));
+  }
+};

backend/src/services/secret-sync/hc-vault/hc-vault-sync-schemas.ts

@@ -0,0 +1,57 @@
+import { z } from "zod";
+
+import { SecretSyncs } from "@app/lib/api-docs";
+import { AppConnection } from "@app/services/app-connection/app-connection-enums";
+import { SecretSync } from "@app/services/secret-sync/secret-sync-enums";
+import {
+  BaseSecretSyncSchema,
+  GenericCreateSecretSyncFieldsSchema,
+  GenericUpdateSecretSyncFieldsSchema
+} from "@app/services/secret-sync/secret-sync-schemas";
+import { TSyncOptionsConfig } from "@app/services/secret-sync/secret-sync-types";
+
+const HCVaultSyncDestinationConfigSchema = z.object({
+  mount: z
+    .string()
+    .trim()
+    .min(1, "Secrets Engine Mount required")
+    .describe(SecretSyncs.DESTINATION_CONFIG.HC_VAULT.mount),
+  path: z
+    .string()
+    .trim()
+    .min(1, "Path required")
+    .transform((val) => val.trim().replace(/^\/+|\/+$/g, "")) // removes leading/trailing slashes
+    .refine((val) => /^([a-zA-Z0-9._-]+\/)*[a-zA-Z0-9._-]+$/.test(val), {
+      message:
+        "Invalid Vault path format. Use alphanumerics, dots, dashes, underscores, and single slashes between segments."
+    })
+    .describe(SecretSyncs.DESTINATION_CONFIG.HC_VAULT.path)
+});
+
+const HCVaultSyncOptionsConfig: TSyncOptionsConfig = { canImportSecrets: true };
+
+export const HCVaultSyncSchema = BaseSecretSyncSchema(SecretSync.HCVault, HCVaultSyncOptionsConfig).extend({
+  destination: z.literal(SecretSync.HCVault),
+  destinationConfig: HCVaultSyncDestinationConfigSchema
+});
+
+export const CreateHCVaultSyncSchema = GenericCreateSecretSyncFieldsSchema(
+  SecretSync.HCVault,
+  HCVaultSyncOptionsConfig
+).extend({
+  destinationConfig: HCVaultSyncDestinationConfigSchema
+});
+
+export const UpdateHCVaultSyncSchema = GenericUpdateSecretSyncFieldsSchema(
+  SecretSync.HCVault,
+  HCVaultSyncOptionsConfig
+).extend({
+  destinationConfig: HCVaultSyncDestinationConfigSchema.optional()
+});
+
+export const HCVaultSyncListItemSchema = z.object({
+  name: z.literal("Hashicorp Vault"),
+  connection: z.literal(AppConnection.HCVault),
+  destination: z.literal(SecretSync.HCVault),
+  canImportSecrets: z.literal(true)
+});

backend/src/services/secret-sync/hc-vault/hc-vault-sync-types.ts

@@ -0,0 +1,38 @@
+import { z } from "zod";
+
+import { THCVaultConnection } from "@app/services/app-connection/hc-vault";
+
+import { CreateHCVaultSyncSchema, HCVaultSyncListItemSchema, HCVaultSyncSchema } from "./hc-vault-sync-schemas";
+
+export type THCVaultSync = z.infer<typeof HCVaultSyncSchema>;
+
+export type THCVaultSyncInput = z.infer<typeof CreateHCVaultSyncSchema>;
+
+export type THCVaultSyncListItem = z.infer<typeof HCVaultSyncListItemSchema>;
+
+export type THCVaultSyncWithCredentials = THCVaultSync & {
+  connection: THCVaultConnection;
+};
+
+export type THCVaultListVariablesResponse = {
+  data: {
+    data: {
+      [key: string]: string;
+    };
+  };
+};
+
+export type THCVaultListVariables = {
+  accessToken: string;
+  instanceUrl: string;
+  mount: string;
+  path: string;
+};
+
+export type TPostHCVaultVariable = THCVaultListVariables & {
+  data: {
+    [key: string]: string;
+  };
+};
+
+export type TDeleteHCVaultVariable = THCVaultListVariables;

backend/src/services/secret-sync/hc-vault/index.ts

@@ -0,0 +1,4 @@
+export * from "./hc-vault-sync-constants";
+export * from "./hc-vault-sync-fns";
+export * from "./hc-vault-sync-schemas";
+export * from "./hc-vault-sync-types";