Bound checked candidate metadata and restricted invocation resources
This commit is contained in:
@@ -1,19 +1,18 @@
|
|||||||
import { graphExecutionRepresentation } from "./graph-execution.js";
|
import { graphExecutionRepresentation } from "./graph-execution.js";
|
||||||
import { open, lstat } from "node:fs/promises";
|
import { lstat } from "node:fs/promises";
|
||||||
import { constants } from "node:fs";
|
|
||||||
import { join } from "node:path";
|
import { join } from "node:path";
|
||||||
import { hexDigest, ExecutionPlanError, type ExecutionPlan } from "./plan.js";
|
import { hexDigest, ExecutionPlanError, type ExecutionPlan } from "./plan.js";
|
||||||
import { loadExecutionInstallation, type PackageInstallationSelection } from "./installation.js";
|
import { loadExecutionInstallation, type PackageInstallationSelection } from "./installation.js";
|
||||||
|
import {
|
||||||
|
candidateMetadataBudget,
|
||||||
|
readCandidateMetadata,
|
||||||
|
type CandidateMetadataBudget,
|
||||||
|
type CandidateMetadataScope,
|
||||||
|
} from "./metadata.js";
|
||||||
const rootPattern = /^\/nix\/store\/[a-z0-9]{32}-[^/\s]+$/;
|
const rootPattern = /^\/nix\/store\/[a-z0-9]{32}-[^/\s]+$/;
|
||||||
async function readJson(root: string, file: string): Promise<any> {
|
async function readJson(root: string, file: string, scope: CandidateMetadataScope): Promise<any> {
|
||||||
const handle = await open(join(root, file), constants.O_RDONLY | constants.O_NOFOLLOW);
|
const bytes = await readCandidateMetadata(join(root, file), scope, 32 * 1024 * 1024);
|
||||||
try {
|
return JSON.parse(new TextDecoder("utf-8", { fatal: true }).decode(bytes));
|
||||||
const metadata = await handle.stat();
|
|
||||||
if (!metadata.isFile() || metadata.size > 32 * 1024 * 1024) throw Error(`Invalid checked candidate file: ${file}`);
|
|
||||||
return JSON.parse(await handle.readFile("utf8"));
|
|
||||||
} finally {
|
|
||||||
await handle.close();
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
/** Load the checked Nix output, preserving its original compilation and provenance.
|
/** Load the checked Nix output, preserving its original compilation and provenance.
|
||||||
* The selected toolchain validates generated code during the build. This loader
|
* The selected toolchain validates generated code during the build. This loader
|
||||||
@@ -22,19 +21,27 @@ async function readJson(root: string, file: string): Promise<any> {
|
|||||||
export async function loadCheckedInstallationCandidate(
|
export async function loadCheckedInstallationCandidate(
|
||||||
root: string,
|
root: string,
|
||||||
selections: Readonly<Record<string, PackageInstallationSelection>> = {},
|
selections: Readonly<Record<string, PackageInstallationSelection>> = {},
|
||||||
|
resources: { budget?: CandidateMetadataBudget; owner?: string } = {},
|
||||||
) {
|
) {
|
||||||
if (!rootPattern.test(root) || !(await lstat(root)).isDirectory())
|
if (!rootPattern.test(root) || !(await lstat(root)).isDirectory())
|
||||||
throw Error("Candidate must be an immutable Nix output directory");
|
throw Error("Candidate must be an immutable Nix output directory");
|
||||||
const [candidate, plan, artifacts, source, entryRequest, kernel, queries, graph] = await Promise.all([
|
const scope = (resources.budget ?? candidateMetadataBudget).acquire(resources.owner ?? root);
|
||||||
readJson(root, "candidate.json"),
|
try {
|
||||||
readJson(root, "execution-plan.json"),
|
// Sequential reads avoid partially rejected Promise.all() work allocating
|
||||||
readJson(root, "execution-artifacts.json"),
|
// after the failed candidate's reservation has been released.
|
||||||
readJson(root, "source.json"),
|
const values = [];
|
||||||
readJson(root, "entry.json"),
|
for (const file of [
|
||||||
readJson(root, "kernel.json"),
|
"candidate.json",
|
||||||
readJson(root, "queries.json"),
|
"execution-plan.json",
|
||||||
readJson(root, "graph-execution.json"),
|
"execution-artifacts.json",
|
||||||
]);
|
"source.json",
|
||||||
|
"entry.json",
|
||||||
|
"kernel.json",
|
||||||
|
"queries.json",
|
||||||
|
"graph-execution.json",
|
||||||
|
])
|
||||||
|
values.push(await readJson(root, file, scope));
|
||||||
|
const [candidate, plan, artifacts, source, entryRequest, kernel, queries, graph] = values;
|
||||||
const { executionContracts: _legacyContracts, ...workspace } = candidate;
|
const { executionContracts: _legacyContracts, ...workspace } = candidate;
|
||||||
if (
|
if (
|
||||||
plan?.definition?.codec !== "camino-execution-plan-v1" ||
|
plan?.definition?.codec !== "camino-execution-plan-v1" ||
|
||||||
@@ -77,7 +84,7 @@ export async function loadCheckedInstallationCandidate(
|
|||||||
root,
|
root,
|
||||||
"Package artifacts must be immutable Nix roots",
|
"Package artifacts must be immutable Nix roots",
|
||||||
);
|
);
|
||||||
const installation = await loadExecutionInstallation(plan, artifacts.roots, selections);
|
const installation = await loadExecutionInstallation(plan, artifacts.roots, selections, scope);
|
||||||
const entry = compileWorkspaceEntry(plan, entryRequest);
|
const entry = compileWorkspaceEntry(plan, entryRequest);
|
||||||
for (const [name, program, codec] of [
|
for (const [name, program, codec] of [
|
||||||
["kernel", kernel, "camino-kernel-program-v1"],
|
["kernel", kernel, "camino-kernel-program-v1"],
|
||||||
@@ -128,7 +135,17 @@ export async function loadCheckedInstallationCandidate(
|
|||||||
queries,
|
queries,
|
||||||
installation,
|
installation,
|
||||||
executionPlan: plan as ExecutionPlan,
|
executionPlan: plan as ExecutionPlan,
|
||||||
|
metadata: {
|
||||||
|
get bytes() {
|
||||||
|
return scope.bytes;
|
||||||
|
},
|
||||||
|
release: scope.release,
|
||||||
|
},
|
||||||
};
|
};
|
||||||
|
} catch (error) {
|
||||||
|
scope.release();
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export function compileWorkspaceEntry(plan: ExecutionPlan, entryRequest: unknown): { operation: string } | null {
|
export function compileWorkspaceEntry(plan: ExecutionPlan, entryRequest: unknown): { operation: string } | null {
|
||||||
|
|||||||
@@ -13,6 +13,7 @@ import {
|
|||||||
type CheckedWorld,
|
type CheckedWorld,
|
||||||
} from "./artifacts.js";
|
} from "./artifacts.js";
|
||||||
import { type ExecutionPlan, ExecutionPlanError } from "./plan.js";
|
import { type ExecutionPlan, ExecutionPlanError } from "./plan.js";
|
||||||
|
import type { CandidateMetadataScope } from "./metadata.js";
|
||||||
|
|
||||||
const maxFileBytes = 256 * 1024 * 1024;
|
const maxFileBytes = 256 * 1024 * 1024;
|
||||||
const metadataLimit = 16 * 1024 * 1024;
|
const metadataLimit = 16 * 1024 * 1024;
|
||||||
@@ -21,7 +22,10 @@ const fail = (where: string, message: string): never => {
|
|||||||
};
|
};
|
||||||
/** Roots must be trusted immutable output directories. Refuse symlinks, including
|
/** Roots must be trusted immutable output directories. Refuse symlinks, including
|
||||||
* interior directory links. Hash verification is still required before serving bytes. */
|
* interior directory links. Hash verification is still required before serving bytes. */
|
||||||
export async function artifactFileReader(roots: Readonly<Record<string, string>>): Promise<ArtifactReader> {
|
export async function artifactFileReader(
|
||||||
|
roots: Readonly<Record<string, string>>,
|
||||||
|
metadata?: CandidateMetadataScope,
|
||||||
|
): Promise<ArtifactReader> {
|
||||||
const directories = new Map<string, string>();
|
const directories = new Map<string, string>();
|
||||||
for (const [revision, root] of Object.entries(roots)) {
|
for (const [revision, root] of Object.entries(roots)) {
|
||||||
if (!path.isAbsolute(root) || path.normalize(root) !== root || (await realpath(root)) !== root)
|
if (!path.isAbsolute(root) || path.normalize(root) !== root || (await realpath(root)) !== root)
|
||||||
@@ -47,6 +51,7 @@ export async function artifactFileReader(roots: Readonly<Record<string, string>>
|
|||||||
try {
|
try {
|
||||||
const stat = await handle.stat();
|
const stat = await handle.stat();
|
||||||
if (!stat.isFile() || stat.size > limit) fail(relative, "File exceeds its declared bound");
|
if (!stat.isFile() || stat.size > limit) fail(relative, "File exceeds its declared bound");
|
||||||
|
if (relative === "share/quixos/package-artifacts.json") metadata?.charge((stat.size + 1) * 32);
|
||||||
// A fixed allocation and one extra byte detect growth without readFile's unbounded allocation.
|
// A fixed allocation and one extra byte detect growth without readFile's unbounded allocation.
|
||||||
const buffer = Buffer.alloc(stat.size + 1);
|
const buffer = Buffer.alloc(stat.size + 1);
|
||||||
let offset = 0;
|
let offset = 0;
|
||||||
@@ -72,8 +77,9 @@ export interface LoadedArtifactWorld {
|
|||||||
export async function loadArtifactWorld(
|
export async function loadArtifactWorld(
|
||||||
plan: ExecutionPlan,
|
plan: ExecutionPlan,
|
||||||
roots: Readonly<Record<string, string>>,
|
roots: Readonly<Record<string, string>>,
|
||||||
|
metadata?: CandidateMetadataScope,
|
||||||
): Promise<LoadedArtifactWorld> {
|
): Promise<LoadedArtifactWorld> {
|
||||||
const read = await artifactFileReader(roots),
|
const read = await artifactFileReader(roots, metadata),
|
||||||
manifests: PackageArtifacts[] = [];
|
manifests: PackageArtifacts[] = [];
|
||||||
const expected = plan.definition.packages.map((p) => p.revision).sort();
|
const expected = plan.definition.packages.map((p) => p.revision).sort();
|
||||||
if (JSON.stringify(Object.keys(roots).sort()) !== JSON.stringify(expected))
|
if (JSON.stringify(Object.keys(roots).sort()) !== JSON.stringify(expected))
|
||||||
|
|||||||
@@ -17,6 +17,7 @@ export * from "./queries.js";
|
|||||||
export * from "./query-document.js";
|
export * from "./query-document.js";
|
||||||
export { generatePortableClientBindings } from "../bindings/portable-client.js";
|
export { generatePortableClientBindings } from "../bindings/portable-client.js";
|
||||||
export * from "./candidate.js";
|
export * from "./candidate.js";
|
||||||
|
export * from "./metadata.js";
|
||||||
|
|
||||||
export { reviewSemanticMajors } from "../capability-model/evolution.js";
|
export { reviewSemanticMajors } from "../capability-model/evolution.js";
|
||||||
|
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ import {
|
|||||||
type PublicQueryContract,
|
type PublicQueryContract,
|
||||||
} from "./client-contracts.js";
|
} from "./client-contracts.js";
|
||||||
import { resultInterfaces } from "./projections.js";
|
import { resultInterfaces } from "./projections.js";
|
||||||
|
import type { CandidateMetadataScope } from "./metadata.js";
|
||||||
|
|
||||||
/** Activation is assigned by graph authority, never by a package artifact. */
|
/** Activation is assigned by graph authority, never by a package artifact. */
|
||||||
export interface ActiveExecutionIdentity {
|
export interface ActiveExecutionIdentity {
|
||||||
@@ -159,8 +160,9 @@ export async function loadExecutionInstallation(
|
|||||||
plan: ExecutionPlan,
|
plan: ExecutionPlan,
|
||||||
roots: Readonly<Record<string, string>>,
|
roots: Readonly<Record<string, string>>,
|
||||||
selections: Readonly<Record<string, PackageInstallationSelection>> = {},
|
selections: Readonly<Record<string, PackageInstallationSelection>> = {},
|
||||||
|
metadata?: CandidateMetadataScope,
|
||||||
): Promise<ExecutionInstallation> {
|
): Promise<ExecutionInstallation> {
|
||||||
return assembleExecutionInstallation(plan, roots, await loadArtifactWorld(plan, roots), selections);
|
return assembleExecutionInstallation(plan, roots, await loadArtifactWorld(plan, roots, metadata), selections);
|
||||||
}
|
}
|
||||||
function assembleExecutionInstallation(
|
function assembleExecutionInstallation(
|
||||||
plan: ExecutionPlan,
|
plan: ExecutionPlan,
|
||||||
|
|||||||
@@ -0,0 +1,83 @@
|
|||||||
|
import { constants } from "node:fs";
|
||||||
|
import { open } from "node:fs/promises";
|
||||||
|
|
||||||
|
/** Admission estimates, not a hard V8 heap limit. A process/cgroup ceiling is
|
||||||
|
* still required. Charge input, parse trees and derived indexes before reading
|
||||||
|
* or parsing. Each live candidate retains its reservation until explicit close. */
|
||||||
|
export class CandidateMetadataBudget {
|
||||||
|
readonly limits: Readonly<{ bytes: number; ownerBytes: number; candidates: number }>;
|
||||||
|
private bytes = 0;
|
||||||
|
private scopes = 0;
|
||||||
|
private readonly owners = new Map<string, number>();
|
||||||
|
constructor(limits = { bytes: 512 * 1024 * 1024, ownerBytes: 256 * 1024 * 1024, candidates: 128 }) {
|
||||||
|
for (const value of Object.values(limits))
|
||||||
|
if (!Number.isSafeInteger(value) || value < 1) throw Error("INVALID_CANDIDATE_METADATA_BUDGET");
|
||||||
|
if (limits.ownerBytes > limits.bytes) throw Error("INVALID_CANDIDATE_METADATA_BUDGET");
|
||||||
|
this.limits = Object.freeze({ ...limits });
|
||||||
|
}
|
||||||
|
snapshot() {
|
||||||
|
return { bytes: this.bytes, candidates: this.scopes, owners: this.owners.size, limits: this.limits };
|
||||||
|
}
|
||||||
|
acquire(owner: string) {
|
||||||
|
if (!owner || owner.length > 4096) throw Error("INVALID_CANDIDATE_METADATA_OWNER");
|
||||||
|
if (this.scopes >= this.limits.candidates) throw Error("CANDIDATE_METADATA_LIMIT");
|
||||||
|
this.scopes++;
|
||||||
|
let bytes = 0,
|
||||||
|
closed = false;
|
||||||
|
return {
|
||||||
|
get bytes() {
|
||||||
|
return bytes;
|
||||||
|
},
|
||||||
|
charge: (amount: number) => {
|
||||||
|
if (closed) throw Error("CANDIDATE_METADATA_CLOSED");
|
||||||
|
if (!Number.isSafeInteger(amount) || amount < 0) throw Error("INVALID_CANDIDATE_METADATA_CHARGE");
|
||||||
|
const owned = this.owners.get(owner) ?? 0;
|
||||||
|
if (this.bytes + amount > this.limits.bytes || owned + amount > this.limits.ownerBytes)
|
||||||
|
throw Error("CANDIDATE_METADATA_LIMIT");
|
||||||
|
bytes += amount;
|
||||||
|
this.bytes += amount;
|
||||||
|
this.owners.set(owner, owned + amount);
|
||||||
|
},
|
||||||
|
release: () => {
|
||||||
|
if (closed) return;
|
||||||
|
closed = true;
|
||||||
|
this.bytes -= bytes;
|
||||||
|
this.scopes--;
|
||||||
|
const remaining = (this.owners.get(owner) ?? 0) - bytes;
|
||||||
|
if (remaining) this.owners.set(owner, remaining);
|
||||||
|
else this.owners.delete(owner);
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
export type CandidateMetadataScope = ReturnType<CandidateMetadataBudget["acquire"]>;
|
||||||
|
export const candidateMetadataBudget = new CandidateMetadataBudget();
|
||||||
|
|
||||||
|
/** Immutable regular files only. Fixed allocation plus an extra byte catches
|
||||||
|
* growth; readFile() would allocate before the admission check can intervene. */
|
||||||
|
export async function readCandidateMetadata(
|
||||||
|
path: string,
|
||||||
|
scope: CandidateMetadataScope,
|
||||||
|
limit: number,
|
||||||
|
): Promise<Uint8Array> {
|
||||||
|
const handle = await open(path, constants.O_RDONLY | constants.O_NOFOLLOW | constants.O_NONBLOCK);
|
||||||
|
try {
|
||||||
|
const stat = await handle.stat();
|
||||||
|
if (!stat.isFile() || !Number.isSafeInteger(stat.size) || stat.size > limit)
|
||||||
|
throw Error("CANDIDATE_METADATA_FILE_LIMIT");
|
||||||
|
// Conservative attribution includes strings, small JSON nodes, duplicate
|
||||||
|
// checked representations, digest serialization and installed indexes.
|
||||||
|
scope.charge((stat.size + 1) * 32);
|
||||||
|
const bytes = Buffer.alloc(stat.size + 1);
|
||||||
|
let offset = 0;
|
||||||
|
while (offset < bytes.length) {
|
||||||
|
const read = await handle.read(bytes, offset, bytes.length - offset, offset);
|
||||||
|
if (!read.bytesRead) break;
|
||||||
|
offset += read.bytesRead;
|
||||||
|
}
|
||||||
|
if (offset !== stat.size) throw Error("CANDIDATE_METADATA_CHANGED");
|
||||||
|
return bytes.subarray(0, offset);
|
||||||
|
} finally {
|
||||||
|
await handle.close();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -29,6 +29,8 @@ export interface PackageInvocation {
|
|||||||
/** Capability arguments/receiver use the versioned managed-reference codec. */
|
/** Capability arguments/receiver use the versioned managed-reference codec. */
|
||||||
input: unknown;
|
input: unknown;
|
||||||
receiver: unknown | null;
|
receiver: unknown | null;
|
||||||
|
/** Host-owned remaining root resources, separate from authored input. */
|
||||||
|
budget?: { root: string; depth: number; calls: number; deadlineMs: number };
|
||||||
}
|
}
|
||||||
export type InvocationReply =
|
export type InvocationReply =
|
||||||
| { abi: typeof transactionPortAbi; invocation: string; status: "returned"; output: unknown }
|
| { abi: typeof transactionPortAbi; invocation: string; status: "returned"; output: unknown }
|
||||||
|
|||||||
@@ -0,0 +1,50 @@
|
|||||||
|
import test from "node:test";
|
||||||
|
import assert from "node:assert/strict";
|
||||||
|
import { mkdtemp, writeFile, symlink, rm } from "node:fs/promises";
|
||||||
|
import { join } from "node:path";
|
||||||
|
import { tmpdir } from "node:os";
|
||||||
|
import { CandidateMetadataBudget, readCandidateMetadata } from "../src/execution-world/metadata.js";
|
||||||
|
|
||||||
|
test("concurrent candidate reservations enforce aggregate and owner limits and release exactly once", () => {
|
||||||
|
const budget = new CandidateMetadataBudget({ bytes: 1000, ownerBytes: 600, candidates: 3 });
|
||||||
|
const first = budget.acquire("a"),
|
||||||
|
second = budget.acquire("a"),
|
||||||
|
third = budget.acquire("b");
|
||||||
|
assert.throws(() => budget.acquire("c"), /CANDIDATE_METADATA_LIMIT/);
|
||||||
|
first.charge(400);
|
||||||
|
second.charge(200);
|
||||||
|
third.charge(400);
|
||||||
|
assert.throws(() => second.charge(1), /CANDIDATE_METADATA_LIMIT/);
|
||||||
|
assert.throws(() => third.charge(1), /CANDIDATE_METADATA_LIMIT/);
|
||||||
|
assert.equal(budget.snapshot().bytes, 1000);
|
||||||
|
second.release();
|
||||||
|
second.release();
|
||||||
|
assert.equal(budget.snapshot().bytes, 800);
|
||||||
|
assert.throws(() => second.charge(1), /CANDIDATE_METADATA_CLOSED/);
|
||||||
|
first.release();
|
||||||
|
third.release();
|
||||||
|
assert.deepEqual(budget.snapshot(), { bytes: 0, candidates: 0, owners: 0, limits: budget.limits });
|
||||||
|
});
|
||||||
|
|
||||||
|
test("metadata files reserve parse/index space before allocation and refuse oversized or linked inputs", async () => {
|
||||||
|
const root = await mkdtemp(join(tmpdir(), "qx-metadata-budget-"));
|
||||||
|
const budget = new CandidateMetadataBudget({ bytes: 512, ownerBytes: 512, candidates: 2 });
|
||||||
|
const scope = budget.acquire("workspace");
|
||||||
|
try {
|
||||||
|
const file = join(root, "metadata.json");
|
||||||
|
await writeFile(file, '{"ok":true}');
|
||||||
|
assert.equal(new TextDecoder().decode(await readCandidateMetadata(file, scope, 100)), '{"ok":true}');
|
||||||
|
assert.equal(scope.bytes, 12 * 32);
|
||||||
|
await assert.rejects(readCandidateMetadata(file, scope, 100), /CANDIDATE_METADATA_LIMIT/);
|
||||||
|
assert.equal(scope.bytes, 12 * 32);
|
||||||
|
await assert.rejects(readCandidateMetadata(file, scope, 5), /CANDIDATE_METADATA_FILE_LIMIT/);
|
||||||
|
await symlink(file, join(root, "linked"));
|
||||||
|
await assert.rejects(readCandidateMetadata(join(root, "linked"), scope, 100), { code: "ELOOP" });
|
||||||
|
await assert.rejects(readCandidateMetadata(root, scope, 100), /CANDIDATE_METADATA_FILE_LIMIT/);
|
||||||
|
assert.equal(scope.bytes, 12 * 32);
|
||||||
|
} finally {
|
||||||
|
scope.release();
|
||||||
|
await rm(root, { recursive: true, force: true });
|
||||||
|
}
|
||||||
|
assert.equal(budget.snapshot().bytes, 0);
|
||||||
|
});
|
||||||
Reference in New Issue
Block a user