RomanNum3ral
/
gstack
mirror of https://github.com/garrytan/gstack.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge 7e07964d13 into a3259400a3

This commit is contained in:
Brandon Lipman 2026-07-14 19:17:00 -07:00 committed by GitHub
parent a3259400a3 7e07964d13
commit 9a614e9e4a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 95 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
setup
View File

@ -403,14 +403,46 @@ if [ "$NEEDS_BUILD" -eq 1 ]; then
# macOS kills with SIGKILL (exit 137). The two-step remove+re-sign is # macOS kills with SIGKILL (exit 137). The two-step remove+re-sign is
# required because a naive `codesign -s - -f` fails when the existing # required because a naive `codesign -s - -f` fails when the existing
# signature block is corrupt. This is idempotent and costs <1s. # signature block is corrupt. This is idempotent and costs <1s.
#
# Some binaries (observed: find-browse, gstack-global-discover) also carry
# trailing zero-padding AFTER the Mach-O LC_CODE_SIGNATURE region. macOS
# codesign requires the signature to be the last content and extend to EOF,
# so the padding triggers "main executable failed strict validation" on
# re-sign (and "internal error in Code Signing subsystem" on remove). We
# truncate that trailing slack to the end of LC_CODE_SIGNATURE first, which
# lets the identical re-sign succeed. The binary runs either way: Bun's
# adhoc code-page signature satisfies the kernel's exec check even when
# `codesign --verify` is unhappy, so a re-sign failure only warns when the
# binary is genuinely SIGKILL'd on exec (exit 137).
# See: https://github.com/garrytan/gstack/issues/997 # See: https://github.com/garrytan/gstack/issues/997
if [ "$(uname -s)" = "Darwin" ] && [ "$(uname -m)" = "arm64" ]; then if [ "$(uname -s)" = "Darwin" ] && [ "$(uname -m)" = "arm64" ]; then
for _bin in browse/dist/browse browse/dist/find-browse design/dist/design make-pdf/dist/pdf bin/gstack-global-discover; do for _bin in browse/dist/browse browse/dist/find-browse design/dist/design make-pdf/dist/pdf bin/gstack-global-discover; do
_bin_path="$SOURCE_GSTACK_DIR/$_bin" _bin_path="$SOURCE_GSTACK_DIR/$_bin"
[ -f "$_bin_path" ] && [ -x "$_bin_path" ] || continue [ -f "$_bin_path" ] && [ -x "$_bin_path" ] || continue
# Strip any trailing bytes past LC_CODE_SIGNATURE so codesign can re-sign.
# otool prints the signature's dataoff+datasize; if the file is larger,
# the extra bytes are Bun padding that breaks strict validation.
_sig_end=$(otool -l "$_bin_path" 2>/dev/null | awk '/LC_CODE_SIGNATURE/{f=1} f&&/dataoff/{o=$2} f&&/datasize/{print o+$2; exit}')
_fsize=$(stat -f%z "$_bin_path" 2>/dev/null)
if [ -n "$_sig_end" ] && [ -n "$_fsize" ] && [ "$_sig_end" -gt 0 ] 2>/dev/null && [ "$_sig_end" -lt "$_fsize" ] 2>/dev/null; then
_trunc_tmp=$(mktemp 2>/dev/null) || _trunc_tmp=""
if [ -n "$_trunc_tmp" ] && head -c "$_sig_end" "$_bin_path" > "$_trunc_tmp" 2>/dev/null; then
cat "$_trunc_tmp" > "$_bin_path" && chmod +x "$_bin_path"
fi
[ -n "$_trunc_tmp" ] && rm -f "$_trunc_tmp"
fi
codesign --remove-signature "$_bin_path" 2>/dev/null || true codesign --remove-signature "$_bin_path" 2>/dev/null || true
if ! codesign -s - -f "$_bin_path" 2>/dev/null; then if ! codesign -s - -f "$_bin_path" 2>/dev/null; then
log "warning: codesign failed for $_bin (binary may not run on Apple Silicon)" # Re-sign failed. Only warn if the binary genuinely cannot execute
# (SIGKILL = exit 137). Otherwise Bun's adhoc code-page signature still
# runs fine and the codesign --verify miss is cosmetic. set -e safe.
_probe_rc=0
"$_bin_path" --help >/dev/null 2>&1 || _probe_rc=$?
if [ "$_probe_rc" -eq 137 ]; then
log "warning: codesign failed for $_bin and it is SIGKILL'd on exec (exit 137) — it may not run on Apple Silicon"
else
log "note: codesign could not re-sign $_bin, but it executes fine (Bun adhoc signature); continuing"
fi
fi fi
done done
fi fi

