Skip to content

docs: fix webhook signature header and pas the format check #18

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

Open
AMillionDriver wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix webhook signature header and pas the format check #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 8 additions & 7 deletions apps/docs/integrations/webhooks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ osforms sends a `POST` request with `Content-Type: application/json`:

## Verifying signatures

Every request includes an `X-osforms-Signature-256` header:
Every request includes an `X-osforms-Signature` header:

```
X-osforms-Signature-256: sha256=<hex>
X-osforms-Signature: <hex>
```

The signature is computed as `HMAC-SHA256(requestBody, signingSecret)` where `requestBody` is the raw JSON string.
Expand All @@ -51,16 +51,17 @@ function verifySignature(
signature: string,
secret: string
): boolean {
const expected =
'sha256=' +
crypto.createHmac('sha256', secret).update(rawBody).digest('hex');
const expected = crypto
.createHmac('sha256', secret)
.update(rawBody)
.digest('hex');

return crypto.timingSafeEqual(Buffer.from(signature), Buffer.from(expected));
return crypto.timingSafeEqual(signatureBuffer, expectedBuffer);
}

// Express example
app.post('/webhook', express.raw({ type: 'application/json' }), (req, res) => {
const sig = req.headers['x-osforms-signature-256'] as string;
const sig = req.headers['x-osforms-signature'] as string;
if (!verifySignature(req.body.toString(), sig, process.env.WEBHOOK_SECRET!)) {
return res.status(401).json({ error: 'Invalid signature' });
}
Expand Down