test_views.py 62 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585
  1. import datetime
  2. import itertools
  3. import re
  4. from importlib import import_module
  5. from unittest import mock
  6. from urllib.parse import quote, urljoin
  7. from django.apps import apps
  8. from django.conf import settings
  9. from django.contrib.admin.models import LogEntry
  10. from django.contrib.auth import BACKEND_SESSION_KEY, REDIRECT_FIELD_NAME, SESSION_KEY
  11. from django.contrib.auth.forms import (
  12. AuthenticationForm,
  13. PasswordChangeForm,
  14. SetPasswordForm,
  15. )
  16. from django.contrib.auth.models import Permission, User
  17. from django.contrib.auth.views import (
  18. INTERNAL_RESET_SESSION_TOKEN,
  19. LoginView,
  20. RedirectURLMixin,
  21. logout_then_login,
  22. redirect_to_login,
  23. )
  24. from django.contrib.contenttypes.models import ContentType
  25. from django.contrib.sessions.middleware import SessionMiddleware
  26. from django.contrib.sites.requests import RequestSite
  27. from django.core import mail
  28. from django.core.exceptions import ImproperlyConfigured
  29. from django.db import connection
  30. from django.http import HttpRequest, HttpResponse
  31. from django.middleware.csrf import CsrfViewMiddleware, get_token
  32. from django.test import Client, TestCase, ignore_warnings, override_settings
  33. from django.test.client import RedirectCycleError
  34. from django.urls import NoReverseMatch, reverse, reverse_lazy
  35. from django.utils.deprecation import RemovedInDjango50Warning
  36. from django.utils.http import urlsafe_base64_encode
  37. from .client import PasswordResetConfirmClient
  38. from .models import CustomUser, UUIDUser
  39. from .settings import AUTH_TEMPLATES
  40. class RedirectURLMixinTests(TestCase):
  41. @override_settings(ROOT_URLCONF="auth_tests.urls")
  42. def test_get_default_redirect_url_next_page(self):
  43. class RedirectURLView(RedirectURLMixin):
  44. next_page = "/custom/"
  45. self.assertEqual(RedirectURLView().get_default_redirect_url(), "/custom/")
  46. def test_get_default_redirect_url_no_next_page(self):
  47. msg = "No URL to redirect to. Provide a next_page."
  48. with self.assertRaisesMessage(ImproperlyConfigured, msg):
  49. RedirectURLMixin().get_default_redirect_url()
  50. @override_settings(
  51. LANGUAGES=[("en", "English")],
  52. LANGUAGE_CODE="en",
  53. TEMPLATES=AUTH_TEMPLATES,
  54. ROOT_URLCONF="auth_tests.urls",
  55. )
  56. class AuthViewsTestCase(TestCase):
  57. """
  58. Helper base class for the test classes that follow.
  59. """
  60. @classmethod
  61. def setUpTestData(cls):
  62. cls.u1 = User.objects.create_user(
  63. username="testclient", password="password", email="testclient@example.com"
  64. )
  65. cls.u3 = User.objects.create_user(
  66. username="staff", password="password", email="staffmember@example.com"
  67. )
  68. def login(self, username="testclient", password="password", url="/login/"):
  69. response = self.client.post(
  70. url,
  71. {
  72. "username": username,
  73. "password": password,
  74. },
  75. )
  76. self.assertIn(SESSION_KEY, self.client.session)
  77. return response
  78. def logout(self):
  79. response = self.client.post("/admin/logout/")
  80. self.assertEqual(response.status_code, 200)
  81. self.assertNotIn(SESSION_KEY, self.client.session)
  82. def assertFormError(self, response, error):
  83. """Assert that error is found in response.context['form'] errors"""
  84. form_errors = list(itertools.chain(*response.context["form"].errors.values()))
  85. self.assertIn(str(error), form_errors)
  86. @override_settings(ROOT_URLCONF="django.contrib.auth.urls")
  87. class AuthViewNamedURLTests(AuthViewsTestCase):
  88. def test_named_urls(self):
  89. "Named URLs should be reversible"
  90. expected_named_urls = [
  91. ("login", [], {}),
  92. ("logout", [], {}),
  93. ("password_change", [], {}),
  94. ("password_change_done", [], {}),
  95. ("password_reset", [], {}),
  96. ("password_reset_done", [], {}),
  97. (
  98. "password_reset_confirm",
  99. [],
  100. {
  101. "uidb64": "aaaaaaa",
  102. "token": "1111-aaaaa",
  103. },
  104. ),
  105. ("password_reset_complete", [], {}),
  106. ]
  107. for name, args, kwargs in expected_named_urls:
  108. with self.subTest(name=name):
  109. try:
  110. reverse(name, args=args, kwargs=kwargs)
  111. except NoReverseMatch:
  112. self.fail(
  113. "Reversal of url named '%s' failed with NoReverseMatch" % name
  114. )
  115. class PasswordResetTest(AuthViewsTestCase):
  116. def setUp(self):
  117. self.client = PasswordResetConfirmClient()
  118. def test_email_not_found(self):
  119. """If the provided email is not registered, don't raise any error but
  120. also don't send any email."""
  121. response = self.client.get("/password_reset/")
  122. self.assertEqual(response.status_code, 200)
  123. response = self.client.post(
  124. "/password_reset/", {"email": "not_a_real_email@email.com"}
  125. )
  126. self.assertEqual(response.status_code, 302)
  127. self.assertEqual(len(mail.outbox), 0)
  128. def test_email_found(self):
  129. "Email is sent if a valid email address is provided for password reset"
  130. response = self.client.post(
  131. "/password_reset/", {"email": "staffmember@example.com"}
  132. )
  133. self.assertEqual(response.status_code, 302)
  134. self.assertEqual(len(mail.outbox), 1)
  135. self.assertIn("http://", mail.outbox[0].body)
  136. self.assertEqual(settings.DEFAULT_FROM_EMAIL, mail.outbox[0].from_email)
  137. # optional multipart text/html email has been added. Make sure original,
  138. # default functionality is 100% the same
  139. self.assertFalse(mail.outbox[0].message().is_multipart())
  140. def test_extra_email_context(self):
  141. """
  142. extra_email_context should be available in the email template context.
  143. """
  144. response = self.client.post(
  145. "/password_reset_extra_email_context/",
  146. {"email": "staffmember@example.com"},
  147. )
  148. self.assertEqual(response.status_code, 302)
  149. self.assertEqual(len(mail.outbox), 1)
  150. self.assertIn('Email email context: "Hello!"', mail.outbox[0].body)
  151. self.assertIn("http://custom.example.com/reset/", mail.outbox[0].body)
  152. def test_html_mail_template(self):
  153. """
  154. A multipart email with text/plain and text/html is sent
  155. if the html_email_template parameter is passed to the view
  156. """
  157. response = self.client.post(
  158. "/password_reset/html_email_template/", {"email": "staffmember@example.com"}
  159. )
  160. self.assertEqual(response.status_code, 302)
  161. self.assertEqual(len(mail.outbox), 1)
  162. message = mail.outbox[0].message()
  163. self.assertEqual(len(message.get_payload()), 2)
  164. self.assertTrue(message.is_multipart())
  165. self.assertEqual(message.get_payload(0).get_content_type(), "text/plain")
  166. self.assertEqual(message.get_payload(1).get_content_type(), "text/html")
  167. self.assertNotIn("<html>", message.get_payload(0).get_payload())
  168. self.assertIn("<html>", message.get_payload(1).get_payload())
  169. def test_email_found_custom_from(self):
  170. """
  171. Email is sent if a valid email address is provided for password reset
  172. when a custom from_email is provided.
  173. """
  174. response = self.client.post(
  175. "/password_reset_from_email/", {"email": "staffmember@example.com"}
  176. )
  177. self.assertEqual(response.status_code, 302)
  178. self.assertEqual(len(mail.outbox), 1)
  179. self.assertEqual("staffmember@example.com", mail.outbox[0].from_email)
  180. # Skip any 500 handler action (like sending more mail...)
  181. @override_settings(DEBUG_PROPAGATE_EXCEPTIONS=True)
  182. def test_poisoned_http_host(self):
  183. "Poisoned HTTP_HOST headers can't be used for reset emails"
  184. # This attack is based on the way browsers handle URLs. The colon
  185. # should be used to separate the port, but if the URL contains an @,
  186. # the colon is interpreted as part of a username for login purposes,
  187. # making 'evil.com' the request domain. Since HTTP_HOST is used to
  188. # produce a meaningful reset URL, we need to be certain that the
  189. # HTTP_HOST header isn't poisoned. This is done as a check when get_host()
  190. # is invoked, but we check here as a practical consequence.
  191. with self.assertLogs("django.security.DisallowedHost", "ERROR"):
  192. response = self.client.post(
  193. "/password_reset/",
  194. {"email": "staffmember@example.com"},
  195. headers={"host": "www.example:dr.frankenstein@evil.tld"},
  196. )
  197. self.assertEqual(response.status_code, 400)
  198. self.assertEqual(len(mail.outbox), 0)
  199. # Skip any 500 handler action (like sending more mail...)
  200. @override_settings(DEBUG_PROPAGATE_EXCEPTIONS=True)
  201. def test_poisoned_http_host_admin_site(self):
  202. "Poisoned HTTP_HOST headers can't be used for reset emails on admin views"
  203. with self.assertLogs("django.security.DisallowedHost", "ERROR"):
  204. response = self.client.post(
  205. "/admin_password_reset/",
  206. {"email": "staffmember@example.com"},
  207. headers={"host": "www.example:dr.frankenstein@evil.tld"},
  208. )
  209. self.assertEqual(response.status_code, 400)
  210. self.assertEqual(len(mail.outbox), 0)
  211. def _test_confirm_start(self):
  212. # Start by creating the email
  213. self.client.post("/password_reset/", {"email": "staffmember@example.com"})
  214. self.assertEqual(len(mail.outbox), 1)
  215. return self._read_signup_email(mail.outbox[0])
  216. def _read_signup_email(self, email):
  217. urlmatch = re.search(r"https?://[^/]*(/.*reset/\S*)", email.body)
  218. self.assertIsNotNone(urlmatch, "No URL found in sent email")
  219. return urlmatch[0], urlmatch[1]
  220. def test_confirm_valid(self):
  221. url, path = self._test_confirm_start()
  222. response = self.client.get(path)
  223. # redirect to a 'complete' page:
  224. self.assertContains(response, "Please enter your new password")
  225. def test_confirm_invalid(self):
  226. url, path = self._test_confirm_start()
  227. # Let's munge the token in the path, but keep the same length,
  228. # in case the URLconf will reject a different length.
  229. path = path[:-5] + ("0" * 4) + path[-1]
  230. response = self.client.get(path)
  231. self.assertContains(response, "The password reset link was invalid")
  232. def test_confirm_invalid_user(self):
  233. # A nonexistent user returns a 200 response, not a 404.
  234. response = self.client.get("/reset/123456/1-1/")
  235. self.assertContains(response, "The password reset link was invalid")
  236. def test_confirm_overflow_user(self):
  237. # A base36 user id that overflows int returns a 200 response.
  238. response = self.client.get("/reset/zzzzzzzzzzzzz/1-1/")
  239. self.assertContains(response, "The password reset link was invalid")
  240. def test_confirm_invalid_post(self):
  241. # Same as test_confirm_invalid, but trying to do a POST instead.
  242. url, path = self._test_confirm_start()
  243. path = path[:-5] + ("0" * 4) + path[-1]
  244. self.client.post(
  245. path,
  246. {
  247. "new_password1": "anewpassword",
  248. "new_password2": " anewpassword",
  249. },
  250. )
  251. # Check the password has not been changed
  252. u = User.objects.get(email="staffmember@example.com")
  253. self.assertTrue(not u.check_password("anewpassword"))
  254. def test_confirm_invalid_hash(self):
  255. """A POST with an invalid token is rejected."""
  256. u = User.objects.get(email="staffmember@example.com")
  257. original_password = u.password
  258. url, path = self._test_confirm_start()
  259. path_parts = path.split("-")
  260. path_parts[-1] = ("0") * 20 + "/"
  261. path = "-".join(path_parts)
  262. response = self.client.post(
  263. path,
  264. {
  265. "new_password1": "anewpassword",
  266. "new_password2": "anewpassword",
  267. },
  268. )
  269. self.assertIs(response.context["validlink"], False)
  270. u.refresh_from_db()
  271. self.assertEqual(original_password, u.password) # password hasn't changed
  272. def test_confirm_complete(self):
  273. url, path = self._test_confirm_start()
  274. response = self.client.post(
  275. path, {"new_password1": "anewpassword", "new_password2": "anewpassword"}
  276. )
  277. # Check the password has been changed
  278. u = User.objects.get(email="staffmember@example.com")
  279. self.assertTrue(u.check_password("anewpassword"))
  280. # The reset token is deleted from the session.
  281. self.assertNotIn(INTERNAL_RESET_SESSION_TOKEN, self.client.session)
  282. # Check we can't use the link again
  283. response = self.client.get(path)
  284. self.assertContains(response, "The password reset link was invalid")
  285. def test_confirm_different_passwords(self):
  286. url, path = self._test_confirm_start()
  287. response = self.client.post(
  288. path, {"new_password1": "anewpassword", "new_password2": "x"}
  289. )
  290. self.assertFormError(
  291. response, SetPasswordForm.error_messages["password_mismatch"]
  292. )
  293. def test_reset_redirect_default(self):
  294. response = self.client.post(
  295. "/password_reset/", {"email": "staffmember@example.com"}
  296. )
  297. self.assertRedirects(
  298. response, "/password_reset/done/", fetch_redirect_response=False
  299. )
  300. def test_reset_custom_redirect(self):
  301. response = self.client.post(
  302. "/password_reset/custom_redirect/", {"email": "staffmember@example.com"}
  303. )
  304. self.assertRedirects(response, "/custom/", fetch_redirect_response=False)
  305. def test_reset_custom_redirect_named(self):
  306. response = self.client.post(
  307. "/password_reset/custom_redirect/named/",
  308. {"email": "staffmember@example.com"},
  309. )
  310. self.assertRedirects(
  311. response, "/password_reset/", fetch_redirect_response=False
  312. )
  313. def test_confirm_redirect_default(self):
  314. url, path = self._test_confirm_start()
  315. response = self.client.post(
  316. path, {"new_password1": "anewpassword", "new_password2": "anewpassword"}
  317. )
  318. self.assertRedirects(response, "/reset/done/", fetch_redirect_response=False)
  319. def test_confirm_redirect_custom(self):
  320. url, path = self._test_confirm_start()
  321. path = path.replace("/reset/", "/reset/custom/")
  322. response = self.client.post(
  323. path, {"new_password1": "anewpassword", "new_password2": "anewpassword"}
  324. )
  325. self.assertRedirects(response, "/custom/", fetch_redirect_response=False)
  326. def test_confirm_redirect_custom_named(self):
  327. url, path = self._test_confirm_start()
  328. path = path.replace("/reset/", "/reset/custom/named/")
  329. response = self.client.post(
  330. path, {"new_password1": "anewpassword", "new_password2": "anewpassword"}
  331. )
  332. self.assertRedirects(
  333. response, "/password_reset/", fetch_redirect_response=False
  334. )
  335. def test_confirm_custom_reset_url_token(self):
  336. url, path = self._test_confirm_start()
  337. path = path.replace("/reset/", "/reset/custom/token/")
  338. self.client.reset_url_token = "set-passwordcustom"
  339. response = self.client.post(
  340. path,
  341. {"new_password1": "anewpassword", "new_password2": "anewpassword"},
  342. )
  343. self.assertRedirects(response, "/reset/done/", fetch_redirect_response=False)
  344. def test_confirm_login_post_reset(self):
  345. url, path = self._test_confirm_start()
  346. path = path.replace("/reset/", "/reset/post_reset_login/")
  347. response = self.client.post(
  348. path, {"new_password1": "anewpassword", "new_password2": "anewpassword"}
  349. )
  350. self.assertRedirects(response, "/reset/done/", fetch_redirect_response=False)
  351. self.assertIn(SESSION_KEY, self.client.session)
  352. @override_settings(
  353. AUTHENTICATION_BACKENDS=[
  354. "django.contrib.auth.backends.ModelBackend",
  355. "django.contrib.auth.backends.AllowAllUsersModelBackend",
  356. ]
  357. )
  358. def test_confirm_login_post_reset_custom_backend(self):
  359. # This backend is specified in the URL pattern.
  360. backend = "django.contrib.auth.backends.AllowAllUsersModelBackend"
  361. url, path = self._test_confirm_start()
  362. path = path.replace("/reset/", "/reset/post_reset_login_custom_backend/")
  363. response = self.client.post(
  364. path, {"new_password1": "anewpassword", "new_password2": "anewpassword"}
  365. )
  366. self.assertRedirects(response, "/reset/done/", fetch_redirect_response=False)
  367. self.assertIn(SESSION_KEY, self.client.session)
  368. self.assertEqual(self.client.session[BACKEND_SESSION_KEY], backend)
  369. def test_confirm_login_post_reset_already_logged_in(self):
  370. url, path = self._test_confirm_start()
  371. path = path.replace("/reset/", "/reset/post_reset_login/")
  372. self.login()
  373. response = self.client.post(
  374. path, {"new_password1": "anewpassword", "new_password2": "anewpassword"}
  375. )
  376. self.assertRedirects(response, "/reset/done/", fetch_redirect_response=False)
  377. self.assertIn(SESSION_KEY, self.client.session)
  378. def test_confirm_display_user_from_form(self):
  379. url, path = self._test_confirm_start()
  380. response = self.client.get(path)
  381. # The password_reset_confirm() view passes the user object to the
  382. # SetPasswordForm``, even on GET requests (#16919). For this test,
  383. # {{ form.user }}`` is rendered in the template
  384. # registration/password_reset_confirm.html.
  385. username = User.objects.get(email="staffmember@example.com").username
  386. self.assertContains(response, "Hello, %s." % username)
  387. # However, the view should NOT pass any user object on a form if the
  388. # password reset link was invalid.
  389. response = self.client.get("/reset/zzzzzzzzzzzzz/1-1/")
  390. self.assertContains(response, "Hello, .")
  391. def test_confirm_link_redirects_to_set_password_page(self):
  392. url, path = self._test_confirm_start()
  393. # Don't use PasswordResetConfirmClient (self.client) here which
  394. # automatically fetches the redirect page.
  395. client = Client()
  396. response = client.get(path)
  397. token = response.resolver_match.kwargs["token"]
  398. uuidb64 = response.resolver_match.kwargs["uidb64"]
  399. self.assertRedirects(response, "/reset/%s/set-password/" % uuidb64)
  400. self.assertEqual(client.session["_password_reset_token"], token)
  401. def test_confirm_custom_reset_url_token_link_redirects_to_set_password_page(self):
  402. url, path = self._test_confirm_start()
  403. path = path.replace("/reset/", "/reset/custom/token/")
  404. client = Client()
  405. response = client.get(path)
  406. token = response.resolver_match.kwargs["token"]
  407. uuidb64 = response.resolver_match.kwargs["uidb64"]
  408. self.assertRedirects(
  409. response, "/reset/custom/token/%s/set-passwordcustom/" % uuidb64
  410. )
  411. self.assertEqual(client.session["_password_reset_token"], token)
  412. def test_invalid_link_if_going_directly_to_the_final_reset_password_url(self):
  413. url, path = self._test_confirm_start()
  414. _, uuidb64, _ = path.strip("/").split("/")
  415. response = Client().get("/reset/%s/set-password/" % uuidb64)
  416. self.assertContains(response, "The password reset link was invalid")
  417. def test_missing_kwargs(self):
  418. msg = "The URL path must contain 'uidb64' and 'token' parameters."
  419. with self.assertRaisesMessage(ImproperlyConfigured, msg):
  420. self.client.get("/reset/missing_parameters/")
  421. @override_settings(AUTH_USER_MODEL="auth_tests.CustomUser")
  422. class CustomUserPasswordResetTest(AuthViewsTestCase):
  423. user_email = "staffmember@example.com"
  424. @classmethod
  425. def setUpTestData(cls):
  426. cls.u1 = CustomUser.custom_objects.create(
  427. email="staffmember@example.com",
  428. date_of_birth=datetime.date(1976, 11, 8),
  429. )
  430. cls.u1.set_password("password")
  431. cls.u1.save()
  432. def setUp(self):
  433. self.client = PasswordResetConfirmClient()
  434. def _test_confirm_start(self):
  435. # Start by creating the email
  436. response = self.client.post("/password_reset/", {"email": self.user_email})
  437. self.assertEqual(response.status_code, 302)
  438. self.assertEqual(len(mail.outbox), 1)
  439. return self._read_signup_email(mail.outbox[0])
  440. def _read_signup_email(self, email):
  441. urlmatch = re.search(r"https?://[^/]*(/.*reset/\S*)", email.body)
  442. self.assertIsNotNone(urlmatch, "No URL found in sent email")
  443. return urlmatch[0], urlmatch[1]
  444. def test_confirm_valid_custom_user(self):
  445. url, path = self._test_confirm_start()
  446. response = self.client.get(path)
  447. # redirect to a 'complete' page:
  448. self.assertContains(response, "Please enter your new password")
  449. # then submit a new password
  450. response = self.client.post(
  451. path,
  452. {
  453. "new_password1": "anewpassword",
  454. "new_password2": "anewpassword",
  455. },
  456. )
  457. self.assertRedirects(response, "/reset/done/")
  458. @override_settings(AUTH_USER_MODEL="auth_tests.UUIDUser")
  459. class UUIDUserPasswordResetTest(CustomUserPasswordResetTest):
  460. def _test_confirm_start(self):
  461. # instead of fixture
  462. UUIDUser.objects.create_user(
  463. email=self.user_email,
  464. username="foo",
  465. password="foo",
  466. )
  467. return super()._test_confirm_start()
  468. def test_confirm_invalid_uuid(self):
  469. """A uidb64 that decodes to a non-UUID doesn't crash."""
  470. _, path = self._test_confirm_start()
  471. invalid_uidb64 = urlsafe_base64_encode(b"INVALID_UUID")
  472. first, _uuidb64_, second = path.strip("/").split("/")
  473. response = self.client.get(
  474. "/" + "/".join((first, invalid_uidb64, second)) + "/"
  475. )
  476. self.assertContains(response, "The password reset link was invalid")
  477. class ChangePasswordTest(AuthViewsTestCase):
  478. def fail_login(self):
  479. response = self.client.post(
  480. "/login/",
  481. {
  482. "username": "testclient",
  483. "password": "password",
  484. },
  485. )
  486. self.assertFormError(
  487. response,
  488. AuthenticationForm.error_messages["invalid_login"]
  489. % {"username": User._meta.get_field("username").verbose_name},
  490. )
  491. def logout(self):
  492. self.client.post("/logout/")
  493. def test_password_change_fails_with_invalid_old_password(self):
  494. self.login()
  495. response = self.client.post(
  496. "/password_change/",
  497. {
  498. "old_password": "donuts",
  499. "new_password1": "password1",
  500. "new_password2": "password1",
  501. },
  502. )
  503. self.assertFormError(
  504. response, PasswordChangeForm.error_messages["password_incorrect"]
  505. )
  506. def test_password_change_fails_with_mismatched_passwords(self):
  507. self.login()
  508. response = self.client.post(
  509. "/password_change/",
  510. {
  511. "old_password": "password",
  512. "new_password1": "password1",
  513. "new_password2": "donuts",
  514. },
  515. )
  516. self.assertFormError(
  517. response, SetPasswordForm.error_messages["password_mismatch"]
  518. )
  519. def test_password_change_succeeds(self):
  520. self.login()
  521. self.client.post(
  522. "/password_change/",
  523. {
  524. "old_password": "password",
  525. "new_password1": "password1",
  526. "new_password2": "password1",
  527. },
  528. )
  529. self.fail_login()
  530. self.login(password="password1")
  531. def test_password_change_done_succeeds(self):
  532. self.login()
  533. response = self.client.post(
  534. "/password_change/",
  535. {
  536. "old_password": "password",
  537. "new_password1": "password1",
  538. "new_password2": "password1",
  539. },
  540. )
  541. self.assertRedirects(
  542. response, "/password_change/done/", fetch_redirect_response=False
  543. )
  544. @override_settings(LOGIN_URL="/login/")
  545. def test_password_change_done_fails(self):
  546. response = self.client.get("/password_change/done/")
  547. self.assertRedirects(
  548. response,
  549. "/login/?next=/password_change/done/",
  550. fetch_redirect_response=False,
  551. )
  552. def test_password_change_redirect_default(self):
  553. self.login()
  554. response = self.client.post(
  555. "/password_change/",
  556. {
  557. "old_password": "password",
  558. "new_password1": "password1",
  559. "new_password2": "password1",
  560. },
  561. )
  562. self.assertRedirects(
  563. response, "/password_change/done/", fetch_redirect_response=False
  564. )
  565. def test_password_change_redirect_custom(self):
  566. self.login()
  567. response = self.client.post(
  568. "/password_change/custom/",
  569. {
  570. "old_password": "password",
  571. "new_password1": "password1",
  572. "new_password2": "password1",
  573. },
  574. )
  575. self.assertRedirects(response, "/custom/", fetch_redirect_response=False)
  576. def test_password_change_redirect_custom_named(self):
  577. self.login()
  578. response = self.client.post(
  579. "/password_change/custom/named/",
  580. {
  581. "old_password": "password",
  582. "new_password1": "password1",
  583. "new_password2": "password1",
  584. },
  585. )
  586. self.assertRedirects(
  587. response, "/password_reset/", fetch_redirect_response=False
  588. )
  589. class SessionAuthenticationTests(AuthViewsTestCase):
  590. def test_user_password_change_updates_session(self):
  591. """
  592. #21649 - Ensure contrib.auth.views.password_change updates the user's
  593. session auth hash after a password change so the session isn't logged out.
  594. """
  595. self.login()
  596. original_session_key = self.client.session.session_key
  597. response = self.client.post(
  598. "/password_change/",
  599. {
  600. "old_password": "password",
  601. "new_password1": "password1",
  602. "new_password2": "password1",
  603. },
  604. )
  605. # if the hash isn't updated, retrieving the redirection page will fail.
  606. self.assertRedirects(response, "/password_change/done/")
  607. # The session key is rotated.
  608. self.assertNotEqual(original_session_key, self.client.session.session_key)
  609. class LoginTest(AuthViewsTestCase):
  610. def test_current_site_in_context_after_login(self):
  611. response = self.client.get(reverse("login"))
  612. self.assertEqual(response.status_code, 200)
  613. if apps.is_installed("django.contrib.sites"):
  614. Site = apps.get_model("sites.Site")
  615. site = Site.objects.get_current()
  616. self.assertEqual(response.context["site"], site)
  617. self.assertEqual(response.context["site_name"], site.name)
  618. else:
  619. self.assertIsInstance(response.context["site"], RequestSite)
  620. self.assertIsInstance(response.context["form"], AuthenticationForm)
  621. def test_security_check(self):
  622. login_url = reverse("login")
  623. # These URLs should not pass the security check.
  624. bad_urls = (
  625. "http://example.com",
  626. "http:///example.com",
  627. "https://example.com",
  628. "ftp://example.com",
  629. "///example.com",
  630. "//example.com",
  631. 'javascript:alert("XSS")',
  632. )
  633. for bad_url in bad_urls:
  634. with self.subTest(bad_url=bad_url):
  635. nasty_url = "%(url)s?%(next)s=%(bad_url)s" % {
  636. "url": login_url,
  637. "next": REDIRECT_FIELD_NAME,
  638. "bad_url": quote(bad_url),
  639. }
  640. response = self.client.post(
  641. nasty_url,
  642. {
  643. "username": "testclient",
  644. "password": "password",
  645. },
  646. )
  647. self.assertEqual(response.status_code, 302)
  648. self.assertNotIn(
  649. bad_url, response.url, "%s should be blocked" % bad_url
  650. )
  651. # These URLs should pass the security check.
  652. good_urls = (
  653. "/view/?param=http://example.com",
  654. "/view/?param=https://example.com",
  655. "/view?param=ftp://example.com",
  656. "view/?param=//example.com",
  657. "https://testserver/",
  658. "HTTPS://testserver/",
  659. "//testserver/",
  660. "/url%20with%20spaces/",
  661. )
  662. for good_url in good_urls:
  663. with self.subTest(good_url=good_url):
  664. safe_url = "%(url)s?%(next)s=%(good_url)s" % {
  665. "url": login_url,
  666. "next": REDIRECT_FIELD_NAME,
  667. "good_url": quote(good_url),
  668. }
  669. response = self.client.post(
  670. safe_url,
  671. {
  672. "username": "testclient",
  673. "password": "password",
  674. },
  675. )
  676. self.assertEqual(response.status_code, 302)
  677. self.assertIn(good_url, response.url, "%s should be allowed" % good_url)
  678. def test_security_check_https(self):
  679. login_url = reverse("login")
  680. non_https_next_url = "http://testserver/path"
  681. not_secured_url = "%(url)s?%(next)s=%(next_url)s" % {
  682. "url": login_url,
  683. "next": REDIRECT_FIELD_NAME,
  684. "next_url": quote(non_https_next_url),
  685. }
  686. post_data = {
  687. "username": "testclient",
  688. "password": "password",
  689. }
  690. response = self.client.post(not_secured_url, post_data, secure=True)
  691. self.assertEqual(response.status_code, 302)
  692. self.assertNotEqual(response.url, non_https_next_url)
  693. self.assertEqual(response.url, settings.LOGIN_REDIRECT_URL)
  694. def test_login_form_contains_request(self):
  695. # The custom authentication form for this login requires a request to
  696. # initialize it.
  697. response = self.client.post(
  698. "/custom_request_auth_login/",
  699. {
  700. "username": "testclient",
  701. "password": "password",
  702. },
  703. )
  704. # The login was successful.
  705. self.assertRedirects(
  706. response, settings.LOGIN_REDIRECT_URL, fetch_redirect_response=False
  707. )
  708. def test_login_csrf_rotate(self):
  709. """
  710. Makes sure that a login rotates the currently-used CSRF token.
  711. """
  712. def get_response(request):
  713. return HttpResponse()
  714. # Do a GET to establish a CSRF token
  715. # The test client isn't used here as it's a test for middleware.
  716. req = HttpRequest()
  717. CsrfViewMiddleware(get_response).process_view(req, LoginView.as_view(), (), {})
  718. # get_token() triggers CSRF token inclusion in the response
  719. get_token(req)
  720. resp = CsrfViewMiddleware(LoginView.as_view())(req)
  721. csrf_cookie = resp.cookies.get(settings.CSRF_COOKIE_NAME, None)
  722. token1 = csrf_cookie.coded_value
  723. # Prepare the POST request
  724. req = HttpRequest()
  725. req.COOKIES[settings.CSRF_COOKIE_NAME] = token1
  726. req.method = "POST"
  727. req.POST = {
  728. "username": "testclient",
  729. "password": "password",
  730. "csrfmiddlewaretoken": token1,
  731. }
  732. # Use POST request to log in
  733. SessionMiddleware(get_response).process_request(req)
  734. CsrfViewMiddleware(get_response).process_view(req, LoginView.as_view(), (), {})
  735. req.META[
  736. "SERVER_NAME"
  737. ] = "testserver" # Required to have redirect work in login view
  738. req.META["SERVER_PORT"] = 80
  739. resp = CsrfViewMiddleware(LoginView.as_view())(req)
  740. csrf_cookie = resp.cookies.get(settings.CSRF_COOKIE_NAME, None)
  741. token2 = csrf_cookie.coded_value
  742. # Check the CSRF token switched
  743. self.assertNotEqual(token1, token2)
  744. def test_session_key_flushed_on_login(self):
  745. """
  746. To avoid reusing another user's session, ensure a new, empty session is
  747. created if the existing session corresponds to a different authenticated
  748. user.
  749. """
  750. self.login()
  751. original_session_key = self.client.session.session_key
  752. self.login(username="staff")
  753. self.assertNotEqual(original_session_key, self.client.session.session_key)
  754. def test_session_key_flushed_on_login_after_password_change(self):
  755. """
  756. As above, but same user logging in after a password change.
  757. """
  758. self.login()
  759. original_session_key = self.client.session.session_key
  760. # If no password change, session key should not be flushed.
  761. self.login()
  762. self.assertEqual(original_session_key, self.client.session.session_key)
  763. user = User.objects.get(username="testclient")
  764. user.set_password("foobar")
  765. user.save()
  766. self.login(password="foobar")
  767. self.assertNotEqual(original_session_key, self.client.session.session_key)
  768. def test_login_session_without_hash_session_key(self):
  769. """
  770. Session without django.contrib.auth.HASH_SESSION_KEY should login
  771. without an exception.
  772. """
  773. user = User.objects.get(username="testclient")
  774. engine = import_module(settings.SESSION_ENGINE)
  775. session = engine.SessionStore()
  776. session[SESSION_KEY] = user.id
  777. session.save()
  778. original_session_key = session.session_key
  779. self.client.cookies[settings.SESSION_COOKIE_NAME] = original_session_key
  780. self.login()
  781. self.assertNotEqual(original_session_key, self.client.session.session_key)
  782. def test_login_get_default_redirect_url(self):
  783. response = self.login(url="/login/get_default_redirect_url/")
  784. self.assertRedirects(response, "/custom/", fetch_redirect_response=False)
  785. def test_login_next_page(self):
  786. response = self.login(url="/login/next_page/")
  787. self.assertRedirects(response, "/somewhere/", fetch_redirect_response=False)
  788. def test_login_named_next_page_named(self):
  789. response = self.login(url="/login/next_page/named/")
  790. self.assertRedirects(
  791. response, "/password_reset/", fetch_redirect_response=False
  792. )
  793. @override_settings(LOGIN_REDIRECT_URL="/custom/")
  794. def test_login_next_page_overrides_login_redirect_url_setting(self):
  795. response = self.login(url="/login/next_page/")
  796. self.assertRedirects(response, "/somewhere/", fetch_redirect_response=False)
  797. def test_login_redirect_url_overrides_next_page(self):
  798. response = self.login(url="/login/next_page/?next=/test/")
  799. self.assertRedirects(response, "/test/", fetch_redirect_response=False)
  800. def test_login_redirect_url_overrides_get_default_redirect_url(self):
  801. response = self.login(url="/login/get_default_redirect_url/?next=/test/")
  802. self.assertRedirects(response, "/test/", fetch_redirect_response=False)
  803. class LoginURLSettings(AuthViewsTestCase):
  804. """Tests for settings.LOGIN_URL."""
  805. def assertLoginURLEquals(self, url):
  806. response = self.client.get("/login_required/")
  807. self.assertRedirects(response, url, fetch_redirect_response=False)
  808. @override_settings(LOGIN_URL="/login/")
  809. def test_standard_login_url(self):
  810. self.assertLoginURLEquals("/login/?next=/login_required/")
  811. @override_settings(LOGIN_URL="login")
  812. def test_named_login_url(self):
  813. self.assertLoginURLEquals("/login/?next=/login_required/")
  814. @override_settings(LOGIN_URL="http://remote.example.com/login")
  815. def test_remote_login_url(self):
  816. quoted_next = quote("http://testserver/login_required/")
  817. expected = "http://remote.example.com/login?next=%s" % quoted_next
  818. self.assertLoginURLEquals(expected)
  819. @override_settings(LOGIN_URL="https:///login/")
  820. def test_https_login_url(self):
  821. quoted_next = quote("http://testserver/login_required/")
  822. expected = "https:///login/?next=%s" % quoted_next
  823. self.assertLoginURLEquals(expected)
  824. @override_settings(LOGIN_URL="/login/?pretty=1")
  825. def test_login_url_with_querystring(self):
  826. self.assertLoginURLEquals("/login/?pretty=1&next=/login_required/")
  827. @override_settings(LOGIN_URL="http://remote.example.com/login/?next=/default/")
  828. def test_remote_login_url_with_next_querystring(self):
  829. quoted_next = quote("http://testserver/login_required/")
  830. expected = "http://remote.example.com/login/?next=%s" % quoted_next
  831. self.assertLoginURLEquals(expected)
  832. @override_settings(LOGIN_URL=reverse_lazy("login"))
  833. def test_lazy_login_url(self):
  834. self.assertLoginURLEquals("/login/?next=/login_required/")
  835. class LoginRedirectUrlTest(AuthViewsTestCase):
  836. """Tests for settings.LOGIN_REDIRECT_URL."""
  837. def assertLoginRedirectURLEqual(self, url):
  838. response = self.login()
  839. self.assertRedirects(response, url, fetch_redirect_response=False)
  840. def test_default(self):
  841. self.assertLoginRedirectURLEqual("/accounts/profile/")
  842. @override_settings(LOGIN_REDIRECT_URL="/custom/")
  843. def test_custom(self):
  844. self.assertLoginRedirectURLEqual("/custom/")
  845. @override_settings(LOGIN_REDIRECT_URL="password_reset")
  846. def test_named(self):
  847. self.assertLoginRedirectURLEqual("/password_reset/")
  848. @override_settings(LOGIN_REDIRECT_URL="http://remote.example.com/welcome/")
  849. def test_remote(self):
  850. self.assertLoginRedirectURLEqual("http://remote.example.com/welcome/")
  851. class RedirectToLoginTests(AuthViewsTestCase):
  852. """Tests for the redirect_to_login view"""
  853. @override_settings(LOGIN_URL=reverse_lazy("login"))
  854. def test_redirect_to_login_with_lazy(self):
  855. login_redirect_response = redirect_to_login(next="/else/where/")
  856. expected = "/login/?next=/else/where/"
  857. self.assertEqual(expected, login_redirect_response.url)
  858. @override_settings(LOGIN_URL=reverse_lazy("login"))
  859. def test_redirect_to_login_with_lazy_and_unicode(self):
  860. login_redirect_response = redirect_to_login(next="/else/where/झ/")
  861. expected = "/login/?next=/else/where/%E0%A4%9D/"
  862. self.assertEqual(expected, login_redirect_response.url)
  863. class LogoutThenLoginTests(AuthViewsTestCase):
  864. """Tests for the logout_then_login view"""
  865. def confirm_logged_out(self):
  866. self.assertNotIn(SESSION_KEY, self.client.session)
  867. @override_settings(LOGIN_URL="/login/")
  868. def test_default_logout_then_login(self):
  869. self.login()
  870. req = HttpRequest()
  871. req.method = "POST"
  872. csrf_token = get_token(req)
  873. req.COOKIES[settings.CSRF_COOKIE_NAME] = csrf_token
  874. req.POST = {"csrfmiddlewaretoken": csrf_token}
  875. req.META["SERVER_NAME"] = "testserver"
  876. req.META["SERVER_PORT"] = 80
  877. req.session = self.client.session
  878. response = logout_then_login(req)
  879. self.confirm_logged_out()
  880. self.assertRedirects(response, "/login/", fetch_redirect_response=False)
  881. def test_logout_then_login_with_custom_login(self):
  882. self.login()
  883. req = HttpRequest()
  884. req.method = "POST"
  885. csrf_token = get_token(req)
  886. req.COOKIES[settings.CSRF_COOKIE_NAME] = csrf_token
  887. req.POST = {"csrfmiddlewaretoken": csrf_token}
  888. req.META["SERVER_NAME"] = "testserver"
  889. req.META["SERVER_PORT"] = 80
  890. req.session = self.client.session
  891. response = logout_then_login(req, login_url="/custom/")
  892. self.confirm_logged_out()
  893. self.assertRedirects(response, "/custom/", fetch_redirect_response=False)
  894. @ignore_warnings(category=RemovedInDjango50Warning)
  895. @override_settings(LOGIN_URL="/login/")
  896. def test_default_logout_then_login_get(self):
  897. self.login()
  898. req = HttpRequest()
  899. req.method = "GET"
  900. req.META["SERVER_NAME"] = "testserver"
  901. req.META["SERVER_PORT"] = 80
  902. req.session = self.client.session
  903. response = logout_then_login(req)
  904. # RemovedInDjango50Warning: When the deprecation ends, replace with
  905. # self.assertEqual(response.status_code, 405)
  906. self.confirm_logged_out()
  907. self.assertRedirects(response, "/login/", fetch_redirect_response=False)
  908. class LoginRedirectAuthenticatedUser(AuthViewsTestCase):
  909. dont_redirect_url = "/login/redirect_authenticated_user_default/"
  910. do_redirect_url = "/login/redirect_authenticated_user/"
  911. def test_default(self):
  912. """Stay on the login page by default."""
  913. self.login()
  914. response = self.client.get(self.dont_redirect_url)
  915. self.assertEqual(response.status_code, 200)
  916. self.assertEqual(response.context["next"], "")
  917. def test_guest(self):
  918. """If not logged in, stay on the same page."""
  919. response = self.client.get(self.do_redirect_url)
  920. self.assertEqual(response.status_code, 200)
  921. def test_redirect(self):
  922. """If logged in, go to default redirected URL."""
  923. self.login()
  924. response = self.client.get(self.do_redirect_url)
  925. self.assertRedirects(
  926. response, "/accounts/profile/", fetch_redirect_response=False
  927. )
  928. @override_settings(LOGIN_REDIRECT_URL="/custom/")
  929. def test_redirect_url(self):
  930. """If logged in, go to custom redirected URL."""
  931. self.login()
  932. response = self.client.get(self.do_redirect_url)
  933. self.assertRedirects(response, "/custom/", fetch_redirect_response=False)
  934. def test_redirect_param(self):
  935. """If next is specified as a GET parameter, go there."""
  936. self.login()
  937. url = self.do_redirect_url + "?next=/custom_next/"
  938. response = self.client.get(url)
  939. self.assertRedirects(response, "/custom_next/", fetch_redirect_response=False)
  940. def test_redirect_loop(self):
  941. """
  942. Detect a redirect loop if LOGIN_REDIRECT_URL is not correctly set,
  943. with and without custom parameters.
  944. """
  945. self.login()
  946. msg = (
  947. "Redirection loop for authenticated user detected. Check that "
  948. "your LOGIN_REDIRECT_URL doesn't point to a login page."
  949. )
  950. with self.settings(LOGIN_REDIRECT_URL=self.do_redirect_url):
  951. with self.assertRaisesMessage(ValueError, msg):
  952. self.client.get(self.do_redirect_url)
  953. url = self.do_redirect_url + "?bla=2"
  954. with self.assertRaisesMessage(ValueError, msg):
  955. self.client.get(url)
  956. def test_permission_required_not_logged_in(self):
  957. # Not logged in ...
  958. with self.settings(LOGIN_URL=self.do_redirect_url):
  959. # redirected to login.
  960. response = self.client.get("/permission_required_redirect/", follow=True)
  961. self.assertEqual(response.status_code, 200)
  962. # exception raised.
  963. response = self.client.get("/permission_required_exception/", follow=True)
  964. self.assertEqual(response.status_code, 403)
  965. # redirected to login.
  966. response = self.client.get(
  967. "/login_and_permission_required_exception/", follow=True
  968. )
  969. self.assertEqual(response.status_code, 200)
  970. def test_permission_required_logged_in(self):
  971. self.login()
  972. # Already logged in...
  973. with self.settings(LOGIN_URL=self.do_redirect_url):
  974. # redirect loop encountered.
  975. with self.assertRaisesMessage(
  976. RedirectCycleError, "Redirect loop detected."
  977. ):
  978. self.client.get("/permission_required_redirect/", follow=True)
  979. # exception raised.
  980. response = self.client.get("/permission_required_exception/", follow=True)
  981. self.assertEqual(response.status_code, 403)
  982. # exception raised.
  983. response = self.client.get(
  984. "/login_and_permission_required_exception/", follow=True
  985. )
  986. self.assertEqual(response.status_code, 403)
  987. class LoginSuccessURLAllowedHostsTest(AuthViewsTestCase):
  988. def test_success_url_allowed_hosts_same_host(self):
  989. response = self.client.post(
  990. "/login/allowed_hosts/",
  991. {
  992. "username": "testclient",
  993. "password": "password",
  994. "next": "https://testserver/home",
  995. },
  996. )
  997. self.assertIn(SESSION_KEY, self.client.session)
  998. self.assertRedirects(
  999. response, "https://testserver/home", fetch_redirect_response=False
  1000. )
  1001. def test_success_url_allowed_hosts_safe_host(self):
  1002. response = self.client.post(
  1003. "/login/allowed_hosts/",
  1004. {
  1005. "username": "testclient",
  1006. "password": "password",
  1007. "next": "https://otherserver/home",
  1008. },
  1009. )
  1010. self.assertIn(SESSION_KEY, self.client.session)
  1011. self.assertRedirects(
  1012. response, "https://otherserver/home", fetch_redirect_response=False
  1013. )
  1014. def test_success_url_allowed_hosts_unsafe_host(self):
  1015. response = self.client.post(
  1016. "/login/allowed_hosts/",
  1017. {
  1018. "username": "testclient",
  1019. "password": "password",
  1020. "next": "https://evil/home",
  1021. },
  1022. )
  1023. self.assertIn(SESSION_KEY, self.client.session)
  1024. self.assertRedirects(
  1025. response, "/accounts/profile/", fetch_redirect_response=False
  1026. )
  1027. class LogoutTest(AuthViewsTestCase):
  1028. def confirm_logged_out(self):
  1029. self.assertNotIn(SESSION_KEY, self.client.session)
  1030. def test_logout_default(self):
  1031. "Logout without next_page option renders the default template"
  1032. self.login()
  1033. response = self.client.post("/logout/")
  1034. self.assertContains(response, "Logged out")
  1035. self.confirm_logged_out()
  1036. def test_logout_with_post(self):
  1037. self.login()
  1038. response = self.client.post("/logout/")
  1039. self.assertContains(response, "Logged out")
  1040. self.confirm_logged_out()
  1041. def test_logout_with_get_raises_deprecation_warning(self):
  1042. self.login()
  1043. msg = (
  1044. "Log out via GET requests is deprecated and will be removed in Django 5.0. "
  1045. "Use POST requests for logging out."
  1046. )
  1047. with self.assertWarnsMessage(RemovedInDjango50Warning, msg):
  1048. response = self.client.get("/logout/")
  1049. self.assertContains(response, "Logged out")
  1050. self.confirm_logged_out()
  1051. def test_14377(self):
  1052. # Bug 14377
  1053. self.login()
  1054. response = self.client.post("/logout/")
  1055. self.assertIn("site", response.context)
  1056. def test_logout_doesnt_cache(self):
  1057. """
  1058. The logout() view should send "no-cache" headers for reasons described
  1059. in #25490.
  1060. """
  1061. response = self.client.post("/logout/")
  1062. self.assertIn("no-store", response.headers["Cache-Control"])
  1063. def test_logout_with_overridden_redirect_url(self):
  1064. # Bug 11223
  1065. self.login()
  1066. response = self.client.post("/logout/next_page/")
  1067. self.assertRedirects(response, "/somewhere/", fetch_redirect_response=False)
  1068. response = self.client.post("/logout/next_page/?next=/login/")
  1069. self.assertRedirects(response, "/login/", fetch_redirect_response=False)
  1070. self.confirm_logged_out()
  1071. def test_logout_with_next_page_specified(self):
  1072. "Logout with next_page option given redirects to specified resource"
  1073. self.login()
  1074. response = self.client.post("/logout/next_page/")
  1075. self.assertRedirects(response, "/somewhere/", fetch_redirect_response=False)
  1076. self.confirm_logged_out()
  1077. def test_logout_with_redirect_argument(self):
  1078. "Logout with query string redirects to specified resource"
  1079. self.login()
  1080. response = self.client.post("/logout/?next=/login/")
  1081. self.assertRedirects(response, "/login/", fetch_redirect_response=False)
  1082. self.confirm_logged_out()
  1083. def test_logout_with_custom_redirect_argument(self):
  1084. "Logout with custom query string redirects to specified resource"
  1085. self.login()
  1086. response = self.client.post("/logout/custom_query/?follow=/somewhere/")
  1087. self.assertRedirects(response, "/somewhere/", fetch_redirect_response=False)
  1088. self.confirm_logged_out()
  1089. def test_logout_with_named_redirect(self):
  1090. "Logout resolves names or URLs passed as next_page."
  1091. self.login()
  1092. response = self.client.post("/logout/next_page/named/")
  1093. self.assertRedirects(
  1094. response, "/password_reset/", fetch_redirect_response=False
  1095. )
  1096. self.confirm_logged_out()
  1097. def test_success_url_allowed_hosts_same_host(self):
  1098. self.login()
  1099. response = self.client.post("/logout/allowed_hosts/?next=https://testserver/")
  1100. self.assertRedirects(
  1101. response, "https://testserver/", fetch_redirect_response=False
  1102. )
  1103. self.confirm_logged_out()
  1104. def test_success_url_allowed_hosts_safe_host(self):
  1105. self.login()
  1106. response = self.client.post("/logout/allowed_hosts/?next=https://otherserver/")
  1107. self.assertRedirects(
  1108. response, "https://otherserver/", fetch_redirect_response=False
  1109. )
  1110. self.confirm_logged_out()
  1111. def test_success_url_allowed_hosts_unsafe_host(self):
  1112. self.login()
  1113. response = self.client.post("/logout/allowed_hosts/?next=https://evil/")
  1114. self.assertRedirects(
  1115. response, "/logout/allowed_hosts/", fetch_redirect_response=False
  1116. )
  1117. self.confirm_logged_out()
  1118. def test_security_check(self):
  1119. logout_url = reverse("logout")
  1120. # These URLs should not pass the security check.
  1121. bad_urls = (
  1122. "http://example.com",
  1123. "http:///example.com",
  1124. "https://example.com",
  1125. "ftp://example.com",
  1126. "///example.com",
  1127. "//example.com",
  1128. 'javascript:alert("XSS")',
  1129. )
  1130. for bad_url in bad_urls:
  1131. with self.subTest(bad_url=bad_url):
  1132. nasty_url = "%(url)s?%(next)s=%(bad_url)s" % {
  1133. "url": logout_url,
  1134. "next": REDIRECT_FIELD_NAME,
  1135. "bad_url": quote(bad_url),
  1136. }
  1137. self.login()
  1138. response = self.client.post(nasty_url)
  1139. self.assertEqual(response.status_code, 302)
  1140. self.assertNotIn(
  1141. bad_url, response.url, "%s should be blocked" % bad_url
  1142. )
  1143. self.confirm_logged_out()
  1144. # These URLs should pass the security check.
  1145. good_urls = (
  1146. "/view/?param=http://example.com",
  1147. "/view/?param=https://example.com",
  1148. "/view?param=ftp://example.com",
  1149. "view/?param=//example.com",
  1150. "https://testserver/",
  1151. "HTTPS://testserver/",
  1152. "//testserver/",
  1153. "/url%20with%20spaces/",
  1154. )
  1155. for good_url in good_urls:
  1156. with self.subTest(good_url=good_url):
  1157. safe_url = "%(url)s?%(next)s=%(good_url)s" % {
  1158. "url": logout_url,
  1159. "next": REDIRECT_FIELD_NAME,
  1160. "good_url": quote(good_url),
  1161. }
  1162. self.login()
  1163. response = self.client.post(safe_url)
  1164. self.assertEqual(response.status_code, 302)
  1165. self.assertIn(good_url, response.url, "%s should be allowed" % good_url)
  1166. self.confirm_logged_out()
  1167. def test_security_check_https(self):
  1168. logout_url = reverse("logout")
  1169. non_https_next_url = "http://testserver/"
  1170. url = "%(url)s?%(next)s=%(next_url)s" % {
  1171. "url": logout_url,
  1172. "next": REDIRECT_FIELD_NAME,
  1173. "next_url": quote(non_https_next_url),
  1174. }
  1175. self.login()
  1176. response = self.client.post(url, secure=True)
  1177. self.assertRedirects(response, logout_url, fetch_redirect_response=False)
  1178. self.confirm_logged_out()
  1179. def test_logout_preserve_language(self):
  1180. """Language is preserved after logout."""
  1181. self.login()
  1182. self.client.post("/setlang/", {"language": "pl"})
  1183. self.assertEqual(self.client.cookies[settings.LANGUAGE_COOKIE_NAME].value, "pl")
  1184. self.client.post("/logout/")
  1185. self.assertEqual(self.client.cookies[settings.LANGUAGE_COOKIE_NAME].value, "pl")
  1186. @override_settings(LOGOUT_REDIRECT_URL="/custom/")
  1187. def test_logout_redirect_url_setting(self):
  1188. self.login()
  1189. response = self.client.post("/logout/")
  1190. self.assertRedirects(response, "/custom/", fetch_redirect_response=False)
  1191. @override_settings(LOGOUT_REDIRECT_URL="/custom/")
  1192. def test_logout_redirect_url_setting_allowed_hosts_unsafe_host(self):
  1193. self.login()
  1194. response = self.client.post("/logout/allowed_hosts/?next=https://evil/")
  1195. self.assertRedirects(response, "/custom/", fetch_redirect_response=False)
  1196. @override_settings(LOGOUT_REDIRECT_URL="logout")
  1197. def test_logout_redirect_url_named_setting(self):
  1198. self.login()
  1199. response = self.client.post("/logout/")
  1200. self.assertContains(response, "Logged out")
  1201. self.confirm_logged_out()
  1202. def get_perm(Model, perm):
  1203. ct = ContentType.objects.get_for_model(Model)
  1204. return Permission.objects.get(content_type=ct, codename=perm)
  1205. # Redirect in test_user_change_password will fail if session auth hash
  1206. # isn't updated after password change (#21649)
  1207. @override_settings(ROOT_URLCONF="auth_tests.urls_admin")
  1208. class ChangelistTests(AuthViewsTestCase):
  1209. @classmethod
  1210. def setUpTestData(cls):
  1211. super().setUpTestData()
  1212. # Make me a superuser before logging in.
  1213. User.objects.filter(username="testclient").update(
  1214. is_staff=True, is_superuser=True
  1215. )
  1216. def setUp(self):
  1217. self.login()
  1218. # Get the latest last_login value.
  1219. self.admin = User.objects.get(pk=self.u1.pk)
  1220. def get_user_data(self, user):
  1221. return {
  1222. "username": user.username,
  1223. "password": user.password,
  1224. "email": user.email,
  1225. "is_active": user.is_active,
  1226. "is_staff": user.is_staff,
  1227. "is_superuser": user.is_superuser,
  1228. "last_login_0": user.last_login.strftime("%Y-%m-%d"),
  1229. "last_login_1": user.last_login.strftime("%H:%M:%S"),
  1230. "initial-last_login_0": user.last_login.strftime("%Y-%m-%d"),
  1231. "initial-last_login_1": user.last_login.strftime("%H:%M:%S"),
  1232. "date_joined_0": user.date_joined.strftime("%Y-%m-%d"),
  1233. "date_joined_1": user.date_joined.strftime("%H:%M:%S"),
  1234. "initial-date_joined_0": user.date_joined.strftime("%Y-%m-%d"),
  1235. "initial-date_joined_1": user.date_joined.strftime("%H:%M:%S"),
  1236. "first_name": user.first_name,
  1237. "last_name": user.last_name,
  1238. }
  1239. # #20078 - users shouldn't be allowed to guess password hashes via
  1240. # repeated password__startswith queries.
  1241. def test_changelist_disallows_password_lookups(self):
  1242. # A lookup that tries to filter on password isn't OK
  1243. with self.assertLogs("django.security.DisallowedModelAdminLookup", "ERROR"):
  1244. response = self.client.get(
  1245. reverse("auth_test_admin:auth_user_changelist")
  1246. + "?password__startswith=sha1$"
  1247. )
  1248. self.assertEqual(response.status_code, 400)
  1249. def test_user_change_email(self):
  1250. data = self.get_user_data(self.admin)
  1251. data["email"] = "new_" + data["email"]
  1252. response = self.client.post(
  1253. reverse("auth_test_admin:auth_user_change", args=(self.admin.pk,)), data
  1254. )
  1255. self.assertRedirects(response, reverse("auth_test_admin:auth_user_changelist"))
  1256. row = LogEntry.objects.latest("id")
  1257. self.assertEqual(row.get_change_message(), "Changed Email address.")
  1258. def test_user_not_change(self):
  1259. response = self.client.post(
  1260. reverse("auth_test_admin:auth_user_change", args=(self.admin.pk,)),
  1261. self.get_user_data(self.admin),
  1262. )
  1263. self.assertRedirects(response, reverse("auth_test_admin:auth_user_changelist"))
  1264. row = LogEntry.objects.latest("id")
  1265. self.assertEqual(row.get_change_message(), "No fields changed.")
  1266. def test_user_change_password(self):
  1267. user_change_url = reverse(
  1268. "auth_test_admin:auth_user_change", args=(self.admin.pk,)
  1269. )
  1270. password_change_url = reverse(
  1271. "auth_test_admin:auth_user_password_change", args=(self.admin.pk,)
  1272. )
  1273. response = self.client.get(user_change_url)
  1274. # Test the link inside password field help_text.
  1275. rel_link = re.search(
  1276. r'you can change the password using <a href="([^"]*)">this form</a>',
  1277. response.content.decode(),
  1278. )[1]
  1279. self.assertEqual(urljoin(user_change_url, rel_link), password_change_url)
  1280. response = self.client.post(
  1281. password_change_url,
  1282. {
  1283. "password1": "password1",
  1284. "password2": "password1",
  1285. },
  1286. )
  1287. self.assertRedirects(response, user_change_url)
  1288. row = LogEntry.objects.latest("id")
  1289. self.assertEqual(row.get_change_message(), "Changed password.")
  1290. self.logout()
  1291. self.login(password="password1")
  1292. def test_user_change_different_user_password(self):
  1293. u = User.objects.get(email="staffmember@example.com")
  1294. response = self.client.post(
  1295. reverse("auth_test_admin:auth_user_password_change", args=(u.pk,)),
  1296. {
  1297. "password1": "password1",
  1298. "password2": "password1",
  1299. },
  1300. )
  1301. self.assertRedirects(
  1302. response, reverse("auth_test_admin:auth_user_change", args=(u.pk,))
  1303. )
  1304. row = LogEntry.objects.latest("id")
  1305. self.assertEqual(row.user_id, self.admin.pk)
  1306. self.assertEqual(row.object_id, str(u.pk))
  1307. self.assertEqual(row.get_change_message(), "Changed password.")
  1308. def test_password_change_bad_url(self):
  1309. response = self.client.get(
  1310. reverse("auth_test_admin:auth_user_password_change", args=("foobar",))
  1311. )
  1312. self.assertEqual(response.status_code, 404)
  1313. @mock.patch("django.contrib.auth.admin.UserAdmin.has_change_permission")
  1314. def test_user_change_password_passes_user_to_has_change_permission(
  1315. self, has_change_permission
  1316. ):
  1317. url = reverse(
  1318. "auth_test_admin:auth_user_password_change", args=(self.admin.pk,)
  1319. )
  1320. self.client.post(url, {"password1": "password1", "password2": "password1"})
  1321. (_request, user), _kwargs = has_change_permission.call_args
  1322. self.assertEqual(user.pk, self.admin.pk)
  1323. def test_view_user_password_is_readonly(self):
  1324. u = User.objects.get(username="testclient")
  1325. u.is_superuser = False
  1326. u.save()
  1327. original_password = u.password
  1328. u.user_permissions.add(get_perm(User, "view_user"))
  1329. response = self.client.get(
  1330. reverse("auth_test_admin:auth_user_change", args=(u.pk,)),
  1331. )
  1332. algo, salt, hash_string = u.password.split("$")
  1333. self.assertContains(response, '<div class="readonly">testclient</div>')
  1334. # ReadOnlyPasswordHashWidget is used to render the field.
  1335. self.assertContains(
  1336. response,
  1337. "<strong>algorithm</strong>: <bdi>%s</bdi>\n\n"
  1338. "<strong>salt</strong>: <bdi>%s********************</bdi>\n\n"
  1339. "<strong>hash</strong>: <bdi>%s**************************</bdi>\n\n"
  1340. % (
  1341. algo,
  1342. salt[:2],
  1343. hash_string[:6],
  1344. ),
  1345. html=True,
  1346. )
  1347. # Value in POST data is ignored.
  1348. data = self.get_user_data(u)
  1349. data["password"] = "shouldnotchange"
  1350. change_url = reverse("auth_test_admin:auth_user_change", args=(u.pk,))
  1351. response = self.client.post(change_url, data)
  1352. self.assertEqual(response.status_code, 403)
  1353. u.refresh_from_db()
  1354. self.assertEqual(u.password, original_password)
  1355. @override_settings(
  1356. AUTH_USER_MODEL="auth_tests.UUIDUser",
  1357. ROOT_URLCONF="auth_tests.urls_custom_user_admin",
  1358. )
  1359. class UUIDUserTests(TestCase):
  1360. def test_admin_password_change(self):
  1361. u = UUIDUser.objects.create_superuser(
  1362. username="uuid", email="foo@bar.com", password="test"
  1363. )
  1364. self.assertTrue(self.client.login(username="uuid", password="test"))
  1365. user_change_url = reverse(
  1366. "custom_user_admin:auth_tests_uuiduser_change", args=(u.pk,)
  1367. )
  1368. response = self.client.get(user_change_url)
  1369. self.assertEqual(response.status_code, 200)
  1370. password_change_url = reverse(
  1371. "custom_user_admin:auth_user_password_change", args=(u.pk,)
  1372. )
  1373. response = self.client.get(password_change_url)
  1374. # The action attribute is omitted.
  1375. self.assertContains(response, '<form method="post" id="uuiduser_form">')
  1376. # A LogEntry is created with pk=1 which breaks a FK constraint on MySQL
  1377. with connection.constraint_checks_disabled():
  1378. response = self.client.post(
  1379. password_change_url,
  1380. {
  1381. "password1": "password1",
  1382. "password2": "password1",
  1383. },
  1384. )
  1385. self.assertRedirects(response, user_change_url)
  1386. row = LogEntry.objects.latest("id")
  1387. self.assertEqual(row.user_id, 1) # hardcoded in CustomUserAdmin.log_change()
  1388. self.assertEqual(row.object_id, str(u.pk))
  1389. self.assertEqual(row.get_change_message(), "Changed password.")
  1390. # The LogEntry.user column isn't altered to a UUID type so it's set to
  1391. # an integer manually in CustomUserAdmin to avoid an error. To avoid a
  1392. # constraint error, delete the entry before constraints are checked
  1393. # after the test.
  1394. row.delete()