Skip to content

Commit b162649

Browse files
committed
fix(studio-server): reject linked waveform cache directories
1 parent 8382eb2 commit b162649

3 files changed

Lines changed: 91 additions & 8 deletions

File tree

‎packages/studio-server/src/helpers/waveform.file-race.test.ts‎

Lines changed: 67 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ const hooks = vi.hoisted(() => {
1515
failDecode: boolean;
1616
failWrite: boolean;
1717
failRename: boolean;
18-
} = { failDecode: false, failWrite: false, failRename: false };
18+
failCleanup: boolean;
19+
} = { failDecode: false, failWrite: false, failRename: false, failCleanup: false };
1920
return state;
2021
});
2122
vi.mock("node:child_process", async () => {
@@ -46,6 +47,10 @@ vi.mock("node:fs", async (importOriginal) => {
4647
}
4748
return fs.writeFileSync(...args);
4849
},
50+
rmSync: (...args: Parameters<typeof fs.rmSync>) => {
51+
if (hooks.failCleanup) throw new Error("cache cleanup failed");
52+
return fs.rmSync(...args);
53+
},
4954
renameSync: (...args: Parameters<typeof fs.renameSync>) => {
5055
if (hooks.failRename) throw new Error("cache rename failed");
5156
return fs.renameSync(...args);
@@ -66,6 +71,7 @@ beforeEach(() => {
6671
failDecode: false,
6772
failWrite: false,
6873
failRename: false,
74+
failCleanup: false,
6975
});
7076
projectDir = fs.mkdtempSync(join(tmpdir(), "hf-waveform-test-"));
7177
fs.writeFileSync(join(projectDir, "audio.wav"), "audio");
@@ -128,6 +134,52 @@ for (const caller of ["helper", "route"]) {
128134
},
129135
);
130136

137+
it.each([true, false])(
138+
"rejects a cache-directory symlink (target exists: %s)",
139+
async (exists) => {
140+
const outside = fs.mkdtempSync(join(tmpdir(), "hf-waveform-outside-"));
141+
const target = join(outside, "cache");
142+
const outsideCache = join(
143+
target,
144+
buildWaveformCacheKey("audio.wav", fs.statSync(join(projectDir, "audio.wav"))),
145+
);
146+
if (exists) {
147+
fs.mkdirSync(target);
148+
fs.writeFileSync(outsideCache, "untouched");
149+
}
150+
fs.symlinkSync(target, cacheDir, process.platform === "win32" ? "junction" : "dir");
151+
try {
152+
if (caller === "helper")
153+
await expect(generateWaveformCache(projectDir, "audio.wav")).rejects.toThrow();
154+
else {
155+
const response = await request();
156+
expect(response.status).toBe(200);
157+
expect((await response.json()).peaks).toHaveLength(4000);
158+
}
159+
if (exists) {
160+
expect(fs.readFileSync(outsideCache, "utf8")).toBe("untouched");
161+
expect(fs.readdirSync(target)).toHaveLength(1);
162+
} else expect(fs.existsSync(target)).toBe(false);
163+
} finally {
164+
fs.rmSync(outside, { recursive: true, force: true });
165+
}
166+
},
167+
);
168+
169+
it("rejects a cache-directory symlink planted during decoding", async () => {
170+
const outside = fs.mkdtempSync(join(tmpdir(), "hf-waveform-outside-"));
171+
hooks.decode = () =>
172+
fs.symlinkSync(outside, cacheDir, process.platform === "win32" ? "junction" : "dir");
173+
try {
174+
if (caller === "helper")
175+
await expect(generateWaveformCache(projectDir, "audio.wav")).rejects.toThrow();
176+
else expect((await request()).status).toBe(200);
177+
expect(fs.readdirSync(outside)).toEqual([]);
178+
} finally {
179+
fs.rmSync(outside, { recursive: true, force: true });
180+
}
181+
});
182+
131183
it("reuses an existing cache without decoding", async () => {
132184
seedCache("[0.25,1]");
133185
await generate();
@@ -202,3 +254,17 @@ it("keeps helper skipping, route 404s and decode failures unchanged", async () =
202254
expect((await request()).status).toBe(404);
203255
expect(fs.existsSync(cacheDir)).toBe(false);
204256
});
257+
258+
it("cleanup failure does not turn a successful publication into a helper error", async () => {
259+
hooks.failCleanup = true;
260+
await expect(generateWaveformCache(projectDir, "audio.wav")).resolves.toBeUndefined();
261+
expect(readPeaks()).toHaveLength(4000);
262+
});
263+
it("cleanup failure does not mask the original write error", async () => {
264+
hooks.failWrite = true;
265+
hooks.failCleanup = true;
266+
await expect(generateWaveformCache(projectDir, "audio.wav")).rejects.toThrow(
267+
"cache write failed",
268+
);
269+
expect(fs.existsSync(cachePath)).toBe(false);
270+
});

‎packages/studio-server/src/helpers/waveform.ts‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import {
33
existsSync,
44
writeFileSync,
55
mkdirSync,
6+
lstatSync,
67
mkdtempSync,
78
renameSync,
89
rmSync,
@@ -105,22 +106,37 @@ export async function generateWaveformCache(projectDir: string, assetPath: strin
105106
const stats = statSync(audioPath);
106107
const cacheDir = join(projectDir, ".waveform-cache");
107108
const cachePath = join(cacheDir, buildWaveformCacheKey(assetPath, stats));
108-
if (existsSync(cachePath)) return;
109+
if (isWaveformCacheDirectory(cacheDir) && existsSync(cachePath)) return;
109110

110111
const peaks = await decodeAudioPeaks(audioPath);
111112
writeWaveformCache(cachePath, peaks);
112113
}
113114

115+
export function isWaveformCacheDirectory(cacheDir: string): boolean {
116+
return lstatSync(cacheDir, { throwIfNoEntry: false })?.isDirectory() ?? false;
117+
}
118+
114119
/** Publish complete peaks without following a replaced cache-file symlink. */
115120
export function writeWaveformCache(cachePath: string, peaks: number[]): void {
116121
const cacheDir = dirname(cachePath);
117-
mkdirSync(cacheDir, { recursive: true });
122+
try {
123+
mkdirSync(cacheDir, { mode: 0o700 });
124+
} catch (error) {
125+
if (!(error instanceof Error && "code" in error && error.code === "EEXIST")) throw error;
126+
}
127+
if (!isWaveformCacheDirectory(cacheDir)) {
128+
throw new Error("Waveform cache must be a directory, not a symlink");
129+
}
118130
const stagingDir = mkdtempSync(join(cacheDir, ".waveform-"));
119131
try {
120132
const stagingPath = join(stagingDir, "peaks.json");
121133
writeFileSync(stagingPath, JSON.stringify(peaks), { flag: "wx" });
122134
renameSync(stagingPath, cachePath);
123135
} finally {
124-
rmSync(stagingDir, { recursive: true, force: true });
136+
try {
137+
rmSync(stagingDir, { recursive: true, force: true });
138+
} catch {
139+
// Cleanup must not mask a write error or fail an already published cache.
140+
}
125141
}
126142
}

‎packages/studio-server/src/routes/waveform.ts‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import {
66
decodeAudioPeaks,
77
buildWaveformCacheKey,
88
writeWaveformCache,
9+
isWaveformCacheDirectory,
910
} from "../helpers/waveform.js";
1011

1112
export function registerWaveformRoutes(api: Hono, adapter: StudioApiAdapter): void {
@@ -25,13 +26,13 @@ export function registerWaveformRoutes(api: Hono, adapter: StudioApiAdapter): vo
2526
// asset in place invalidates its peaks instead of drawing the old ones.
2627
const cachePath = join(cacheDir, buildWaveformCacheKey(assetPath, stats));
2728

28-
if (existsSync(cachePath)) {
29-
try {
29+
try {
30+
if (isWaveformCacheDirectory(cacheDir) && existsSync(cachePath)) {
3031
const peaks = JSON.parse(readFileSync(cachePath, "utf-8")) as number[];
3132
return c.json({ peaks });
32-
} catch {
33-
// corrupt cache — regenerate
3433
}
34+
} catch {
35+
// corrupt or inaccessible cache — regenerate
3536
}
3637

3738
let peaks: number[];

0 commit comments

Comments
 (0)