Add option to skip signature verification #595
Conversation
examples/echo_bot/server.go
Outdated
| 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
| 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.
There was a problem hiding this comment.
To make sure this change doesn't break existing code that uses the current line-bot-sdk-go, I also added tests for the existing ParseRequest (without options). d12c7df
There was a problem hiding this comment.
thank you.
Once again: Would adding an option in another change cause any issues in your land(like compile fails)?
type ParseOption struct {
SkipSignatureValidation func() bool
+ SomethingNew func() bool // Adding this later may cause compile error in your land? or not?
}
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