Files
rea/tests/fixtures/fakeGhidra.mjs
T
N0zoM1z0andGitHub 9bab55337a feat(ghidra): add atomic function annotation edits (#709)
* feat(ghidra): edit function annotations atomically

Return annotation readback and refreshed function analysis through CLI and MCP. Own each database transaction, invalidate caches and immutable snapshots, preserve executable bytes, and retain the Windows mutation boundary.

Assisted-by: Nitori (gensokyo-skills:nitori-reverse-engineering)

* fix(ghidra): preserve qualified function annotation identity

Preserve namespaces during local name writes and match qualified readback to the refreshed dossier. Add a producer-shaped regression and verify a real namespaced C++ function through the CLI.

Assisted-by: Nitori (gensokyo-skills:nitori-reverse-engineering)

* test(ghidra): align verification with annotation authority

Keep strict capability and profile checks while admitting the explicit session metadata operation. Verify packaged transport authority and atomic transaction commitments and preserve a read-only Windows expectation.

Assisted-by: Nitori (gensokyo-skills:nitori-reverse-engineering)
2026-10-06 17:24:33 +08:00

334 lines
8.3 KiB
JavaScript

import { rename, rm, writeFile } from "node:fs/promises";
import { createServer } from "node:net";
const configuration = JSON.parse(
process.env.REA_GHIDRA_FIXTURE_CONFIG ?? "null",
);
const {
endpointPath,
token,
runId,
providerVersion,
profileDigest,
targetSha256,
transport,
mode = "success",
} = configuration ?? {};
if (
endpointPath === undefined ||
token === undefined ||
runId === undefined ||
providerVersion === undefined ||
profileDigest === undefined ||
targetSha256 === undefined ||
!["unix-socket", "authenticated-loopback-tcp"].includes(transport)
) {
process.exit(64);
}
if (mode === "exit") process.exit(73);
if (mode === "silent") setInterval(() => undefined, 1_000);
else {
await rm(endpointPath, { force: true });
const server = createServer((socket) => {
socket.setEncoding("utf8");
const state = {
buffer: { value: "" },
pings: { value: 0 },
mode,
token,
runId,
providerVersion,
profileDigest,
targetSha256,
};
socket.on("data", (chunk) => onSocketData(socket, server, chunk, state));
});
if (transport === "unix-socket") server.listen(endpointPath);
else {
server.listen(0, "127.0.0.1", async () => {
const address = server.address();
if (address === null || typeof address === "string") process.exit(65);
const pending = `${endpointPath}.pending`;
await writeFile(
pending,
`${JSON.stringify({
host: "127.0.0.1",
port: address.port,
})}\n`,
{ flag: "wx" },
);
await rename(pending, endpointPath);
});
}
}
const onSocketData = (socket, server, chunk, state) => {
state.buffer.value += chunk;
let newline = state.buffer.value.indexOf("\n");
while (newline >= 0) {
const line = state.buffer.value.slice(0, newline);
state.buffer.value = state.buffer.value.slice(newline + 1);
newline = state.buffer.value.indexOf("\n");
const request = JSON.parse(line);
if (request.token !== state.token) {
socket.end(
`${JSON.stringify({
id: request.id,
ok: false,
error: { code: "auth", message: "Authentication failed" },
})}\n`,
);
continue;
}
handleRequest(socket, server, request, state);
}
};
const handleRequest = (socket, server, request, state) => {
if (request.method === "ping") {
handlePing(socket, request, state);
return;
}
if (state.mode === "remote_error" && request.method === "list_procedures") {
socket.write(
`${JSON.stringify({
id: request.id,
ok: false,
error: {
code: "not_found",
message: "Unknown Ghidra procedure name",
},
})}\n`,
);
return;
}
if (state.mode === "exit_tools" && request.method !== "shutdown")
process.exit(74);
if (state.mode === "hang_tools" && request.method !== "shutdown") return;
const inventory = inventoryResultFor(request.method);
if (inventory !== undefined) {
socket.write(
`${JSON.stringify({ id: request.id, ok: true, result: inventory })}\n`,
);
return;
}
if (request.method === "shutdown") {
socket.end(
`${JSON.stringify({
id: request.id,
...(state.mode === "shutdown_error"
? {
ok: false,
error: {
code: "shutdown_fixture_failure",
message: `Shutdown denied for ${state.token}: /tmp/password-fixture http://localhost/secret?token=public-value`,
},
}
: {
ok: true,
result: {
shutdown: state.mode !== "invalid_shutdown_ack",
project_ephemeral: true,
},
}),
})}\n`,
);
server.close(() => process.exit(0));
}
};
const handlePing = (socket, request, state) => {
state.pings.value += 1;
if (state.mode === "malformed") {
socket.write("{invalid\n");
return;
}
if (state.mode === "contradictory") {
socket.write(
`${JSON.stringify({
id: request.id,
ok: false,
result: { unexpected: true },
error: { code: "failure", message: "Failed" },
})}\n`,
);
return;
}
if (state.mode === "future_id") {
socket.write(
`${JSON.stringify({ id: request.id + 10, ok: true, result: null })}\n`,
);
return;
}
if (state.mode === "hang_after_start" && state.pings.value > 1) return;
const result = sessionInfo({
runId: state.runId,
providerVersion:
state.mode === "wrong_identity" ? "0.0.0" : state.providerVersion,
profileDigest: state.profileDigest,
targetSha256: state.targetSha256,
timedOut: state.mode === "analysis_timeout",
});
const response = `${JSON.stringify({ id: request.id, ok: true, result })}\n`;
if (state.mode === "fragmented") {
const split = Math.floor(response.length / 2);
socket.write(response.slice(0, split));
setTimeout(() => socket.write(response.slice(split)), 5);
} else socket.write(response);
};
const sessionInfo = ({
runId: sessionRunId,
providerVersion: version,
profileDigest: digest,
targetSha256: sha256,
timedOut,
}) => ({
name: "REA Ghidra bridge",
run_id: sessionRunId,
profile_digest: digest,
provider: { id: "ghidra", version },
read_only: transport !== "unix-socket",
analysis_complete: !timedOut,
analysis_timed_out: timedOut,
capabilities: [
"ping",
"shutdown",
"inspect_native_load_image",
"read_bytes",
"address_to_file_offset",
"address_name",
"list_documents",
"list_names",
"list_procedures",
"list_segments",
"list_strings",
"procedure_address",
"resolve_containing_procedure",
"search_procedures",
"search_strings",
"annotate_native_function",
"inspect_native_data_type",
"inspect_native_instruction",
"resolve_native_call_targets",
"analyze_function",
"procedure_assembly",
"procedure_callees",
"procedure_callers",
"procedure_info",
"procedure_pseudo_code",
"read_function_instructions",
"procedure_references",
"xrefs",
].filter(
(value) =>
transport === "unix-socket" || value !== "annotate_native_function",
),
target: {
name: "fixture",
language_id: "x86:LE:64:default",
compiler_spec_id: "gcc",
image_base: "0x1000",
default_address_space: "ram",
sha256,
},
});
const inventoryResultFor = (method) => {
switch (method) {
case "address_name":
return "fixture_main";
case "list_documents":
return ["fixture"];
case "list_names":
return [nameItem()];
case "list_procedures":
return [procedureItem()];
case "list_segments":
return [segmentItem()];
case "list_strings":
return [stringItem("0x2000", "fixture value")];
case "procedure_address":
return "0x1000";
case "resolve_containing_procedure":
return containingProcedureResult();
case "search_procedures":
return [procedureSearchItem()];
case "search_strings":
return [stringSearchItem()];
default:
return undefined;
}
};
const nameItem = () => ({
address: "0x1000",
value: "fixture_main",
symbol: {
primary: true,
dynamic: false,
external: false,
type: "function",
source: "analysis",
},
});
const procedureItem = () => ({
address: "0x1000",
value: "fixture_main",
procedure: { external: false, thunk: false, thunk_target: null },
});
const segmentItem = () => ({
name: ".text",
start: "0x1000",
end: "0x1100",
readable: true,
writable: false,
executable: true,
permissions: { available: true, source: "ghidra-memory-block" },
provenance: "ghidra-memory-block",
address_space: "ram",
image_base: "0x1000",
initialized: true,
overlay: false,
sections: [],
});
const stringItem = (address, value) => ({
address,
value,
string: {
encoding: "UTF-8",
termination: "present_or_not_required",
byte_length: value.length + 1,
},
});
const containingProcedureResult = () => ({
query_address: "0x1001",
found: true,
procedure: {
address: "0x1000",
name: "fixture_main",
classification: {
external: false,
thunk: false,
thunk_target: null,
provenance: "ghidra-function-manager",
},
},
});
const procedureSearchItem = () => ({
address: "0x1000",
value: "fixture_main",
});
const stringSearchItem = () => ({
address: "0x2000",
value: "fixture value",
});