Skip to content

fix(security): strip credentials from migration snapshots and enforce blueprint digest #743

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cv merged 10 commits into from
Mar 25, 2026
+505 −19
Merged

fix(security): strip credentials from migration snapshots and enforce blueprint digest #743

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
4f8d9a4
fix(security): strip credentials from migration snapshots and enforce…
ericksoa Mar 25, 2026
3705ced
Merge branch 'main' into fix/strip-credentials-migration-snapshots
ericksoa Mar 25, 2026
5d2440f
fix(security): fail closed on v3 blueprint digest and normalize crede…
ericksoa Mar 25, 2026
0fccba7
Merge branch 'fix/strip-credentials-migration-snapshots' of https://g…
ericksoa Mar 25, 2026
48f8833
chore: fix prettier formatting
ericksoa Mar 25, 2026
557dfa6
test: add v3 snapshot restore without blueprintPath
ericksoa Mar 25, 2026
559996a
fix(security): fail closed only when blueprintDigest key is present
ericksoa Mar 25, 2026
3137546
fix(security): add stripCredentials to prepareSandboxState copy and f…
ericksoa Mar 25, 2026
cb490c3
Merge branch 'main' into fix/strip-credentials-migration-snapshots
cv Mar 25, 2026
b91c22d
Merge branch 'main' into fix/strip-credentials-migration-snapshots
cv Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
355 changes: 353 additions & 2 deletions nemoclaw/src/commands/migration-state.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,11 @@ vi.mock("node:fs", async (importOriginal) => {
if (!entry) throw new Error(`ENOENT: ${src}`);
store.set(dest, { ...entry });
}),
cpSync: vi.fn((src: string, dest: string) => {
cpSync: vi.fn((src: string, dest: string, opts?: { filter?: (source: string) => boolean }) => {
// Shallow copy: copy all entries whose path starts with src
for (const [k, v] of store) {
if (k === src || k.startsWith(src + "/")) {
if (opts?.filter && !opts.filter(k)) continue;
const relative = k.slice(src.length);
store.set(dest + relative, { ...v });
}
Expand Down Expand Up @@ -455,7 +456,7 @@ describe("commands/migration-state", () => {
expect.unreachable("bundle should not be null");
return;
}
expect(bundle.manifest.version).toBe(2);
expect(bundle.manifest.version).toBe(3);
expect(bundle.manifest.homeDir).toBe("/home/user");
expect(bundle.temporary).toBe(false);
});
Expand Down Expand Up @@ -529,6 +530,156 @@ describe("commands/migration-state", () => {
}
expect(bundle.manifest.externalRoots.length).toBe(1);
});

it("excludes auth-profiles.json from snapshot", () => {
const logger = makeLogger();
addDir("/home/user/.openclaw");
addFile("/home/user/.openclaw/openclaw.json", JSON.stringify({ version: 1 }));
addDir("/home/user/.openclaw/agents/main/agent");
addFile(
"/home/user/.openclaw/agents/main/agent/auth-profiles.json",
JSON.stringify({ "nvidia:manual": { type: "api_key" } }),
);
addFile(
"/home/user/.openclaw/agents/main/agent/config.json",
JSON.stringify({ name: "main" }),
);

const hostState: HostOpenClawState = {
exists: true,
homeDir: "/home/user",
stateDir: "/home/user/.openclaw",
configDir: "/home/user/.openclaw",
configPath: "/home/user/.openclaw/openclaw.json",
workspaceDir: null,
extensionsDir: null,
skillsDir: null,
hooksDir: null,
externalRoots: [],
warnings: [],
errors: [],
hasExternalConfig: false,
};

const bundle = createSnapshotBundle(hostState, logger, { persist: false });
if (bundle === null) {
expect.unreachable("bundle should not be null");
return;
}

// auth-profiles.json should not exist anywhere in the snapshot
const snapshotKeys = [...store.keys()].filter((k) => k.startsWith(bundle.snapshotDir));
const authProfileKeys = snapshotKeys.filter((k) => k.endsWith("auth-profiles.json"));
expect(authProfileKeys).toHaveLength(0);

// config.json should still be present
const configKeys = snapshotKeys.filter((k) => k.endsWith("agents/main/agent/config.json"));
expect(configKeys.length).toBeGreaterThan(0);
});

it("strips gateway key from sandbox openclaw.json", () => {
const logger = makeLogger();
addDir("/home/user/.openclaw");
addFile(
"/home/user/.openclaw/openclaw.json",
JSON.stringify({ version: 1, gateway: { auth: { token: "secret123" } } }),
);

const hostState: HostOpenClawState = {
exists: true,
homeDir: "/home/user",
stateDir: "/home/user/.openclaw",
configDir: "/home/user/.openclaw",
configPath: "/home/user/.openclaw/openclaw.json",
workspaceDir: null,
extensionsDir: null,
skillsDir: null,
hooksDir: null,
externalRoots: [],
warnings: [],
errors: [],
hasExternalConfig: false,
};

const bundle = createSnapshotBundle(hostState, logger, { persist: false });
if (bundle === null) {
expect.unreachable("bundle should not be null");
return;
}

// Read the sandbox-bundle openclaw.json
const sandboxConfigEntry = store.get(bundle.preparedStateDir + "/openclaw.json");
if (!sandboxConfigEntry?.content) {
expect.unreachable("sandbox config entry should exist with content");
return;
}
const sandboxConfig = JSON.parse(sandboxConfigEntry.content);
expect(sandboxConfig).not.toHaveProperty("gateway");
expect(sandboxConfig).toHaveProperty("version", 1);
});

it("records blueprintDigest when blueprintPath is provided", () => {
const logger = makeLogger();
addDir("/home/user/.openclaw");
addFile("/home/user/.openclaw/openclaw.json", JSON.stringify({ version: 1 }));
addFile("/test/blueprint.yaml", "version: 0.1.0\ndigest: ''\n");

const hostState: HostOpenClawState = {
exists: true,
homeDir: "/home/user",
stateDir: "/home/user/.openclaw",
configDir: "/home/user/.openclaw",
configPath: "/home/user/.openclaw/openclaw.json",
workspaceDir: null,
extensionsDir: null,
skillsDir: null,
hooksDir: null,
externalRoots: [],
warnings: [],
errors: [],
hasExternalConfig: false,
};

const bundle = createSnapshotBundle(hostState, logger, {
persist: false,
blueprintPath: "/test/blueprint.yaml",
});
if (bundle === null) {
expect.unreachable("bundle should not be null");
return;
}
expect(typeof bundle.manifest.blueprintDigest).toBe("string");
expect((bundle.manifest.blueprintDigest ?? "").length).toBeGreaterThan(0);
});

it("blueprintDigest is null when no blueprintPath given", () => {
const logger = makeLogger();
addDir("/home/user/.openclaw");
addFile("/home/user/.openclaw/openclaw.json", JSON.stringify({ version: 1 }));

const hostState: HostOpenClawState = {
exists: true,
homeDir: "/home/user",
stateDir: "/home/user/.openclaw",
configDir: "/home/user/.openclaw",
configPath: "/home/user/.openclaw/openclaw.json",
workspaceDir: null,
extensionsDir: null,
skillsDir: null,
hooksDir: null,
externalRoots: [],
warnings: [],
errors: [],
hasExternalConfig: false,
};

const bundle = createSnapshotBundle(hostState, logger, { persist: false });
if (bundle === null) {
expect.unreachable("bundle should not be null");
return;
}
expect(bundle.manifest.blueprintDigest).toBeNull();
});
});

// -------------------------------------------------------------------------
Expand Down Expand Up @@ -896,5 +1047,205 @@ describe("commands/migration-state", () => {
}
}
});

