mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-08 00:31:24 +00:00
fix: enforce hooks token separation from gateway auth (#20813)
* fix(an-03): apply security fix Generated by staged fix workflow. * fix(an-03): apply security fix Generated by staged fix workflow. * fix(an-03): remove stale test-link artifact from patch Remove accidental a2ui test-link artifact from the tracked diff and keep startup auth enforcement centralized in startup-auth.ts.
This commit is contained in:
@@ -13,7 +13,10 @@ vi.mock("../config/config.js", async (importOriginal) => {
|
||||
};
|
||||
});
|
||||
|
||||
import { ensureGatewayStartupAuth } from "./startup-auth.js";
|
||||
import {
|
||||
assertHooksTokenSeparateFromGatewayAuth,
|
||||
ensureGatewayStartupAuth,
|
||||
} from "./startup-auth.js";
|
||||
|
||||
describe("ensureGatewayStartupAuth", () => {
|
||||
async function expectEphemeralGeneratedTokenWhenOverridden(cfg: OpenClawConfig) {
|
||||
@@ -188,4 +191,79 @@ describe("ensureGatewayStartupAuth", () => {
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
it("throws when hooks token reuses gateway token resolved from env", async () => {
|
||||
await expect(
|
||||
ensureGatewayStartupAuth({
|
||||
cfg: {
|
||||
hooks: {
|
||||
enabled: true,
|
||||
token: "shared-gateway-token-1234567890",
|
||||
},
|
||||
},
|
||||
env: {
|
||||
OPENCLAW_GATEWAY_TOKEN: "shared-gateway-token-1234567890",
|
||||
} as NodeJS.ProcessEnv,
|
||||
}),
|
||||
).rejects.toThrow(/hooks\.token must not match gateway auth token/i);
|
||||
});
|
||||
});
|
||||
|
||||
describe("assertHooksTokenSeparateFromGatewayAuth", () => {
|
||||
it("throws when hooks token reuses gateway token auth", () => {
|
||||
expect(() =>
|
||||
assertHooksTokenSeparateFromGatewayAuth({
|
||||
cfg: {
|
||||
hooks: {
|
||||
enabled: true,
|
||||
token: "shared-gateway-token-1234567890",
|
||||
},
|
||||
},
|
||||
auth: {
|
||||
mode: "token",
|
||||
modeSource: "config",
|
||||
token: "shared-gateway-token-1234567890",
|
||||
allowTailscale: false,
|
||||
},
|
||||
}),
|
||||
).toThrow(/hooks\.token must not match gateway auth token/i);
|
||||
});
|
||||
|
||||
it("allows hooks token when gateway auth is not token mode", () => {
|
||||
expect(() =>
|
||||
assertHooksTokenSeparateFromGatewayAuth({
|
||||
cfg: {
|
||||
hooks: {
|
||||
enabled: true,
|
||||
token: "shared-gateway-token-1234567890",
|
||||
},
|
||||
},
|
||||
auth: {
|
||||
mode: "password",
|
||||
modeSource: "config",
|
||||
password: "pw",
|
||||
allowTailscale: false,
|
||||
},
|
||||
}),
|
||||
).not.toThrow();
|
||||
});
|
||||
|
||||
it("allows matching values when hooks are disabled", () => {
|
||||
expect(() =>
|
||||
assertHooksTokenSeparateFromGatewayAuth({
|
||||
cfg: {
|
||||
hooks: {
|
||||
enabled: false,
|
||||
token: "shared-gateway-token-1234567890",
|
||||
},
|
||||
},
|
||||
auth: {
|
||||
mode: "token",
|
||||
modeSource: "config",
|
||||
token: "shared-gateway-token-1234567890",
|
||||
allowTailscale: false,
|
||||
},
|
||||
}),
|
||||
).not.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
@@ -109,6 +109,7 @@ export async function ensureGatewayStartupAuth(params: {
|
||||
tailscaleOverride: params.tailscaleOverride,
|
||||
});
|
||||
if (resolved.mode !== "token" || (resolved.token?.trim().length ?? 0) > 0) {
|
||||
assertHooksTokenSeparateFromGatewayAuth({ cfg: params.cfg, auth: resolved });
|
||||
return { cfg: params.cfg, auth: resolved, persistedGeneratedToken: false };
|
||||
}
|
||||
|
||||
@@ -138,6 +139,7 @@ export async function ensureGatewayStartupAuth(params: {
|
||||
authOverride: params.authOverride,
|
||||
tailscaleOverride: params.tailscaleOverride,
|
||||
});
|
||||
assertHooksTokenSeparateFromGatewayAuth({ cfg: nextCfg, auth: nextAuth });
|
||||
return {
|
||||
cfg: nextCfg,
|
||||
auth: nextAuth,
|
||||
@@ -145,3 +147,30 @@ export async function ensureGatewayStartupAuth(params: {
|
||||
persistedGeneratedToken: persist,
|
||||
};
|
||||
}
|
||||
|
||||
export function assertHooksTokenSeparateFromGatewayAuth(params: {
|
||||
cfg: OpenClawConfig;
|
||||
auth: ResolvedGatewayAuth;
|
||||
}): void {
|
||||
if (params.cfg.hooks?.enabled !== true) {
|
||||
return;
|
||||
}
|
||||
const hooksToken =
|
||||
typeof params.cfg.hooks.token === "string" ? params.cfg.hooks.token.trim() : "";
|
||||
if (!hooksToken) {
|
||||
return;
|
||||
}
|
||||
const gatewayToken =
|
||||
params.auth.mode === "token" && typeof params.auth.token === "string"
|
||||
? params.auth.token.trim()
|
||||
: "";
|
||||
if (!gatewayToken) {
|
||||
return;
|
||||
}
|
||||
if (hooksToken !== gatewayToken) {
|
||||
return;
|
||||
}
|
||||
throw new Error(
|
||||
"Invalid config: hooks.token must not match gateway auth token. Set a distinct hooks.token for hook ingress.",
|
||||
);
|
||||
}
|
||||
|
||||
@@ -441,7 +441,7 @@ export function collectHooksHardeningFindings(
|
||||
if (token && gatewayToken && token === gatewayToken) {
|
||||
findings.push({
|
||||
checkId: "hooks.token_reuse_gateway_token",
|
||||
severity: "warn",
|
||||
severity: "critical",
|
||||
title: "Hooks token reuses the Gateway token",
|
||||
detail:
|
||||
"hooks.token matches gateway.auth token; compromise of hooks expands blast radius to the Gateway API.",
|
||||
|
||||
@@ -1356,7 +1356,7 @@ describe("security audit", () => {
|
||||
);
|
||||
});
|
||||
|
||||
it("warns when hooks token reuses the gateway env token", async () => {
|
||||
it("flags hooks token reuse of the gateway env token as critical", async () => {
|
||||
const prevToken = process.env.OPENCLAW_GATEWAY_TOKEN;
|
||||
process.env.OPENCLAW_GATEWAY_TOKEN = "shared-gateway-token-1234567890";
|
||||
const cfg: OpenClawConfig = {
|
||||
@@ -1372,7 +1372,10 @@ describe("security audit", () => {
|
||||
|
||||
expect(res.findings).toEqual(
|
||||
expect.arrayContaining([
|
||||
expect.objectContaining({ checkId: "hooks.token_reuse_gateway_token", severity: "warn" }),
|
||||
expect.objectContaining({
|
||||
checkId: "hooks.token_reuse_gateway_token",
|
||||
severity: "critical",
|
||||
}),
|
||||
]),
|
||||
);
|
||||
} finally {
|
||||
|
||||
Reference in New Issue
Block a user