mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-09 16:10:43 +00:00
* fix(googlechat): log webhook auth reject reasons and warn on appPrincipal misconfig Closes #71078 Webhook auth failures previously returned 401 with no log line, leaving operators no signal to diagnose. Additionally, app-url audience requires a numeric OAuth 2.0 client ID as appPrincipal, but a misconfigured email or empty value silently caused all requests to be rejected. Changes: - Log a WARN with accountId and reject reason when verifyGoogleChatRequest fails. - Add warnAppPrincipalMisconfiguration() called at provider init: warns when audienceType=app-url and appPrincipal is missing or contains '@'. Tests: +9 cases in monitor-webhook.test.ts (3 reject-reason scenarios + 4 warner cases). * fix(googlechat): defer auth rejection logs * docs: note googlechat webhook auth fix --------- Co-authored-by: luyao618 <luyao618@users.noreply.github.com> Co-authored-by: Peter Steinberger <steipete@gmail.com>
286 lines
9.1 KiB
TypeScript
286 lines
9.1 KiB
TypeScript
import type { IncomingMessage, ServerResponse } from "node:http";
|
|
import { normalizeLowercaseStringOrEmpty } from "openclaw/plugin-sdk/text-runtime";
|
|
import type { WebhookInFlightLimiter } from "openclaw/plugin-sdk/webhook-request-guards";
|
|
import { readJsonWebhookBodyOrReject } from "openclaw/plugin-sdk/webhook-request-guards";
|
|
import {
|
|
resolveWebhookTargetWithAuthOrReject,
|
|
withResolvedWebhookRequestPipeline,
|
|
} from "openclaw/plugin-sdk/webhook-targets";
|
|
import { verifyGoogleChatRequest } from "./auth.js";
|
|
import type { WebhookTarget } from "./monitor-types.js";
|
|
import type {
|
|
GoogleChatEvent,
|
|
GoogleChatMessage,
|
|
GoogleChatSpace,
|
|
GoogleChatUser,
|
|
} from "./types.js";
|
|
|
|
function extractBearerToken(header: unknown): string {
|
|
const authHeader = Array.isArray(header)
|
|
? typeof header[0] === "string"
|
|
? header[0]
|
|
: ""
|
|
: typeof header === "string"
|
|
? header
|
|
: "";
|
|
return normalizeLowercaseStringOrEmpty(authHeader).startsWith("bearer ")
|
|
? authHeader.slice("bearer ".length).trim()
|
|
: "";
|
|
}
|
|
|
|
const ADD_ON_PREAUTH_MAX_BYTES = 16 * 1024;
|
|
const ADD_ON_PREAUTH_TIMEOUT_MS = 3_000;
|
|
|
|
type ParsedGoogleChatInboundPayload =
|
|
| { ok: true; event: GoogleChatEvent; addOnBearerToken: string }
|
|
| { ok: false };
|
|
type ParsedGoogleChatInboundSuccess = Extract<ParsedGoogleChatInboundPayload, { ok: true }>;
|
|
|
|
function parseGoogleChatInboundPayload(
|
|
raw: unknown,
|
|
res: ServerResponse,
|
|
): ParsedGoogleChatInboundPayload {
|
|
if (!raw || typeof raw !== "object" || Array.isArray(raw)) {
|
|
res.statusCode = 400;
|
|
res.end("invalid payload");
|
|
return { ok: false };
|
|
}
|
|
|
|
let eventPayload = raw;
|
|
let addOnBearerToken = "";
|
|
|
|
// Transform Google Workspace Add-on format to standard Chat API format.
|
|
const rawObj = raw as {
|
|
commonEventObject?: { hostApp?: string };
|
|
chat?: {
|
|
messagePayload?: { space?: GoogleChatSpace; message?: GoogleChatMessage };
|
|
user?: GoogleChatUser;
|
|
eventTime?: string;
|
|
};
|
|
authorizationEventObject?: { systemIdToken?: string };
|
|
};
|
|
|
|
if (rawObj.commonEventObject?.hostApp === "CHAT" && rawObj.chat?.messagePayload) {
|
|
const chat = rawObj.chat;
|
|
const messagePayload = chat.messagePayload;
|
|
eventPayload = {
|
|
type: "MESSAGE",
|
|
space: messagePayload?.space,
|
|
message: messagePayload?.message,
|
|
user: chat.user,
|
|
eventTime: chat.eventTime,
|
|
};
|
|
addOnBearerToken =
|
|
typeof rawObj.authorizationEventObject?.systemIdToken === "string"
|
|
? rawObj.authorizationEventObject.systemIdToken.trim()
|
|
: "";
|
|
}
|
|
|
|
const event = eventPayload as GoogleChatEvent;
|
|
const eventType = event.type ?? (eventPayload as { eventType?: string }).eventType;
|
|
if (typeof eventType !== "string") {
|
|
res.statusCode = 400;
|
|
res.end("invalid payload");
|
|
return { ok: false };
|
|
}
|
|
|
|
if (!event.space || typeof event.space !== "object" || Array.isArray(event.space)) {
|
|
res.statusCode = 400;
|
|
res.end("invalid payload");
|
|
return { ok: false };
|
|
}
|
|
|
|
if (eventType === "MESSAGE") {
|
|
if (!event.message || typeof event.message !== "object" || Array.isArray(event.message)) {
|
|
res.statusCode = 400;
|
|
res.end("invalid payload");
|
|
return { ok: false };
|
|
}
|
|
}
|
|
|
|
return { ok: true, event, addOnBearerToken };
|
|
}
|
|
|
|
type GoogleChatWebhookAuthRejection = {
|
|
target: WebhookTarget;
|
|
reason: string;
|
|
};
|
|
|
|
async function verifyGoogleChatTargetAuth(
|
|
target: WebhookTarget,
|
|
bearer: string,
|
|
): Promise<{ ok: true } | { ok: false; reason: string }> {
|
|
const verification = await verifyGoogleChatRequest({
|
|
bearer,
|
|
audienceType: target.audienceType,
|
|
audience: target.audience,
|
|
expectedAddOnPrincipal: target.account.config.appPrincipal,
|
|
});
|
|
return verification.ok ? { ok: true } : { ok: false, reason: verification.reason ?? "unknown" };
|
|
}
|
|
|
|
function logGoogleChatWebhookAuthRejections(rejections: GoogleChatWebhookAuthRejection[]): void {
|
|
for (const rejection of rejections) {
|
|
rejection.target.runtime.log?.(
|
|
`[${rejection.target.account.accountId}] Google Chat webhook auth rejected: ${rejection.reason}`,
|
|
);
|
|
}
|
|
}
|
|
|
|
function logGoogleChatWebhookAuthRejectedForTargets(
|
|
targets: readonly WebhookTarget[],
|
|
reason: string,
|
|
): void {
|
|
logGoogleChatWebhookAuthRejections(targets.map((target) => ({ target, reason })));
|
|
}
|
|
|
|
async function resolveGoogleChatWebhookTargetWithAuthOrReject(params: {
|
|
targets: readonly WebhookTarget[];
|
|
res: ServerResponse;
|
|
bearer: string;
|
|
}): Promise<WebhookTarget | null> {
|
|
const rejections: GoogleChatWebhookAuthRejection[] = [];
|
|
let verifiedTargetCount = 0;
|
|
const selectedTarget = await resolveWebhookTargetWithAuthOrReject({
|
|
targets: params.targets,
|
|
res: params.res,
|
|
isMatch: async (target) => {
|
|
const verification = await verifyGoogleChatTargetAuth(target, params.bearer);
|
|
if (verification.ok) {
|
|
verifiedTargetCount += 1;
|
|
return true;
|
|
}
|
|
rejections.push({ target, reason: verification.reason });
|
|
return false;
|
|
},
|
|
});
|
|
if (!selectedTarget && verifiedTargetCount === 0) {
|
|
logGoogleChatWebhookAuthRejections(rejections);
|
|
}
|
|
return selectedTarget;
|
|
}
|
|
|
|
export function warnAppPrincipalMisconfiguration(params: {
|
|
accountId: string;
|
|
audienceType?: string;
|
|
appPrincipal?: string | null;
|
|
log?: (message: string) => void;
|
|
}): void {
|
|
if (params.audienceType !== "app-url") {
|
|
return;
|
|
}
|
|
const principal = params.appPrincipal?.trim();
|
|
if (!principal) {
|
|
params.log?.(
|
|
`[${params.accountId}] appPrincipal is missing for audienceType "app-url"; add-on token verification will fail. Set appPrincipal to the numeric OAuth 2.0 client ID (uniqueId, 21 digits), not an email.`,
|
|
);
|
|
} else if (principal.includes("@")) {
|
|
params.log?.(
|
|
`[${params.accountId}] appPrincipal "${principal}" looks like an email address. Set appPrincipal to the numeric OAuth 2.0 client ID (uniqueId, 21 digits), not an email.`,
|
|
);
|
|
}
|
|
}
|
|
|
|
export function createGoogleChatWebhookRequestHandler(params: {
|
|
webhookTargets: Map<string, WebhookTarget[]>;
|
|
webhookInFlightLimiter: WebhookInFlightLimiter;
|
|
processEvent: (event: GoogleChatEvent, target: WebhookTarget) => Promise<void>;
|
|
}): (req: IncomingMessage, res: ServerResponse) => Promise<boolean> {
|
|
return async (req: IncomingMessage, res: ServerResponse): Promise<boolean> => {
|
|
return await withResolvedWebhookRequestPipeline({
|
|
req,
|
|
res,
|
|
targetsByPath: params.webhookTargets,
|
|
allowMethods: ["POST"],
|
|
requireJsonContentType: true,
|
|
inFlightLimiter: params.webhookInFlightLimiter,
|
|
handle: async ({ targets }) => {
|
|
const headerBearer = extractBearerToken(req.headers.authorization);
|
|
let selectedTarget: WebhookTarget | null = null;
|
|
let parsedEvent: GoogleChatEvent | null = null;
|
|
const readAndParseEvent = async (
|
|
profile: "pre-auth" | "post-auth",
|
|
): Promise<ParsedGoogleChatInboundSuccess | null> => {
|
|
const body = await readJsonWebhookBodyOrReject({
|
|
req,
|
|
res,
|
|
profile,
|
|
...(profile === "pre-auth"
|
|
? {
|
|
maxBytes: ADD_ON_PREAUTH_MAX_BYTES,
|
|
timeoutMs: ADD_ON_PREAUTH_TIMEOUT_MS,
|
|
}
|
|
: {}),
|
|
emptyObjectOnEmpty: false,
|
|
invalidJsonMessage: "invalid payload",
|
|
});
|
|
if (!body.ok) {
|
|
return null;
|
|
}
|
|
|
|
const parsed = parseGoogleChatInboundPayload(body.value, res);
|
|
return parsed.ok ? parsed : null;
|
|
};
|
|
|
|
if (headerBearer) {
|
|
selectedTarget = await resolveGoogleChatWebhookTargetWithAuthOrReject({
|
|
targets,
|
|
res,
|
|
bearer: headerBearer,
|
|
});
|
|
if (!selectedTarget) {
|
|
return true;
|
|
}
|
|
|
|
const parsed = await readAndParseEvent("post-auth");
|
|
if (!parsed) {
|
|
return true;
|
|
}
|
|
parsedEvent = parsed.event;
|
|
} else {
|
|
const parsed = await readAndParseEvent("pre-auth");
|
|
if (!parsed) {
|
|
return true;
|
|
}
|
|
parsedEvent = parsed.event;
|
|
|
|
if (!parsed.addOnBearerToken) {
|
|
logGoogleChatWebhookAuthRejectedForTargets(targets, "missing token");
|
|
res.statusCode = 401;
|
|
res.end("unauthorized");
|
|
return true;
|
|
}
|
|
|
|
selectedTarget = await resolveGoogleChatWebhookTargetWithAuthOrReject({
|
|
targets,
|
|
res,
|
|
bearer: parsed.addOnBearerToken,
|
|
});
|
|
if (!selectedTarget) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
if (!selectedTarget || !parsedEvent) {
|
|
res.statusCode = 401;
|
|
res.end("unauthorized");
|
|
return true;
|
|
}
|
|
|
|
const dispatchTarget = selectedTarget;
|
|
dispatchTarget.statusSink?.({ lastInboundAt: Date.now() });
|
|
params.processEvent(parsedEvent, dispatchTarget).catch((err) => {
|
|
dispatchTarget.runtime.error?.(
|
|
`[${dispatchTarget.account.accountId}] Google Chat webhook failed: ${String(err)}`,
|
|
);
|
|
});
|
|
|
|
res.statusCode = 200;
|
|
res.setHeader("Content-Type", "application/json");
|
|
res.end("{}");
|
|
return true;
|
|
},
|
|
});
|
|
};
|
|
}
|