it("restore succeeds when blueprint digest matches", () => {
const logger = makeLogger();
const origHome = process.env.HOME;
process.env.HOME = "/home/user";
try {
// Create a blueprint file and compute its expected digest
const blueprintContent = "version: 0.1.0\ndigest: ''\n";
addFile("/test/blueprint.yaml", blueprintContent);

// First create a snapshot with blueprintPath to get the real digest
addDir("/home/user/.openclaw");
addFile("/home/user/.openclaw/openclaw.json", JSON.stringify({ version: 1 }));
const hostState: HostOpenClawState = {
exists: true,
homeDir: "/home/user",
stateDir: "/home/user/.openclaw",
configDir: "/home/user/.openclaw",
configPath: "/home/user/.openclaw/openclaw.json",
workspaceDir: null,
extensionsDir: null,
skillsDir: null,
hooksDir: null,
externalRoots: [],
warnings: [],
errors: [],
hasExternalConfig: false,
};
const bundle = createSnapshotBundle(hostState, logger, {
persist: false,
blueprintPath: "/test/blueprint.yaml",
});
if (bundle === null) {
expect.unreachable("bundle should not be null");
return;
}
const digest = bundle.manifest.blueprintDigest;
expect(digest).toBeTruthy();

// Now set up for restore with matching digest
store.clear();
const manifest: SnapshotManifest = {
version: 3,
createdAt: "2026-03-01T00:00:00.000Z",
homeDir: "/home/user",
stateDir: "/home/user/.openclaw",
configPath: null,
hasExternalConfig: false,
externalRoots: [],
warnings: [],
blueprintDigest: digest,
};
addFile("/snapshots/snap1/snapshot.json", JSON.stringify(manifest));
addDir("/snapshots/snap1/openclaw");
addFile("/snapshots/snap1/openclaw/openclaw.json", JSON.stringify({ restored: true }));
addFile("/test/blueprint.yaml", blueprintContent);

const result = restoreSnapshotToHost("/snapshots/snap1", logger, {
blueprintPath: "/test/blueprint.yaml",
});
expect(result).toBe(true);
} finally {
if (origHome === undefined) {
delete process.env.HOME;
} else {
process.env.HOME = origHome;
}
}
});

