Merge remote-tracking branch 'origin/main' into ponytail-inspiration-review

# Conflicts:
#	bin/gstack-config
#	browse/test/path-validation.test.ts
#	package.json
#	test/helpers/carve-guards.ts
This commit is contained in:
Garry Tan
2026-08-29 04:33:10 +00:00
58 changed files with 1206 additions and 112 deletions
+91 -2
View File
@@ -135,6 +135,21 @@ export function restrictFilePermissions(filePath: string): void {
* POSIX: `fs.chmodSync(path, 0o700)`. Idempotent if the dir was already
* created with `{ mode: 0o700 }`.
*
* Owner-only hardening is for directories gstack creates and owns. Two
* pre-existing shapes must never be chmodded, so the POSIX branch refuses
* them:
*
* - A directory owned by another user. On most hosts the chmod just
* fails EPERM, but run as root (or with CAP_FOWNER — containers, CI
* sandboxes) it SUCCEEDS and takes the directory away from its owner.
* - A shared sticky world-writable directory (`/tmp`, `/var/tmp`).
* Callers land here when a state file is configured directly inside
* the system temp dir (`BROWSE_STATE_FILE=/tmp/foo.json` makes
* `path.dirname()` derive `/tmp` as the state dir). A 0o700 `/tmp`
* locks every other process on the machine out of it: access(2)-based
* checks (`fs.existsSync`) return EACCES→false machine-wide, even
* while stat keeps working for capability-holding processes.
*
* Windows: `icacls /inheritance:r /grant:r <user>:(OI)(CI)(F)`. The
* `(OI)(CI)` flags make new files (OI = object inherit) and subdirs
* (CI = container inherit) inherit the single-user-full ACL — important
@@ -155,7 +170,78 @@ export function restrictDirectoryPermissions(dirPath: string): void {
}
return;
}
try { fs.chmodSync(dirPath, 0o700); } catch { /* best-effort */ }
try {
// fd-anchored check-then-act: statSync + chmodSync resolve the path twice,
// so a symlink swapped in between would let the chmod land on a directory
// the check never saw (exactly the CAP_FOWNER hosts this guard exists
// for). O_NOFOLLOW refuses a symlinked state dir outright; fstat + fchmod
// pin both the check and the act to the same inode.
const fd = fs.openSync(
dirPath,
fs.constants.O_RDONLY | fs.constants.O_DIRECTORY | fs.constants.O_NOFOLLOW,
);
try {
if (!shouldHardenDir(fs.fstatSync(fd))) {
warnUnhardenedDirOnce(dirPath);
return;
}
fs.fchmodSync(fd, 0o700);
} finally {
fs.closeSync(fd);
}
} catch (err: any) {
// The fd path refuses two shapes the old chmodSync handled, and a silent
// skip here would quietly lose hardening (the module's own rule is that
// refusals are never silent):
// ELOOP/ENOTDIR — dirPath is a symlink (dotfiles-managed ~/.gstack via
// stow/chezmoi). Never follow it blind; warn so the operator knows.
// EACCES — an OWNED dir stuck without the read bit (mode 0300/0000)
// can't be opened but could always be repaired by plain chmod. Keep
// that self-repair: re-check ownership via lstat (no link follow) and
// chmod only a real, owned, non-shared directory.
if (err?.code === 'EACCES') {
try {
const st = fs.lstatSync(dirPath);
if (st.isDirectory() && shouldHardenDir(st)) {
fs.chmodSync(dirPath, 0o700);
return;
}
} catch { /* fall through to the warning */ }
}
if (err?.code === 'ELOOP' || err?.code === 'ENOTDIR' || err?.code === 'EACCES') {
warnUnhardenedDirOnce(dirPath);
}
/* anything else: best-effort, matching the old behavior */
}
}
/** Owner-only hardening applies to a real dir we own that isn't shared. */
function shouldHardenDir(st: fs.Stats): boolean {
// chmod authorization is judged on the EFFECTIVE uid; fall back to the
// real uid where geteuid is unavailable (Windows — unreachable here).
const uid = process.geteuid?.() ?? process.getuid?.();
if (st.uid !== uid) return false;
// sticky + world-writable = shared temp dir (/tmp, /var/tmp) — never ours
// to restrict. Running as root, treat ANY world-writable dir as shared:
// root "owns" docker/CI volume mounts (0777, no sticky bit) that other
// users depend on, and a 0700 there locks them all out.
if ((st.mode & 0o1002) === 0o1002) return false;
if (uid === 0 && (st.mode & 0o002) === 0o002) return false;
return true;
}
// The POSIX refusal must not be silent (the Windows branch already warns when
// icacls misses its hardening target): an operator who points state at a
// shared or foreign-owned directory should learn it was left unhardened.
const unhardenedWarned = new Set<string>();
function warnUnhardenedDirOnce(dirPath: string): void {
if (unhardenedWarned.has(dirPath)) return;
unhardenedWarned.add(dirPath);
// biome-ignore lint/suspicious/noConsole: intentional user-facing warning
console.warn(
`[gstack] directory ${dirPath} is shared, symlinked, or owned by another user; ` +
'gstack left its permissions untouched — use a private, non-symlinked directory for owner-only hardening',
);
}
/**
@@ -218,7 +304,10 @@ export function repairBrokenDacl(dirPath: string): void {
/**
* `mkdir -p` with owner-only directory permissions, cross-platform.
* Replaces `fs.mkdirSync(path, { recursive: true, mode: 0o700 })` + Windows ACL.
* Safe to call on an existing directory — re-applies the ACL idempotently.
* Safe to call on an existing directory — re-applies the ACL idempotently,
* except on directories gstack doesn't own (another user's dir, or a shared
* sticky world-writable dir like `/tmp`), which are left untouched — see
* `restrictDirectoryPermissions`.
*
* Windows: after applying the restricted ACL, verifies the directory is
* still listable by this process and repairs a broken DACL (#1605) if not.