Files
reverse-engineering-anything/src/application/analysisView/evidenceFileSource.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

223 lines
7.7 KiB
TypeScript

import type { z } from "zod";
import { requireAuthenticationHeadroom } from "../JsonAuthenticationHeadroom.js";
import { authenticateEvidenceBundleValue } from "../EvidenceBundleFiles.js";
import type { ArtifactResourceScope } from "../../resources/index.js";
import type { AnalysisError } from "../../domain/analysisErrorBase.js";
import {
AnalysisInputError,
type AnalysisInputIssue,
cancelledBy,
} from "../../domain/analysisErrorCore.js";
import { INSPECT_ANALYSIS_VIEW_OPERATION } from "../../domain/analysisView/analysisViewErrors.js";
import { err, ok, type Result } from "../../domain/result.js";
import type { Evidence } from "../../domain/evidence.js";
import {
safeParseImmutableEvidence,
unsupportedEvidenceFormatError,
} from "../../domain/evidenceValidation.js";
import { isUnsupportedEvidenceFormat } from "../../domain/evidenceFormat.js";
import { EvidenceFileError } from "../../domain/evidenceErrors.js";
import { projectInputIssuesBounded } from "../../domain/inputIssueProjection.js";
import { readJsonFile } from "../JsonFiles.js";
/** The request cancellation and the scope retaining descriptors whose close failed. */
export interface EvidenceFileReadOptions {
readonly signal?: AbortSignal;
readonly resources?: ArtifactResourceScope;
}
/** Caller context and related-record resolution for this admitted file. */
export interface EvidenceFileSourceContext {
readonly operation: string;
readonly path: readonly (string | number)[];
readonly resolveSelected?: EvidenceFileRecordResolver;
}
/** Resolve related facts while the authenticated file records are in scope. */
export type EvidenceFileRecordResolver = (
selected: Evidence,
lookup: (evidenceId: string) => Evidence | undefined,
) => Result<Evidence, AnalysisError>;
const ANALYSIS_VIEW_SOURCE: EvidenceFileSourceContext = {
operation: INSPECT_ANALYSIS_VIEW_OPERATION,
path: ["source"],
};
const selectionError = (
site: EvidenceFileSourceContext,
message: string,
): AnalysisInputError =>
new AnalysisInputError(site.operation, { userMessage: message }, [
{
path: [...site.path, "evidence_id"],
reason: "invalid_value",
message,
},
]);
/** Listed identities stay bounded so a large bundle cannot grow the error itself. */
const RECORD_REFERENCE_PREVIEW_BYTES = 2048;
/** Select the one record a source names from an authenticated bundle. */
const selectBundleRecord = (
records: readonly Evidence[],
path: string,
evidenceId: string | undefined,
site: EvidenceFileSourceContext,
): Result<Evidence, AnalysisError> => {
if (evidenceId !== undefined) {
const selected = records.find(
(record) => record.evidence_id === evidenceId,
);
return selected === undefined
? err(
selectionError(
site,
`Evidence bundle ${path} holds no record ${evidenceId}. It holds ${listRecordIds(records)}.`,
),
)
: ok(selected);
}
const only = records[0];
if (only === undefined)
return err(
selectionError(site, `Evidence bundle ${path} holds no records.`),
);
if (records.length > 1)
return err(
selectionError(
site,
`Evidence bundle ${path} holds ${String(records.length)} records; select one with ${[...site.path, "evidence_id"].join(".")}. It holds ${listRecordIds(records)}.`,
),
);
return ok(only);
};
const listRecordIds = (records: readonly Evidence[]): string => {
const labels: string[] = [];
let bytes = 0;
for (const record of records) {
const separator = labels.length === 0 ? "" : ", ";
const remaining = RECORD_REFERENCE_PREVIEW_BYTES - bytes;
let label = `${record.evidence_id} (operation omitted)`;
// UTF-8/JSON cannot use fewer bytes than the source UTF-16 code units.
// Reject a label before copying it when even that lower bound cannot fit.
if (record.operation.length <= remaining) {
const complete = `${record.evidence_id} (${record.operation})`;
if (
Buffer.byteLength(JSON.stringify(separator + complete), "utf8") <=
remaining
)
label = complete;
}
const encodedBytes = Buffer.byteLength(
JSON.stringify(separator + label),
"utf8",
);
if (encodedBytes > remaining) break;
labels.push(label);
bytes += encodedBytes;
}
const omitted = records.length - labels.length;
const listed = labels.join(", ");
return omitted > 0 ? `${listed} and ${String(omitted)} more` : listed;
};
/**
* Budget for projected field-level diagnostics. A malformed file can carry tens
* of thousands of issues, and projecting all of them pushes the error past the
* MCP response budget, which then hides the typed file error and its path. Keep
* the leading issues that fit and say how many were omitted.
*/
const EVIDENCE_CONTENT_ISSUE_BUDGET_BYTES = 65_536;
const boundedContentIssues = (
issues: readonly z.core.$ZodIssue[],
input: unknown,
): readonly AnalysisInputIssue[] => {
const bounded = projectInputIssuesBounded(
issues,
input,
EVIDENCE_CONTENT_ISSUE_BUDGET_BYTES,
);
if (bounded.omittedIssueCount === 0) return bounded.issues;
return [
...bounded.issues,
{
path: [],
reason: "invalid_value",
message: `${String(bounded.omittedIssueCount)} of ${String(issues.length)} validator issues were omitted because they do not fit the response budget; repair the reported fields and retry.`,
},
];
};
/** Read one Evidence record or select from an authenticated bundle without rereading the file. */
export const readEvidenceFileSource = async (
path: string,
options: EvidenceFileReadOptions = {},
evidenceId?: string,
site: EvidenceFileSourceContext = ANALYSIS_VIEW_SOURCE,
): Promise<Result<Evidence, AnalysisError>> => {
const { signal, resources } = options;
const { operation } = site;
const resolveSelected =
site.resolveSelected ?? ((selected: Evidence) => ok(selected));
if (signal?.aborted) return err(cancelledBy(operation, signal));
const loaded = await readJsonFile(path, signal, resources, operation);
if (!loaded.ok) return loaded;
if (signal?.aborted) return err(cancelledBy(operation, signal));
const value = loaded.value;
if (
typeof value === "object" &&
value !== null &&
!Array.isArray(value) &&
Object.hasOwn(value, "records")
) {
const bundle = authenticateEvidenceBundleValue(value, path, {
operation,
immutable: true,
});
if (!bundle.ok) return bundle;
const selected = selectBundleRecord(
bundle.value.records,
path,
evidenceId,
site,
);
return selected.ok
? resolveSelected(selected.value, (id) =>
bundle.value.records.find((record) => record.evidence_id === id),
)
: selected;
}
const headroom = requireAuthenticationHeadroom(value, {
operation,
path,
description: "Insufficient heap headroom to authenticate the Evidence file",
});
if (!headroom.ok) return headroom;
const parsed = safeParseImmutableEvidence(value);
if (!parsed.ok)
return err(
isUnsupportedEvidenceFormat(parsed.error)
? unsupportedEvidenceFormatError(parsed.error)
: new EvidenceFileError("read", "wrong-kind", {
path,
cause: parsed.error,
contentIssues: boundedContentIssues(parsed.error.issues, value),
userMessage:
"The selected file does not contain valid Evidence. Repair or recreate the file and try again.",
}),
);
if (evidenceId !== undefined && parsed.value.evidence_id !== evidenceId)
return err(
selectionError(
site,
`Evidence file ${path} holds ${parsed.value.evidence_id}, not selected record ${evidenceId}.`,
),
);
return resolveSelected(parsed.value, (id) =>
parsed.value.evidence_id === id ? parsed.value : undefined,
);
};