it("restore fails when blueprint digest mismatches", () => {
const logger = makeLogger();
const origHome = process.env.HOME;
process.env.HOME = "/home/user";
try {
const manifest: SnapshotManifest = {
version: 3,
createdAt: "2026-03-01T00:00:00.000Z",
homeDir: "/home/user",
stateDir: "/home/user/.openclaw",
configPath: null,
hasExternalConfig: false,
externalRoots: [],
warnings: [],
blueprintDigest: "wrong-hash-value",
};
addFile("/snapshots/snap1/snapshot.json", JSON.stringify(manifest));
addDir("/snapshots/snap1/openclaw");
addFile("/test/blueprint.yaml", "version: 0.1.0\n");

const result = restoreSnapshotToHost("/snapshots/snap1", logger, {
blueprintPath: "/test/blueprint.yaml",
});
expect(result).toBe(false);
expect(logger.error).toHaveBeenCalledWith(expect.stringContaining("digest mismatch"));
} finally {
if (origHome === undefined) {
delete process.env.HOME;
} else {
process.env.HOME = origHome;
}
}
});

it("restore fails when manifest has empty string blueprintDigest", () => {
const logger = makeLogger();
const origHome = process.env.HOME;
process.env.HOME = "/home/user";
try {
const manifest: SnapshotManifest = {
version: 3,
createdAt: "2026-03-01T00:00:00.000Z",
homeDir: "/home/user",
stateDir: "/home/user/.openclaw",
configPath: null,
hasExternalConfig: false,
externalRoots: [],
warnings: [],
blueprintDigest: "",
};
addFile("/snapshots/snap1/snapshot.json", JSON.stringify(manifest));
addDir("/snapshots/snap1/openclaw");

const result = restoreSnapshotToHost("/snapshots/snap1", logger);
expect(result).toBe(false);
expect(logger.error).toHaveBeenCalledWith(
expect.stringContaining("invalid blueprintDigest"),
);
} finally {
if (origHome === undefined) {
delete process.env.HOME;
} else {
process.env.HOME = origHome;
}
}
});

it("restore fails when manifest has digest but no blueprintPath provided", () => {
const logger = makeLogger();
const origHome = process.env.HOME;
process.env.HOME = "/home/user";
try {
const manifest: SnapshotManifest = {
version: 3,
createdAt: "2026-03-01T00:00:00.000Z",
homeDir: "/home/user",
stateDir: "/home/user/.openclaw",
configPath: null,
hasExternalConfig: false,
externalRoots: [],
warnings: [],
blueprintDigest: "abc123",
};
addFile("/snapshots/snap1/snapshot.json", JSON.stringify(manifest));
addDir("/snapshots/snap1/openclaw");

const result = restoreSnapshotToHost("/snapshots/snap1", logger);
expect(result).toBe(false);
expect(logger.error).toHaveBeenCalledWith(
expect.stringContaining("no blueprint is available"),
);
} finally {
if (origHome === undefined) {
delete process.env.HOME;
} else {
process.env.HOME = origHome;
}
}
});

it("restore succeeds when manifest has no blueprintDigest (backward compat)", () => {
const logger = makeLogger();
const origHome = process.env.HOME;
process.env.HOME = "/home/user";
try {
const manifest: SnapshotManifest = {
version: 2,
createdAt: "2026-03-01T00:00:00.000Z",
homeDir: "/home/user",
stateDir: "/home/user/.openclaw",
configPath: null,
hasExternalConfig: false,
externalRoots: [],
warnings: [],
// no blueprintDigest field
};
addFile("/snapshots/snap1/snapshot.json", JSON.stringify(manifest));
addDir("/snapshots/snap1/openclaw");
addFile("/snapshots/snap1/openclaw/openclaw.json", JSON.stringify({ restored: true }));

const result = restoreSnapshotToHost("/snapshots/snap1", logger);
expect(result).toBe(true);
} finally {
if (origHome === undefined) {
delete process.env.HOME;
} else {
process.env.HOME = origHome;
}
}
});
});
});
Loading
Loading