Skip to content
This repository has been archived by the owner on Jul 13, 2023. It is now read-only.

Commit

Permalink
bug: fix header_cleanup for aesgcm
Browse files Browse the repository at this point in the history 
* Remove embedded " and = from Encryption and Crypto-Key header values

Closes #1419
  • Loading branch information
@jrconlin
jrconlin committed Jul 21, 2020
1 parent 4cc1250 commit ab14372
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 15 deletions.
45 changes: 32 additions & 13 deletions autopush/tests/test_integration.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ def __init__(self, url, sslcontext=None):
self.messages = {}
self.notif_response = None # type: Optional[HTTPResponse]
self._crypto_key = """\
keyid="http://example.org/bob/keys/123;salt="XZwpw6o37R-6qoZjw6KwAw"\
keyid="http://example.org/bob/keys/123";salt="XZwpw6o37R-6qoZjw6KwAw=="\
"""
self.sslcontext = sslcontext
self.headers = {
Expand Down Expand Up @@ -679,7 +679,10 @@ def test_basic_delivery(self):
data = str(uuid.uuid4())
client = yield self.quick_register()
result = yield client.send_notification(data=data)
assert result["headers"]["encryption"] == client._crypto_key
# the following presumes that only `salt` is padded.
clean_header = client._crypto_key.replace(
'"', '').rstrip('=')
assert result["headers"]["encryption"] == clean_header
assert result["data"] == base64url_encode(data)
assert result["messageType"] == "notification"
yield self.shut_down(client)
Expand All @@ -694,7 +697,9 @@ def test_topic_basic_delivery(self):
data = str(uuid.uuid4())
client = yield self.quick_register()
result = yield client.send_notification(data=data, topic="Inbox")
assert result["headers"]["encryption"] == client._crypto_key
clean_header = client._crypto_key.replace(
'"', '').rstrip('=')
assert result["headers"]["encryption"] == clean_header
assert result["data"] == base64url_encode(data)
assert result["messageType"] == "notification"
yield self.shut_down(client)
Expand All @@ -710,7 +715,9 @@ def test_topic_replacement_delivery(self):
yield client.connect()
yield client.hello()
result = yield client.get_notification()
assert result["headers"]["encryption"] == client._crypto_key
clean_header = client._crypto_key.replace(
'"', '').rstrip('=')
assert result["headers"]["encryption"] == clean_header
assert result["data"] == base64url_encode(data2)
assert result["messageType"] == "notification"
result = yield client.get_notification()
Expand All @@ -726,7 +733,9 @@ def test_topic_no_delivery_on_reconnect(self):
yield client.connect()
yield client.hello()
result = yield client.get_notification(timeout=10)
assert result["headers"]["encryption"] == client._crypto_key
clean_header = client._crypto_key.replace(
'"', '').rstrip('=')
assert result["headers"]["encryption"] == clean_header
assert result["data"] == base64url_encode(data)
assert result["messageType"] == "notification"
yield client.ack(result["channelID"], result["version"])
Expand All @@ -746,7 +755,9 @@ def test_basic_delivery_with_vapid(self):
client = yield self.quick_register()
vapid_info = _get_vapid()
result = yield client.send_notification(data=data, vapid=vapid_info)
assert result["headers"]["encryption"] == client._crypto_key
clean_header = client._crypto_key.replace(
'"', '').rstrip('=')
assert result["headers"]["encryption"] == clean_header
assert result["data"] == base64url_encode(data)
assert result["messageType"] == "notification"
assert self.logs.logged_ci(lambda ci: 'router_key' in ci)
Expand Down Expand Up @@ -1013,7 +1024,9 @@ def test_ttl_not_present_connected(self):
client = yield self.quick_register()
result = yield client.send_notification(data=data, ttl=None)
assert result is not None
assert result["headers"]["encryption"] == client._crypto_key
clean_header = client._crypto_key.replace(
'"', '').rstrip('=')
assert result["headers"]["encryption"] == clean_header
assert result["data"] == base64url_encode(data)
assert result["messageType"] == "notification"
yield self.shut_down(client)
Expand All @@ -1024,7 +1037,9 @@ def test_ttl_not_present_connected_no_ack(self):
client = yield self.quick_register()
result = yield client.send_notification(data=data, ttl=None)
assert result is not None
assert result["headers"]["encryption"] == client._crypto_key
clean_header = client._crypto_key.replace(
'"', '').rstrip('=')
assert result["headers"]["encryption"] == clean_header
assert result["data"] == base64url_encode(data)
assert result["messageType"] == "notification"
yield client.disconnect()
Expand All @@ -1040,7 +1055,9 @@ def test_ttl_0_connected(self):
client = yield self.quick_register()
result = yield client.send_notification(data=data, ttl=0)
assert result is not None
assert result["headers"]["encryption"] == client._crypto_key
clean_header = client._crypto_key.replace(
'"', '').rstrip('=')
assert result["headers"]["encryption"] == clean_header
assert result["data"] == base64url_encode(data)
assert result["messageType"] == "notification"
yield self.shut_down(client)
Expand Down Expand Up @@ -1091,7 +1108,9 @@ def test_ttl_batch_expired_and_good_one(self):
yield client.hello()
result = yield client.get_notification(timeout=4)
assert result is not None
assert result["headers"]["encryption"] == client._crypto_key
clean_header = client._crypto_key.replace(
'"', '').rstrip('=')
assert result["headers"]["encryption"] == clean_header
assert result["data"] == base64url_encode(data2)
assert result["messageType"] == "notification"
result = yield client.get_notification()
Expand Down Expand Up @@ -2267,9 +2286,9 @@ def test_bad_sends(self):
))
assert response.code == 200
jbody = json.loads(body)
crypto_key = ("keyid=p256dh;dh=BAFJxCIaaWyb4JSkZopERL9MjXBeh3WdBxew"
"SYP0cZWNMJaT7YNaJUiSqBuGUxfRj-9vpTPz5ANmUYq3-u-HWOI")
salt = "keyid=p256dh;salt=S82AseB7pAVBJ2143qtM3A"
crypto_key = ("keyid=p256dh;dh=\"BAFJxCIaaWyb4JSkZopERL9MjXBeh3WdBxew"
"SYP0cZWNMJaT7YNaJUiSqBuGUxfRj-9vpTPz5ANmUYq3-u-HWOI\"")
salt = "keyid=p256dh;salt=\"S82AseB7pAVBJ2143qtM3A==\""
content_encoding = "aesgcm"

# Test ADMAuth Error
Expand Down
6 changes: 4 additions & 2 deletions autopush/utils.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -375,9 +375,11 @@ def cleanup_headers(self):
headers = self.headers
# Strip crypto/encryption headers down
for hdr in ["crypto-key", "encryption"]:
if STRIP_PADDING.search(headers.get(hdr, "")):
if hdr in headers:
head = headers[hdr].replace('"', '')
headers[hdr] = STRIP_PADDING.sub("", head)
head = STRIP_PADDING.sub("", head)
head.decode('ascii')
headers[hdr] = head

# content-encoding header may already be stored as "encoding",
# this is a failover to ensure that the proper value is pulled in.
Expand Down

0 comments on commit ab14372

Please sign in to comment.