97
test/setup-codesign.test.ts
View File

@ -1,78 +1,105 @@
import { describe, test, expect } from 'bun:test'; import { describe, test, expect } from "bun:test";
import { spawnSync } from 'child_process'; import { spawnSync } from "child_process";
import * as path from 'path'; import * as path from "path";
import * as fs from 'fs'; import * as fs from "fs";
import * as os from 'os'; import * as os from "os";
const ROOT = path.resolve(import.meta.dir, '..'); const ROOT = path.resolve(import.meta.dir, "..");
const SETUP_SCRIPT = path.join(ROOT, 'setup'); const SETUP_SCRIPT = path.join(ROOT, "setup");
describe('setup: Apple Silicon codesign', () => { describe("setup: Apple Silicon codesign", () => {
test('setup script contains codesign block for Darwin arm64', () => { test("setup script contains codesign block for Darwin arm64", () => {
const content = fs.readFileSync(SETUP_SCRIPT, 'utf-8'); const content = fs.readFileSync(SETUP_SCRIPT, "utf-8");
// Verify the codesign guard checks both Darwin and arm64 // Verify the codesign guard checks both Darwin and arm64
expect(content).toContain('$(uname -s)" = "Darwin"'); expect(content).toContain('$(uname -s)" = "Darwin"');
expect(content).toContain('$(uname -m)" = "arm64"'); expect(content).toContain('$(uname -m)" = "arm64"');
// Verify remove-then-resign two-step pattern // Verify remove-then-resign two-step pattern
expect(content).toContain('codesign --remove-signature'); expect(content).toContain("codesign --remove-signature");
expect(content).toContain('codesign -s - -f'); expect(content).toContain("codesign -s - -f");
}); });
test('codesign block covers all compiled binaries', () => { test("codesign block covers all compiled binaries", () => {
const content = fs.readFileSync(SETUP_SCRIPT, 'utf-8'); const content = fs.readFileSync(SETUP_SCRIPT, "utf-8");
// Extract the binaries from the codesign for-loop // Extract the binaries from the codesign for-loop
const forMatch = content.match(/for _bin in ([^;]+);/); const forMatch = content.match(/for _bin in ([^;]+);/);
expect(forMatch).toBeTruthy(); expect(forMatch).toBeTruthy();
const binaries = forMatch![1].trim().split(/\s+/); const binaries = forMatch![1].trim().split(/\s+/);
// All four compiled binaries from `bun run build` must be covered // All four compiled binaries from `bun run build` must be covered
expect(binaries).toContain('browse/dist/browse'); expect(binaries).toContain("browse/dist/browse");
expect(binaries).toContain('browse/dist/find-browse'); expect(binaries).toContain("browse/dist/find-browse");
expect(binaries).toContain('design/dist/design'); expect(binaries).toContain("design/dist/design");
expect(binaries).toContain('bin/gstack-global-discover'); expect(binaries).toContain("bin/gstack-global-discover");
}); });
test('codesign block is inside the NEEDS_BUILD=1 branch', () => { test("codesign block is inside the NEEDS_BUILD=1 branch", () => {
const content = fs.readFileSync(SETUP_SCRIPT, 'utf-8'); const content = fs.readFileSync(SETUP_SCRIPT, "utf-8");
// The codesign block should appear after the build command and before the // The codesign block should appear after the build command and before the
// `if [ ! -x "$BROWSE_BIN" ]` guard that checks the build succeeded. The // `if [ ! -x "$BROWSE_BIN" ]` guard that checks the build succeeded. The
// setup script invokes the build via `bun_cmd run build` (not literal // setup script invokes the build via `bun_cmd run build` (not literal
// `bun run build`) so the wrapper can route through asdf/volta/etc; // `bun run build`) so the wrapper can route through asdf/volta/etc;
// matching the wrapped form keeps this test stable across that indirection. // matching the wrapped form keeps this test stable across that indirection.
const buildIdx = content.indexOf('bun_cmd run build'); const buildIdx = content.indexOf("bun_cmd run build");
const codesignIdx = content.indexOf('codesign --remove-signature'); const codesignIdx = content.indexOf("codesign --remove-signature");
const browseCheckIdx = content.indexOf('gstack setup failed: browse binary missing'); const browseCheckIdx = content.indexOf(
"gstack setup failed: browse binary missing",
);
expect(buildIdx).toBeGreaterThan(-1); expect(buildIdx).toBeGreaterThan(-1);
expect(codesignIdx).toBeGreaterThan(buildIdx); expect(codesignIdx).toBeGreaterThan(buildIdx);
expect(browseCheckIdx).toBeGreaterThan(codesignIdx); expect(browseCheckIdx).toBeGreaterThan(codesignIdx);
}); });
test('codesign block is idempotent (skips missing binaries)', () => { test("codesign block is idempotent (skips missing binaries)", () => {
const content = fs.readFileSync(SETUP_SCRIPT, 'utf-8'); const content = fs.readFileSync(SETUP_SCRIPT, "utf-8");
// The loop must guard with a file-existence + executable check before codesigning // The loop must guard with a file-existence + executable check before codesigning
expect(content).toContain('[ -f "$_bin_path" ] && [ -x "$_bin_path" ] || continue'); expect(content).toContain(
'[ -f "$_bin_path" ] && [ -x "$_bin_path" ] || continue',
);
}); });
test('codesign failure is a warning, not a fatal error', () => { test("codesign failure is a warning, not a fatal error", () => {
const content = fs.readFileSync(SETUP_SCRIPT, 'utf-8'); const content = fs.readFileSync(SETUP_SCRIPT, "utf-8");
// On codesign failure, log a warning but don't exit // On codesign failure, log a warning but don't exit
expect(content).toContain('warning: codesign failed for'); expect(content).toContain("warning: codesign failed for");
// Should NOT have `set -e` causing exit on codesign failure // Should NOT have `set -e` causing exit on codesign failure
// (the `|| true` after --remove-signature and the if-guard around -s - -f handle this) // (the `|| true` after --remove-signature and the if-guard around -s - -f handle this)
expect(content).toContain('codesign --remove-signature "$_bin_path" 2>/dev/null || true'); expect(content).toContain(
'codesign --remove-signature "$_bin_path" 2>/dev/null || true',
);
}); });
test('codesign shell snippet is syntactically valid', () => { test("codesign block truncates trailing data past LC_CODE_SIGNATURE", () => {
const content = fs.readFileSync(SETUP_SCRIPT, "utf-8");
// Bun --compile can leave zero-padding after the signature region, which
// breaks `codesign -s - -f` with "main executable failed strict
// validation". Setup must compute the signature end via otool and truncate
// the file to it before signing.
expect(content).toContain("LC_CODE_SIGNATURE");
expect(content).toContain('head -c "$_sig_end"');
expect(content).toContain('"$_sig_end" -lt "$_fsize"');
});
test("re-sign failure only warns when the binary is SIGKILLed (exit 137)", () => {
const content = fs.readFileSync(SETUP_SCRIPT, "utf-8");
// A failed re-sign is not fatal and not always a real problem: Bun's adhoc
// code-page signature still satisfies the kernel. Setup must probe the
// binary and reserve the scary "may not run" warning for exit 137.
expect(content).toContain('"$_probe_rc" -eq 137');
// The probe must be set -e safe (|| _probe_rc=$?), since setup runs set -e.
expect(content).toContain("|| _probe_rc=$?");
});
test("codesign shell snippet is syntactically valid", () => {
// Extract the codesign block and validate it parses as bash // Extract the codesign block and validate it parses as bash
const content = fs.readFileSync(SETUP_SCRIPT, 'utf-8'); const content = fs.readFileSync(SETUP_SCRIPT, "utf-8");
const match = content.match( const match = content.match(
/# macOS Apple Silicon: ad-hoc codesign[\s\S]*?done\n\s*fi/ /# macOS Apple Silicon: ad-hoc codesign[\s\S]*?done\n\s*fi/,
); );
expect(match).toBeTruthy(); expect(match).toBeTruthy();
const snippet = match![0]; const snippet = match![0];
// Wrap in a function to make it a complete script, then syntax-check // Wrap in a function to make it a complete script, then syntax-check
const testScript = `#!/usr/bin/env bash\nset -e\n_test_fn() {\n${snippet}\n}\n`; const testScript = `#!/usr/bin/env bash\nset -e\n_test_fn() {\n${snippet}\n}\n`;
const result = spawnSync('bash', ['-n', '-c', testScript], { const result = spawnSync("bash", ["-n", "-c", testScript], {
stdio: ['pipe', 'pipe', 'pipe'], stdio: ["pipe", "pipe", "pipe"],
timeout: 5000, timeout: 5000,
}); });
expect(result.status).toBe(0); expect(result.status).toBe(0);