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
check if a secret will fail the github sync before updating it there
adilson242ffc342778
diff --git a/backend/src/services/secret-sync/github/github-sync-fns.test.ts b/backend/src/services/secret-sync/github/github-sync-fns.test.tsindex deb90a34a3..6f9b7623c6 100644--- a/backend/src/services/secret-sync/github/github-sync-fns.test.ts+++ b/backend/src/services/secret-sync/github/github-sync-fns.test.ts@@ -275,6 +275,48 @@ describe("GithubSyncFns.syncSecrets", () => {expect(callsWith("PUT")).toHaveLength(1000);});++ it.each(["BAD NAME", "BAD-NAME", "1LEADING"])(+ "refuses %s before calling GitHub and names that secret",+ async (key) => {+ const error = await runSync(+ makeSync(repoConfig(GitHubSyncSecretType.Dependabot)),+ makePayload([key, "VALID_NAME"])+ ).catch((err: unknown) => err);++ expect(error).toBeInstanceOf(SecretSyncError);+ expect(error).toMatchObject({+ shouldRetry: false,+ secretKey: key,+ message: `GitHub does not accept secret names unless they contain only letters, digits, and underscores, and start with a letter or an underscore. Spaces are not allowed. Rename the secrets that failed this check: "${key}".`+ });+ expect((error as SecretSyncError).message).not.toContain("VALID_NAME");+ expect(requestMock).not.toHaveBeenCalled();+ expect(paginatedMock).not.toHaveBeenCalled();+ }+ );++ it("names every secret GitHub would reject", async () => {+ const error = await runSync(+ makeSync(repoConfig(GitHubSyncSecretType.Dependabot)),+ makePayload(["BAD NAME", "1LEADING", "VALID_NAME"])+ ).catch((err: unknown) => err);++ expect(error).toMatchObject({+ shouldRetry: false,+ secretKey: "BAD NAME",+ message: expect.stringContaining('Rename the secrets that failed this check: "BAD NAME", "1LEADING".')+ });+ expect((error as SecretSyncError).message).not.toContain("VALID_NAME");+ expect(requestMock).not.toHaveBeenCalled();+ expect(paginatedMock).not.toHaveBeenCalled();+ });++ it("syncs a secret name that starts with an underscore", async () => {+ await runSync(makeSync(repoConfig(GitHubSyncSecretType.Dependabot)), makePayload(["_TOKEN"]));++ expect(callsWith("PUT")[0].url).toBe("https://api.github.com/repos/acme/app/dependabot/secrets/_TOKEN");+ });});describe("GitHub permission errors", () => {diff --git a/backend/src/services/secret-sync/github/github-sync-fns.ts b/backend/src/services/secret-sync/github/github-sync-fns.tsindex fe0e46d961..937b4cf686 100644--- a/backend/src/services/secret-sync/github/github-sync-fns.ts+++ b/backend/src/services/secret-sync/github/github-sync-fns.ts@@ -1,5 +1,6 @@import { AxiosError, isAxiosError } from "axios";import sodium from "libsodium-wrappers";+import RE2 from "re2";import { TGatewayPoolServiceFactory } from "@app/ee/services/gateway-pool/gateway-pool-service";import { TGatewayV2ServiceFactory } from "@app/ee/services/gateway-v2/gateway-v2-service";@@ -69,6 +70,24 @@ const GITHUB_SECRET_TYPES: Record<GitHubSyncSecretType, TGitHubSecretTypeDefinitconst CODESPACES_ON_GITHUB_SERVER_MESSAGE ="Codespaces secrets are not available on GitHub Enterprise Server. Choose the Actions or Dependabot secret type, or use a GitHub.com connection.";+const GITHUB_SECRET_NAME_PATTERN = new RE2(/^[A-Za-z_][A-Za-z0-9_]*$/);++const GITHUB_SECRET_NAME_RULE =+ "GitHub does not accept secret names unless they contain only letters, digits, and underscores, and start with a letter or an underscore. Spaces are not allowed.";++const assertGitHubSecretNames = (names: string[]) => {+ const invalidNames = names.filter((name) => !GITHUB_SECRET_NAME_PATTERN.test(name));+ if (!invalidNames.length) return;++ throw new SecretSyncError({+ secretKey: invalidNames[0],+ shouldRetry: false,+ message: `${GITHUB_SECRET_NAME_RULE} Rename the secrets that failed this check: ${invalidNames+ .map((name) => `"${name}"`)+ .join(", ")}.`+ });+};+// actions is the default for legacy syncsexport const getGitHubSyncSecretType = (destinationConfig: { secretType?: GitHubSyncSecretType }) =>destinationConfig.secretType ?? GitHubSyncSecretType.Actions;@@ -327,6 +346,8 @@ export const GithubSyncFns = {const ogSecretMap = payload.flatten();const secretMap = Object.fromEntries(Object.entries(ogSecretMap).map(([i, v]) => [i.toUpperCase(), v]));+ assertGitHubSecretNames(Object.keys(secretMap));+const { name: secretTypeName, limit } = GITHUB_SECRET_TYPES[getGitHubSyncSecretType(secretSync.destinationConfig)];const level = secretSync.destinationConfig.scope === GitHubSyncScope.Organization ? "organization" : "repository";