feat(webhooks): export verifyWebhookSignature and WebhookVerificationError from index (Fixes #617) - #806
Draft
s6pa1rta3n-lab wants to merge 1 commit into
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #617
/claim #617
Description
This PR exposes
verifyWebhookSignatureandWebhookVerificationErroras first-class standalone exports fromsrc/webhooks/verify.tsandsrc/index.ts, allowing consumers to directly verify incoming webhook payloads without manual copying of cryptographic verification logic.Summary of Changes
src/webhooks/verify.ts:verifyWebhookSignature(payload: string, signature: string, secret: string): boolean.crypto.createHmac('sha256', secret).update(payload).digest('hex')) and constant-time comparison viacrypto.timingSafeEqualto prevent timing side-channel attacks.falsewithout throwing.WebhookVerificationErrorclass (extendingStellarSplitError) with static.verify(...)and.assert(...)helper methods, as well asassertWebhookSignaturestandalone helper.src/errors.ts: AddedWebhookVerificationErrorto SDK typed errors.src/index.ts: ExportedverifyWebhookSignature,WebhookVerificationError,assertWebhookSignature,WebhookAgent, andWEBHOOK_SIGNATURE_HEADER.test/webhookVerify.test.ts: Comprehensive unit test suite covering valid HMAC signatures, case-insensitivity, invalid secrets, tampered payloads, length mismatches, odd-length signatures, malformed hex, non-string arguments, andWebhookVerificationErrorassertions.Acceptance Criteria Checklist
verifyWebhookSignature(payload: string, signature: string, secret: string): booleanexported fromsrc/webhooks/verify.tscrypto.createHmac('sha256', secret).update(payload).digest('hex')and compares withsignatureusing a timing-safe comparison (crypto.timingSafeEqual)false(never throws) when signature is malformed or lengths differWebhookVerificationErrorclass exported for consumers who prefer throwing — wrapsverifyWebhookSignatureand throws if it returnsfalsesrc/index.tsPayout Routing
0xF46C9F6d70C50BF81ef3588AB523a90a594a2F89GCL6OXAMLD75BMTINA6EMRUDWK5THQUSHMYNLSNBCJAPZJHNYJTUNIBC