LINE auth boundary hardening synthesis for inbound webhook authn/z/authz: - account-scoped pairing-store access - strict DM/group allowlist boundary separation - fail-closed webhook auth/runtime behavior - replay and duplicate handling with in-flight continuity for concurrent redeliveries Source PRs: #26701, #26683, #25978, #17593, #16619, #31990, #26047, #30584, #18777 Related continuity context: #21955 Co-authored-by: bmendonca3 <208517100+bmendonca3@users.noreply.github.com> Co-authored-by: davidahmann <46606159+davidahmann@users.noreply.github.com> Co-authored-by: harshang03 <58983401+harshang03@users.noreply.github.com> Co-authored-by: haosenwang1018 <167664334+haosenwang1018@users.noreply.github.com> Co-authored-by: liuxiaopai-ai <73659136+liuxiaopai-ai@users.noreply.github.com> Co-authored-by: coygeek <65363919+coygeek@users.noreply.github.com> Co-authored-by: lailoo <20536249+lailoo@users.noreply.github.com>
152 lines
5.2 KiB
TypeScript
152 lines
5.2 KiB
TypeScript
import crypto from "node:crypto";
|
|
import type { WebhookRequestBody } from "@line/bot-sdk";
|
|
import { describe, expect, it, vi } from "vitest";
|
|
import { createLineWebhookMiddleware, startLineWebhook } from "./webhook.js";
|
|
|
|
const sign = (body: string, secret: string) =>
|
|
crypto.createHmac("SHA256", secret).update(body).digest("base64");
|
|
|
|
const createRes = () => {
|
|
const res = {
|
|
status: vi.fn(),
|
|
json: vi.fn(),
|
|
headersSent: false,
|
|
// oxlint-disable-next-line typescript/no-explicit-any
|
|
} as any;
|
|
res.status.mockReturnValue(res);
|
|
res.json.mockReturnValue(res);
|
|
return res;
|
|
};
|
|
|
|
const SECRET = "secret";
|
|
|
|
async function invokeWebhook(params: {
|
|
body: unknown;
|
|
headers?: Record<string, string>;
|
|
onEvents?: ReturnType<typeof vi.fn>;
|
|
autoSign?: boolean;
|
|
}) {
|
|
const onEventsMock = params.onEvents ?? vi.fn(async () => {});
|
|
const middleware = createLineWebhookMiddleware({
|
|
channelSecret: SECRET,
|
|
onEvents: onEventsMock as unknown as (body: WebhookRequestBody) => Promise<void>,
|
|
});
|
|
|
|
const headers = { ...params.headers };
|
|
const autoSign = params.autoSign ?? true;
|
|
if (autoSign && !headers["x-line-signature"]) {
|
|
if (typeof params.body === "string") {
|
|
headers["x-line-signature"] = sign(params.body, SECRET);
|
|
} else if (Buffer.isBuffer(params.body)) {
|
|
headers["x-line-signature"] = sign(params.body.toString("utf-8"), SECRET);
|
|
}
|
|
}
|
|
|
|
const req = {
|
|
headers,
|
|
body: params.body,
|
|
// oxlint-disable-next-line typescript/no-explicit-any
|
|
} as any;
|
|
const res = createRes();
|
|
// oxlint-disable-next-line typescript/no-explicit-any
|
|
await middleware(req, res, {} as any);
|
|
return { res, onEvents: onEventsMock };
|
|
}
|
|
|
|
describe("createLineWebhookMiddleware", () => {
|
|
it("rejects startup when channel secret is missing", () => {
|
|
expect(() =>
|
|
startLineWebhook({
|
|
channelSecret: " ",
|
|
onEvents: async () => {},
|
|
}),
|
|
).toThrow(/requires a non-empty channel secret/i);
|
|
});
|
|
|
|
it.each([
|
|
["raw string body", JSON.stringify({ events: [{ type: "message" }] })],
|
|
["raw buffer body", Buffer.from(JSON.stringify({ events: [{ type: "follow" }] }), "utf-8")],
|
|
])("parses JSON from %s", async (_label, body) => {
|
|
const { res, onEvents } = await invokeWebhook({ body });
|
|
expect(res.status).toHaveBeenCalledWith(200);
|
|
expect(onEvents).toHaveBeenCalledWith(expect.objectContaining({ events: expect.any(Array) }));
|
|
});
|
|
|
|
it("rejects invalid JSON payloads", async () => {
|
|
const { res, onEvents } = await invokeWebhook({ body: "not json" });
|
|
expect(res.status).toHaveBeenCalledWith(400);
|
|
expect(onEvents).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("rejects webhooks with invalid signatures", async () => {
|
|
const { res, onEvents } = await invokeWebhook({
|
|
body: JSON.stringify({ events: [{ type: "message" }] }),
|
|
headers: { "x-line-signature": "invalid-signature" },
|
|
});
|
|
expect(res.status).toHaveBeenCalledWith(401);
|
|
expect(onEvents).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("returns 200 for verification request (empty events, no signature)", async () => {
|
|
const { res, onEvents } = await invokeWebhook({
|
|
body: JSON.stringify({ events: [] }),
|
|
headers: {},
|
|
autoSign: false,
|
|
});
|
|
expect(res.status).toHaveBeenCalledWith(200);
|
|
expect(res.json).toHaveBeenCalledWith({ status: "ok" });
|
|
expect(onEvents).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("rejects missing signature when events are non-empty", async () => {
|
|
const { res, onEvents } = await invokeWebhook({
|
|
body: JSON.stringify({ events: [{ type: "message" }] }),
|
|
headers: {},
|
|
autoSign: false,
|
|
});
|
|
expect(res.status).toHaveBeenCalledWith(400);
|
|
expect(res.json).toHaveBeenCalledWith({ error: "Missing X-Line-Signature header" });
|
|
expect(onEvents).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("rejects signed requests when raw body is missing", async () => {
|
|
const { res, onEvents } = await invokeWebhook({
|
|
body: { events: [{ type: "message" }] },
|
|
headers: { "x-line-signature": "signed" },
|
|
});
|
|
expect(res.status).toHaveBeenCalledWith(400);
|
|
expect(res.json).toHaveBeenCalledWith({
|
|
error: "Missing raw request body for signature verification",
|
|
});
|
|
expect(onEvents).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("returns 500 when event processing fails and does not acknowledge with 200", async () => {
|
|
const onEvents = vi.fn(async () => {
|
|
throw new Error("boom");
|
|
});
|
|
const runtime = { log: vi.fn(), error: vi.fn(), exit: vi.fn() };
|
|
const rawBody = JSON.stringify({ events: [{ type: "message" }] });
|
|
const middleware = createLineWebhookMiddleware({
|
|
channelSecret: SECRET,
|
|
onEvents,
|
|
runtime,
|
|
});
|
|
|
|
const req = {
|
|
headers: { "x-line-signature": sign(rawBody, SECRET) },
|
|
body: rawBody,
|
|
// oxlint-disable-next-line typescript/no-explicit-any
|
|
} as any;
|
|
const res = createRes();
|
|
|
|
// oxlint-disable-next-line typescript/no-explicit-any
|
|
await middleware(req, res, {} as any);
|
|
|
|
expect(res.status).toHaveBeenCalledWith(500);
|
|
expect(res.status).not.toHaveBeenCalledWith(200);
|
|
expect(res.json).toHaveBeenCalledWith({ error: "Internal server error" });
|
|
expect(runtime.error).toHaveBeenCalled();
|
|
});
|
|
});
|