Skip to content

UD-12010 updated webhook verify to be more secure #522

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Aug 5, 2025
Merged

UD-12010 updated webhook verify to be more secure #522

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b57c361
updated webhook verify to be more secure
Yaniv-Nimni Aug 4, 2025
6917da0
update error message
Yaniv-Nimni Aug 4, 2025
5bdbafa
change test params
Yaniv-Nimni Aug 5, 2025
6e54fef
Merge branch 'main' into update-webhook-verify
ilyamerman Aug 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion resources/webhooks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,11 @@ export class Webhooks extends BaseResource {
}

public verify(signature: string, secret: string, payload: any) {
const signatureBuffer = Buffer.from(signature, "base64")
const hmac = crypto.createHmac("sha1", secret)
hmac.update(JSON.stringify(payload))
return hmac.digest("base64") == signature

return crypto.timingSafeEqual(hmac.digest(), signatureBuffer)
Comment on lines +48 to +49
Copy link

Copilot AI Aug 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comparison will fail because hmac.digest() returns a Buffer while signatureBuffer is created from base64. Both should use the same encoding - either both as base64 strings or both as raw Buffers. Consider using hmac.digest('base64') or converting signatureBuffer to raw bytes.

Suggested change
return crypto.timingSafeEqual(hmac.digest(), signatureBuffer)
const computedSignatureBuffer = Buffer.from(hmac.digest('base64'), 'base64')
return crypto.timingSafeEqual(computedSignatureBuffer, signatureBuffer)

Copilot uses AI. Check for mistakes.
}
}

Expand Down
11 changes: 11 additions & 0 deletions tests/webhooks.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,15 @@ describe("Get Webhook Test", () => {
expect(res.data.type === "webhook").toBeTruthy()
})
})
})

describe("Verify Webhook test", () => {
test("verify webhook signature", () => {
const signature = "UUNz8ch1Ovjg+ijXUEwlAlWEktU="
const secret = "OB2HL5E3B4HJ7IVXRNL4YQKYIQIVJK36ZZLPZEFWZVSDSC7LLFJQ===="
const payload = {"data":[{"id":"46306092","type":"application.approved","attributes":{"createdAt":"2025-08-05T06:48:38.957Z","tags":{"key":"another-tag","test":"webhook-tag","number":"111"}},"relationships":{"application":{"data":{"id":"3895367","type":"individualApplication"}},"customer":{"data":{"id":"3310133","type":"individualCustomer"}}}}]}

const verifyResult = unit.webhooks.verify(signature, secret, payload)
expect(verifyResult).toBeTruthy()
})
})
Loading