Update "Securing Your Webhooks" to prefer X-Hub-Signature-Sha-256 header #82
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
|
Related doc-content issue so we make sure it's replaced everywhere. https://github.com/github/docs-content/issues/2664 |
|
Closing this PR in favor of https://github.com/github/docs-internal/pull/15968 that updates all content mentions. |
jnidzwetzki
referenced
this pull request
in jnidzwetzki/docs
Oct 6, 2022
* set up for promscale section * Promscale content * move up one level * Move to top level * Remove promscale from this level * Fix syntax * Add missing directory * Update promscale/page-index/page-index.js Co-authored-by: Ryan Booz <[email protected]> * Adds index * Apply suggestions from code review Co-authored-by: Matvey Arye <[email protected]> * fix page index * Edits per feedback * Edits per feedback Co-authored-by: Ryan Booz <[email protected]> Co-authored-by: Matvey Arye <[email protected]> Co-authored-by: Jacob <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
We plan to enable inclusion of a new HTTP header for all webhooks that are configured with a secret. The new header computes a signature for our webhook payloads based on SHA-256 instead of the less-secure SHA-1.
https://github.com/github/hookshot-go/pull/610 added the feature (disabled behind a flag) and https://github.com/github/hookshot-go/pull/612 will enable inclusion of the new header once it's merged.
This PR updates our recommendation for verifying webhook payloads to use the new SHA-256-based signature. We mention the existence of the old header just to minimize any potential confusion, and make it clear that we don't plan to eliminate it.
/cc @gwestersf