Skip to content
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.

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

notification/webhook: all webhooks are signed by a new set of signing keys #4225

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

EvanMerlock
Copy link
Collaborator

@EvanMerlock EvanMerlock commented Dec 22, 2024

  • Identified the issue which this PR solves.
  • Read the CONTRIBUTING document.
  • Code builds clean without any errors or warnings.
  • Added appropriate tests for any new functionality.
  • All new and existing tests passed.
  • Added comments in the code, where necessary.
  • Ran make check to catch common errors. Fixed any that came up.

Description:
This PR:

  • initializes a new set of signing keys for the webhook delivery method
  • ensures that every outgoing webhook is signed
  • ensures that the signature is included in X-Webhook-Signature, converting the raw binary signature to base64

Which issue(s) this PR fixes:
Part of #4224

Out of Scope:

  • API changes to expose the public signing key
  • API changes to allow for the rotation of the signing key (if desired)
  • UI changes to allow for getting the signing key of the instance

Screenshots:

very basic webhook signatures

Describe any introduced user-facing changes:
Users will notice a new X-Webhook-Signature header on any outgoing webhook.

They will not be able to validate the webhook signature with just this PR as the public key will not have been exposed.

Describe any introduced API changes:
N/a

Additional Info:

@EvanMerlock EvanMerlock marked this pull request as ready for review December 24, 2024 03:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant