Add option to skip signature verification #595
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
Yang-33
reviewed
Jul 4, 2025
examples/echo_bot/server.go
Outdated
Comment on lines
41
to
43
| cb, err := webhook.ParseRequestWithOption(channelSecret, req, &webhook.ParseOption{ | ||
| SkipSignatureValidation: func() bool { return true }, | ||
| }) |
There was a problem hiding this comment.
Normally, webhook signature verification "should" be done. Providing examples that skip it might lead to uninformed users using this, so please do not offer it as an example.
| func ParseRequest(channelSecret string, r *http.Request) (*CallbackRequest, error) { | ||
| return ParseRequestWithOption(channelSecret, r, nil) | ||
| } | ||
|
|
There was a problem hiding this comment.
Can you do these like the Java SDK?
- Write comments explaining why users need this option in
ParseRequestWithOption/when it should be used. - Indicate to
ParseRequestusers that there is a version where the option can be utilized. - Write sufficient tests.
habara-k
force-pushed
the
allow-to-skip-signature-verification
branch
from
4fe9ebf to
fa77c70
Compare
Yang-33
reviewed
Jul 9, 2025
Comment on lines
+18
to
+26
| type ParseOption struct { | ||
| // SkipSignatureValidation is a function that determines whether to skip | ||
| // webhook signature verification. | ||
| // | ||
| // If the function returns true, the signature verification step is skipped. | ||
| // This can be useful in scenarios such as when you're in the process of updating | ||
| // the channel secret and need to temporarily bypass verification to avoid disruptions. | ||
| SkipSignatureValidation func() bool | ||
| } |
There was a problem hiding this comment.
When adding another option later, would it always require a major version upgrade? I think it's better to ensure the code works seamlessly with users' existing builds, even when adding another option.
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.
Changes
Motivation
The signature returned with webhooks is calculated using a single channel secret. If the bot owner changes their channel secret, the signature for webhooks starts being calculated using the new channel secret. To avoid signature verification failures, the bot owner must update the channel secret on their server, which is used for signature verification. However, if there is a timing mismatch in the update—and such a mismatch is almost unavoidable—verification will fail during that period.
In such cases, having an option to skip signature verification for webhooks would be a convenient way to avoid these issues.
Related PRs