mirror of
https://github.com/morluto/rea.git
synced 2026-11-16 19:53:50 +00:00
* 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).
249 lines
9.0 KiB
TypeScript
249 lines
9.0 KiB
TypeScript
import { z } from "zod";
|
|
import { Budget } from "../budget.js";
|
|
import { fixedAllowanceOptions } from "../fixedAllowanceRemediation.js";
|
|
import {
|
|
AnalysisResourceConstraintError,
|
|
AnalysisUnsupportedTargetError,
|
|
} from "../analysisErrorCore.js";
|
|
import type { AnalysisError } from "../analysisErrorBase.js";
|
|
import { compareUnicodeCodePoints as compare } from "../unicodeCodePointOrder.js";
|
|
import { err, ok, type Result } from "../result.js";
|
|
import {
|
|
safeParseOwnedWebNetworkCapture,
|
|
type WebNetworkCapture,
|
|
} from "../webNetworkCapture.js";
|
|
import { admitAnalysisViewData } from "./analysisViewDataAdmission.js";
|
|
import { analysisViewInputError } from "./analysisViewErrors.js";
|
|
import { analysisInputErrorFromIssues } from "../inputIssueProjection.js";
|
|
import type { AnalysisViewParent } from "./analysisViewParent.js";
|
|
import {
|
|
ENTRY_BYTES,
|
|
textBytes,
|
|
type Reserve,
|
|
} from "./webNetworkRouteTemplates.js";
|
|
import { evidenceFileTarget } from "../evidence.js";
|
|
|
|
/** Shared retained/temporary byte accounting for views that group retained HAR records. */
|
|
export abstract class WebNetworkProjectionAccumulator {
|
|
readonly #limitations = new Set<string>();
|
|
/** Retained state and temporary work share one allowance. */
|
|
readonly #bytes: Budget;
|
|
/** The retained and temporary shares of `#bytes`, for their checkpoints. */
|
|
readonly #retained: Budget;
|
|
readonly #temporary: Budget;
|
|
/** Per-record scratch reservation handed to the shared record readers. */
|
|
protected readonly scratch: Reserve = (bytes) => this.temporary(bytes);
|
|
|
|
protected constructor(
|
|
readonly maximumBytes: number,
|
|
private readonly budgetSubject: string,
|
|
private readonly operation = "inspect_analysis_view",
|
|
) {
|
|
this.#bytes = new Budget(maximumBytes);
|
|
this.#retained = new Budget(maximumBytes);
|
|
this.#temporary = new Budget(maximumBytes);
|
|
}
|
|
|
|
#charge(share: Budget, bytes: number): boolean {
|
|
if (!this.#bytes.tryCharge(bytes)) return false;
|
|
// A share never exceeds the whole, so it always fits.
|
|
return share.tryCharge(bytes);
|
|
}
|
|
|
|
#restore(share: Budget, mark: number): void {
|
|
this.#bytes.refund(share.restore(mark));
|
|
}
|
|
|
|
protected retain(bytes: number): boolean {
|
|
return this.#charge(this.#retained, bytes);
|
|
}
|
|
|
|
protected temporary(bytes: number): boolean {
|
|
return this.#charge(this.#temporary, bytes);
|
|
}
|
|
|
|
/**
|
|
* Release the scratch charged by a nested body lease. Leases end in LIFO
|
|
* order and `releaseTemporary` never runs inside one, so the enclosing
|
|
* parse's scratch is still charged when this runs.
|
|
*/
|
|
protected temporaryCheckpoint(): () => void {
|
|
const mark = this.#temporary.used;
|
|
return () => {
|
|
this.#restore(this.#temporary, mark);
|
|
};
|
|
}
|
|
|
|
/** Mark the retained bytes; the returned call releases what was retained since, once none of it is held. */
|
|
protected retainedCheckpoint(): () => void {
|
|
const mark = this.#retained.used;
|
|
return () => {
|
|
this.#restore(this.#retained, mark);
|
|
};
|
|
}
|
|
|
|
/** Per-record strings and descriptors never become cumulative scratch. */
|
|
protected releaseTemporary(): void {
|
|
this.#restore(this.#temporary, 0);
|
|
}
|
|
|
|
protected overBudget(): Result<never, AnalysisError> {
|
|
return err(
|
|
new AnalysisResourceConstraintError(
|
|
this.operation,
|
|
"memory",
|
|
`${this.budgetSubject} retained state and temporary work exceed the projection representation budget.`,
|
|
{ output_bytes: this.maximumBytes },
|
|
fixedAllowanceOptions(
|
|
"The analysis-view projection allowance",
|
|
"parser",
|
|
),
|
|
),
|
|
);
|
|
}
|
|
|
|
/** Reserve schema output and validation scratch while the borrowed parent stays live. */
|
|
admitCaptureClone(value: unknown): Result<void, AnalysisError> {
|
|
return admitAnalysisViewData(value, false, (bytes) =>
|
|
this.retain(bytes) ? ok(undefined) : this.overBudget(),
|
|
);
|
|
}
|
|
|
|
/** Reserve bytes a view derives from the borrowed parent before it allocates them. */
|
|
admitDerivedBytes(bytes: number): Result<void, AnalysisError> {
|
|
return this.retain(bytes) ? ok(undefined) : this.overBudget();
|
|
}
|
|
|
|
/** Admit the complete portable envelope before cloning or authenticating it. */
|
|
admitInlineEvidence(value: unknown): Result<void, AnalysisError> {
|
|
return admitAnalysisViewData(value, true, (bytes) =>
|
|
this.retain(bytes) ? ok(undefined) : this.overBudget(),
|
|
);
|
|
}
|
|
|
|
addLimitations(limitations: readonly string[]): Result<void, AnalysisError> {
|
|
const prepared = this.prepareLimitations(limitations);
|
|
if (!prepared.ok) return prepared;
|
|
prepared.value();
|
|
return ok(undefined);
|
|
}
|
|
|
|
/** Admit record qualifications without publishing them before the record commits. */
|
|
protected prepareLimitations(
|
|
limitations: readonly string[],
|
|
): Result<() => void, AnalysisError> {
|
|
const rollbackAdmission = this.retainedCheckpoint();
|
|
const pending = new Set<string>();
|
|
for (const limitation of limitations) {
|
|
if (this.#limitations.has(limitation) || pending.has(limitation))
|
|
continue;
|
|
if (!this.retain(ENTRY_BYTES + textBytes(limitation.length))) {
|
|
rollbackAdmission();
|
|
return this.overBudget();
|
|
}
|
|
pending.add(limitation);
|
|
}
|
|
return ok(() => {
|
|
for (const limitation of pending) this.#limitations.add(limitation);
|
|
});
|
|
}
|
|
|
|
/** Derive budgeted qualifications for this snapshot without retaining old snapshots. */
|
|
protected snapshotLimitations(
|
|
derived: readonly string[],
|
|
): Result<string[], AnalysisError> {
|
|
const release = this.temporaryCheckpoint();
|
|
if (
|
|
!this.scratch(
|
|
derived.reduce(
|
|
(bytes, limitation) =>
|
|
bytes + ENTRY_BYTES + textBytes(limitation.length),
|
|
0,
|
|
),
|
|
)
|
|
)
|
|
return this.overBudget();
|
|
try {
|
|
return ok([...new Set([...this.#limitations, ...derived])].sort(compare));
|
|
} finally {
|
|
release();
|
|
}
|
|
}
|
|
|
|
protected sortedLimitations(): string[] {
|
|
return [...this.#limitations].sort(compare);
|
|
}
|
|
}
|
|
|
|
/** Authenticate and gate a retained HAR parent before a grouping view reads any record. */
|
|
export const admitHarCaptureParent = (
|
|
parent: AnalysisViewParent,
|
|
viewKind: "api-surface" | "environment-manifest" | "environment-state",
|
|
accumulator: WebNetworkProjectionAccumulator,
|
|
context: { readonly operation?: string; readonly sourceField?: string } = {},
|
|
): Result<WebNetworkCapture, AnalysisError> => {
|
|
const operation = context.operation ?? "inspect_analysis_view";
|
|
const sourceField = context.sourceField ?? "source";
|
|
const unsupported = (reason: string, remediationAction?: string) =>
|
|
err(
|
|
new AnalysisUnsupportedTargetError(
|
|
operation,
|
|
parent.evidenceId,
|
|
reason,
|
|
remediationAction === undefined ? undefined : { remediationAction },
|
|
),
|
|
);
|
|
if (parent.operation !== "inspect_web_network_capture")
|
|
return unsupported(
|
|
`View ${viewKind} is unsupported for parent operation ${parent.operation}; ${viewKind} requires ${viewKind === "api-surface" ? "inspect_web_network_capture" : "inspect_web_network_capture or capture_browser_scenario"}.`,
|
|
);
|
|
const admitted = accumulator.admitCaptureClone(parent.normalizedResult);
|
|
if (!admitted.ok) return admitted;
|
|
const parsed = safeParseOwnedWebNetworkCapture(parent.normalizedResult);
|
|
if (!parsed.success)
|
|
return err(
|
|
analysisInputErrorFromIssues(
|
|
operation,
|
|
parsed.error.issues.map((issue) => ({
|
|
...issue,
|
|
path: [sourceField, "normalized_result", ...issue.path],
|
|
})),
|
|
{ [sourceField]: { normalized_result: parent.normalizedResult } },
|
|
{ cause: parsed.error },
|
|
),
|
|
);
|
|
if (parsed.data.format !== "har")
|
|
return unsupported(
|
|
`${viewKind} does not support capture format ${parsed.data.format}.`,
|
|
);
|
|
// Environment views preserve the recorded report path and authenticate its digest;
|
|
// the api-surface view keeps the admission its existing callers rely on.
|
|
const { artifact } = parsed.data;
|
|
const subject = evidenceFileTarget(parent);
|
|
if (
|
|
viewKind !== "api-surface" &&
|
|
artifact.sha256 !== null &&
|
|
(subject == null || subject.sha256 !== artifact.sha256)
|
|
)
|
|
return err(
|
|
analysisViewInputError([
|
|
{
|
|
path: ["source", "subject"],
|
|
reason: "invalid_value",
|
|
message: "Capture parent subject must identify the report's SHA-256.",
|
|
},
|
|
]),
|
|
);
|
|
// The view would write path templates it cannot check against declarations
|
|
// the parent does not retain, so the refusal does not repeat declaration text.
|
|
const declarations = z
|
|
.object({ sensitive_value_count: z.number().int().nonnegative() })
|
|
.safeParse(parent.parameters);
|
|
if (!declarations.success || declarations.data.sensitive_value_count > 0)
|
|
return unsupported(
|
|
"sensitive_values_unretained",
|
|
"This view cannot safely project this capture because sensitivity declarations are not retained. Use a compatible capture or summary view to inspect retained observations. Do not remove sensitivity declarations to bypass this restriction.",
|
|
);
|
|
return ok(parsed.data);
|
|
};
|