Correct the VerifyWebhookSignature method to use the WebhookSigningKey as the signature key #321
Conversation
This file contains 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
…y as the signature key, instead of incorrectly using the APIKey as the signature key.
vtopc
requested changes
Sep 15, 2024
| client *http.Client | ||
| baseURL string | ||
| overrideHeaders map[string]string | ||
| capturedCurlOutput string | ||
| } | ||
|
|
||
| // NewMailGun creates a new client instance. | ||
| func NewMailgun(domain, apiKey string) *MailgunImpl { | ||
| // If you need to verify whether a Webhook originates from Mailgun, the webhookSigningKey is required. | ||
| func NewMailgun(domain, apiKey string, webhookSigningKey ...string) *MailgunImpl { |
There was a problem hiding this comment.
What if we needed some other keys later?
Ideally, this should be an option, but they are slow(https://www.evanjones.ca/go-functional-options-slow.html)
So having some (mg *MailgunImpl) SetWebhookSigningKey(string) should be OK.
Comment on lines
+124
to
+126
| if mg.WebhookSigningKey() == "" { | ||
| return false, fmt.Errorf("webhook signing key not set") | ||
| } |
There was a problem hiding this comment.
This is kind of a breaking change, it is better to fall back to the API key.
Maybe with some TODO(v5): to remove the fallback in the future.
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.
Correct the VerifyWebhookSignature method to use the WebhookSigningKey as the signature key, instead of incorrectly using the APIKey as the signature key.