From 889c7efba02be9b375be0aec656fdb4539955af0 Mon Sep 17 00:00:00 2001 From: sim Date: Sat, 12 Sep 2026 11:54:08 -0400 Subject: [PATCH 01/11] test(#4653): failing-first coverage for the narrowed containment export MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Phase 3 of epic #4636. Tests only; no implementation. These MUST fail. A refactor changes what a good test looks like: the behavior under test must be IDENTICAL before and after, so most of this phase's safety comes from invariance rather than new assertions. That safety net already exists and is untouched here — tests/security.test.cjs already pins the two engine behaviors a re-derivation would silently lose: :177 a DANGLING symlink to a non-existent OUTSIDE target stays safe:false (the existence-oracle closure) :213 a not-yet-created file in a not-yet-created subdir under a non-canonical base stays safe:true (ancestor canonicalization) plus traversal, absolute in/out, null bytes, empty, non-string, and requireSafePath's throw. Those 0 deletions are the point: if any of them had to change, the engine would have changed, and the engine is not supposed to. What is new is the export surface Phase 3 introduces: assertWithinRoot(candidate, root, label?, opts?) -> ContainedPath (throws) tryWithinRoot(candidate, root, opts?) -> ContainedPath | null Two shapes rather than one, because several call sites need a NON-throwing check — findPhaseArtifact probes a direct path, then a .planning/ path, then each readdir entry, and throwing on the first miss would break it outright. ADR-4650 names only the throwing form; this is the gap between the ADR and the call sites, recorded rather than papered over. Rows that exist because they are the ones nobody enumerates: - tryWithinRoot must return EXACTLY null on escape, and its return must not contain the escaping path's basename. The shape being replaced populates its "resolved" field with the escaping path precisely on the traversal branch, so a caller who ignores the boolean gets a usable attacker-controlled value. That is the defect the narrowing exists to remove, so it is asserted directly. - A seeded parity property: tryWithinRoot returns non-null if and only if assertWithinRoot does not throw, and the values agree. Two exported shapes over one engine is a divergence pair by construction. - The rejection text still contains the phrase "escapes allowed directory". Another suite surfaces it through a user-facing "reason" field, and a refactor is exactly where wording drifts unnoticed. Co-Authored-By: Claude Opus 5 --- tests/security.test.cjs | 147 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 147 insertions(+) diff --git a/tests/security.test.cjs b/tests/security.test.cjs index f7e34d523..6433bacae 100644 --- a/tests/security.test.cjs +++ b/tests/security.test.cjs @@ -24,6 +24,8 @@ const { validateFieldName, validateShellArg, validatePromptStructure, + assertWithinRoot, + tryWithinRoot, } = require('../gsd-core/bin/lib/security.cjs'); // ─── Path Traversal Prevention ────────────────────────────────────────────── @@ -1346,3 +1348,148 @@ describe('cross-boundary containment — shared escaping inputs, same rejection }); } }); + +// ─── #4653: assertWithinRoot / tryWithinRoot — narrowed export ────────────── +// +// Phase 3 narrows the public surface: `validatePath` becomes module-internal +// and two new exports appear, both returning a branded ContainedPath. +// `assertWithinRoot` throws on escape (requireSafePath becomes a thin alias +// of it); `tryWithinRoot` returns null on escape. Neither export exists yet +// — this whole block is RED by construction (missing export, not a typo: +// verified against the compiled gsd-core/bin/lib/security.cjs export list, +// which lists only validatePath/loadTrustedGlobalRoots/requireSafePath/ +// scanForInjection/sanitizeForPrompt/sanitizeForDisplay/sanitizeLabel/ +// validateShellArg/safeJsonParse/validatePhaseNumber/validateFieldName/ +// validatePromptStructure). + +describe('assertWithinRoot / tryWithinRoot — narrowed export (#4653)', () => { + const base = '/projects/my-app'; + + describe('assertWithinRoot', () => { + test('returns the resolved path for a contained relative input', () => { + const resolved = assertWithinRoot('src/index.js', base); + assert.equal(resolved, path.resolve(base, 'src/index.js')); + }); + + test('returns the resolved path for an absolute input INSIDE the root when {allowAbsolute:true}', () => { + const resolved = assertWithinRoot(path.join(base, 'src/file.js'), base, null, { allowAbsolute: true }); + assert.equal(resolved, path.resolve(base, 'src/file.js')); + }); + + test('throws on a ../ traversal escaping the root', () => { + assert.throws(() => assertWithinRoot('../../etc/passwd', base)); + }); + + test('throws on an absolute path outside the root even with {allowAbsolute:true}', () => { + assert.throws(() => assertWithinRoot('/etc/passwd', base, null, { allowAbsolute: true })); + }); + + test('throws on a null byte', () => { + assert.throws(() => assertWithinRoot('src/\0evil.js', base)); + }); + + test('throws on empty input', () => { + assert.throws(() => assertWithinRoot('', base)); + }); + + test('throws on non-string input', () => { + assert.throws(() => assertWithinRoot(42, base)); + }); + + test('thrown message uses the label, matching requireSafePath\'s "