Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.
TypeScript acmeagentsai-agentscertificate-managementdevsecopsenvironment-variableskubernetesopen-sourcepampkipostgresprivate-caprivileged-access-managementsecret-managementsecret-managersecretssecrets-managementsecuritysecurity-toolsvault
feat(secret-sync): add secret payload contract with duplicate-name detection
Calvin9fb3b641d770
diff --git a/backend/src/services/secret-sync/aws-secrets-manager/aws-secrets-manager-sync-fns.ts b/backend/src/services/secret-sync/aws-secrets-manager/aws-secrets-manager-sync-fns.tsindex b5e1c5885f..7847920bfe 100644--- a/backend/src/services/secret-sync/aws-secrets-manager/aws-secrets-manager-sync-fns.ts+++ b/backend/src/services/secret-sync/aws-secrets-manager/aws-secrets-manager-sync-fns.ts@@ -28,7 +28,8 @@ import { crypto } from "@app/lib/crypto";import { getAwsConnectionConfig } from "@app/services/app-connection/aws/aws-connection-fns";import { AwsSecretsManagerSyncMappingBehavior } from "@app/services/secret-sync/aws-secrets-manager/aws-secrets-manager-sync-enums";import { SecretSyncError } from "@app/services/secret-sync/secret-sync-errors";-import { getKeyWithSchema, matchesSchema } from "@app/services/secret-sync/secret-sync-fns";+import { matchesSchema } from "@app/services/secret-sync/secret-sync-fns";+import { getKeyWithSchema } from "@app/services/secret-sync/secret-sync-payload";import { TSecretMap } from "@app/services/secret-sync/secret-sync-types";import { TAwsSecretsManagerSyncWithCredentials } from "./aws-secrets-manager-sync-types";diff --git a/backend/src/services/secret-sync/secret-sync-fns.ts b/backend/src/services/secret-sync/secret-sync-fns.tsindex a2dc587741..d2ecd0e322 100644--- a/backend/src/services/secret-sync/secret-sync-fns.ts+++ b/backend/src/services/secret-sync/secret-sync-fns.ts@@ -189,23 +189,6 @@ type TSyncSecretDeps = {gatewayPoolService: Pick<TGatewayPoolServiceFactory, "resolveEffectiveGatewayId">;};-export const getKeyWithSchema = ({- key,- environment,- schema-}: {- key: string;- environment: string;- schema?: string;-}) => {- if (!schema) return key;-- return handlebars.compile(schema)({- secretKey: key,- environment- });-};-// Add schema to secret keysconst addSchema = (unprocessedSecretMap: TSecretMap, environment: string, schema?: string): TSecretMap => {if (!schema) return unprocessedSecretMap;diff --git a/backend/src/services/secret-sync/secret-sync-payload.test.ts b/backend/src/services/secret-sync/secret-sync-payload.test.tsnew file mode 100644index 0000000000..1c4e30fcdd--- /dev/null+++ b/backend/src/services/secret-sync/secret-sync-payload.test.ts@@ -0,0 +1,67 @@+import { createSecretSyncPayload, TSecretPayload } from "./secret-sync-payload";++const secret = (key: string, path: string, value = "v"): TSecretPayload => ({ key, path, value });++describe("createSecretSyncPayload", () => {+ test("all() returns every secret, including ones that share a name", () => {+ const payload = createSecretSyncPayload([secret("DB_URL", "/"), secret("DB_URL", "/api")], {+ environment: "dev"+ });++ expect(payload.all()).toHaveLength(2);+ });++ test("flatten() returns one entry per secret when names are unique", () => {+ const payload = createSecretSyncPayload([secret("DB_URL", "/", "one"), secret("API_KEY", "/api", "two")], {+ environment: "dev"+ });++ expect(payload.flatten()).toEqual({+ DB_URL: { value: "one", id: undefined, comment: undefined, secretMetadata: undefined },+ API_KEY: { value: "two", id: undefined, comment: undefined, secretMetadata: undefined }+ });+ });++ test("flatten() throws naming both folders when a name appears twice", () => {+ const payload = createSecretSyncPayload([secret("DB_URL", "/backend"), secret("DB_URL", "/backend/api")], {+ environment: "dev"+ });++ expect(() => payload.flatten()).toThrow(/"DB_URL" in \/backend and \/backend\/api/);+ });++ test("flatten() reports every conflict in one throw, capped at five with a remainder count", () => {+ const secrets = Array.from({ length: 7 }, (_, i) => [secret(`K${i}`, "/"), secret(`K${i}`, "/api")]).flat();+ const payload = createSecretSyncPayload(secrets, { environment: "dev" });++ let message = "";+ try {+ payload.flatten();+ } catch (err) {+ message = (err as Error).message;+ }++ expect(message).toContain("K0");+ expect(message).toContain("K4");+ expect(message).not.toContain("K5");+ expect(message).toContain("and 2 more");+ });++ test("flatten() applies the key schema to destination keys", () => {+ const payload = createSecretSyncPayload([secret("DB_URL", "/")], {+ environment: "dev",+ keySchema: "{{environment}}_{{secretKey}}"+ });++ expect(Object.keys(payload.flatten())).toEqual(["dev_DB_URL"]);+ });++ test("flatten() does not treat a name that only resembles a schema-prefixed one as a conflict", () => {+ const payload = createSecretSyncPayload([secret("DB_URL", "/"), secret("dev_DB_URL", "/api")], {+ environment: "dev",+ keySchema: "{{secretKey}}"+ });++ expect(() => payload.flatten()).not.toThrow();+ });+});diff --git a/backend/src/services/secret-sync/secret-sync-payload.ts b/backend/src/services/secret-sync/secret-sync-payload.tsnew file mode 100644index 0000000000..5d0f8b5e03--- /dev/null+++ b/backend/src/services/secret-sync/secret-sync-payload.ts@@ -0,0 +1,101 @@+import handlebars from "handlebars";++import { SecretSyncError } from "@app/services/secret-sync/secret-sync-errors";+import { TSecretMap } from "@app/services/secret-sync/secret-sync-types";++export const MAX_REPORTED_KEY_CONFLICTS = 5;++export type TSecretPayload = {+ key: string;+ path: string;+ value: string;+ id?: string;+ comment?: string;+ secretMetadata?: TSecretMap[string]["secretMetadata"];+};++export type TSecretSyncPayload = {+ all: () => TSecretPayload[];+ flatten: () => TSecretMap;+};++export const getKeyWithSchema = ({+ key,+ environment,+ schema+}: {+ key: string;+ environment: string;+ schema?: string;+}) => {+ if (!schema) return key;++ return handlebars.compile(schema)({+ secretKey: key,+ environment+ });+};++const buildConflictError = (conflicts: [string, TSecretPayload[]][]) => {+ const shown = conflicts.slice(0, MAX_REPORTED_KEY_CONFLICTS);+ const remainder = conflicts.length - shown.length;++ const detail = shown+ .map(+ ([key, group]) =>+ `"${key}" in ${group+ .map((entry) => entry.path)+ .sort()+ .join(" and ")}`+ )+ .join("; ");++ return new SecretSyncError({+ message: `This destination stores secrets in a single flat list, so each name can be used only once. These names are used in more than one folder: ${detail}${+ remainder > 0 ? `, and ${remainder} more` : ""+ }. Rename or move one secret in each pair, or point the sync at a narrower secret path.`,+ shouldRetry: false+ });+};++export const createSecretSyncPayload = (+ secrets: TSecretPayload[],+ { environment, keySchema }: { environment: string; keySchema?: string }+): TSecretSyncPayload => {+ let flattened: TSecretMap | undefined;++ return {+ all: () => secrets,+ flatten: () => {+ if (flattened) return flattened;++ const grouped = new Map<string, TSecretPayload[]>();++ for (const entry of secrets) {+ const destinationKey = getKeyWithSchema({ key: entry.key, environment, schema: keySchema });+ const group = grouped.get(destinationKey);++ if (group) group.push(entry);+ else grouped.set(destinationKey, [entry]);+ }++ const conflicts = [...grouped.entries()].filter(([, group]) => group.length > 1);++ if (conflicts.length) throw buildConflictError(conflicts);++ const map: TSecretMap = {};++ for (const [destinationKey, [entry]] of grouped) {+ map[destinationKey] = {+ value: entry.value,+ id: entry.id,+ comment: entry.comment,+ secretMetadata: entry.secretMetadata+ };+ }++ flattened = map;+ return map;+ }+ };+};