Files
reverse-engineering-anything/src/hopper/HopperMachOImage.test.ts
T
morluto cef87c498a refactor(architecture): add the ports and resources layers, move ports and shared resource owners there, and ratchet the layer baseline (#11208)
* test(architecture): fail on a stale layer baseline and document the declared layers

verify:module-boundaries reported a layer baseline entry whose imports were
gone but still passed, so main kept process -> artifacts at 20 after it fell
to 17 and a later change could add three imports back unnoticed. A stale
entry now fails like growth; --shrink-layer-baseline lowers it in the change
that removes the imports. The architecture map and CONTRIBUTING name
scripts/lib/module-layers.mjs as the per-directory layer declaration.

* test(architecture): refuse to lower the layer baseline after an inspection failure

A file that cannot be parsed contributes no imports, so a shrink run would record counts that fail as growth once the file is fixed. Whole-command tests cover stale rejection, shrinking, refused growth and the inspection failure.

* refactor(ports): move the progress, work-scope and inspection-scope ports to src/ports (#11214)

* refactor(ports): move the progress, work-scope and inspection-scope ports to src/ports

Pure move with git mv and import specifier updates.

* test(architecture): declare the ports layer and lower the layer baseline

src/ports sits between the foundation and the providers. Moving the three
ports removes 11 provider -> application imports.

* refactor(ports): move AnalysisProvider to src/ports (#11217)

* refactor(ports): move AnalysisProvider to src/ports

Pure move with git mv and import specifier updates in its importers, the
built-fixture path, the CI scope glob and the lint-rule test spellings.

* test(architecture): lower the layer baseline after moving AnalysisProvider

* refactor(ports): move the per-feature provider ports to src/ports (#11226)

* refactor(ports): move the per-feature provider ports to src/ports

Pure move with git mv and import specifier updates: the 47 *Port.ts and
*Ports.ts files that providers implement, plus OptionalObservationProviders,
which only composes the observation ports.

* test(architecture): lower the layer baseline after moving the feature ports

* refactor(providers): move closeAnalysisClient and the Frida session input errors to their owners (#11233)

* refactor(providers): move closeAnalysisClient to src/providers and the Frida session input errors to src/frida

Pure move with git mv and import specifier updates.

* test(architecture): drop the application-providers and application-frida cycles from the layer baseline

* fix(ci): keep provider lanes selecting the ports moved to src/ports

Each lane glob that matched a moved port under src/application gains its src/ports counterpart; the change-scope test pins one moved port per lane.

* refactor(domain): declare the localPath host exception and read HOST_PLATFORM there (#11256)

absoluteLocalPathStringSchema decides which paths are absolute on the running host, so it reads HOST_PLATFORM instead of process.platform. Domain may not import outside domain/contracts; module-layers now declares LAYER_EXCEPTIONS, exact file-to-file imports with a reason, and both the layer count and the pure-layer boundary skip only that import. Any other domain -> platform import still fails.

* refactor(ports): move the doctor check and provider inspection types to src/ports (#11246)

* refactor(ports): move the doctor check and provider inspection types to src/ports

Declaration move from application/Doctor.ts (unchanged text) and import updates; no re-export from Doctor.ts.

* test(architecture): lower the layer baseline after moving the doctor provider types

* refactor(ports): move the packet capture and signal recording ports to src/ports (#11249)

* refactor(ports): move the packet capture and signal recording ports to src/ports

Declaration move (unchanged text) out of the two application services, with import updates.

* test(architecture): lower the layer baseline after moving the capture and signal ports

* refactor(domain): move the analysis error projection schema from contracts to domain (#11251)

* refactor(domain): move the analysis error projection schema from contracts to domain

Declaration move (unchanged text) of the projection schemas that domain modules embed; contracts/errorSchemas.ts keeps the CLI envelope and the published JSON Schema. Import updates only.

* test(architecture): drop the contracts-domain cycle from the layer baseline

* refactor(ports): drop the imports the moved capture, signal and doctor types left behind

Also give the packet capture and signal recording lanes the new port paths, with change-scope cases.

* refactor(resources): add src/resources and move AnalysisCleanupLease and ArtifactReader there (#11259)

* refactor(resources): move AnalysisCleanupLease to src/resources

Pure move: git mv plus import specifier rewrites (source, tests, and the dist paths the verifier scripts load).

* refactor(resources): declare src/resources as a foundation unit

src/resources owns the shared analysis resource modules that process, windows and providers hold; AnalysisCleanupLease is the first. Its tests join the adapters project, the apk signature lane selects it beside src/artifacts, and the layer baseline drops the process and windows imports of the lease.

* test(ci): pin the apk signature lane on the moved cleanup lease

* refactor(resources): move ArtifactReader to src/resources

Pure move: git mv plus import specifier rewrites (source, tests, and the dist path a verifier script loads).

* test(architecture): lower the layer baseline after moving ArtifactReader

windows no longer imports src/artifacts; process -> artifacts 11 -> 9. The CI lanes that selected src/artifacts/ArtifactReader.ts select its new path, pinned in the change-scope test.

* refactor(resources): move ArtifactResourceScope to src/resources (#11265)

* refactor(artifacts): name the output tree and private root capabilities the resource scope releases

ArtifactResourceScope typed its output-tree and private-runtime-root owners with SafeOutputTree (src/artifacts) and PrivateRuntimeRoot (src/process). It only calls rollback() and close(), so it now declares those capabilities itself and names neither unit, which lets it move to src/resources without a resources <-> process cycle. The withheld-export test narrows to SafeOutputTree where it reads the published flag.

* refactor(resources): move ArtifactResourceScope to src/resources

Pure move: git mv plus import specifier rewrites (source, tests, the dist paths verifier scripts load, and the FIFO probe's module-relative URL).

* test(architecture): lower the layer baseline after moving ArtifactResourceScope

process -> artifacts 9 -> 5, and the artifacts <-> dotnet mutual pair is gone. The sqlite and agentenv lanes select the scope at its new path, pinned in the change-scope test.

* refactor(resources): move ArtifactFileOperation to src/resources (#11269)

* refactor(resources): move ArtifactFileOperation to src/resources

Pure move: git mv plus import specifier rewrites (source, tests, and the dist paths verifier scripts load).

* test(architecture): lower the layer baseline after moving ArtifactFileOperation

process -> artifacts 5 -> 1.

* refactor(resources): move readStableArtifact to src/resources (#11271)

* refactor(resources): move readStableArtifact to src/resources

Pure move: git mv plus import specifier rewrites.

* test(architecture): lower the layer baseline after moving readStableArtifact

process no longer imports src/artifacts: process -> artifacts 1 -> 0 and the artifacts <-> process mutual pair is gone. The seven lanes that selected readStableArtifact select its new path, pinned in the change-scope test; the architecture map lists what src/resources owns.

* refactor(hopper): take Linux launcher verification from composition through a port (#11278)

The Hopper launcher imported inspectLinuxHopperLauncher and retryLinuxHopperPublisherCleanup from src/application (the two hopper -> application imports). src/ports/LinuxHopperLauncherVerification.ts now names that capability; src/application/LinuxHopper.ts provides LINUX_HOPPER_LAUNCHER_VERIFICATION, binary composition passes it to HopperProvider, and the provider hands it to the launcher. A launcher built without one refuses a Linux demo launch with reason verification_unavailable before running the launcher. Layer baseline: hopper -> application 2 -> 0.

* refactor(config): move Hopper launcher discovery to a src/hopperPaths foundation unit (#11292)

* refactor(hopper): move the launcher discovery and macOS Hopper paths to src/hopperPaths

Pure move: git mv plus import specifier rewrites.

* refactor(hopper): declare src/hopperPaths as a foundation unit with the Linux launcher candidates

Hopper install paths and launcher discovery are pure path facts that the
Hopper provider, doctor and setup all read. Declare src/hopperPaths in the
foundation layer, add it to the adapters test project, the architecture
map and the package-baseline CI lane, and move the Linux launcher
candidates out of src/application/LinuxHopper.ts into
src/hopperPaths/LinuxHopperPaths.ts so discovery no longer imports
application code.

* refactor(config): leave Hopper launcher discovery to the Hopper provider

parseConfig resolved an unset HOPPER_LAUNCHER_PATH by probing the
filesystem through application-owned discovery, so config imported
application (config -> application 2, application <-> config cycle) and
read process.platform ambiently.

AppConfig.hopperLauncherPath is now the caller's HOPPER_LAUNCHER_PATH
unchanged (string | undefined). src/hopperPaths/HopperLauncherDiscovery.ts
owns the selection (selectedHopperLauncherPath: the configured spelling,
else discovery from the caller environment's home on the provider's
platform); HopperProvider and the two real-Hopper verifiers read it.
Discovery tests move from config.test.ts to src/hopperPaths; a provider
test covers discovery from the provider's own platform and home.

Module layers: config -> application 2 -> 0; application <-> config removed.
Architecture guards: ambient platform reads in parseConfig.ts 2 -> 0.

* refactor(providers): move owned-process prerequisite availability out of application (#11294)

* refactor(providers): move the owned-process prerequisite availability mapping to src/providers

Pure move: git mv plus import specifier rewrites.

* test(architecture): lower the layer baseline after moving owned-process availability

android -> application 1 -> 0; apktool -> application 1 -> 0.

* refactor(process): move the regular-file read owner out of application (#11299)

* refactor(process): move the regular-file read owner from src/application to src/process

Pure move: git mv plus import specifier rewrites.

* test(architecture): lower the layer baseline after moving the regular-file read owner

desktop -> application 5 -> 4; dotnet -> application 2 -> 1.

The agentenv lane listed src/application/RegularFileRead.ts. At its new
path it is a src/process/ shared boundary: fast qualification selects the
code and runtime checks (and the single owning lane, web_source_map, via
src/process/**), and full qualification selects every lane, as for every
other src/process/ module. A second owner entry would only suppress the
web_source_map selection, so the agentenv entry is removed, not renamed.

* refactor(resources): give atomic text writes their own owner (#11302)

* refactor(resources): give atomic text writes their own owner in src/resources

src/application/JsonFiles.ts owned both JSON input reads and the atomic
text write (writeTextFile / writeTextParts and their staged-output
publication). The write side depends only on domain, filesystem and
resource owners, but il2cpp's Ghidra seed writer had to import
application to reach it (il2cpp -> application).

Move the write side verbatim to src/resources/TextFileWrite.ts
(TextWriteCancellation, writeTextFile, writeTextParts and their private
staging, publication and failure classification helpers). JsonFiles keeps
the JSON read owner and reads the shared errno-to-reason classifier
(fileAccessFailureReason) from the write owner instead of a copy.
Importers (il2cpp seed writer, evidence bundle files, desktop build
solves, analysis snapshot files and four boundary tests) read the new
path; no re-export is left in JsonFiles.

* test(architecture): lower the layer baseline after moving the text write owner

il2cpp -> application 1 -> 0.

* refactor(ports): move the desktop build host contract to src/ports (#11303)

* refactor(domain): move the setup cancellation check from src/application to src/domain

Pure move: git mv plus import specifier rewrites.

* refactor(ports): move the desktop build host contract to src/ports

The desktop provider implements doctor's desktop build facts reader and
setup's desktop build host, but the contract it implements lived in
application (DesktopBuildDoctor, SetupDesktopBuild, Doctor's
clientRegistrations signature, ClientRegistrationEnvironment's setting
types), so desktop imported application four times and the two units
were a recorded mutual pair.

src/ports/DesktopBuildHost.ts now holds that contract, moved verbatim:
DesktopBuildCommand, DesktopBuildFacts, DesktopBuildFactsInput,
DesktopBuildSetupFacts, DesktopBuildSetupHost, RecordedProviderSettings
and OwnedProviderSetting. Two names are new: DesktopBuildRegistration,
the registration facts the host reads (client, command and the
recorded-settings names; client registration status satisfies it), and
DesktopBuildRegistrationReader, which replaces
DoctorHost["clientRegistrations"] in the setup host. The facts input's
registration reader returns DesktopBuildRegistration instead of the full
application status; the setup facts' settings are spelled
Readonly<Record<string, string>> (SetupProviderEnvironment's definition).
Application imports the types from the port; no re-export is left.

* test(architecture): lower the layer baseline after the desktop build host port

desktop -> application 4 -> 0; the application <-> desktop mutual pair is gone.

* refactor(domain): define the resolved app bundle resource root beside its schema (#11304)

* refactor(domain): define the resolved app bundle resource root beside its provenance schema

ResolvedAppBundleResourceRoot (an app directory's resource-only identity)
is a pure type over BundleResourceRoot's layout, but it lived in
src/application/AppBundleExecutable.ts, so the native and artifact
providers that receive it imported application.

Move the interface verbatim to src/domain/apple/bundleResourceRoot.ts,
which owns BundleResourceRoot, and point its eight readers there (native
macOS provider and plist source, artifact provider, binary composition,
and the binary session, status, port and bundle-resource session). The
resolver that produces it stays in application.

* test(architecture): lower the layer baseline after moving the resource root type

native -> application 2 -> 0; artifacts -> application 2 -> 1 (the
artifact provider still constructs BundleResourceSession).

* refactor(config): move the pwntools input bound parser to src/config (#11306)

* refactor(config): move the pwntools input bound parser from src/native to src/config

Pure move: git mv plus import specifier rewrites, and the module path in docs/design/rea-limit-inventory.md (table realigned by oxfmt).

* test(architecture): lower the layer baseline after moving the pwntools input bound

config -> native 1 -> 0. The binary_layout and recorded_crash lanes, which
select src/native/pwntools/**, also select src/config/pwntoolsInputLimit*.ts;
ciChangeScope.test.ts pins both.

* refactor(filesystem): move REA cache directory helpers out of config (#11309)

* refactor(filesystem): move the REA cache directory and lexical directory helpers from src/config to src/filesystem

Pure move: git mv plus import specifier rewrites.

* test(architecture): drop the config and filesystem cycle from the layer baseline

config no longer imports filesystem; filesystem still reads the Windows
ChangeTime settle budget from config.

* refactor(windows): break the process and windows import cycle (#11317)

* refactor(domain): move the runtime-control and private-runtime-root refusals from src/process to src/domain

Pure move: git mv plus import specifier rewrites (including the dist path scripts/verify-windows-native.mjs loads).

* refactor(windows): type Job Object cleanup by what a Windows job reports

WindowsOwnedProcess.cleanup() returned process-ownership's
ProcessCleanupResult, so src/windows imported src/process for a type while
process imports windows to supervise Windows trees. A Job Object stop only
ever reports settled-and-signalled or a reason it did not settle; name that
subset WindowsJobCleanupResult in windows. It stays assignable to
ProcessCleanupResult, so the process supervisor reads it unchanged.

* test(architecture): drop the process and windows cycle from the layer baseline

* test(architecture): ratchet cross-provider imports and imports past a provider entry (#11386)

* test(architecture): ratchet cross-provider imports and imports past a provider entry

A provider folder may import the domain, contracts, foundation and ports layers, the shared provider core (src/providers) and its own files; an import of another provider folder is a recorded exception. Application, composition and the CLI/MCP adapters reach a provider only through src/<provider>/index.ts. verify:module-boundaries counts both kinds of import per unit pair in the layer baseline (crossProvider, providerEntry); like the upward counts they may only shrink, and a pair missing from the baseline fails.

* refactor(resources): move StableArtifactFailure and StableArtifactObservation into src/resources (#11387)

* refactor(resources): move StableArtifactFailure and StableArtifactObservation into src/resources

Providers project stable-read failures through StableArtifactFailure next to the other shared provider toolkit owners (ArtifactReader, ArtifactResourceScope, ArtifactFileOperation, AnalysisCleanupLease, readStableArtifact) that already live in src/resources. Under src/artifacts it made every provider that reads a stable artifact import the artifacts provider. Pure move: git mv plus import specifier and baseline updates; the layer baseline drops the provider-boundary counts the move removes.

* refactor(resources): reach the shared provider toolkit through src/resources/index.ts (#11390)

* refactor(resources): import the shared provider toolkit through src/resources/index.ts

Adds src/resources/index.ts, which exports the toolkit names that production code outside src/resources uses, and rewrites those importers (420 files) to import from it, merging each importer's toolkit imports into one declaration. Mechanical: import declarations only.

* test(architecture): reach src/resources only through its entry file

verify:module-boundaries now counts any production import of a src/resources file other than src/resources/index.ts, from any unit, with the imports past a provider entry. The count is renamed from providerEntry to entry ("import past the entry file"); it may only shrink, and src/resources starts at zero.

* test(architecture): cover provider boundary counts through the verifier command

* refactor(resources): move the safe output tree and artifact path owners into src/resources (#11398)

* refactor(resources): move the safe output tree and artifact path owners into src/resources

SafeOutputTree (with its admission, creation failure, readback, cleanup and identity files), StreamBytes, ArtifactPaths and readArtifactFileChunks depend only on domain, filesystem, platform and the toolkit, and browser, firmware, ghidra, javascript, android and apktool use them to publish outputs. Under src/artifacts every such provider imported the artifacts provider. Pure move: git mv, importers moved onto src/resources/index.ts (names added to the entry), the moved files import toolkit modules directly, path keys in the CI scopes and guard baseline follow the move, and the layer baseline drops the removed imports.

* test(architecture): give the shared provider core its own layer below the providers (#11401)

src/providers (deferred client owners and failure attribution) now imports only domain, ports, process, filesystem and the resources toolkit. Declaring it as the providerCore layer, between ports and providers, makes any import from it into a provider folder an upward import that verify:module-boundaries rejects, and lets every unit in the providers layer be a provider folder.

* test(architecture): declare each provider's entry files instead of a provider barrel (#11407)

* chore: ignore the source map parser move (#11348) in blame

* test(architecture): declare inspector's use of the browser CDP client as a provider dependency (#11420)
2026-11-16 03:56:10 +08:00

835 lines
30 KiB
TypeScript

import { requirePermissionDenial } from "../../tests/fixtures/permissionDenial.js";
import { createHash } from "node:crypto";
import {
access,
chmod,
mkdir,
open,
readFile,
readdir,
writeFile,
type FileHandle,
} from "node:fs/promises";
import { join } from "node:path";
import { afterEach, expect, it, vi } from "vitest";
import { createInspectionResources } from "../../tests/fixtures/inspectionResources.js";
import { hopperImageCopyFileSystem } from "../../tests/fixtures/hopperImageCopyFileSystem.js";
import { createTestTempDirectory } from "../../tests/fixtures/temporaryDirectory.js";
import { ArtifactResourceScope } from "../resources/ArtifactResourceScope.js";
import { BinaryTargetError } from "../domain/configurationErrors.js";
import { projectAnalysisError } from "../domain/analysisErrorProjection.js";
import {
prepareHopperMachOImage,
resolveHopperMachOImage as resolveHopperMachOImageWithOwner,
} from "./HopperMachOImage.js";
import { HopperApplicationLauncher } from "./BridgeLauncher.js";
const CPU_TYPES = { x86_64: 0x01000007, arm64: 0x0100000c } as const;
const FAT32_ALIGNMENT = 12;
const FAT32_SLICE_SIZE = 64;
const ARM64E = 2;
const ARM64E_X1 = 12;
const ARM64E_WITH_CAPABILITIES = 0x80000002;
const ARM64E_X1_WITH_CAPABILITIES = 0x8000000c;
interface FatFixtureSlice {
readonly cpuType: number;
readonly cpuSubtype: number;
/** Thin-slice byte order, independent of the container's table byte order. */
readonly little?: boolean;
}
interface Fat32Fixture {
readonly container: Buffer;
readonly sliceOffsets: readonly number[];
}
/** Synthesize a FAT32 container whose slices are 4096-aligned thin headers. */
const buildFat32Container = (
slices: readonly FatFixtureSlice[],
options: { readonly littleEndianTable?: boolean } = {},
): Fat32Fixture => {
const littleTable = options.littleEndianTable === true;
const writeTableUInt32 = littleTable
? (buffer: Buffer, offset: number, value: number): number =>
buffer.writeUInt32LE(value, offset)
: (buffer: Buffer, offset: number, value: number): number =>
buffer.writeUInt32BE(value, offset);
const unit = 2 ** FAT32_ALIGNMENT;
const sliceOffsets = slices.map((_slice, index) => unit * (index + 1));
const lastOffset = sliceOffsets[sliceOffsets.length - 1] ?? unit;
const container = Buffer.alloc(lastOffset + FAT32_SLICE_SIZE, 0);
// The magic VALUE is 0xcafebabe in the table's byte order: little-endian
// storage yields the FAT_CIGAM magic a big-endian reader observes.
writeTableUInt32(container, 0, 0xcafebabe);
writeTableUInt32(container, 4, slices.length);
for (const [index, slice] of slices.entries()) {
const entry = 8 + index * 20;
const offset = sliceOffsets[index]!;
writeTableUInt32(container, entry, slice.cpuType);
writeTableUInt32(container, entry + 4, slice.cpuSubtype);
writeTableUInt32(container, entry + 8, offset);
writeTableUInt32(container, entry + 12, FAT32_SLICE_SIZE);
writeTableUInt32(container, entry + 16, FAT32_ALIGNMENT);
const writeThinUInt32 =
slice.little === true
? (buffer: Buffer, fieldOffset: number, value: number): number =>
buffer.writeUInt32LE(value, fieldOffset)
: (buffer: Buffer, fieldOffset: number, value: number): number =>
buffer.writeUInt32BE(value, fieldOffset);
writeThinUInt32(container, offset, 0xfeedfacf);
writeThinUInt32(container, offset + 4, slice.cpuType);
writeThinUInt32(container, offset + 8, slice.cpuSubtype);
}
return { container, sliceOffsets };
};
const writeFixture = async (
directory: string,
name: string,
fixture: Fat32Fixture,
): Promise<string> => {
const path = join(directory, name);
await writeFile(path, fixture.container);
return path;
};
/** A universal target whose admission selected FAT entry `admittedIndex`. */
const fat32Target = (
path: string,
fixture: Fat32Fixture,
architecture: "arm64" | "x86_64",
admittedIndex = 0,
) => ({
path,
sha256: createHash("sha256").update(fixture.container).digest("hex"),
kind: "executable" as const,
format: "mach-o-universal" as const,
architecture,
availableArchitectures: ["x86_64", "arm64"] as const,
universalSlice: {
offset: fixture.sliceOffsets[admittedIndex]!,
size: FAT32_SLICE_SIZE,
},
});
const requireResolved = (
result: Awaited<ReturnType<typeof resolveHopperMachOImage>>,
) => {
if (!result.ok)
throw new Error(
`FAT fixture resolution failed: ${JSON.stringify(projectAnalysisError(result.error))}`,
);
return result.value;
};
let inspectionResources = createInspectionResources();
afterEach(async () => {
await inspectionResources.close();
inspectionResources = createInspectionResources();
});
const resolveHopperMachOImage = (
target: Parameters<typeof resolveHopperMachOImageWithOwner>[0],
) =>
resolveHopperMachOImageWithOwner(target, {
resourceScope: inspectionResources.owner,
});
it("retains Hopper FAT selection across short header, table and slice reads", async () => {
const root = await createTestTempDirectory("rea-hopper-short-reads-");
const fixture = buildFat32Container([
{ cpuType: CPU_TYPES.arm64, cpuSubtype: 0, little: true },
]);
const path = await writeFixture(root, "fat", fixture);
const target = fat32Target(path, fixture, "arm64");
const expected = await resolveHopperMachOImage(target);
expect(expected.ok).toBe(true);
let shortReads = 0;
const handles: FileHandle[] = [];
const actual = await resolveHopperMachOImageWithOwner(target, {
resourceScope: inspectionResources.owner,
fileSystem: {
open: (async (...args: Parameters<typeof open>) => {
const handle = await open(...args);
handles.push(handle);
const read = handle.read.bind(handle);
vi.spyOn(handle, "read").mockImplementation((async (
...readArgs: unknown[]
) => {
if (typeof readArgs[2] === "number" && readArgs[2] > 3) {
readArgs[2] = 3;
shortReads += 1;
}
return Reflect.apply(read, handle, readArgs);
}) as typeof handle.read);
return handle;
}) as typeof open,
},
});
expect(actual).toEqual(expected);
expect(shortReads).toBeGreaterThan(5);
expect(handles.every((handle) => handle.fd === -1)).toBe(true);
});
it.skipIf(process.platform === "win32")(
"reports a FAT64 source that became unreadable as a host read denial",
async (context) => {
await requirePermissionDenial(context, "file-read");
const directory = await createTestTempDirectory("rea-hopper-fat64-");
const path = join(directory, "universal");
await writeFile(path, Buffer.alloc(64));
await chmod(path, 0);
try {
const result = await resolveHopperMachOImage({
path,
sha256: "0".repeat(64),
kind: "executable",
format: "mach-o",
architecture: "arm64",
availableArchitectures: ["arm64"],
});
expect(result.ok).toBe(false);
if (result.ok) return;
expect(result.error).toMatchObject({ systemCode: "EACCES" });
expect(projectAnalysisError(result.error)).toMatchObject({
code: "access_denied",
details: { path, system_code: "EACCES" },
});
} finally {
await chmod(path, 0o600);
}
},
);
it("rejects an ELF target before attempting FAT source preparation", async () => {
const directory = await createTestTempDirectory("rea-hopper-mips-boundary-");
// No file is created: format validation must precede any filesystem lookup.
const path = join(directory, "mips.elf");
const result = await resolveHopperMachOImage({
path,
sha256: "0".repeat(64),
kind: "executable",
format: "elf",
architecture: "mips",
availableArchitectures: ["mips"],
mips: { elfClass: 32, byteOrder: "little", type: 2, flags: 0x70001001 },
});
if (result.ok)
throw new Error("An ELF target entered Mach-O image preparation");
expect(result.error).toMatchObject({
_tag: "BinaryTargetError",
path,
reason: "Hopper image preparation requires a Mach-O target",
});
});
it("reads the admitted arm64e slice of an Apple-style FAT32 container", async () => {
const directory = await createTestTempDirectory("rea-hopper-fat32-arm64e-");
// /bin/* system binaries: x86_64, arm64e (cpusubtype 2), arm64e.x1 (subtype 12).
const fixture = buildFat32Container([
{ cpuType: CPU_TYPES.x86_64, cpuSubtype: 3 },
{ cpuType: CPU_TYPES.arm64, cpuSubtype: ARM64E },
{ cpuType: CPU_TYPES.arm64, cpuSubtype: ARM64E_X1 },
]);
const path = await writeFixture(directory, "system.fat", fixture);
const result = requireResolved(
await resolveHopperMachOImage(fat32Target(path, fixture, "arm64", 1)),
);
expect(result).toMatchObject({
method: "fat32_thin_slice",
architecture_count: 3,
source_offset: fixture.sliceOffsets[1],
byte_length: FAT32_SLICE_SIZE,
cpu_type: CPU_TYPES.arm64,
cpu_subtype: ARM64E,
});
});
// Target admission owns slice choice (src/domain/binaryTarget.ts). Hopper
// must analyze the slice the session's Evidence names, never rank again.
it.each([
{
layout: "arm64, arm64e",
slices: [0, ARM64E],
admitted: 1,
},
{
layout: "arm64e, arm64e.x1 with capability bits",
slices: [ARM64E_X1_WITH_CAPABILITIES, ARM64E_WITH_CAPABILITIES],
admitted: 1,
},
{
layout: "two arm64e capability variants",
slices: [0x80000002, 0x81000002],
admitted: 0,
},
])(
"reads the admitted slice of $layout instead of choosing one",
async ({ slices, admitted }) => {
const directory = await createTestTempDirectory("rea-hopper-admitted-");
const fixture = buildFat32Container(
slices.map((cpuSubtype) => ({ cpuType: CPU_TYPES.arm64, cpuSubtype })),
);
const path = await writeFixture(directory, "admitted.fat", fixture);
const result = requireResolved(
await resolveHopperMachOImage(
fat32Target(path, fixture, "arm64", admitted),
),
);
expect(result).toMatchObject({
source_offset: fixture.sliceOffsets[admitted],
cpu_subtype: slices[admitted],
});
},
);
it("keeps a lone arm64e.x1 FAT32 slice selectable to preserve today's open behavior", async () => {
const directory = await createTestTempDirectory("rea-hopper-fat32-lone-");
const fixture = buildFat32Container([
{ cpuType: CPU_TYPES.arm64, cpuSubtype: ARM64E_X1 },
]);
const path = await writeFixture(directory, "lone.fat", fixture);
const result = requireResolved(
await resolveHopperMachOImage(fat32Target(path, fixture, "arm64")),
);
expect(result).toMatchObject({ cpu_subtype: ARM64E_X1 });
});
it.each([
{
case: "a range the FAT table does not declare",
edit: (target: ReturnType<typeof fat32Target>) => ({
...target,
universalSlice: {
offset: target.universalSlice.offset,
size: FAT32_SLICE_SIZE - 1,
},
}),
reason: /admitted arm64 slice .* is not declared by the FAT table/u,
},
{
case: "a slice of another architecture",
edit: (target: ReturnType<typeof fat32Target>) => ({
...target,
architecture: "x86_64" as const,
}),
reason: /admitted slice at file offset \d+ is not x86_64/u,
},
])("refuses $case", async ({ edit, reason }) => {
const directory = await createTestTempDirectory("rea-hopper-fat32-refuse-");
const fixture = buildFat32Container([
{ cpuType: CPU_TYPES.arm64, cpuSubtype: ARM64E },
]);
const path = await writeFixture(directory, "refused.fat", fixture);
const result = await resolveHopperMachOImage(
edit(fat32Target(path, fixture, "arm64")),
);
if (result.ok) throw new Error("A non-admitted FAT slice was read");
expect(result.error).toBeInstanceOf(BinaryTargetError);
expect(
projectAnalysisError(result.error).details?.reason ?? result.error,
).toMatch(reason);
});
it("selects the single x86_64 slice of a FAT32 container for an x86_64 target", async () => {
const directory = await createTestTempDirectory("rea-hopper-fat32-intel-");
const fixture = buildFat32Container([
{ cpuType: CPU_TYPES.arm64, cpuSubtype: ARM64E },
{ cpuType: CPU_TYPES.x86_64, cpuSubtype: 3 },
]);
const path = await writeFixture(directory, "universal.fat", fixture);
const result = requireResolved(
await resolveHopperMachOImage(fat32Target(path, fixture, "x86_64", 1)),
);
expect(result).toMatchObject({
cpu_type: CPU_TYPES.x86_64,
cpu_subtype: 3,
source_offset: fixture.sliceOffsets[1],
});
});
it("parses a little-endian FAT32 table without tying it to slice byte order", async () => {
const directory = await createTestTempDirectory("rea-hopper-fat32-le-");
const fixture = buildFat32Container(
[
{ cpuType: CPU_TYPES.x86_64, cpuSubtype: 3 },
{ cpuType: CPU_TYPES.arm64, cpuSubtype: ARM64E },
{ cpuType: CPU_TYPES.arm64, cpuSubtype: ARM64E_X1 },
],
{ littleEndianTable: true },
);
const path = await writeFixture(directory, "little.fat", fixture);
const result = requireResolved(
await resolveHopperMachOImage(fat32Target(path, fixture, "arm64", 1)),
);
expect(result).toMatchObject({
method: "fat32_thin_slice",
cpu_subtype: ARM64E,
source_offset: fixture.sliceOffsets[1],
});
});
it("rejects a FAT32 slice whose declared range extends beyond the file", async () => {
const directory = await createTestTempDirectory("rea-hopper-fat32-range-");
const fixture = buildFat32Container([
{ cpuType: CPU_TYPES.arm64, cpuSubtype: ARM64E },
]);
fixture.container.writeUInt32BE(fixture.container.length + 16, 8 + 12);
const path = await writeFixture(directory, "overrange.fat", fixture);
const result = await resolveHopperMachOImage(
fat32Target(path, fixture, "arm64"),
);
if (result.ok) throw new Error("An overranging FAT32 slice was accepted");
expect(
projectAnalysisError(result.error).details?.reason ?? result.error,
).toMatch(/extends beyond the file/u);
});
it("copies exactly the selected FAT32 slice bytes and verifies the source", async () => {
const directory = await createTestTempDirectory("rea-hopper-fat32-copy-");
const fixture = buildFat32Container([
{ cpuType: CPU_TYPES.x86_64, cpuSubtype: 3 },
{ cpuType: CPU_TYPES.arm64, cpuSubtype: ARM64E },
{ cpuType: CPU_TYPES.arm64, cpuSubtype: ARM64E_X1 },
]);
const path = await writeFixture(directory, "system.fat", fixture);
const target = fat32Target(path, fixture, "arm64", 1);
const resolved = requireResolved(await resolveHopperMachOImage(target));
const destination = join(directory, "image.macho");
const prepared = await prepareHopperMachOImage(
path,
target.sha256,
resolved,
destination,
{ resourceScope: new ArtifactResourceScope() },
);
if (!prepared.ok) throw new Error(prepared.error.userMessage);
const arm64eOffset = fixture.sliceOffsets[1]!;
const copied = fixture.container.subarray(
arm64eOffset,
arm64eOffset + FAT32_SLICE_SIZE,
);
expect(Buffer.compare(await readFile(destination), copied)).toBe(0);
});
it("retains the caller reason when a FAT copy is cancelled after its final write", async () => {
const directory = await createTestTempDirectory("rea-hopper-fat-cancel-");
const fixture = buildFat32Container([
{ cpuType: CPU_TYPES.arm64, cpuSubtype: ARM64E },
]);
const path = await writeFixture(directory, "system.fat", fixture);
const target = fat32Target(path, fixture, "arm64");
const image = requireResolved(await resolveHopperMachOImage(target));
const destination = join(directory, "image.macho");
const controller = new AbortController();
const reason = { request: "cancel-after-fat-write" };
const prepared = await prepareHopperMachOImage(
path,
target.sha256,
image,
destination,
{
resourceScope: new ArtifactResourceScope(),
signal: controller.signal,
fileSystem: hopperImageCopyFileSystem(
destination,
async (copiedBytes) => {
expect(copiedBytes).toBe(FAT32_SLICE_SIZE);
controller.abort(reason);
},
),
},
);
if (prepared.ok) throw new Error("Cancelled FAT copy was accepted");
expect(prepared.error._tag).toBe("HopperCancelledError");
expect(prepared.error.cause).toBe(reason);
// The private session directory remains the owner of partial output.
expect(
Buffer.compare(
await readFile(destination),
fixture.container.subarray(
fixture.sliceOffsets[0],
fixture.sliceOffsets[0]! + FAT32_SLICE_SIZE,
),
),
).toBe(0);
});
it("retains a failed prepared-image close through launcher cleanup and blocks another launch", async () => {
const directory = await createTestTempDirectory("rea-hopper-copy-close-");
const bytes = thinFixture();
const path = join(directory, "source.macho");
await writeFile(path, bytes);
const target = thinTarget(path, bytes);
const image = requireResolved(await resolveHopperMachOImage(target));
const actualFs =
await vi.importActual<typeof import("node:fs/promises")>(
"node:fs/promises",
);
const firstCloseFailure = new Error("first close attempt failed");
const retryCloseFailure = new Error("cleanup retry failed");
let allowClose = false;
let sourceCloseAttempts = 0;
const imageFileSystem = {
open: async (...arguments_: Parameters<typeof actualFs.open>) => {
const handle = await actualFs.open(...arguments_);
if (arguments_[0] !== path) return handle;
const sourceClose = async (): Promise<void> => {
sourceCloseAttempts += 1;
if (!allowClose && sourceCloseAttempts === 1) throw firstCloseFailure;
if (!allowClose) throw retryCloseFailure;
await handle.close();
};
return new Proxy(handle, {
get(targetHandle, property) {
if (property === "close") return sourceClose;
const value = Reflect.get(targetHandle, property, targetHandle);
return typeof value === "function" ? value.bind(targetHandle) : value;
},
});
},
};
const sessionDirectory = join(directory, "session");
await mkdir(sessionDirectory);
const launcher = new HopperApplicationLauncher(
{
environment: {},
launcherPath: join(directory, "hopper"),
targetPath: path,
targetKind: "executable",
loaderArgs: ["-l", "Mach-O", "--aarch64"],
bridgeScriptPath: join(directory, "bridge.py"),
preparedImage: { image, sourceSha256: target.sha256 },
launchMode: "native",
},
{ platform: "linux", imageFileSystem },
);
const initial = await launcher.launch({
directory: sessionDirectory,
socketPath: join(sessionDirectory, "bridge.sock"),
token: "fixture-token",
runId: "fixture-run-1",
});
if (initial.ok) throw new Error("A copy with failed close was accepted");
expect(initial.error._tag).toBe("HopperStartError");
expect(initial.error.cause).toBe(firstCloseFailure);
expect(initial.error.cleanupIncomplete).toBe(true);
expect(initial.error.cleanupResources).toEqual([
`hopper-image-source:${path}`,
]);
const blocked = await launcher.launch({
directory: sessionDirectory,
socketPath: join(sessionDirectory, "bridge.sock"),
token: "fixture-token",
runId: "fixture-run-2",
});
if (blocked.ok) throw new Error("A launch bypassed retained file cleanup");
expect(blocked.error.cleanupIncomplete).toBe(true);
expect(blocked.error.cleanupResources).toEqual([
`hopper-image-source:${path}`,
]);
expect(sourceCloseAttempts).toBe(3);
const cleanupPending = await launcher.cleanup();
expect(cleanupPending.ok).toBe(false);
if (cleanupPending.ok)
throw new Error("Cleanup without release was reported successful");
expect(cleanupPending.error.cleanupIncomplete).toBe(true);
expect(cleanupPending.error.cleanupResources).toEqual([
`hopper-image-source:${path}`,
]);
expect(sourceCloseAttempts).toBe(4);
allowClose = true;
await expect(launcher.cleanup()).resolves.toEqual({ ok: true, value: null });
expect(initial.error.cleanupIncomplete).toBe(false);
expect(blocked.error.cleanupIncomplete).toBe(false);
expect(cleanupPending.error.cleanupIncomplete).toBe(false);
expect(
Buffer.compare(
await readFile(join(sessionDirectory, "image.macho")),
bytes,
),
).toBe(0);
});
it("observes caller cancellation that arrives during final source-handle cleanup", async () => {
const directory = await createTestTempDirectory(
"rea-hopper-copy-close-cancel-",
);
const bytes = thinFixture();
const path = join(directory, "source.macho");
await writeFile(path, bytes);
const target = thinTarget(path, bytes);
const image = requireResolved(await resolveHopperMachOImage(target));
const controller = new AbortController();
const reason = { request: "cancel-during-final-close" };
const actualFs =
await vi.importActual<typeof import("node:fs/promises")>(
"node:fs/promises",
);
const fileSystem = {
open: async (...arguments_: Parameters<typeof actualFs.open>) => {
const handle = await actualFs.open(...arguments_);
if (arguments_[0] !== path) return handle;
const closeHandle = handle.close.bind(handle);
Object.defineProperty(handle, "close", {
configurable: true,
value: async (): Promise<void> => {
controller.abort(reason);
await closeHandle();
},
});
return handle;
},
};
const prepared = await prepareHopperMachOImage(
path,
target.sha256,
image,
join(directory, "image.macho"),
{
resourceScope: new ArtifactResourceScope(),
signal: controller.signal,
fileSystem,
},
);
if (prepared.ok) throw new Error("Finalization cancellation was ignored");
expect(prepared.error._tag).toBe("HopperCancelledError");
expect(prepared.error.cause).toBe(reason);
expect(
Buffer.compare(await readFile(join(directory, "image.macho")), bytes),
).toBe(0);
});
it("rejects FAT32 preparation when the source table changed after resolution", async () => {
const directory = await createTestTempDirectory("rea-hopper-fat32-race-");
const fixture = buildFat32Container([
{ cpuType: CPU_TYPES.arm64, cpuSubtype: ARM64E },
{ cpuType: CPU_TYPES.arm64, cpuSubtype: ARM64E_X1 },
]);
const path = await writeFixture(directory, "system.fat", fixture);
const target = fat32Target(path, fixture, "arm64");
const resolved = requireResolved(await resolveHopperMachOImage(target));
const mutated = Buffer.from(fixture.container);
mutated.writeUInt32BE(0x01000007, 8);
await writeFile(path, mutated);
const destination = join(directory, "image.macho");
const prepared = await prepareHopperMachOImage(
path,
target.sha256,
resolved,
destination,
{ resourceScope: new ArtifactResourceScope() },
);
if (prepared.ok)
throw new Error("A mutated FAT32 source passed verification");
expect(prepared.error.userMessage).toMatch(/no longer agrees/u);
});
const thinFixture = (): Buffer => {
const image = Buffer.alloc(64, 0x5a);
image.writeUInt32BE(0xfeedfacf, 0);
image.writeUInt32BE(CPU_TYPES.arm64, 4);
image.writeUInt32BE(ARM64E_WITH_CAPABILITIES, 8);
return image;
};
const thinTarget = (path: string, bytes: Buffer) => ({
path,
sha256: createHash("sha256").update(bytes).digest("hex"),
kind: "executable" as const,
format: "mach-o" as const,
architecture: "arm64" as const,
availableArchitectures: ["arm64"] as const,
});
it("copies an admitted thin Mach-O through the owned verified-image path", async () => {
const directory = await createTestTempDirectory("rea-hopper-thin-copy-");
const bytes = thinFixture();
const path = join(directory, "source.macho");
await writeFile(path, bytes);
const target = thinTarget(path, bytes);
const image = requireResolved(await resolveHopperMachOImage(target));
expect(image).toEqual({
method: "thin_verified_copy",
byte_length: bytes.length,
cpu_type: CPU_TYPES.arm64,
cpu_subtype: ARM64E_WITH_CAPABILITIES,
});
const destination = join(directory, "private", "image.macho");
await mkdir(join(directory, "private"));
const prepared = await prepareHopperMachOImage(
path,
target.sha256,
image,
destination,
{ resourceScope: new ArtifactResourceScope() },
);
if (!prepared.ok) throw new Error(prepared.error.userMessage);
expect(prepared.value).toBe(destination);
expect(Buffer.compare(await readFile(destination), bytes)).toBe(0);
expect(target.path).toBe(path);
});
it("does not launch a thin selection when its admitted source changes before copy", async () => {
const directory = await createTestTempDirectory("rea-hopper-thin-race-");
const bytes = thinFixture();
const path = join(directory, "source.macho");
await writeFile(path, bytes);
const target = thinTarget(path, bytes);
const image = requireResolved(await resolveHopperMachOImage(target));
const changed = Buffer.from(bytes);
changed.writeUInt8(
changed.readUInt8(changed.length - 1) ^ 1,
changed.length - 1,
);
await writeFile(path, changed);
const sessionDirectory = join(directory, "session");
await mkdir(sessionDirectory);
const launcher = new HopperApplicationLauncher(
{
environment: process.env,
launcherPath: join(directory, "hopper"),
targetPath: path,
targetKind: "executable",
loaderArgs: ["-l", "Mach-O", "--aarch64"],
bridgeScriptPath: join(directory, "bridge.py"),
preparedImage: { image, sourceSha256: target.sha256 },
launchMode: "native",
},
{ platform: "linux" },
);
const launched = await launcher.launch({
directory: sessionDirectory,
socketPath: join(sessionDirectory, "bridge.sock"),
token: "fixture-token",
runId: "fixture-run",
});
if (launched.ok) throw new Error("Changed source reached Hopper launch");
expect(launched.error.userMessage).toContain(
"no longer agrees with its admitted digest, size, or selected header",
);
await expect(
access(join(sessionDirectory, "bootstrap.py")),
).rejects.toMatchObject({
code: "ENOENT",
});
// The session directory remains the cleanup owner for partial private output.
await expect(readdir(sessionDirectory)).resolves.toContain("image.macho");
});
it("keeps caller cancellation primary after verified thin-image preparation", async () => {
const directory = await createTestTempDirectory("rea-hopper-thin-cancel-");
const bytes = thinFixture();
const path = join(directory, "source.macho");
await writeFile(path, bytes);
const target = thinTarget(path, bytes);
const image = requireResolved(await resolveHopperMachOImage(target));
const controller = new AbortController();
controller.abort(new Error("caller cancellation"));
const prepared = await prepareHopperMachOImage(
path,
target.sha256,
image,
join(directory, "image.macho"),
{ resourceScope: new ArtifactResourceScope(), signal: controller.signal },
);
expect(prepared).toMatchObject({
ok: false,
error: { _tag: "HopperCancelledError" },
});
});
it("retains an owned partial thin image and exact cancellation reason after a write", async () => {
const directory = await createTestTempDirectory("rea-hopper-thin-partial-");
const bytes = Buffer.alloc(2 * 1024 * 1024, 0x5a);
bytes.writeUInt32BE(0xfeedfacf, 0);
bytes.writeUInt32BE(CPU_TYPES.arm64, 4);
bytes.writeUInt32BE(ARM64E_WITH_CAPABILITIES, 8);
const path = join(directory, "source.macho");
await writeFile(path, bytes);
const target = thinTarget(path, bytes);
const image = requireResolved(await resolveHopperMachOImage(target));
const sessionDirectory = join(directory, "session");
await mkdir(sessionDirectory);
const destination = join(sessionDirectory, "image.macho");
const controller = new AbortController();
const reason = { owner: "caller", request: 44 };
let releaseWrite: (() => void) | undefined;
let announceWrite: ((copiedBytes: number) => void) | undefined;
const writeGate = new Promise<void>((resolve) => {
releaseWrite = resolve;
});
const firstWrite = new Promise<number>((resolve) => {
announceWrite = resolve;
});
const preparing = prepareHopperMachOImage(
path,
target.sha256,
image,
destination,
{
resourceScope: new ArtifactResourceScope(),
signal: controller.signal,
fileSystem: hopperImageCopyFileSystem(
destination,
async (copiedBytes) => {
announceWrite?.(copiedBytes);
await writeGate;
},
),
},
);
const copiedBytes = await firstWrite;
const partial = await readFile(destination);
expect(partial.byteLength).toBe(copiedBytes);
expect(copiedBytes).toBeGreaterThan(0);
expect(copiedBytes).toBeLessThan(bytes.length);
controller.abort(reason);
const finishWrite = releaseWrite;
if (finishWrite === undefined)
throw new Error("Copy barrier was not created");
finishWrite();
const prepared = await preparing;
if (prepared.ok) throw new Error("Cancelled partial copy was accepted");
expect(prepared.error._tag).toBe("HopperCancelledError");
expect(prepared.error.cause).toBe(reason);
expect(Buffer.compare(await readFile(destination), partial)).toBe(0);
await expect(access(destination)).resolves.toBeUndefined();
});
it.each([0, 129])(
"keeps Hopper FAT count admission explicit for count %i",
async (count) => {
const directory = await createTestTempDirectory("rea-hopper-fat-count-");
const fixture = buildFat32Container([
{ cpuType: CPU_TYPES.arm64, cpuSubtype: 0 },
]);
fixture.container.writeUInt32BE(count, 4);
const path = await writeFixture(directory, "counts.fat", fixture);
const result = await resolveHopperMachOImage(
fat32Target(path, fixture, "arm64"),
);
if (result.ok) throw new Error("Invalid FAT count was admitted");
expect(result.error).toMatchObject({
_tag: "BinaryTargetError",
path,
reason: expect.stringMatching(
/FAT architecture table.*truncated.*128 entries/i,
),
});
},
);