1. import base64

  2. import os

  3. import shutil

  4. import string

  5. import tempfile

  6. import unittest

  7. from datetime import timedelta

  8. from http import cookies

  9. from pathlib import Path

  10. from unittest import mock

  11. 

  12. from django.conf import settings

  13. from django.contrib.sessions.backends.base import UpdateError

  14. from django.contrib.sessions.backends.cache import SessionStore as CacheSession

  15. from django.contrib.sessions.backends.cached_db import SessionStore as CacheDBSession

  16. from django.contrib.sessions.backends.db import SessionStore as DatabaseSession

  17. from django.contrib.sessions.backends.file import SessionStore as FileSession

  18. from django.contrib.sessions.backends.signed_cookies import (

  19.     SessionStore as CookieSession,

  20. )

  21. from django.contrib.sessions.exceptions import InvalidSessionKey, SessionInterrupted

  22. from django.contrib.sessions.middleware import SessionMiddleware

  23. from django.contrib.sessions.models import Session

  24. from django.contrib.sessions.serializers import JSONSerializer

  25. from django.core import management

  26. from django.core.cache import caches

  27. from django.core.cache.backends.base import InvalidCacheBackendError

  28. from django.core.exceptions import ImproperlyConfigured

  29. from django.core.signing import TimestampSigner

  30. from django.http import HttpResponse

  31. from django.test import (

  32.     RequestFactory,

  33.     SimpleTestCase,

  34.     TestCase,

  35.     ignore_warnings,

  36.     override_settings,

  37. )

  38. from django.utils import timezone

  39. 

  40. from .models import SessionStore as CustomDatabaseSession

  41. 

  42. 

  43. class SessionTestsMixin:

  44.     # This does not inherit from TestCase to avoid any tests being run with this

  45.     # class, which wouldn't work, and to allow different TestCase subclasses to

  46.     # be used.

  47. 

  48.     backend = None  # subclasses must specify

  49. 

  50.     def setUp(self):

  51.         self.session = self.backend()

  52. 

  53.     def tearDown(self):

  54.         # NB: be careful to delete any sessions created; stale sessions fill up

  55.         # the /tmp (with some backends) and eventually overwhelm it after lots

  56.         # of runs (think buildbots)

  57.         self.session.delete()

  58. 

  59.     def test_new_session(self):

  60.         self.assertIs(self.session.modified, False)

  61.         self.assertIs(self.session.accessed, False)

  62. 

  63.     def test_get_empty(self):

  64.         self.assertIsNone(self.session.get("cat"))

  65. 

  66.     def test_store(self):

  67.         self.session["cat"] = "dog"

  68.         self.assertIs(self.session.modified, True)

  69.         self.assertEqual(self.session.pop("cat"), "dog")

  70. 

  71.     def test_pop(self):

  72.         self.session["some key"] = "exists"

  73.         # Need to reset these to pretend we haven't accessed it:

  74.         self.accessed = False

  75.         self.modified = False

  76. 

  77.         self.assertEqual(self.session.pop("some key"), "exists")

  78.         self.assertIs(self.session.accessed, True)

  79.         self.assertIs(self.session.modified, True)

  80.         self.assertIsNone(self.session.get("some key"))

  81. 

  82.     def test_pop_default(self):

  83.         self.assertEqual(

  84.             self.session.pop("some key", "does not exist"), "does not exist"

  85.         )

  86.         self.assertIs(self.session.accessed, True)

  87.         self.assertIs(self.session.modified, False)

  88. 

  89.     def test_pop_default_named_argument(self):

  90.         self.assertEqual(

  91.             self.session.pop("some key", default="does not exist"), "does not exist"

  92.         )

  93.         self.assertIs(self.session.accessed, True)

  94.         self.assertIs(self.session.modified, False)

  95. 

  96.     def test_pop_no_default_keyerror_raised(self):

  97.         with self.assertRaises(KeyError):

  98.             self.session.pop("some key")

  99. 

  100.     def test_setdefault(self):

  101.         self.assertEqual(self.session.setdefault("foo", "bar"), "bar")

  102.         self.assertEqual(self.session.setdefault("foo", "baz"), "bar")

  103.         self.assertIs(self.session.accessed, True)

  104.         self.assertIs(self.session.modified, True)

  105. 

  106.     def test_update(self):

  107.         self.session.update({"update key": 1})

  108.         self.assertIs(self.session.accessed, True)

  109.         self.assertIs(self.session.modified, True)

  110.         self.assertEqual(self.session.get("update key", None), 1)

  111. 

  112.     def test_has_key(self):

  113.         self.session["some key"] = 1

  114.         self.session.modified = False

  115.         self.session.accessed = False

  116.         self.assertIn("some key", self.session)

  117.         self.assertIs(self.session.accessed, True)

  118.         self.assertIs(self.session.modified, False)

  119. 

  120.     def test_values(self):

  121.         self.assertEqual(list(self.session.values()), [])

  122.         self.assertIs(self.session.accessed, True)

  123.         self.session["some key"] = 1

  124.         self.session.modified = False

  125.         self.session.accessed = False

  126.         self.assertEqual(list(self.session.values()), [1])

  127.         self.assertIs(self.session.accessed, True)

  128.         self.assertIs(self.session.modified, False)

  129. 

  130.     def test_keys(self):

  131.         self.session["x"] = 1

  132.         self.session.modified = False

  133.         self.session.accessed = False

  134.         self.assertEqual(list(self.session.keys()), ["x"])

  135.         self.assertIs(self.session.accessed, True)

  136.         self.assertIs(self.session.modified, False)

  137. 

  138.     def test_items(self):

  139.         self.session["x"] = 1

  140.         self.session.modified = False

  141.         self.session.accessed = False

  142.         self.assertEqual(list(self.session.items()), [("x", 1)])

  143.         self.assertIs(self.session.accessed, True)

  144.         self.assertIs(self.session.modified, False)

  145. 

  146.     def test_clear(self):

  147.         self.session["x"] = 1

  148.         self.session.modified = False

  149.         self.session.accessed = False

  150.         self.assertEqual(list(self.session.items()), [("x", 1)])

  151.         self.session.clear()

  152.         self.assertEqual(list(self.session.items()), [])

  153.         self.assertIs(self.session.accessed, True)

  154.         self.assertIs(self.session.modified, True)

  155. 

  156.     def test_save(self):

  157.         self.session.save()

  158.         self.assertIs(self.session.exists(self.session.session_key), True)

  159. 

  160.     def test_delete(self):

  161.         self.session.save()

  162.         self.session.delete(self.session.session_key)

  163.         self.assertIs(self.session.exists(self.session.session_key), False)

  164. 

  165.     def test_flush(self):

  166.         self.session["foo"] = "bar"

  167.         self.session.save()

  168.         prev_key = self.session.session_key

  169.         self.session.flush()

  170.         self.assertIs(self.session.exists(prev_key), False)

  171.         self.assertNotEqual(self.session.session_key, prev_key)

  172.         self.assertIsNone(self.session.session_key)

  173.         self.assertIs(self.session.modified, True)

  174.         self.assertIs(self.session.accessed, True)

  175. 

  176.     def test_cycle(self):

  177.         self.session["a"], self.session["b"] = "c", "d"

  178.         self.session.save()

  179.         prev_key = self.session.session_key

  180.         prev_data = list(self.session.items())

  181.         self.session.cycle_key()

  182.         self.assertIs(self.session.exists(prev_key), False)

  183.         self.assertNotEqual(self.session.session_key, prev_key)

  184.         self.assertEqual(list(self.session.items()), prev_data)

  185. 

  186.     def test_cycle_with_no_session_cache(self):

  187.         self.session["a"], self.session["b"] = "c", "d"

  188.         self.session.save()

  189.         prev_data = self.session.items()

  190.         self.session = self.backend(self.session.session_key)

  191.         self.assertIs(hasattr(self.session, "_session_cache"), False)

  192.         self.session.cycle_key()

  193.         self.assertCountEqual(self.session.items(), prev_data)

  194. 

  195.     def test_save_doesnt_clear_data(self):

  196.         self.session["a"] = "b"

  197.         self.session.save()

  198.         self.assertEqual(self.session["a"], "b")

  199. 

  200.     def test_invalid_key(self):

  201.         # Submitting an invalid session key (either by guessing, or if the db has

  202.         # removed the key) results in a new key being generated.

  203.         try:

  204.             session = self.backend("1")

  205.             session.save()

  206.             self.assertNotEqual(session.session_key, "1")

  207.             self.assertIsNone(session.get("cat"))

  208.             session.delete()

  209.         finally:

  210.             # Some backends leave a stale cache entry for the invalid

  211.             # session key; make sure that entry is manually deleted

  212.             session.delete("1")

  213. 

  214.     def test_session_key_empty_string_invalid(self):

  215.         """Falsey values (Such as an empty string) are rejected."""

  216.         self.session._session_key = ""

  217.         self.assertIsNone(self.session.session_key)

  218. 

  219.     def test_session_key_too_short_invalid(self):

  220.         """Strings shorter than 8 characters are rejected."""

  221.         self.session._session_key = "1234567"

  222.         self.assertIsNone(self.session.session_key)

  223. 

  224.     def test_session_key_valid_string_saved(self):

  225.         """Strings of length 8 and up are accepted and stored."""

  226.         self.session._session_key = "12345678"

  227.         self.assertEqual(self.session.session_key, "12345678")

  228. 

  229.     def test_session_key_is_read_only(self):

  230.         def set_session_key(session):

  231.             session.session_key = session._get_new_session_key()

  232. 

  233.         with self.assertRaises(AttributeError):

  234.             set_session_key(self.session)

  235. 

  236.     # Custom session expiry

  237.     def test_default_expiry(self):

  238.         # A normal session has a max age equal to settings

  239.         self.assertEqual(self.session.get_expiry_age(), settings.SESSION_COOKIE_AGE)

  240. 

  241.         # So does a custom session with an idle expiration time of 0 (but it'll

  242.         # expire at browser close)

  243.         self.session.set_expiry(0)

  244.         self.assertEqual(self.session.get_expiry_age(), settings.SESSION_COOKIE_AGE)

  245. 

  246.     def test_custom_expiry_seconds(self):

  247.         modification = timezone.now()

  248. 

  249.         self.session.set_expiry(10)

  250. 

  251.         date = self.session.get_expiry_date(modification=modification)

  252.         self.assertEqual(date, modification + timedelta(seconds=10))

  253. 

  254.         age = self.session.get_expiry_age(modification=modification)

  255.         self.assertEqual(age, 10)

  256. 

  257.     def test_custom_expiry_timedelta(self):

  258.         modification = timezone.now()

  259. 

  260.         # Mock timezone.now, because set_expiry calls it on this code path.

  261.         original_now = timezone.now

  262.         try:

  263.             timezone.now = lambda: modification

  264.             self.session.set_expiry(timedelta(seconds=10))

  265.         finally:

  266.             timezone.now = original_now

  267. 

  268.         date = self.session.get_expiry_date(modification=modification)

  269.         self.assertEqual(date, modification + timedelta(seconds=10))

  270. 

  271.         age = self.session.get_expiry_age(modification=modification)

  272.         self.assertEqual(age, 10)

  273. 

  274.     def test_custom_expiry_datetime(self):

  275.         modification = timezone.now()

  276. 

  277.         self.session.set_expiry(modification + timedelta(seconds=10))

  278. 

  279.         date = self.session.get_expiry_date(modification=modification)

  280.         self.assertEqual(date, modification + timedelta(seconds=10))

  281. 

  282.         age = self.session.get_expiry_age(modification=modification)

  283.         self.assertEqual(age, 10)

  284. 

  285.     def test_custom_expiry_reset(self):

  286.         self.session.set_expiry(None)

  287.         self.session.set_expiry(10)

  288.         self.session.set_expiry(None)

  289.         self.assertEqual(self.session.get_expiry_age(), settings.SESSION_COOKIE_AGE)

  290. 

  291.     def test_get_expire_at_browser_close(self):

  292.         # Tests get_expire_at_browser_close with different settings and different

  293.         # set_expiry calls

  294.         with override_settings(SESSION_EXPIRE_AT_BROWSER_CLOSE=False):

  295.             self.session.set_expiry(10)

  296.             self.assertIs(self.session.get_expire_at_browser_close(), False)

  297. 

  298.             self.session.set_expiry(0)

  299.             self.assertIs(self.session.get_expire_at_browser_close(), True)

  300. 

  301.             self.session.set_expiry(None)

  302.             self.assertIs(self.session.get_expire_at_browser_close(), False)

  303. 

  304.         with override_settings(SESSION_EXPIRE_AT_BROWSER_CLOSE=True):

  305.             self.session.set_expiry(10)

  306.             self.assertIs(self.session.get_expire_at_browser_close(), False)

  307. 

  308.             self.session.set_expiry(0)

  309.             self.assertIs(self.session.get_expire_at_browser_close(), True)

  310. 

  311.             self.session.set_expiry(None)

  312.             self.assertIs(self.session.get_expire_at_browser_close(), True)

  313. 

  314.     def test_decode(self):

  315.         # Ensure we can decode what we encode

  316.         data = {"a test key": "a test value"}

  317.         encoded = self.session.encode(data)

  318.         self.assertEqual(self.session.decode(encoded), data)

  319. 

  320.     def test_decode_failure_logged_to_security(self):

  321.         tests = [

  322.             base64.b64encode(b"flaskdj:alkdjf").decode("ascii"),

  323.             "bad:encoded:value",

  324.         ]

  325.         for encoded in tests:

  326.             with self.subTest(encoded=encoded):

  327.                 with self.assertLogs(

  328.                     "django.security.SuspiciousSession", "WARNING"

  329.                 ) as cm:

  330.                     self.assertEqual(self.session.decode(encoded), {})

  331.                 # The failed decode is logged.

  332.                 self.assertIn("Session data corrupted", cm.output[0])

  333. 

  334.     def test_decode_serializer_exception(self):

  335.         signer = TimestampSigner(salt=self.session.key_salt)

  336.         encoded = signer.sign(b"invalid data")

  337.         self.assertEqual(self.session.decode(encoded), {})

  338. 

  339.     def test_actual_expiry(self):

  340.         old_session_key = None

  341.         new_session_key = None

  342.         try:

  343.             self.session["foo"] = "bar"

  344.             self.session.set_expiry(-timedelta(seconds=10))

  345.             self.session.save()

  346.             old_session_key = self.session.session_key

  347.             # With an expiry date in the past, the session expires instantly.

  348.             new_session = self.backend(self.session.session_key)

  349.             new_session_key = new_session.session_key

  350.             self.assertNotIn("foo", new_session)

  351.         finally:

  352.             self.session.delete(old_session_key)

  353.             self.session.delete(new_session_key)

  354. 

  355.     def test_session_load_does_not_create_record(self):

  356.         """

  357.         Loading an unknown session key does not create a session record.

  358. 

  359.         Creating session records on load is a DOS vulnerability.

  360.         """

  361.         session = self.backend("someunknownkey")

  362.         session.load()

  363. 

  364.         self.assertIsNone(session.session_key)

  365.         self.assertIs(session.exists(session.session_key), False)

  366.         # provided unknown key was cycled, not reused

  367.         self.assertNotEqual(session.session_key, "someunknownkey")

  368. 

  369.     def test_session_save_does_not_resurrect_session_logged_out_in_other_context(self):

  370.         """

  371.         Sessions shouldn't be resurrected by a concurrent request.

  372.         """

  373.         # Create new session.

  374.         s1 = self.backend()

  375.         s1["test_data"] = "value1"

  376.         s1.save(must_create=True)

  377. 

  378.         # Logout in another context.

  379.         s2 = self.backend(s1.session_key)

  380.         s2.delete()

  381. 

  382.         # Modify session in first context.

  383.         s1["test_data"] = "value2"

  384.         with self.assertRaises(UpdateError):

  385.             # This should throw an exception as the session is deleted, not

  386.             # resurrect the session.

  387.             s1.save()

  388. 

  389.         self.assertEqual(s1.load(), {})

  390. 

  391. 

  392. class DatabaseSessionTests(SessionTestsMixin, TestCase):

  393.     backend = DatabaseSession

  394.     session_engine = "django.contrib.sessions.backends.db"

  395. 

  396.     @property

  397.     def model(self):

  398.         return self.backend.get_model_class()

  399. 

  400.     def test_session_str(self):

  401.         "Session repr should be the session key."

  402.         self.session["x"] = 1

  403.         self.session.save()

  404. 

  405.         session_key = self.session.session_key

  406.         s = self.model.objects.get(session_key=session_key)

  407. 

  408.         self.assertEqual(str(s), session_key)

  409. 

  410.     def test_session_get_decoded(self):

  411.         """

  412.         Test we can use Session.get_decoded to retrieve data stored

  413.         in normal way

  414.         """

  415.         self.session["x"] = 1

  416.         self.session.save()

  417. 

  418.         s = self.model.objects.get(session_key=self.session.session_key)

  419. 

  420.         self.assertEqual(s.get_decoded(), {"x": 1})

  421. 

  422.     def test_sessionmanager_save(self):

  423.         """

  424.         Test SessionManager.save method

  425.         """

  426.         # Create a session

  427.         self.session["y"] = 1

  428.         self.session.save()

  429. 

  430.         s = self.model.objects.get(session_key=self.session.session_key)

  431.         # Change it

  432.         self.model.objects.save(s.session_key, {"y": 2}, s.expire_date)

  433.         # Clear cache, so that it will be retrieved from DB

  434.         del self.session._session_cache

  435.         self.assertEqual(self.session["y"], 2)

  436. 

  437.     def test_clearsessions_command(self):

  438.         """

  439.         Test clearsessions command for clearing expired sessions.

  440.         """

  441.         self.assertEqual(0, self.model.objects.count())

  442. 

  443.         # One object in the future

  444.         self.session["foo"] = "bar"

  445.         self.session.set_expiry(3600)

  446.         self.session.save()

  447. 

  448.         # One object in the past

  449.         other_session = self.backend()

  450.         other_session["foo"] = "bar"

  451.         other_session.set_expiry(-3600)

  452.         other_session.save()

  453. 

  454.         # Two sessions are in the database before clearsessions...

  455.         self.assertEqual(2, self.model.objects.count())

  456.         with override_settings(SESSION_ENGINE=self.session_engine):

  457.             management.call_command("clearsessions")

  458.         # ... and one is deleted.

  459.         self.assertEqual(1, self.model.objects.count())

  460. 

  461. 

  462. @override_settings(USE_TZ=True)

  463. class DatabaseSessionWithTimeZoneTests(DatabaseSessionTests):

  464.     pass

  465. 

  466. 

  467. class CustomDatabaseSessionTests(DatabaseSessionTests):

  468.     backend = CustomDatabaseSession

  469.     session_engine = "sessions_tests.models"

  470.     custom_session_cookie_age = 60 * 60 * 24  # One day.

  471. 

  472.     def test_extra_session_field(self):

  473.         # Set the account ID to be picked up by a custom session storage

  474.         # and saved to a custom session model database column.

  475.         self.session["_auth_user_id"] = 42

  476.         self.session.save()

  477. 

  478.         # Make sure that the customized create_model_instance() was called.

  479.         s = self.model.objects.get(session_key=self.session.session_key)

  480.         self.assertEqual(s.account_id, 42)

  481. 

  482.         # Make the session "anonymous".

  483.         self.session.pop("_auth_user_id")

  484.         self.session.save()

  485. 

  486.         # Make sure that save() on an existing session did the right job.

  487.         s = self.model.objects.get(session_key=self.session.session_key)

  488.         self.assertIsNone(s.account_id)

  489. 

  490.     def test_custom_expiry_reset(self):

  491.         self.session.set_expiry(None)

  492.         self.session.set_expiry(10)

  493.         self.session.set_expiry(None)

  494.         self.assertEqual(self.session.get_expiry_age(), self.custom_session_cookie_age)

  495. 

  496.     def test_default_expiry(self):

  497.         self.assertEqual(self.session.get_expiry_age(), self.custom_session_cookie_age)

  498.         self.session.set_expiry(0)

  499.         self.assertEqual(self.session.get_expiry_age(), self.custom_session_cookie_age)

  500. 

  501. 

  502. class CacheDBSessionTests(SessionTestsMixin, TestCase):

  503.     backend = CacheDBSession

  504. 

  505.     def test_exists_searches_cache_first(self):

  506.         self.session.save()

  507.         with self.assertNumQueries(0):

  508.             self.assertIs(self.session.exists(self.session.session_key), True)

  509. 

  510.     # Some backends might issue a warning

  511.     @ignore_warnings(module="django.core.cache.backends.base")

  512.     def test_load_overlong_key(self):

  513.         self.session._session_key = (string.ascii_letters + string.digits) * 20

  514.         self.assertEqual(self.session.load(), {})

  515. 

  516.     @override_settings(SESSION_CACHE_ALIAS="sessions")

  517.     def test_non_default_cache(self):

  518.         # 21000 - CacheDB backend should respect SESSION_CACHE_ALIAS.

  519.         with self.assertRaises(InvalidCacheBackendError):

  520.             self.backend()

  521. 

  522. 

  523. @override_settings(USE_TZ=True)

  524. class CacheDBSessionWithTimeZoneTests(CacheDBSessionTests):

  525.     pass

  526. 

  527. 

  528. class FileSessionTests(SessionTestsMixin, SimpleTestCase):

  529.     backend = FileSession

  530. 

  531.     def setUp(self):

  532.         # Do file session tests in an isolated directory, and kill it after we're done.

  533.         self.original_session_file_path = settings.SESSION_FILE_PATH

  534.         self.temp_session_store = settings.SESSION_FILE_PATH = self.mkdtemp()

  535.         # Reset the file session backend's internal caches

  536.         if hasattr(self.backend, "_storage_path"):

  537.             del self.backend._storage_path

  538.         super().setUp()

  539. 

  540.     def tearDown(self):

  541.         super().tearDown()

  542.         settings.SESSION_FILE_PATH = self.original_session_file_path

  543.         shutil.rmtree(self.temp_session_store)

  544. 

  545.     def mkdtemp(self):

  546.         return tempfile.mkdtemp()

  547. 

  548.     @override_settings(

  549.         SESSION_FILE_PATH="/if/this/directory/exists/you/have/a/weird/computer",

  550.     )

  551.     def test_configuration_check(self):

  552.         del self.backend._storage_path

  553.         # Make sure the file backend checks for a good storage dir

  554.         with self.assertRaises(ImproperlyConfigured):

  555.             self.backend()

  556. 

  557.     def test_invalid_key_backslash(self):

  558.         # Ensure we don't allow directory-traversal.

  559.         # This is tested directly on _key_to_file, as load() will swallow

  560.         # a SuspiciousOperation in the same way as an OSError - by creating

  561.         # a new session, making it unclear whether the slashes were detected.

  562.         with self.assertRaises(InvalidSessionKey):

  563.             self.backend()._key_to_file("a\\b\\c")

  564. 

  565.     def test_invalid_key_forwardslash(self):

  566.         # Ensure we don't allow directory-traversal

  567.         with self.assertRaises(InvalidSessionKey):

  568.             self.backend()._key_to_file("a/b/c")

  569. 

  570.     @override_settings(

  571.         SESSION_ENGINE="django.contrib.sessions.backends.file",

  572.         SESSION_COOKIE_AGE=0,

  573.     )

  574.     def test_clearsessions_command(self):

  575.         """

  576.         Test clearsessions command for clearing expired sessions.

  577.         """

  578.         storage_path = self.backend._get_storage_path()

  579.         file_prefix = settings.SESSION_COOKIE_NAME

  580. 

  581.         def count_sessions():

  582.             return len(

  583.                 [

  584.                     session_file

  585.                     for session_file in os.listdir(storage_path)

  586.                     if session_file.startswith(file_prefix)

  587.                 ]

  588.             )

  589. 

  590.         self.assertEqual(0, count_sessions())

  591. 

  592.         # One object in the future

  593.         self.session["foo"] = "bar"

  594.         self.session.set_expiry(3600)

  595.         self.session.save()

  596. 

  597.         # One object in the past

  598.         other_session = self.backend()

  599.         other_session["foo"] = "bar"

  600.         other_session.set_expiry(-3600)

  601.         other_session.save()

  602. 

  603.         # One object in the present without an expiry (should be deleted since

  604.         # its modification time + SESSION_COOKIE_AGE will be in the past when

  605.         # clearsessions runs).

  606.         other_session2 = self.backend()

  607.         other_session2["foo"] = "bar"

  608.         other_session2.save()

  609. 

  610.         # Three sessions are in the filesystem before clearsessions...

  611.         self.assertEqual(3, count_sessions())

  612.         management.call_command("clearsessions")

  613.         # ... and two are deleted.

  614.         self.assertEqual(1, count_sessions())

  615. 

  616. 

  617. class FileSessionPathLibTests(FileSessionTests):

  618.     def mkdtemp(self):

  619.         tmp_dir = super().mkdtemp()

  620.         return Path(tmp_dir)

  621. 

  622. 

  623. class CacheSessionTests(SessionTestsMixin, SimpleTestCase):

  624.     backend = CacheSession

  625. 

  626.     # Some backends might issue a warning

  627.     @ignore_warnings(module="django.core.cache.backends.base")

  628.     def test_load_overlong_key(self):

  629.         self.session._session_key = (string.ascii_letters + string.digits) * 20

  630.         self.assertEqual(self.session.load(), {})

  631. 

  632.     def test_default_cache(self):

  633.         self.session.save()

  634.         self.assertIsNotNone(caches["default"].get(self.session.cache_key))

  635. 

  636.     @override_settings(

  637.         CACHES={

  638.             "default": {

  639.                 "BACKEND": "django.core.cache.backends.dummy.DummyCache",

  640.             },

  641.             "sessions": {

  642.                 "BACKEND": "django.core.cache.backends.locmem.LocMemCache",

  643.                 "LOCATION": "session",

  644.             },

  645.         },

  646.         SESSION_CACHE_ALIAS="sessions",

  647.     )

  648.     def test_non_default_cache(self):

  649.         # Re-initialize the session backend to make use of overridden settings.

  650.         self.session = self.backend()

  651. 

  652.         self.session.save()

  653.         self.assertIsNone(caches["default"].get(self.session.cache_key))

  654.         self.assertIsNotNone(caches["sessions"].get(self.session.cache_key))

  655. 

  656.     def test_create_and_save(self):

  657.         self.session = self.backend()

  658.         self.session.create()

  659.         self.session.save()

  660.         self.assertIsNotNone(caches["default"].get(self.session.cache_key))

  661. 

  662. 

  663. class SessionMiddlewareTests(TestCase):

  664.     request_factory = RequestFactory()

  665. 

  666.     @staticmethod

  667.     def get_response_touching_session(request):

  668.         request.session["hello"] = "world"

  669.         return HttpResponse("Session test")

  670. 

  671.     @override_settings(SESSION_COOKIE_SECURE=True)

  672.     def test_secure_session_cookie(self):

  673.         request = self.request_factory.get("/")

  674.         middleware = SessionMiddleware(self.get_response_touching_session)

  675. 

  676.         # Handle the response through the middleware

  677.         response = middleware(request)

  678.         self.assertIs(response.cookies[settings.SESSION_COOKIE_NAME]["secure"], True)

  679. 

  680.     @override_settings(SESSION_COOKIE_HTTPONLY=True)

  681.     def test_httponly_session_cookie(self):

  682.         request = self.request_factory.get("/")

  683.         middleware = SessionMiddleware(self.get_response_touching_session)

  684. 

  685.         # Handle the response through the middleware

  686.         response = middleware(request)

  687.         self.assertIs(response.cookies[settings.SESSION_COOKIE_NAME]["httponly"], True)

  688.         self.assertIn(

  689.             cookies.Morsel._reserved["httponly"],

  690.             str(response.cookies[settings.SESSION_COOKIE_NAME]),

  691.         )

  692. 

  693.     @override_settings(SESSION_COOKIE_SAMESITE="Strict")

  694.     def test_samesite_session_cookie(self):

  695.         request = self.request_factory.get("/")

  696.         middleware = SessionMiddleware(self.get_response_touching_session)

  697.         response = middleware(request)

  698.         self.assertEqual(

  699.             response.cookies[settings.SESSION_COOKIE_NAME]["samesite"], "Strict"

  700.         )

  701. 

  702.     @override_settings(SESSION_COOKIE_HTTPONLY=False)

  703.     def test_no_httponly_session_cookie(self):

  704.         request = self.request_factory.get("/")

  705.         middleware = SessionMiddleware(self.get_response_touching_session)

  706.         response = middleware(request)

  707.         self.assertEqual(response.cookies[settings.SESSION_COOKIE_NAME]["httponly"], "")

  708.         self.assertNotIn(

  709.             cookies.Morsel._reserved["httponly"],

  710.             str(response.cookies[settings.SESSION_COOKIE_NAME]),

  711.         )

  712. 

  713.     def test_session_save_on_500(self):

  714.         def response_500(requset):

  715.             response = HttpResponse("Horrible error")

  716.             response.status_code = 500

  717.             request.session["hello"] = "world"

  718.             return response

  719. 

  720.         request = self.request_factory.get("/")

  721.         SessionMiddleware(response_500)(request)

  722. 

  723.         # The value wasn't saved above.

  724.         self.assertNotIn("hello", request.session.load())

  725. 

  726.     def test_session_update_error_redirect(self):

  727.         def response_delete_session(request):

  728.             request.session = DatabaseSession()

  729.             request.session.save(must_create=True)

  730.             request.session.delete()

  731.             return HttpResponse()

  732. 

  733.         request = self.request_factory.get("/foo/")

  734.         middleware = SessionMiddleware(response_delete_session)

  735. 

  736.         msg = (

  737.             "The request's session was deleted before the request completed. "

  738.             "The user may have logged out in a concurrent request, for example."

  739.         )

  740.         with self.assertRaisesMessage(SessionInterrupted, msg):

  741.             # Handle the response through the middleware. It will try to save

  742.             # the deleted session which will cause an UpdateError that's caught

  743.             # and raised as a SessionInterrupted.

  744.             middleware(request)

  745. 

  746.     def test_session_delete_on_end(self):

  747.         def response_ending_session(request):

  748.             request.session.flush()

  749.             return HttpResponse("Session test")

  750. 

  751.         request = self.request_factory.get("/")

  752.         middleware = SessionMiddleware(response_ending_session)

  753. 

  754.         # Before deleting, there has to be an existing cookie

  755.         request.COOKIES[settings.SESSION_COOKIE_NAME] = "abc"

  756. 

  757.         # Handle the response through the middleware

  758.         response = middleware(request)

  759. 

  760.         # The cookie was deleted, not recreated.

  761.         # A deleted cookie header looks like:

  762.         #  "Set-Cookie: sessionid=; expires=Thu, 01 Jan 1970 00:00:00 GMT; "

  763.         #  "Max-Age=0; Path=/"

  764.         self.assertEqual(

  765.             'Set-Cookie: {}=""; expires=Thu, 01 Jan 1970 00:00:00 GMT; '

  766.             "Max-Age=0; Path=/; SameSite={}".format(

  767.                 settings.SESSION_COOKIE_NAME,

  768.                 settings.SESSION_COOKIE_SAMESITE,

  769.             ),

  770.             str(response.cookies[settings.SESSION_COOKIE_NAME]),

  771.         )

  772.         # SessionMiddleware sets 'Vary: Cookie' to prevent the 'Set-Cookie'

  773.         # from being cached.

  774.         self.assertEqual(response.headers["Vary"], "Cookie")

  775. 

  776.     @override_settings(

  777.         SESSION_COOKIE_DOMAIN=".example.local", SESSION_COOKIE_PATH="/example/"

  778.     )

  779.     def test_session_delete_on_end_with_custom_domain_and_path(self):

  780.         def response_ending_session(request):

  781.             request.session.flush()

  782.             return HttpResponse("Session test")

  783. 

  784.         request = self.request_factory.get("/")

  785.         middleware = SessionMiddleware(response_ending_session)

  786. 

  787.         # Before deleting, there has to be an existing cookie

  788.         request.COOKIES[settings.SESSION_COOKIE_NAME] = "abc"

  789. 

  790.         # Handle the response through the middleware

  791.         response = middleware(request)

  792. 

  793.         # The cookie was deleted, not recreated.

  794.         # A deleted cookie header with a custom domain and path looks like:

  795.         #  Set-Cookie: sessionid=; Domain=.example.local;

  796.         #              expires=Thu, 01 Jan 1970 00:00:00 GMT; Max-Age=0;

  797.         #              Path=/example/

  798.         self.assertEqual(

  799.             'Set-Cookie: {}=""; Domain=.example.local; expires=Thu, '

  800.             "01 Jan 1970 00:00:00 GMT; Max-Age=0; Path=/example/; SameSite={}".format(

  801.                 settings.SESSION_COOKIE_NAME,

  802.                 settings.SESSION_COOKIE_SAMESITE,

  803.             ),

  804.             str(response.cookies[settings.SESSION_COOKIE_NAME]),

  805.         )

  806. 

  807.     def test_flush_empty_without_session_cookie_doesnt_set_cookie(self):

  808.         def response_ending_session(request):

  809.             request.session.flush()

  810.             return HttpResponse("Session test")

  811. 

  812.         request = self.request_factory.get("/")

  813.         middleware = SessionMiddleware(response_ending_session)

  814. 

  815.         # Handle the response through the middleware

  816.         response = middleware(request)

  817. 

  818.         # A cookie should not be set.

  819.         self.assertEqual(response.cookies, {})

  820.         # The session is accessed so "Vary: Cookie" should be set.

  821.         self.assertEqual(response.headers["Vary"], "Cookie")

  822. 

  823.     def test_empty_session_saved(self):

  824.         """

  825.         If a session is emptied of data but still has a key, it should still

  826.         be updated.

  827.         """

  828. 

  829.         def response_set_session(request):

  830.             # Set a session key and some data.

  831.             request.session["foo"] = "bar"

  832.             return HttpResponse("Session test")

  833. 

  834.         request = self.request_factory.get("/")

  835.         middleware = SessionMiddleware(response_set_session)

  836. 

  837.         # Handle the response through the middleware.

  838.         response = middleware(request)

  839.         self.assertEqual(tuple(request.session.items()), (("foo", "bar"),))

  840.         # A cookie should be set, along with Vary: Cookie.

  841.         self.assertIn(

  842.             "Set-Cookie: sessionid=%s" % request.session.session_key,

  843.             str(response.cookies),

  844.         )

  845.         self.assertEqual(response.headers["Vary"], "Cookie")

  846. 

  847.         # Empty the session data.

  848.         del request.session["foo"]

  849.         # Handle the response through the middleware.

  850.         response = HttpResponse("Session test")

  851.         response = middleware.process_response(request, response)

  852.         self.assertEqual(dict(request.session.values()), {})

  853.         session = Session.objects.get(session_key=request.session.session_key)

  854.         self.assertEqual(session.get_decoded(), {})

  855.         # While the session is empty, it hasn't been flushed so a cookie should

  856.         # still be set, along with Vary: Cookie.

  857.         self.assertGreater(len(request.session.session_key), 8)

  858.         self.assertIn(

  859.             "Set-Cookie: sessionid=%s" % request.session.session_key,

  860.             str(response.cookies),

  861.         )

  862.         self.assertEqual(response.headers["Vary"], "Cookie")

  863. 

  864. 

  865. class CookieSessionTests(SessionTestsMixin, SimpleTestCase):

  866.     backend = CookieSession

  867. 

  868.     def test_save(self):

  869.         """

  870.         This test tested exists() in the other session backends, but that

  871.         doesn't make sense for us.

  872.         """

  873.         pass

  874. 

  875.     def test_cycle(self):

  876.         """

  877.         This test tested cycle_key() which would create a new session

  878.         key for the same session data. But we can't invalidate previously

  879.         signed cookies (other than letting them expire naturally) so

  880.         testing for this behavior is meaningless.

  881.         """

  882.         pass

  883. 

  884.     @unittest.expectedFailure

  885.     def test_actual_expiry(self):

  886.         # The cookie backend doesn't handle non-default expiry dates, see #19201

  887.         super().test_actual_expiry()

  888. 

  889.     def test_unpickling_exception(self):

  890.         # signed_cookies backend should handle unpickle exceptions gracefully

  891.         # by creating a new session

  892.         self.assertEqual(self.session.serializer, JSONSerializer)

  893.         self.session.save()

  894.         with mock.patch("django.core.signing.loads", side_effect=ValueError):

  895.             self.session.load()

  896. 

  897.     @unittest.skip(

  898.         "Cookie backend doesn't have an external store to create records in."

  899.     )

  900.     def test_session_load_does_not_create_record(self):

  901.         pass

  902. 

  903.     @unittest.skip(

  904.         "CookieSession is stored in the client and there is no way to query it."

  905.     )

  906.     def test_session_save_does_not_resurrect_session_logged_out_in_other_context(self):

  907.         pass

  908. 

  909. 

  910. class ClearSessionsCommandTests(SimpleTestCase):

  911.     def test_clearsessions_unsupported(self):

  912.         msg = (

  913.             "Session engine 'sessions_tests.no_clear_expired' doesn't "

  914.             "support clearing expired sessions."

  915.         )

  916.         with self.settings(SESSION_ENGINE="sessions_tests.no_clear_expired"):

  917.             with self.assertRaisesMessage(management.CommandError, msg):

  918.                 management.call_command("clearsessions")
About Sign Up Leave Feedback Contact