Skip to content
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.

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

fix: handles verify error #917

Merged
merged 1 commit into from
Nov 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ on:
- master
- next
- beta
- "v*.x" # maintenance release branches, e.g. v1.x
- "*.x" # maintenance release branches, e.g. 1.x
jobs:
release:
name: release
Expand Down
2 changes: 1 addition & 1 deletion src/verify-and-receive.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export async function verifyAndReceive(
? toNormalizedJsonString(event.payload)
: event.payload,
event.signature
);
).catch(() => false);

if (!matchesSignature) {
const error = new Error(
Expand Down
47 changes: 47 additions & 0 deletions test/integration/node-middleware.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -500,4 +500,51 @@ describe("createNodeMiddleware(webhooks)", () => {

server.close();
});

test("Handles invalid signature", async () => {
expect.assertions(3);

const webhooks = new Webhooks({
secret: "mySecret",
});

webhooks.onError((error) => {
expect(error.message).toContain(
"signature does not match event payload and secret"
);
});

const log = {
debug: jest.fn(),
info: jest.fn(),
warn: jest.fn(),
error: jest.fn(),
};
const middleware = createNodeMiddleware(webhooks, { log });
const server = createServer(middleware).listen();

// @ts-expect-error complains about { port } although it's included in returned AddressInfo interface
const { port } = server.address();

const response = await fetch(
`http://localhost:${port}/api/github/webhooks`,
{
method: "POST",
headers: {
"Content-Type": "application/json",
"X-GitHub-Delivery": "1",
"X-GitHub-Event": "push",
"X-Hub-Signature-256": "",
},
body: pushEventPayload,
}
);

expect(response.status).toEqual(400);
await expect(response.text()).resolves.toContain(
"Error: [@octokit/webhooks] signature does not match event payload and secret"
);

server.close();
});
});