| import fs from "node:fs/promises"; |
| import os from "node:os"; |
| import path from "node:path"; |
|
|
| import { describe, expect, it } from "vitest"; |
|
|
| import { fixSecurityFootguns } from "./fix.js"; |
|
|
| const isWindows = process.platform === "win32"; |
|
|
| const expectPerms = (actual: number, expected: number) => { |
| if (isWindows) { |
| expect([expected, 0o666, 0o777]).toContain(actual); |
| return; |
| } |
| expect(actual).toBe(expected); |
| }; |
|
|
| describe("security fix", () => { |
| it("tightens groupPolicy + filesystem perms", async () => { |
| const tmp = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-security-fix-")); |
| const stateDir = path.join(tmp, "state"); |
| await fs.mkdir(stateDir, { recursive: true }); |
| await fs.chmod(stateDir, 0o755); |
|
|
| const configPath = path.join(stateDir, "openclaw.json"); |
| await fs.writeFile( |
| configPath, |
| `${JSON.stringify( |
| { |
| channels: { |
| telegram: { groupPolicy: "open" }, |
| whatsapp: { groupPolicy: "open" }, |
| discord: { groupPolicy: "open" }, |
| signal: { groupPolicy: "open" }, |
| imessage: { groupPolicy: "open" }, |
| }, |
| logging: { redactSensitive: "off" }, |
| }, |
| null, |
| 2, |
| )}\n`, |
| "utf-8", |
| ); |
| await fs.chmod(configPath, 0o644); |
|
|
| const credsDir = path.join(stateDir, "credentials"); |
| await fs.mkdir(credsDir, { recursive: true }); |
| await fs.writeFile( |
| path.join(credsDir, "whatsapp-allowFrom.json"), |
| `${JSON.stringify({ version: 1, allowFrom: [" +15551234567 "] }, null, 2)}\n`, |
| "utf-8", |
| ); |
|
|
| const env = { |
| ...process.env, |
| OPENCLAW_STATE_DIR: stateDir, |
| OPENCLAW_CONFIG_PATH: "", |
| }; |
|
|
| const res = await fixSecurityFootguns({ env }); |
| expect(res.ok).toBe(true); |
| expect(res.configWritten).toBe(true); |
| expect(res.changes).toEqual( |
| expect.arrayContaining([ |
| "channels.telegram.groupPolicy=open -> allowlist", |
| "channels.whatsapp.groupPolicy=open -> allowlist", |
| "channels.discord.groupPolicy=open -> allowlist", |
| "channels.signal.groupPolicy=open -> allowlist", |
| "channels.imessage.groupPolicy=open -> allowlist", |
| 'logging.redactSensitive=off -> "tools"', |
| ]), |
| ); |
|
|
| const stateMode = (await fs.stat(stateDir)).mode & 0o777; |
| expectPerms(stateMode, 0o700); |
|
|
| const configMode = (await fs.stat(configPath)).mode & 0o777; |
| expectPerms(configMode, 0o600); |
|
|
| const parsed = JSON.parse(await fs.readFile(configPath, "utf-8")) as Record<string, unknown>; |
| const channels = parsed.channels as Record<string, Record<string, unknown>>; |
| expect(channels.telegram.groupPolicy).toBe("allowlist"); |
| expect(channels.whatsapp.groupPolicy).toBe("allowlist"); |
| expect(channels.discord.groupPolicy).toBe("allowlist"); |
| expect(channels.signal.groupPolicy).toBe("allowlist"); |
| expect(channels.imessage.groupPolicy).toBe("allowlist"); |
|
|
| expect(channels.whatsapp.groupAllowFrom).toEqual(["+15551234567"]); |
| }); |
|
|
| it("applies allowlist per-account and seeds WhatsApp groupAllowFrom from store", async () => { |
| const tmp = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-security-fix-")); |
| const stateDir = path.join(tmp, "state"); |
| await fs.mkdir(stateDir, { recursive: true }); |
|
|
| const configPath = path.join(stateDir, "openclaw.json"); |
| await fs.writeFile( |
| configPath, |
| `${JSON.stringify( |
| { |
| channels: { |
| whatsapp: { |
| accounts: { |
| a1: { groupPolicy: "open" }, |
| }, |
| }, |
| }, |
| }, |
| null, |
| 2, |
| )}\n`, |
| "utf-8", |
| ); |
|
|
| const credsDir = path.join(stateDir, "credentials"); |
| await fs.mkdir(credsDir, { recursive: true }); |
| await fs.writeFile( |
| path.join(credsDir, "whatsapp-allowFrom.json"), |
| `${JSON.stringify({ version: 1, allowFrom: ["+15550001111"] }, null, 2)}\n`, |
| "utf-8", |
| ); |
|
|
| const env = { |
| ...process.env, |
| OPENCLAW_STATE_DIR: stateDir, |
| OPENCLAW_CONFIG_PATH: "", |
| }; |
|
|
| const res = await fixSecurityFootguns({ env }); |
| expect(res.ok).toBe(true); |
|
|
| const parsed = JSON.parse(await fs.readFile(configPath, "utf-8")) as Record<string, unknown>; |
| const channels = parsed.channels as Record<string, Record<string, unknown>>; |
| const whatsapp = channels.whatsapp; |
| const accounts = whatsapp.accounts as Record<string, Record<string, unknown>>; |
|
|
| expect(accounts.a1.groupPolicy).toBe("allowlist"); |
| expect(accounts.a1.groupAllowFrom).toEqual(["+15550001111"]); |
| }); |
|
|
| it("does not seed WhatsApp groupAllowFrom if allowFrom is set", async () => { |
| const tmp = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-security-fix-")); |
| const stateDir = path.join(tmp, "state"); |
| await fs.mkdir(stateDir, { recursive: true }); |
|
|
| const configPath = path.join(stateDir, "openclaw.json"); |
| await fs.writeFile( |
| configPath, |
| `${JSON.stringify( |
| { |
| channels: { |
| whatsapp: { groupPolicy: "open", allowFrom: ["+15552223333"] }, |
| }, |
| }, |
| null, |
| 2, |
| )}\n`, |
| "utf-8", |
| ); |
|
|
| const credsDir = path.join(stateDir, "credentials"); |
| await fs.mkdir(credsDir, { recursive: true }); |
| await fs.writeFile( |
| path.join(credsDir, "whatsapp-allowFrom.json"), |
| `${JSON.stringify({ version: 1, allowFrom: ["+15550001111"] }, null, 2)}\n`, |
| "utf-8", |
| ); |
|
|
| const env = { |
| ...process.env, |
| OPENCLAW_STATE_DIR: stateDir, |
| OPENCLAW_CONFIG_PATH: "", |
| }; |
|
|
| const res = await fixSecurityFootguns({ env }); |
| expect(res.ok).toBe(true); |
|
|
| const parsed = JSON.parse(await fs.readFile(configPath, "utf-8")) as Record<string, unknown>; |
| const channels = parsed.channels as Record<string, Record<string, unknown>>; |
| expect(channels.whatsapp.groupPolicy).toBe("allowlist"); |
| expect(channels.whatsapp.groupAllowFrom).toBeUndefined(); |
| }); |
|
|
| it("returns ok=false for invalid config but still tightens perms", async () => { |
| const tmp = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-security-fix-")); |
| const stateDir = path.join(tmp, "state"); |
| await fs.mkdir(stateDir, { recursive: true }); |
| await fs.chmod(stateDir, 0o755); |
|
|
| const configPath = path.join(stateDir, "openclaw.json"); |
| await fs.writeFile(configPath, "{ this is not json }\n", "utf-8"); |
| await fs.chmod(configPath, 0o644); |
|
|
| const env = { |
| ...process.env, |
| OPENCLAW_STATE_DIR: stateDir, |
| OPENCLAW_CONFIG_PATH: "", |
| }; |
|
|
| const res = await fixSecurityFootguns({ env }); |
| expect(res.ok).toBe(false); |
|
|
| const stateMode = (await fs.stat(stateDir)).mode & 0o777; |
| expectPerms(stateMode, 0o700); |
|
|
| const configMode = (await fs.stat(configPath)).mode & 0o777; |
| expectPerms(configMode, 0o600); |
| }); |
|
|
| it("tightens perms for credentials + agent auth/sessions + include files", async () => { |
| const tmp = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-security-fix-")); |
| const stateDir = path.join(tmp, "state"); |
| await fs.mkdir(stateDir, { recursive: true }); |
|
|
| const includesDir = path.join(stateDir, "includes"); |
| await fs.mkdir(includesDir, { recursive: true }); |
| const includePath = path.join(includesDir, "extra.json5"); |
| await fs.writeFile(includePath, "{ logging: { redactSensitive: 'off' } }\n", "utf-8"); |
| await fs.chmod(includePath, 0o644); |
|
|
| const configPath = path.join(stateDir, "openclaw.json"); |
| await fs.writeFile( |
| configPath, |
| `{ "$include": "./includes/extra.json5", channels: { whatsapp: { groupPolicy: "open" } } }\n`, |
| "utf-8", |
| ); |
| await fs.chmod(configPath, 0o644); |
|
|
| const credsDir = path.join(stateDir, "credentials"); |
| await fs.mkdir(credsDir, { recursive: true }); |
| const allowFromPath = path.join(credsDir, "whatsapp-allowFrom.json"); |
| await fs.writeFile( |
| allowFromPath, |
| `${JSON.stringify({ version: 1, allowFrom: ["+15550002222"] }, null, 2)}\n`, |
| "utf-8", |
| ); |
| await fs.chmod(allowFromPath, 0o644); |
|
|
| const agentDir = path.join(stateDir, "agents", "main", "agent"); |
| await fs.mkdir(agentDir, { recursive: true }); |
| const authProfilesPath = path.join(agentDir, "auth-profiles.json"); |
| await fs.writeFile(authProfilesPath, "{}\n", "utf-8"); |
| await fs.chmod(authProfilesPath, 0o644); |
|
|
| const sessionsDir = path.join(stateDir, "agents", "main", "sessions"); |
| await fs.mkdir(sessionsDir, { recursive: true }); |
| const sessionsStorePath = path.join(sessionsDir, "sessions.json"); |
| await fs.writeFile(sessionsStorePath, "{}\n", "utf-8"); |
| await fs.chmod(sessionsStorePath, 0o644); |
|
|
| const env = { |
| ...process.env, |
| OPENCLAW_STATE_DIR: stateDir, |
| OPENCLAW_CONFIG_PATH: "", |
| }; |
|
|
| const res = await fixSecurityFootguns({ env }); |
| expect(res.ok).toBe(true); |
|
|
| expectPerms((await fs.stat(credsDir)).mode & 0o777, 0o700); |
| expectPerms((await fs.stat(allowFromPath)).mode & 0o777, 0o600); |
| expectPerms((await fs.stat(authProfilesPath)).mode & 0o777, 0o600); |
| expectPerms((await fs.stat(sessionsStorePath)).mode & 0o777, 0o600); |
| expectPerms((await fs.stat(includePath)).mode & 0o777, 0o600); |
| }); |
| }); |
|
|