Skip to content

Use X-Hub-Signature-256 #30

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.

Sign up for GitHub

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

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

Use X-Hub-Signature-256 #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e590ff9
Use X-Hub-Signature-256
dinvlad Apr 12, 2021
87535bc
Adjust tests for X-Hub-Signature-256
dinvlad Apr 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions github_webhook/webhook.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,19 +56,19 @@ def decorator(func):
def _get_digest(self):
"""Return message digest if a secret key was provided"""

return hmac.new(self._secret, request.data, hashlib.sha1).hexdigest() if self._secret else None
return hmac.new(self._secret, request.data, hashlib.sha256).hexdigest() if self._secret else None

def _postreceive(self):
"""Callback from Flask"""

digest = self._get_digest()

if digest is not None:
sig_parts = _get_header("X-Hub-Signature").split("=", 1)
sig_parts = _get_header("X-Hub-Signature-256").split("=", 1)
if not isinstance(digest, six.text_type):
digest = six.text_type(digest)

if len(sig_parts) < 2 or sig_parts[0] != "sha1" or not hmac.compare_digest(sig_parts[1], digest):
if len(sig_parts) < 2 or sig_parts[0] != "sha256" or not hmac.compare_digest(sig_parts[1], digest):
abort(400, "Invalid signature")

event_type = _get_header("X-Github-Event")
Expand Down
4 changes: 2 additions & 2 deletions tests/test_webhook.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ def test_can_handle_zero_events(webhook, push_request):
def test_calls_if_signature_is_correct(mock_hmac, app, push_request, secret):
# GIVEN
webhook = Webhook(app, secret=secret)
push_request.headers["X-Hub-Signature"] = "sha1=hash_of_something"
push_request.headers["X-Hub-Signature-256"] = "sha256=hash_of_something"
push_request.data = b"something"
handler = mock.Mock()
mock_hmac.compare_digest.return_value = True
Expand All @@ -175,7 +175,7 @@ def test_calls_if_signature_is_correct(mock_hmac, app, push_request, secret):
def test_does_not_call_if_signature_is_incorrect(mock_hmac, app, push_request):
# GIVEN
webhook = Webhook(app, secret="super_secret")
push_request.headers["X-Hub-Signature"] = "sha1=hash_of_something"
push_request.headers["X-Hub-Signature-256"] = "sha256=hash_of_something"
push_request.data = b"something"
handler = mock.Mock()
mock_hmac.compare_digest.return_value = False
Expand Down