Skip to content

Commit db586ed

Browse files
committed
Security: prevent timing attack on WEBHOOK_AUTHORIZATION secret
Anymail's webhook validation was vulnerable to a timing attack. An attacker could have used this to recover your WEBHOOK_AUTHORIZATION shared secret, potentially allowing them to post fabricated or malicious email tracking events to your app. There have not been any reports of attempted exploit in the wild. (The vulnerability was discovered through code review.) Attempts would be visible in http logs as a very large number of 400 responses on Anymail's webhook urls, or in Python error monitoring as a very large number of AnymailWebhookValidationFailure exceptions. If you are using Anymail's webhooks, you should upgrade to this release. In addition, you may want to rotate to a new WEBHOOK_AUTHORIZATION secret ([docs](http://anymail.readthedocs.io/en/stable/tips/securing_webhooks/#use-a-shared-authorization-secret)), particularly if your logs indicate attempted exploit.
1 parent b57eb94 commit db586ed

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

anymail/webhooks/base.py

+12-3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
import six
44
from django.http import HttpResponse
5+
from django.utils.crypto import constant_time_compare
56
from django.utils.decorators import method_decorator
67
from django.views.decorators.csrf import csrf_exempt
78
from django.views.generic import View
@@ -40,8 +41,13 @@ def __init__(self, **kwargs):
4041
def validate_request(self, request):
4142
"""If configured for webhook basic auth, validate request has correct auth."""
4243
if self.basic_auth:
43-
basic_auth = get_request_basic_auth(request)
44-
if basic_auth is None or basic_auth not in self.basic_auth:
44+
request_auth = get_request_basic_auth(request)
45+
# Use constant_time_compare to avoid timing attack on basic auth. (It's OK that any()
46+
# can terminate early: we're not trying to protect how many auth strings are allowed,
47+
# just the contents of each individual auth string.)
48+
auth_ok = any(constant_time_compare(request_auth, allowed_auth)
49+
for allowed_auth in self.basic_auth)
50+
if not auth_ok:
4551
# noinspection PyUnresolvedReferences
4652
raise AnymailWebhookValidationFailure(
4753
"Missing or invalid basic auth in Anymail %s webhook" % self.esp_name)
@@ -77,8 +83,11 @@ def validate_request(self, request):
7783
*All* definitions of this method in the class chain (including mixins)
7884
will be called. There is no need to chain to the superclass.
7985
(See self.run_validators and collect_all_methods.)
86+
87+
Security note: use django.utils.crypto.constant_time_compare for string
88+
comparisons, to avoid exposing your validation to a timing attack.
8089
"""
81-
# if request.POST['signature'] != expected_signature:
90+
# if not constant_time_compare(request.POST['signature'], expected_signature):
8291
# raise AnymailWebhookValidationFailure("...message...")
8392
# (else just do nothing)
8493
pass

0 commit comments

Comments
 (0)