| 1 |
from datetime import timedelta |
| 2 |
|
| 3 |
from django.core import signing |
| 4 |
from django.http import HttpRequest, HttpResponse |
| 5 |
from django.test import SimpleTestCase, override_settings |
| 6 |
from django.test.utils import freeze_time |
| 7 |
|
| 8 |
|
| 9 |
@override_settings(SIGNED_COOKIE_LEGACY_SALT_FALLBACK=False) |
| 10 |
class SignedCookieTest(SimpleTestCase): |
| 11 |
def test_can_set_and_read_signed_cookies(self): |
| 12 |
response = HttpResponse() |
| 13 |
response.set_signed_cookie("c", "hello") |
| 14 |
self.assertIn("c", response.cookies) |
| 15 |
self.assertTrue(response.cookies["c"].value.startswith("hello:")) |
| 16 |
request = HttpRequest() |
| 17 |
request.COOKIES["c"] = response.cookies["c"].value |
| 18 |
value = request.get_signed_cookie("c") |
| 19 |
self.assertEqual(value, "hello") |
| 20 |
|
| 21 |
def test_can_use_salt(self): |
| 22 |
response = HttpResponse() |
| 23 |
response.set_signed_cookie("a", "hello", salt="one") |
| 24 |
request = HttpRequest() |
| 25 |
request.COOKIES["a"] = response.cookies["a"].value |
| 26 |
value = request.get_signed_cookie("a", salt="one") |
| 27 |
self.assertEqual(value, "hello") |
| 28 |
with self.assertRaises(signing.BadSignature): |
| 29 |
request.get_signed_cookie("a", salt="two") |
| 30 |
|
| 31 |
def test_salt_namespace_is_unambiguous(self): |
| 32 |
response = HttpResponse() |
| 33 |
response.set_signed_cookie("a", "hello", salt="bc") |
| 34 |
request = HttpRequest() |
| 35 |
request.COOKIES["ab"] = response.cookies["a"].value |
| 36 |
with self.assertRaises(signing.BadSignature): |
| 37 |
request.get_signed_cookie("ab", salt="c") |
| 38 |
|
| 39 |
@override_settings(SIGNED_COOKIE_LEGACY_SALT_FALLBACK=True) |
| 40 |
def test_expired_legacy_cookie_raises_signature_expired(self): |
| 41 |
with freeze_time(123456789): |
| 42 |
request = HttpRequest() |
| 43 |
request.COOKIES["a"] = signing.get_cookie_signer( |
| 44 |
salt=signing._cookie_signer_legacy_salt("a", "bc") |
| 45 |
).sign("hello") |
| 46 |
with freeze_time(123456800): |
| 47 |
with self.assertRaises(signing.SignatureExpired): |
| 48 |
request.get_signed_cookie("a", salt="bc", max_age=10) |
| 49 |
|
| 50 |
@override_settings(SIGNED_COOKIE_LEGACY_SALT_FALLBACK=True) |
| 51 |
def test_legacy_salt_namespace_is_accepted_by_default(self): |
| 52 |
request = HttpRequest() |
| 53 |
# Simulate an attack along the lines of CVE-2026-6873, where a value |
| 54 |
# for the "a" cookie is submitted as the value for another cookie. |
| 55 |
request.COOKIES["ab"] = signing.get_cookie_signer( |
| 56 |
salt=signing._cookie_signer_legacy_salt("a", "bc") |
| 57 |
).sign("hello") |
| 58 |
# No protection since SIGNED_COOKIE_LEGACY_SALT_FALLBACK=True. |
| 59 |
self.assertEqual(request.get_signed_cookie("ab", salt="c"), "hello") |
| 60 |
|
| 61 |
def test_legacy_salt_namespace_not_accepted(self): |
| 62 |
request = HttpRequest() |
| 63 |
request.COOKIES["a"] = signing.get_cookie_signer( |
| 64 |
salt=signing._cookie_signer_legacy_salt("a", "bc") |
| 65 |
).sign("hello") |
| 66 |
with self.assertRaises(signing.BadSignature): |
| 67 |
request.get_signed_cookie("a", salt="bc") |
| 68 |
|
| 69 |
@override_settings(SIGNED_COOKIE_LEGACY_SALT_FALLBACK=True) |
| 70 |
def test_expired_new_style_cookie_does_not_fallback_to_legacy_salt(self): |
| 71 |
with freeze_time(123456789): |
| 72 |
response = HttpResponse() |
| 73 |
response.set_signed_cookie("a", "hello", salt="bc") |
| 74 |
request = HttpRequest() |
| 75 |
request.COOKIES["a"] = response.cookies["a"].value |
| 76 |
with freeze_time(123456800): |
| 77 |
with self.assertRaises(signing.SignatureExpired): |
| 78 |
request.get_signed_cookie("a", salt="bc", max_age=10) |
| 79 |
|
| 80 |
def test_detects_tampering(self): |
| 81 |
response = HttpResponse() |
| 82 |
response.set_signed_cookie("c", "hello") |
| 83 |
request = HttpRequest() |
| 84 |
request.COOKIES["c"] = response.cookies["c"].value[:-2] + "$$" |
| 85 |
with self.assertRaises(signing.BadSignature): |
| 86 |
request.get_signed_cookie("c") |
| 87 |
|
| 88 |
def test_default_argument_suppresses_exceptions(self): |
| 89 |
response = HttpResponse() |
| 90 |
response.set_signed_cookie("c", "hello") |
| 91 |
request = HttpRequest() |
| 92 |
request.COOKIES["c"] = response.cookies["c"].value[:-2] + "$$" |
| 93 |
self.assertIsNone(request.get_signed_cookie("c", default=None)) |
| 94 |
|
| 95 |
def test_max_age_argument(self): |
| 96 |
value = "hello" |
| 97 |
with freeze_time(123456789): |
| 98 |
response = HttpResponse() |
| 99 |
response.set_signed_cookie("c", value) |
| 100 |
request = HttpRequest() |
| 101 |
request.COOKIES["c"] = response.cookies["c"].value |
| 102 |
self.assertEqual(request.get_signed_cookie("c"), value) |
| 103 |
|
| 104 |
with freeze_time(123456800): |
| 105 |
self.assertEqual(request.get_signed_cookie("c", max_age=12), value) |
| 106 |
self.assertEqual(request.get_signed_cookie("c", max_age=11), value) |
| 107 |
self.assertEqual( |
| 108 |
request.get_signed_cookie("c", max_age=timedelta(seconds=11)), value |
| 109 |
) |
| 110 |
with self.assertRaises(signing.SignatureExpired): |
| 111 |
request.get_signed_cookie("c", max_age=10) |
| 112 |
with self.assertRaises(signing.SignatureExpired): |
| 113 |
request.get_signed_cookie("c", max_age=timedelta(seconds=10)) |
| 114 |
|
| 115 |
def test_set_signed_cookie_max_age_argument(self): |
| 116 |
response = HttpResponse() |
| 117 |
response.set_signed_cookie("c", "value", max_age=100) |
| 118 |
self.assertEqual(response.cookies["c"]["max-age"], 100) |
| 119 |
response.set_signed_cookie("d", "value", max_age=timedelta(hours=2)) |
| 120 |
self.assertEqual(response.cookies["d"]["max-age"], 7200) |
| 121 |
|
| 122 |
@override_settings(SECRET_KEY=b"\xe7") |
| 123 |
def test_signed_cookies_with_binary_key(self): |
| 124 |
response = HttpResponse() |
| 125 |
response.set_signed_cookie("c", "hello") |
| 126 |
|
| 127 |
request = HttpRequest() |
| 128 |
request.COOKIES["c"] = response.cookies["c"].value |
| 129 |
self.assertEqual(request.get_signed_cookie("c"), "hello") |