Files
reverse-engineering-anything/tests/boundary/process/processCli.test.ts
T
morluto 1f24b3fa57 feat(evidence)!: name the Evidence subject by its target identity (format revision 2) (#11416)
* feat(evidence)!: name the Evidence subject by its target identity (format revision 2)

The Evidence subject carries subject.identity (kind, sha256, format,
architecture, selection) and the Evidence ID commits to it, so raw/DOL
entry points and ESP flash offsets of the same bytes are different
subjects. Every record declares evidence_format: 2; revision 1 bundles,
standalone records and snapshots are refused with the recreate guidance.
binaryTargetIdentity is the one projection of an open target, used by
Evidence and snapshot comparison.

BREAKING CHANGE: Evidence format revision 2. Evidence IDs commit to the
subject's target identity (subject.identity, including the raw/DOL entry
point or ESP flash offsets), and every record declares evidence_format: 2.
Evidence bundles, records and analysis snapshots from earlier releases are
refused; recreate the observations with this release.

* refactor(analysis-view): read parent subjects through the Evidence identity accessors (#11423)

Analysis views compare their parent's file identity (evidenceFileTarget)
and take path and digest from evidenceSubjectTarget instead of reading
the subject's digest, format and architecture members, which duplicate
subject.identity until they are removed. A counted guard
(evidence-subject-declaration-read) keeps new direct reads out and
records the 20 remaining files.

* fix(evidence): carry format refusals through Evidence readers and bind target selections

- safeParseEvidence/safeParseImmutableEvidence return the format refusal as
  an expected failure; every consumer maps it to the one integrity refusal
  with the recreate guidance. An unmarked object is an earlier record only
  when it has every member records have always carried.
- ArtifactProvider inventory roots and provider subjects that name the
  target's own bytes carry the target's selection (ESP flash offsets).
- Snapshot rows bind only Evidence whose identity, selection included,
  matches the snapshot target.
- Entry-point selections use the raw-binary entry point form.

* fix(evidence): refuse unauthenticated or earlier-format records instead of reading them as absent

- recognizeEvidence (evidenceValidation) replaces tryParseEvidence: input
  without an evidence_id is not Evidence (ok(undefined)); a record that names
  one but fails authentication or is from another format revision is an
  EvidenceIntegrityError carrying the recreate guidance, never undefined.
- Direct analysis retains that refusal as a secondary failure instead of
  silently skipping source capture; cleanup projection, source-closure
  annotation and the flutter, debugger and release-exposure recoveries use
  the same owner (the last three previously read the unauthenticated schema).
- A desktop capture.json from an earlier format is refused with the recreate
  guidance instead of "not desktop application capture Evidence".

* fix(evidence): advertise revision 2 ledger examples and rank delivery omissions by serialized size

- The obligation ledger and reconstruction coverage examples named
  evidence_format 1, which revision 2 refuses; they now use
  EVIDENCE_FORMAT_REVISION.
- MCP delivery chose which unretained recovery to omit by a parsed-storage
  lower bound clipped at the response budget. Once revision 2 subjects made
  the source record's estimate cross the budget, both candidates tied at the
  clip and the smaller source was omitted ahead of the larger completed
  observation. Candidates are now ranked by serialized size, which is what
  the budget counts.

* refactor(native): compare function snapshots by their Evidence target identity (#11450)

Function snapshots carry the subject's file target identity instead of the
duplicated subject declaration. Call paths and function comparisons compare
targets through sameTargetIdentity, so the same bytes opened at a different
raw entry point or ESP flash offset no longer count as one coordinate space:
build_call_path refuses the mix, and compare_functions no longer matches
entries by address across selections. Structural candidates and native
function matching read the architecture and digest through
evidenceFileTarget.

Refs #11417

* refactor(artifacts): compare artifact and WASM summaries by their Evidence target identity (#11461)

Artifact comparison authenticates a summary against its retained inventory
through sameTargetIdentity and rebinds the alias with the whole target,
selection included, so a flash-selected inventory summary taken under an
alias path is no longer refused. WASM comparison, the analysis view
artifact projection and the inventory root check read the digest, format
and display path through the Evidence identity accessors.

Refs #11417

* refactor(evidence): read record subjects through the identity accessors in JS, managed, ledger and bundle readers (#11470)

JavaScript application graphs, runtime reconciliation, managed inspection
and native verification sources, the record summary filter, the ledger's
residual-unknown target and bundle scope selection read the subject digest,
format and display path through evidenceFileTarget and
evidenceSubjectDisplay. No comparison changes: each reader matches one
record's facts against its own payload or a caller filter.

Refs #11417

* refactor(evidence)!: name the Evidence subject only by its target identity (#11497)

* refactor(evidence)!: name the Evidence subject only by its target identity

The subject keeps `identity` and the display facts `name` and `local_path`.
The duplicated `digest`, `format` and `architecture` members are removed; the
format-owned declaration now validates the identity itself. Readers the type
checker found move to the owner accessors; untyped reads in verify scripts,
the efficiency harness and test matchers move to `subject.identity`. The
`evidence-subject-declaration-read` text guard and its baseline are deleted.

Fixes #11473
Refs #11417

BREAKING CHANGE: the Evidence subject no longer has `digest`, `format` or
`architecture`; read `subject.identity.sha256`, `subject.identity.format` and
`subject.identity.architecture`. A record that still carries them is refused.

* test(evidence): give the Flutter verifier fixture the identity subject and check the DOL declaration without the ID

* test(evidence): drop the removed subject members from the declaration matrix and tamper fixtures

* feat(evidence)!: give every Evidence record an explicit subject identity (#11536)

* feat(evidence)!: give every Evidence record an explicit subject identity

A producer that cannot name a file passes an `unknown` target identity
with a closed reason (derived-from-linked-evidence, not-observed,
unsupported-subject) instead of no subject. The subject is non-null;
unknown subjects have no display facts. The generic missing-subject
limitation and `subjectUnavailableReason` are removed; producer-specific
explanations are ordinary limitations. Comparison identity requires the
derived unknown, and null-subject consumers ask the owner accessors.

Refs #11417

BREAKING CHANGE: every Evidence record has a subject. A record without a
file target names `subject.identity` `{ "kind": "unknown", "reason": … }`
with `name` and `local_path` null, instead of `subject: null` and the
limitation "Artifact identity is unavailable for this observation.".
Their Evidence IDs change.

* fix(evidence): name explicit unknown subjects in JavaScript callers and keep a managed graph's file subject

The verification scripts are not type-checked, so five createEvidence
callers still passed undefined (or a missing first target) after the subject
became required. They now pass unknownTarget("not-observed").

A managed application graph chose the first present input subject. Every
subject is now present, so an unknown artifact subject hid a file subject on
the member or boundary Evidence. The graph now takes the first input subject
that names a file.

* test(evidence): assert the subject kind instead of a presence the type now guarantees

Every Evidence record has a subject after this change, so test guards and
assertions that checked it for null always passed. Each now checks that the
fixture subject names a file, or is removed where a later fileIdentity,
fileSubjectTarget or fileSubjectDisplay call already requires that. Non-null
assertions on Evidence subjects are removed; analysis-view inputs, whose
subject is optional, keep an undefined check.

* test(evidence): expect the Evidence subject format under its identity

Two boundary tests still matched subject.format, which slice 2e moved into
subject.identity. toMatchObject is not type-checked against the Evidence
shape, so they failed only when run (the signature test on macOS).
2026-11-16 06:28:01 +08:00

519 lines
18 KiB
TypeScript

import { unknownTarget } from "../../../src/domain/targetIdentity.js";
import { access, readFile, readdir, writeFile } from "node:fs/promises";
import { join } from "node:path";
import { fileURLToPath } from "node:url";
import { execFile } from "node:child_process";
import { promisify } from "node:util";
import { describe, expect, it } from "vitest";
import { createTestTempDirectory } from "../../fixtures/temporaryDirectory.js";
import { cliTest } from "../../support/cli/cliFixture.js";
import { captureProcessScenarioFile } from "../../../src/application/process/ProcessCli.js";
import { compareProcessCaptureFiles } from "../../support/cli/processComparisonCli.js";
import { createEvidence } from "../../../src/domain/evidence.js";
import { parseProcessCaptureEvidence } from "../../../src/application/process/ProcessEvidence.js";
import { PROCESS_PROVIDER } from "../../../src/domain/process/processEvidenceProvider.js";
import { INVESTIGATION_EXAMPLES } from "../../../src/contracts/investigationExamples.js";
import { observeProcessStartIdentity } from "../../../src/process/ProcessOwnershipObservation.js";
import { analysisCliErrorEnvelopeSchema } from "../../../src/contracts/errorSchemas.js";
import { analysisErrorProjectionSchema } from "../../../src/domain/analysisErrorProjectionSchema.js";
const execFileAsync = promisify(execFile);
const CLI_INTEGRATION_TIMEOUT_MS = 60_000;
const cleanupTargetSource = `
const fs = process.getBuiltinModule("node:fs");
const [marker, release] = process.argv.slice(2);
if (!marker || !release) throw new Error("Missing cleanup target paths");
fs.writeFileSync(marker, String(process.pid));
setTimeout(() => process.exit(2), ${CLI_INTEGRATION_TIMEOUT_MS}).unref();
const waiting = setInterval(() => {
if (!fs.existsSync(release)) return;
clearInterval(waiting);
}, 10);
`;
const writeUnavailableOwnershipCompiler = async (root: string) => {
// Controlled protocol facts force the refusal independently of native
// platform-binary visibility. No token ever authorizes a signal.
const helper = `#!${process.execPath}
const arguments_ = process.argv.slice(2);
const identities = arguments_[0] === "--identities";
const pids = (identities ? arguments_.slice(1) : arguments_).map(Number);
console.log(JSON.stringify({ results: pids.map(pid => identities ? {
pid, state: "readable", identity: "controlled-start-" + pid,
lifecycle: "non-zombie",
relation: { state: "observed", parent_pid: 1, process_group_id: pid },
} : {
pid, state: "unavailable", reason: "platform_binary_environment_withheld",
}) }));
`;
const compiler = join(root, "controlled-swiftc");
await writeFile(
compiler,
`#!${process.execPath}
const fs = process.getBuiltinModule("node:fs");
const outputIndex = process.argv.indexOf("-o");
const output = process.argv[outputIndex + 1];
if (outputIndex < 0 || !output || output.startsWith("-"))
throw new Error("Missing controlled helper output");
fs.writeFileSync(output, ${JSON.stringify(helper)});
fs.chmodSync(output, 0o755);
`,
{ mode: 0o755 },
);
return compiler;
};
describe("documented process CLI workflow", () => {
cliTest(
"feeds the documented JSON capture into the comparison CLI",
async ({ cli }) => {
const root = await createTestTempDirectory("rea-process-cli-");
const guide = await readFile(
new URL(
"../../../docs/guides/runtime/process-capture.md",
import.meta.url,
),
"utf8",
);
const recipe = /```sh\nrea capture-process ([^\n]+)\n```/u.exec(
guide,
)?.[1];
if (recipe === undefined)
throw new Error("Missing process capture recipe");
const [argumentsText, output] = recipe.split(" > ");
if (argumentsText === undefined || output === undefined)
throw new Error("Missing process capture redirection");
const args = argumentsText.split(/\s+/u);
const input = args[0];
if (input === undefined) throw new Error("Missing scenario path");
await writeFile(
join(root, input),
JSON.stringify({
executable: process.execPath,
arguments: ["-e", "process.stdout.write('documented-capture')"],
}),
);
const capture = await cli.run({
arguments: ["capture-process", ...args],
cwd: root,
});
expect(capture.exitCode, capture.stdout || capture.stderr).toBe(0);
expect(capture.json).toMatchObject({
operation: "capture_process_scenario",
});
await writeFile(join(root, output), capture.stdout);
const comparison = await cli.run({
arguments: ["compare-process-captures", output, output, "--json"],
cwd: root,
});
expect(comparison.exitCode, comparison.stdout || comparison.stderr).toBe(
0,
);
expect(comparison.json).toMatchObject({
operation: "compare_process_captures",
});
},
);
});
describe("process CLI cleanup errors", () => {
cliTest.skipIf(process.platform !== "darwin")(
"reports the retained capture root with a controlled unavailable ownership reader",
async ({ cli }) => {
const root = await createTestTempDirectory("rea-process-cli-cleanup-");
const compiler = await writeUnavailableOwnershipCompiler(root);
const scenario = join(root, "scenario.json");
const marker = join(root, "target.pid");
const release = join(root, "release-target");
const target = join(root, "cleanup-target.cjs");
await writeFile(target, cleanupTargetSource);
await writeFile(
scenario,
JSON.stringify({
executable: process.execPath,
arguments: [target, marker, release],
timeout_ms: 500,
idle_timeout_ms: 500,
finalization_ms: 100,
}),
);
try {
// A retained PTY can keep its CLI process alive. Read the completed
// compiled command result before releasing the child and joining exit.
const result = await cli.run({
arguments: ["capture-process", scenario, "--json"],
environment: {
TMPDIR: root,
REA_DARWIN_SWIFTC_PATH: compiler,
SDKROOT: root,
REA_DARWIN_MODULE_CACHE_PATH: join(root, "modules"),
},
});
const targetPid = Number(await readFile(marker, "utf8"));
expect(Number.isSafeInteger(targetPid) && targetPid > 0).toBe(true);
expect(process.kill(targetPid, 0), "the target remains alive").toBe(
true,
);
expect(result.exitCode, result.stdout || result.stderr).toBe(1);
const retained = (await readdir(root)).filter((name) =>
/^rea-process-(?!token-)/u.test(name),
);
expect(retained).toHaveLength(1);
const retainedRoot = retained[0];
if (retainedRoot === undefined)
throw new Error("Missing retained root");
expect(result.json).toMatchObject({
code: "cleanup_incomplete",
message: expect.stringContaining(
"platform_binary_environment_withheld",
),
details: {
resources: ["owned_process_group", join(root, retainedRoot)],
cleanup_report: {
temporary_root: { state: "unverified" },
},
},
});
} finally {
// Release even when the CLI or an assertion fails. A target starting
// after this point also sees the release and exits without a signal.
await writeFile(release, "release");
const targetPid = await readFile(marker, "utf8").then(
(value) => Number(value),
(cause: unknown) => {
if (
cause instanceof Error &&
"code" in cause &&
cause.code === "ENOENT"
)
return undefined;
throw cause;
},
);
if (targetPid !== undefined) {
expect(Number.isSafeInteger(targetPid) && targetPid > 0).toBe(true);
await expect
.poll(() => observeProcessStartIdentity(targetPid), {
interval: 25,
})
.toBeUndefined();
}
}
},
);
});
describe("process CLI errors", () => {
cliTest(
"returns canonical JSON errors for missing and malformed process files",
async ({ cli }) => {
const root = await createTestTempDirectory("rea-process-cli-errors-");
const malformed = join(root, "malformed.json");
await writeFile(malformed, "not-json");
const cases = [
["capture-process", join(root, "missing.json"), "--json"],
["capture-process", malformed, "--json"],
] as const;
for (const arguments_ of cases) {
const result = await cli.run({
arguments: arguments_,
cwd: root,
});
expect(result.exitCode).toBe(1);
expect(
analysisCliErrorEnvelopeSchema.safeParse(result.json).success,
).toBe(true);
expect(result.json).toMatchObject({
code: "invalid_request",
category: "invalid_input",
retryable: false,
details: {
operation: "capture_process_scenario",
issues: [
expect.objectContaining({
path: ["input_file"],
reason: "invalid_value",
}),
],
},
});
}
// The comparison reads its captures as JSON inputs, naming the file.
const missingLeft = join(root, "missing-left.json");
const compared = await cli.run({
arguments: [
"compare-process-captures",
missingLeft,
join(root, "missing-right.json"),
"--json",
],
cwd: root,
});
expect(compared.exitCode).toBe(1);
expect(
analysisCliErrorEnvelopeSchema.safeParse(compared.json).success,
).toBe(true);
expect(compared.json).toMatchObject({
code: "invalid_request",
category: "invalid_input",
retryable: false,
input_path: missingLeft,
details: { operation: "compare_process_captures" },
});
const full = await cli.run({
arguments: [
"capture-process",
join(root, "missing.json"),
"--json",
"--full-output",
],
cwd: root,
});
expect(full.exitCode).toBe(1);
expect(full.json).toMatchObject({ ok: false });
if (typeof full.json !== "object" || full.json === null)
throw new Error("Expected a full-output CLI error document");
const fullError = Reflect.get(full.json, "error");
expect(analysisErrorProjectionSchema.safeParse(fullError).success).toBe(
true,
);
},
);
it("exits unsuccessfully without writing failure-shaped evidence", async () => {
await expect(
execFileAsync(
process.execPath,
["scripts/rea.mjs", "capture-process", "/missing/scenario.json"],
{ cwd: process.cwd() },
),
).rejects.toMatchObject({
code: 1,
stdout: expect.stringContaining("category: invalid_input"),
});
});
it("rejects NUL arguments before process launch", async () => {
const root = await createTestTempDirectory("rea-process-cli-");
const scenario = join(root, "nul-argument.json");
await writeFile(
scenario,
JSON.stringify({ executable: process.execPath, arguments: ["\0"] }),
);
expect(await captureProcessScenarioFile(scenario)).toMatchObject({
error: "Process command failed",
code: "invalid_request",
category: "invalid_input",
details: {
operation: "capture_process_scenario",
issues: [
{
path: ["arguments", 0],
reason: "invalid_format",
expected: "regex",
message: expect.stringMatching(
/operating.system.*cannot contain NUL/i,
),
},
],
},
});
});
});
describe("process CLI environment key diagnostics", () => {
it("reports the reserved process environment key constraint", async () => {
const root = await createTestTempDirectory("rea-process-cli-");
const scenario = join(root, "reserved-environment.json");
await writeFile(
scenario,
JSON.stringify({
executable: process.execPath,
environment: { REA_PROCESS_RUN_ID: "caller-value" },
}),
);
expect(await captureProcessScenarioFile(scenario)).toMatchObject({
error: "Process command failed",
code: "invalid_request",
category: "invalid_input",
details: {
operation: "capture_process_scenario",
issues: [
{
path: ["environment", "REA_PROCESS_RUN_ID"],
reason: "invalid_format",
expected: "regex",
message: "REA_PROCESS_RUN_ID is reserved by the process adapter",
},
],
},
});
});
});
describe("process CLI evidence validation", () => {
it("captures the minimal executable-and-arguments scenario", async () => {
const root = await createTestTempDirectory("rea-process-cli-");
const scenario = join(root, "scenario.json");
await writeFile(
scenario,
JSON.stringify({
executable: process.execPath,
arguments: ["-e", "process.stdout.write('minimal-capture')"],
}),
);
const evidence = await captureProcessScenarioFile(scenario);
expect(evidence).toMatchObject({
predicate_type: "rea.process-capture",
operation: "capture_process_scenario",
});
const parsed = parseProcessCaptureEvidence(evidence);
if (!parsed.ok)
throw new Error(`Invalid capture evidence: ${parsed.error.kind}`);
expect(
parsed.value.capture.frames.map(({ data }) => data).join(""),
).toContain("minimal-capture");
});
it("plans the minimal scenario without launching it", async () => {
const root = await createTestTempDirectory("rea-process-cli-");
const scenario = join(root, "scenario.json");
const marker = join(root, "launched");
await writeFile(
scenario,
JSON.stringify({
executable: process.execPath,
arguments: [
"-e",
"require('node:fs').writeFileSync(process.argv[1], 'launched')",
marker,
],
dry_run: true,
}),
);
const evidence = await captureProcessScenarioFile(scenario);
expect(evidence).toMatchObject({
predicate_type: "rea.process-scenario-plan",
operation: "capture_process_scenario",
normalized_result: {
status: "planned",
ambient_environment: "inherited-at-run",
scenario: { executable: process.execPath },
},
});
await expect(access(marker)).rejects.toMatchObject({ code: "ENOENT" });
});
it("rejects unrelated capture evidence", async () => {
const root = await createTestTempDirectory("rea-process-cli-");
const invalidCapture = join(root, "invalid-capture.json");
const unrelated = join(root, "unrelated.json");
await writeFile(
invalidCapture,
JSON.stringify(
createEvidence(unknownTarget("not-observed"), PROCESS_PROVIDER, {
predicateType: "rea.process-capture/other",
operation: "capture_process_scenario",
parameters: {},
result: {},
}),
),
);
await writeFile(
unrelated,
JSON.stringify(
createEvidence(unknownTarget("not-observed"), PROCESS_PROVIDER, {
predicateType: "unrelated/v1",
operation: "other",
parameters: {},
result: {},
}),
),
);
expect(
await compareProcessCaptureFiles(invalidCapture, invalidCapture),
).toMatchObject({
category: "invalid_input",
});
const failure = await compareProcessCaptureFiles(unrelated, unrelated);
expect(analysisErrorProjectionSchema.safeParse(failure).success).toBe(true);
expect(failure).toMatchObject({
code: "invalid_request",
retryable: false,
category: "invalid_input",
message: expect.stringMatching(
/capture evidence.*not from.*process-capture.*create new capture evidence/i,
),
details: {
operation: "compare_process_captures",
issues: [{ path: ["left"], reason: "invalid_value" }],
},
});
});
it("classifies malformed capture evidence as invalid input", async () => {
const root = await createTestTempDirectory("rea-process-cli-");
const malformed = join(root, "malformed-evidence.json");
await writeFile(malformed, "{}");
expect(
await compareProcessCaptureFiles(malformed, malformed),
).toMatchObject({
category: "invalid_input",
code: "invalid_request",
details: {
operation: "compare_process_captures",
issues: expect.arrayContaining([
expect.objectContaining({
path: ["parameters"],
reason: "missing_argument",
}),
]),
},
});
});
});
it("reports the JSON depth constraint through the compiled comparison CLI", async () => {
const root = await createTestTempDirectory("rea-process-cli-");
const left = join(root, "left.json");
const right = join(root, "right.json");
const input = INVESTIGATION_EXAMPLES.compare_process_captures.input;
await writeFile(left, JSON.stringify(input.left));
await writeFile(right, JSON.stringify(input.right));
const cli = fileURLToPath(
new URL("../../../scripts/rea.mjs", import.meta.url),
);
const cliArguments = [cli, "compare-process-captures", left, right, "--json"];
const baseline = await execFileAsync(process.execPath, cliArguments);
expect(JSON.parse(baseline.stdout)).toMatchObject({
operation: "compare_process_captures",
});
const nested = '{"nested":'.repeat(10_000) + "1" + "}".repeat(10_000);
await writeFile(
left,
JSON.stringify({
...input.left,
parameters: { attack: "depth-placeholder" },
}).replace('"depth-placeholder"', nested),
);
await expect(
execFileAsync(process.execPath, cliArguments),
).rejects.toMatchObject({
code: 1,
stdout: expect.stringContaining("maximum nesting depth"),
});
});