Skip to content

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

fix(pki): keep failed stale-file deletes tracked and skip cleanup after a host change

bernie-g5cd7f4878784
diff --git a/backend/src/services/certificate-sync/certificate-sync-schemas.ts b/backend/src/services/certificate-sync/certificate-sync-schemas.ts
index 0676e2b381..7ba3156188 100644
--- a/backend/src/services/certificate-sync/certificate-sync-schemas.ts
+++ b/backend/src/services/certificate-sync/certificate-sync-schemas.ts
@@ -19,7 +19,8 @@ export const BaseSyncMetadataSchema = z.object({}).catchall(z.unknown());
* removal targets exactly what was written
*/
export const ServerSyncMetadataSchema = z.object({
- files: z.array(z.string()).optional()
+ files: z.array(z.string()).optional(),
+ host: z.string().optional()
});
export const SyncMetadataSchema = AwsElbSyncMetadataSchema.extend(ServerSyncMetadataSchema.shape)
diff --git a/backend/src/services/pki-sync/linux-server/linux-server-pki-sync-fns.ts b/backend/src/services/pki-sync/linux-server/linux-server-pki-sync-fns.ts
index c7e9b51075..727710c3c1 100644
--- a/backend/src/services/pki-sync/linux-server/linux-server-pki-sync-fns.ts
+++ b/backend/src/services/pki-sync/linux-server/linux-server-pki-sync-fns.ts
@@ -3,7 +3,7 @@ import crypto from "node:crypto";
import path from "node:path";
import RE2 from "re2";
-import { Client, SFTPWrapper } from "ssh2";
+import { Client, SFTPWrapper, utils as ssh2Utils } from "ssh2";
import { TGatewayPoolServiceFactory } from "@app/ee/services/gateway-pool/gateway-pool-service";
import { TGatewayV2ServiceFactory } from "@app/ee/services/gateway-v2/gateway-v2-service";
@@ -240,6 +240,17 @@ const unlinkIfExists = (sftp: SFTPWrapper, filePath: string): Promise<void> =>
sftp.unlink(filePath, () => resolve());
});
+const unlinkOrThrow = (sftp: SFTPWrapper, filePath: string): Promise<void> =>
+ new Promise<void>((resolve, reject) => {
+ sftp.unlink(filePath, (err) => {
+ if (!err || (err as { code?: number }).code === ssh2Utils.sftp.STATUS_CODE.NO_SUCH_FILE) {
+ resolve();
+ return;
+ }
+ reject(err);
+ });
+ });
+
const TEMP_FILE_MARKER = ".infisical.tmp";
// A write completes in seconds, so any temp file older than this was left by an interrupted run
// (dropped connection between write and rename) and is safe to remove even if another sync shares
@@ -446,10 +457,11 @@ export const linuxServerPkiSyncFactory = ({
const sshConfig = await buildSshConfig(pkiSync, { gatewayV2Service, gatewayPoolService, keyStore });
const gatewayLabel = await resolveGatewayLabel(gatewayV2Service, sshConfig.gatewayId);
+ const targetHost = sshConfig.credentials.host;
const describeFailure = (error: unknown) =>
describeHostFailure({
error,
- host: (pkiSync.destinationConfig as TLinuxServerPkiSyncConfig).host,
+ host: targetHost,
gatewayLabel,
transport: "SSH"
});
@@ -549,21 +561,37 @@ export const linuxServerPkiSyncFactory = ({
]);
}
if (record) {
+ const previousMetadata = record.syncMetadata as TSyncMetadata;
const previousFiles =
- (record.syncMetadata as TSyncMetadata)?.files ??
- [record.externalIdentifier].filter((p): p is string => Boolean(p));
- const staleFiles = getStaleCertificateFiles({ previousFiles, writtenPaths, deliveredPaths });
+ previousMetadata?.files ?? [record.externalIdentifier].filter((p): p is string => Boolean(p));
+ const staleFiles = getStaleCertificateFiles({
+ previousFiles,
+ previousHost: previousMetadata?.host,
+ currentHost: targetHost,
+ writtenPaths,
+ deliveredPaths
+ });
+ const staleFilesToRetry: string[] = [];
for (const staleFile of staleFiles) {
- await unlinkIfExists(sftp, staleFile);
+ try {
+ await unlinkOrThrow(sftp, staleFile);
+ } catch (removeErr) {
+ staleFilesToRetry.push(staleFile);
+ failedRemovals.push({
+ name: staleFile,
+ error: (removeErr as Error)?.message ?? "Unknown error"
+ });
+ }
}
- if (staleFiles.length > 0) {
+ const removedCount = staleFiles.length - staleFilesToRetry.length;
+ if (removedCount > 0) {
logger.info(
- `Linux Server PKI sync [syncId=${pkiSync.id}]: removed ${staleFiles.length} file(s) "${baseName}" no longer uses`
+ `Linux Server PKI sync [syncId=${pkiSync.id}]: removed ${removedCount} file(s) "${baseName}" no longer uses`
);
}
await certificateSyncDAL.updateById(record.id, {
externalIdentifier: primaryPath,
- syncMetadata: { files: writtenPaths }
+ syncMetadata: { files: [...writtenPaths, ...staleFilesToRetry], host: targetHost }
});
}
}
diff --git a/backend/src/services/pki-sync/pki-sync-export-fns.test.ts b/backend/src/services/pki-sync/pki-sync-export-fns.test.ts
index 6f0eb7d43a..fb8556f478 100644
--- a/backend/src/services/pki-sync/pki-sync-export-fns.test.ts
+++ b/backend/src/services/pki-sync/pki-sync-export-fns.test.ts
@@ -231,6 +231,8 @@ describe("getStaleCertificateFiles", () => {
test("returns files written last time that this run no longer writes", () => {
expect(
getStaleCertificateFiles({
+ previousHost: "host-a",
+ currentHost: "host-a",
previousFiles: ["/certs/app.jks", "/certs/app.truststore.jks"],
writtenPaths: ["/certs/app.jks"],
deliveredPaths: new Set(["/certs/app.jks"])
@@ -241,6 +243,8 @@ describe("getStaleCertificateFiles", () => {
test("keeps a file another certificate wrote this run", () => {
expect(
getStaleCertificateFiles({
+ previousHost: "host-a",
+ currentHost: "host-a",
previousFiles: ["/certs/app.pem", "/certs/shared.pem"],
writtenPaths: ["/certs/app.jks"],
deliveredPaths: new Set(["/certs/app.jks", "/certs/shared.pem"])
@@ -251,6 +255,8 @@ describe("getStaleCertificateFiles", () => {
test("ignores case when paths are case-insensitive", () => {
expect(
getStaleCertificateFiles({
+ previousHost: "host-a",
+ currentHost: "host-a",
previousFiles: ["C:\\certs\\App.jks", "C:\\certs\\app.truststore.jks"],
writtenPaths: ["C:\\certs\\app.jks"],
deliveredPaths: new Set(["C:\\certs\\app.jks"]),
@@ -258,4 +264,27 @@ describe("getStaleCertificateFiles", () => {
})
).toEqual(["C:\\certs\\app.truststore.jks"]);
});
+
+ test("returns nothing when the files were written to another host", () => {
+ expect(
+ getStaleCertificateFiles({
+ previousHost: "host-a",
+ currentHost: "host-b",
+ previousFiles: ["/certs/app.jks"],
+ writtenPaths: ["/certs/other.jks"],
+ deliveredPaths: new Set(["/certs/other.jks"])
+ })
+ ).toEqual([]);
+ });
+
+ test("returns nothing when the previous host was not recorded", () => {
+ expect(
+ getStaleCertificateFiles({
+ currentHost: "host-a",
+ previousFiles: ["/certs/app.jks"],
+ writtenPaths: ["/certs/other.jks"],
+ deliveredPaths: new Set(["/certs/other.jks"])
+ })
+ ).toEqual([]);
+ });
});
diff --git a/backend/src/services/pki-sync/pki-sync-export-fns.ts b/backend/src/services/pki-sync/pki-sync-export-fns.ts
index 4b2eabaab4..4f0e09750c 100644
--- a/backend/src/services/pki-sync/pki-sync-export-fns.ts
+++ b/backend/src/services/pki-sync/pki-sync-export-fns.ts
@@ -22,18 +22,24 @@ export const stripUnusedKeystoreOptions = (syncOptions: Record<string, unknown>)
};
// Files this sync wrote for a certificate last time but no longer writes, such as a truststore
-// after it is turned off. Paths another certificate wrote this run are left alone.
+// after it is turned off. Paths another certificate wrote this run are left alone, and nothing is
+// returned when the files were written to a different host (or one that was not recorded).
export const getStaleCertificateFiles = ({
previousFiles,
+ previousHost,
+ currentHost,
writtenPaths,
deliveredPaths,
caseInsensitive = false
}: {
previousFiles: string[];
+ previousHost?: string;
+ currentHost?: string;
writtenPaths: string[];
deliveredPaths: Set<string>;
caseInsensitive?: boolean;
}): string[] => {
+ if (!previousHost || !currentHost || previousHost.toLowerCase() !== currentHost.toLowerCase()) return [];
const normalize = (filePath: string) => (caseInsensitive ? filePath.toLowerCase() : filePath);
const current = new Set([...writtenPaths, ...deliveredPaths].map(normalize));
return previousFiles.filter((filePath) => !current.has(normalize(filePath)));
diff --git a/backend/src/services/pki-sync/windows-server/windows-server-pki-sync-fns.ts b/backend/src/services/pki-sync/windows-server/windows-server-pki-sync-fns.ts
index 98d91bed5f..2a86fc5954 100644
--- a/backend/src/services/pki-sync/windows-server/windows-server-pki-sync-fns.ts
+++ b/backend/src/services/pki-sync/windows-server/windows-server-pki-sync-fns.ts
@@ -418,11 +418,13 @@ export const windowsServerPkiSyncFactory = ({
]);
}
if (record) {
+ const previousMetadata = record.syncMetadata as TSyncMetadata;
const previousFiles =
- (record.syncMetadata as TSyncMetadata)?.files ??
- [record.externalIdentifier].filter((p): p is string => Boolean(p));
+ previousMetadata?.files ?? [record.externalIdentifier].filter((p): p is string => Boolean(p));
const staleFiles = getStaleCertificateFiles({
previousFiles,
+ previousHost: previousMetadata?.host,
+ currentHost: target.credentials.host,
writtenPaths: paths,
deliveredPaths,
caseInsensitive: true
@@ -442,7 +444,7 @@ export const windowsServerPkiSyncFactory = ({
}
await certificateSyncDAL.updateById(record.id, {
externalIdentifier: paths[0],
- syncMetadata: { files: [...paths, ...staleFilesToRetry] }
+ syncMetadata: { files: [...paths, ...staleFilesToRetry], host: target.credentials.host }
});
}
}