Files
reverse-engineering-anything/src/ghidra/GhidraClientTypes.ts
T
morluto cb4e5cfbff feat(analysis): make resource budgets recoverable across CLI and MCP (#9706)
* refactor(analysis): centralize resource budgets and recovery facts

* feat(analysis): expose ASAR and Ghidra runtime admission controls

* feat(artifacts): expose reader admission and preserve limited recognition

* feat(javascript): expose recoverable semantic precision budgets

* feat(web): add recoverable source-map budgets and compact retained views

* feat(web): make historical capture decoding budgets recoverable

* fix(desktop): enforce selected view policies across capture and export

* feat(runtime): make Frida and LLDB retention budgets selectable

* feat(native): expose diagnostic budgets and preserve exhaustion causes

* feat(managed): expose recoverable snapshot and representation budgets

* feat(metadata): make Go and Rust inspection budgets recoverable

* feat(wasm): expose representation and producer admissions

* feat(evm): expose per-call worker resource budgets

* feat(android): make resource and string-pool omissions recoverable

* feat(producers): expose command and recorded-capture budgets

* docs(analysis): record recovery contracts and integrated validation

* fix(docs): link calibration oracle from published verification pages

* fix(docs): restore desktop task anchors and receipt links

* test(analysis): align fixtures with selectable budget contracts

* fix(analysis): remove source-location projector dependency cycle

* test(analysis): refresh budget recovery and verifier regressions

* test(analysis): preserve format and publication recovery expectations

* test(windows): align conformance with owned runtime admission

* fix(desktop): preserve selected alias kinds in exported state

* test(analysis): align provider fixtures with recoverable budgets

* test(desktop): validate emitted alias metadata structurally

* fix(ghidra): classify bounded Windows endpoint refusals

* test(cli): assert selectable artifact admission recovery

* fix(cli): preserve capture provenance in environment builds
2026-11-10 05:11:20 -05:00

64 lines
2.8 KiB
TypeScript

import type { Logger } from "pino";
import type { GhidraCheckpointSelection } from "./GhidraCheckpoint.js";
import type { BridgeMaxRequestBytes } from "../config/bridgeMaxRequestBytes.js";
import type { Result } from "../domain/result.js";
import type { LinuxCgroupMemoryState } from "../process/LinuxCgroupMemory.js";
import type { GhidraLauncher } from "./GhidraLauncher.js";
import type { GhidraSessionError } from "./GhidraSessionError.js";
import type { GhidraSessionInfo } from "./GhidraSessionValues.js";
import type { GhidraTransportKind } from "./GhidraTransport.js";
import type { NativeValueFlowLimits } from "../domain/native/nativeValueFlow.js";
/** Result of opening and authenticating one headless Ghidra session. */
export type GhidraStartResult = Result<GhidraSessionInfo, GhidraSessionError>;
/** Cancellation and deadline controls shared by authenticated requests. */
export interface GhidraRequestOptions {
readonly decompileTimeoutSeconds?: number | null;
readonly decompileMaxPayloadMiB?: number | null;
readonly valueFlowLimits?: NativeValueFlowLimits;
readonly signal?: AbortSignal;
/** Internal startup/shutdown deadline; analysis calls have no fixed deadline. */
readonly timeoutMs?: number;
}
/** Safe lifecycle telemetry for one isolated Ghidra headless process. */
export type GhidraDiagnostic =
| {
readonly type: "launcher-output";
readonly stream: "stdout" | "stderr";
readonly bytes: number;
readonly totalBytes: number;
}
| {
readonly type: "launcher-exit";
readonly code: number | null;
readonly signal: NodeJS.Signals | null;
}
| { readonly type: "cleanup-incomplete"; readonly reason: string };
/** Dependencies and exact profile commitment for one headless Program session. */
export interface GhidraClientOptions {
readonly launcher: GhidraLauncher;
readonly runId?: string;
readonly targetPath: string;
readonly targetSha256: string;
readonly existingProject?: boolean;
readonly checkpoint?: GhidraCheckpointSelection;
/** Installation host shared by runtime allocation and snapshot admission. */
readonly platform?: NodeJS.Platform;
readonly transport?: GhidraTransportKind;
readonly providerVersion: string;
readonly profileDigest: string;
readonly expectedLanguageId?: string;
readonly expectedCompilerSpecId?: string;
readonly startupTimeoutMs?: number;
readonly readStartupTimeoutMs?: () => number;
readonly onDiagnostic?: (event: GhidraDiagnostic) => void;
readonly logger?: Logger;
/** Observes REA's memory cgroup around a run; defaults to the Linux cgroup v2 reader. */
readonly readMemoryCgroup?: () => Promise<LinuxCgroupMemoryState | undefined>;
/** Effective request ceiling; defaults to the configured bridge ceiling. */
readonly bridgeMaxRequestBytes?: BridgeMaxRequestBytes;
}