tests.py 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696
  1. # -*- coding: utf-8 -*-
  2. from __future__ import unicode_literals
  3. import logging
  4. import re
  5. import warnings
  6. from django.conf import settings
  7. from django.http import HttpRequest, HttpResponse
  8. from django.middleware.csrf import (
  9. CSRF_TOKEN_LENGTH, REASON_BAD_TOKEN, REASON_NO_CSRF_COOKIE,
  10. CsrfViewMiddleware, _compare_salted_tokens as equivalent_tokens, get_token,
  11. )
  12. from django.template import RequestContext, Template
  13. from django.template.context_processors import csrf
  14. from django.test import SimpleTestCase, override_settings
  15. from django.test.utils import patch_logger
  16. from django.utils.encoding import force_bytes
  17. from django.utils.six import text_type
  18. from django.views.decorators.csrf import (
  19. csrf_exempt, ensure_csrf_cookie, requires_csrf_token,
  20. )
  21. # Response/views used for CsrfResponseMiddleware and CsrfViewMiddleware tests
  22. def post_form_response():
  23. resp = HttpResponse(content="""
  24. <html><body><h1>\u00a1Unicode!<form method="post"><input type="text" /></form></body></html>
  25. """, mimetype="text/html")
  26. return resp
  27. def post_form_view(request):
  28. """A view that returns a POST form (without a token)"""
  29. return post_form_response()
  30. # Response/views used for template tag tests
  31. def token_view(request):
  32. """A view that uses {% csrf_token %}"""
  33. context = RequestContext(request, processors=[csrf])
  34. template = Template("{% csrf_token %}")
  35. return HttpResponse(template.render(context))
  36. def non_token_view_using_request_processor(request):
  37. """
  38. A view that doesn't use the token, but does use the csrf view processor.
  39. """
  40. context = RequestContext(request, processors=[csrf])
  41. template = Template("")
  42. return HttpResponse(template.render(context))
  43. class TestingHttpRequest(HttpRequest):
  44. """
  45. A version of HttpRequest that allows us to change some things
  46. more easily
  47. """
  48. def is_secure(self):
  49. return getattr(self, '_is_secure_override', False)
  50. class CsrfViewMiddlewareTest(SimpleTestCase):
  51. _csrf_id = _csrf_id_cookie = '1bcdefghij2bcdefghij3bcdefghij4bcdefghij5bcdefghij6bcdefghijABCD'
  52. def _get_GET_no_csrf_cookie_request(self):
  53. return TestingHttpRequest()
  54. def _get_GET_csrf_cookie_request(self):
  55. req = TestingHttpRequest()
  56. req.COOKIES[settings.CSRF_COOKIE_NAME] = self._csrf_id_cookie
  57. return req
  58. def _get_POST_csrf_cookie_request(self):
  59. req = self._get_GET_csrf_cookie_request()
  60. req.method = "POST"
  61. return req
  62. def _get_POST_no_csrf_cookie_request(self):
  63. req = self._get_GET_no_csrf_cookie_request()
  64. req.method = "POST"
  65. return req
  66. def _get_POST_request_with_token(self):
  67. req = self._get_POST_csrf_cookie_request()
  68. req.POST['csrfmiddlewaretoken'] = self._csrf_id
  69. return req
  70. def _get_POST_bare_secret_csrf_cookie_request(self):
  71. req = self._get_POST_no_csrf_cookie_request()
  72. req.COOKIES[settings.CSRF_COOKIE_NAME] = self._csrf_id_cookie[:32]
  73. return req
  74. def _get_POST_bare_secret_csrf_cookie_request_with_token(self):
  75. req = self._get_POST_bare_secret_csrf_cookie_request()
  76. req.POST['csrfmiddlewaretoken'] = self._csrf_id_cookie[:32]
  77. return req
  78. def _check_token_present(self, response, csrf_id=None):
  79. text = text_type(response.content, response.charset)
  80. match = re.search("name='csrfmiddlewaretoken' value='(.*?)'", text)
  81. csrf_token = csrf_id or self._csrf_id
  82. self.assertTrue(
  83. match and equivalent_tokens(csrf_token, match.group(1)),
  84. "Could not find csrfmiddlewaretoken to match %s" % csrf_token
  85. )
  86. def test_process_view_token_too_long(self):
  87. """
  88. If the token is longer than expected, it is ignored and a new token is
  89. created.
  90. """
  91. req = self._get_GET_no_csrf_cookie_request()
  92. req.COOKIES[settings.CSRF_COOKIE_NAME] = 'x' * 100000
  93. CsrfViewMiddleware().process_view(req, token_view, (), {})
  94. resp = token_view(req)
  95. resp2 = CsrfViewMiddleware().process_response(req, resp)
  96. csrf_cookie = resp2.cookies.get(settings.CSRF_COOKIE_NAME, False)
  97. self.assertEqual(len(csrf_cookie.value), CSRF_TOKEN_LENGTH)
  98. def test_process_view_token_invalid_chars(self):
  99. """
  100. If the token contains non-alphanumeric characters, it is ignored and a
  101. new token is created.
  102. """
  103. token = ('!@#' + self._csrf_id)[:CSRF_TOKEN_LENGTH]
  104. req = self._get_GET_no_csrf_cookie_request()
  105. req.COOKIES[settings.CSRF_COOKIE_NAME] = token
  106. CsrfViewMiddleware().process_view(req, token_view, (), {})
  107. resp = token_view(req)
  108. resp2 = CsrfViewMiddleware().process_response(req, resp)
  109. csrf_cookie = resp2.cookies.get(settings.CSRF_COOKIE_NAME, False)
  110. self.assertEqual(len(csrf_cookie.value), CSRF_TOKEN_LENGTH)
  111. self.assertNotEqual(csrf_cookie.value, token)
  112. def test_process_view_token_invalid_bytes(self):
  113. """
  114. If the token contains improperly encoded unicode, it is ignored and a
  115. new token is created.
  116. """
  117. token = (b"<1>\xc2\xa1" + force_bytes(self._csrf_id, 'ascii'))[:CSRF_TOKEN_LENGTH]
  118. req = self._get_GET_no_csrf_cookie_request()
  119. req.COOKIES[settings.CSRF_COOKIE_NAME] = token
  120. # We expect a UnicodeWarning here, because we used broken utf-8 on purpose
  121. with warnings.catch_warnings():
  122. warnings.filterwarnings("ignore", category=UnicodeWarning)
  123. CsrfViewMiddleware().process_view(req, token_view, (), {})
  124. resp = token_view(req)
  125. resp2 = CsrfViewMiddleware().process_response(req, resp)
  126. csrf_cookie = resp2.cookies.get(settings.CSRF_COOKIE_NAME, False)
  127. self.assertEqual(len(csrf_cookie.value), CSRF_TOKEN_LENGTH)
  128. self.assertNotEqual(csrf_cookie.value, token)
  129. def test_process_response_get_token_used(self):
  130. """
  131. When get_token is used, check that the cookie is created and headers
  132. patched.
  133. """
  134. req = self._get_GET_no_csrf_cookie_request()
  135. # Put tests for CSRF_COOKIE_* settings here
  136. with self.settings(CSRF_COOKIE_NAME='myname',
  137. CSRF_COOKIE_DOMAIN='.example.com',
  138. CSRF_COOKIE_PATH='/test/',
  139. CSRF_COOKIE_SECURE=True,
  140. CSRF_COOKIE_HTTPONLY=True):
  141. # token_view calls get_token() indirectly
  142. CsrfViewMiddleware().process_view(req, token_view, (), {})
  143. resp = token_view(req)
  144. resp2 = CsrfViewMiddleware().process_response(req, resp)
  145. csrf_cookie = resp2.cookies.get('myname', False)
  146. self.assertIsNot(csrf_cookie, False)
  147. self.assertEqual(csrf_cookie['domain'], '.example.com')
  148. self.assertIs(csrf_cookie['secure'], True)
  149. self.assertIs(csrf_cookie['httponly'], True)
  150. self.assertEqual(csrf_cookie['path'], '/test/')
  151. self.assertIn('Cookie', resp2.get('Vary', ''))
  152. def test_process_response_get_token_not_used(self):
  153. """
  154. Check that if get_token() is not called, the view middleware does not
  155. add a cookie.
  156. """
  157. # This is important to make pages cacheable. Pages which do call
  158. # get_token(), assuming they use the token, are not cacheable because
  159. # the token is specific to the user
  160. req = self._get_GET_no_csrf_cookie_request()
  161. # non_token_view_using_request_processor does not call get_token(), but
  162. # does use the csrf request processor. By using this, we are testing
  163. # that the view processor is properly lazy and doesn't call get_token()
  164. # until needed.
  165. CsrfViewMiddleware().process_view(req, non_token_view_using_request_processor, (), {})
  166. resp = non_token_view_using_request_processor(req)
  167. resp2 = CsrfViewMiddleware().process_response(req, resp)
  168. csrf_cookie = resp2.cookies.get(settings.CSRF_COOKIE_NAME, False)
  169. self.assertIs(csrf_cookie, False)
  170. # Check the request processing
  171. def test_process_request_no_csrf_cookie(self):
  172. """
  173. Check that if no CSRF cookies is present, the middleware rejects the
  174. incoming request. This will stop login CSRF.
  175. """
  176. with patch_logger('django.security.csrf', 'warning') as logger_calls:
  177. req = self._get_POST_no_csrf_cookie_request()
  178. req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  179. self.assertEqual(403, req2.status_code)
  180. self.assertEqual(logger_calls[0], 'Forbidden (%s): ' % REASON_NO_CSRF_COOKIE)
  181. def test_process_request_csrf_cookie_no_token(self):
  182. """
  183. Check that if a CSRF cookie is present but no token, the middleware
  184. rejects the incoming request.
  185. """
  186. with patch_logger('django.security.csrf', 'warning') as logger_calls:
  187. req = self._get_POST_csrf_cookie_request()
  188. req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  189. self.assertEqual(403, req2.status_code)
  190. self.assertEqual(logger_calls[0], 'Forbidden (%s): ' % REASON_BAD_TOKEN)
  191. def test_process_request_csrf_cookie_and_token(self):
  192. """
  193. Check that if both a cookie and a token is present, the middleware lets it through.
  194. """
  195. req = self._get_POST_request_with_token()
  196. req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  197. self.assertIsNone(req2)
  198. def test_process_request_csrf_cookie_no_token_exempt_view(self):
  199. """
  200. Check that if a CSRF cookie is present and no token, but the csrf_exempt
  201. decorator has been applied to the view, the middleware lets it through
  202. """
  203. req = self._get_POST_csrf_cookie_request()
  204. req2 = CsrfViewMiddleware().process_view(req, csrf_exempt(post_form_view), (), {})
  205. self.assertIsNone(req2)
  206. def test_csrf_token_in_header(self):
  207. """
  208. Check that we can pass in the token in a header instead of in the form
  209. """
  210. req = self._get_POST_csrf_cookie_request()
  211. req.META['HTTP_X_CSRFTOKEN'] = self._csrf_id
  212. req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  213. self.assertIsNone(req2)
  214. @override_settings(CSRF_HEADER_NAME='HTTP_X_CSRFTOKEN_CUSTOMIZED')
  215. def test_csrf_token_in_header_with_customized_name(self):
  216. """
  217. settings.CSRF_HEADER_NAME can be used to customize the CSRF header name
  218. """
  219. req = self._get_POST_csrf_cookie_request()
  220. req.META['HTTP_X_CSRFTOKEN_CUSTOMIZED'] = self._csrf_id
  221. req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  222. self.assertIsNone(req2)
  223. def test_put_and_delete_rejected(self):
  224. """
  225. Tests that HTTP PUT and DELETE methods have protection
  226. """
  227. req = TestingHttpRequest()
  228. req.method = 'PUT'
  229. with patch_logger('django.security.csrf', 'warning') as logger_calls:
  230. req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  231. self.assertEqual(403, req2.status_code)
  232. self.assertEqual(logger_calls[0], 'Forbidden (%s): ' % REASON_NO_CSRF_COOKIE)
  233. req = TestingHttpRequest()
  234. req.method = 'DELETE'
  235. with patch_logger('django.security.csrf', 'warning') as logger_calls:
  236. req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  237. self.assertEqual(403, req2.status_code)
  238. self.assertEqual(logger_calls[0], 'Forbidden (%s): ' % REASON_NO_CSRF_COOKIE)
  239. def test_put_and_delete_allowed(self):
  240. """
  241. Tests that HTTP PUT and DELETE methods can get through with
  242. X-CSRFToken and a cookie
  243. """
  244. req = self._get_GET_csrf_cookie_request()
  245. req.method = 'PUT'
  246. req.META['HTTP_X_CSRFTOKEN'] = self._csrf_id
  247. req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  248. self.assertIsNone(req2)
  249. req = self._get_GET_csrf_cookie_request()
  250. req.method = 'DELETE'
  251. req.META['HTTP_X_CSRFTOKEN'] = self._csrf_id
  252. req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  253. self.assertIsNone(req2)
  254. # Tests for the template tag method
  255. def test_token_node_no_csrf_cookie(self):
  256. """
  257. Check that CsrfTokenNode works when no CSRF cookie is set
  258. """
  259. req = self._get_GET_no_csrf_cookie_request()
  260. resp = token_view(req)
  261. token = get_token(req)
  262. self.assertIsNotNone(token)
  263. self._check_token_present(resp, token)
  264. def test_token_node_empty_csrf_cookie(self):
  265. """
  266. Check that we get a new token if the csrf_cookie is the empty string
  267. """
  268. req = self._get_GET_no_csrf_cookie_request()
  269. req.COOKIES[settings.CSRF_COOKIE_NAME] = b""
  270. CsrfViewMiddleware().process_view(req, token_view, (), {})
  271. resp = token_view(req)
  272. token = get_token(req)
  273. self.assertIsNotNone(token)
  274. self._check_token_present(resp, token)
  275. def test_token_node_with_csrf_cookie(self):
  276. """
  277. Check that CsrfTokenNode works when a CSRF cookie is set
  278. """
  279. req = self._get_GET_csrf_cookie_request()
  280. CsrfViewMiddleware().process_view(req, token_view, (), {})
  281. resp = token_view(req)
  282. self._check_token_present(resp)
  283. def test_get_token_for_exempt_view(self):
  284. """
  285. Check that get_token still works for a view decorated with 'csrf_exempt'.
  286. """
  287. req = self._get_GET_csrf_cookie_request()
  288. CsrfViewMiddleware().process_view(req, csrf_exempt(token_view), (), {})
  289. resp = token_view(req)
  290. self._check_token_present(resp)
  291. def test_get_token_for_requires_csrf_token_view(self):
  292. """
  293. Check that get_token works for a view decorated solely with requires_csrf_token
  294. """
  295. req = self._get_GET_csrf_cookie_request()
  296. resp = requires_csrf_token(token_view)(req)
  297. self._check_token_present(resp)
  298. def test_token_node_with_new_csrf_cookie(self):
  299. """
  300. Check that CsrfTokenNode works when a CSRF cookie is created by
  301. the middleware (when one was not already present)
  302. """
  303. req = self._get_GET_no_csrf_cookie_request()
  304. CsrfViewMiddleware().process_view(req, token_view, (), {})
  305. resp = token_view(req)
  306. resp2 = CsrfViewMiddleware().process_response(req, resp)
  307. csrf_cookie = resp2.cookies[settings.CSRF_COOKIE_NAME]
  308. self._check_token_present(resp, csrf_id=csrf_cookie.value)
  309. def test_cookie_not_reset_on_accepted_request(self):
  310. """
  311. The csrf token used in posts is changed on every request (although
  312. stays equivalent). The csrf cookie should not change on accepted
  313. requests. If it appears in the response, it should keep its value.
  314. """
  315. req = self._get_POST_request_with_token()
  316. CsrfViewMiddleware().process_view(req, token_view, (), {})
  317. resp = token_view(req)
  318. resp = CsrfViewMiddleware().process_response(req, resp)
  319. csrf_cookie = resp.cookies.get(settings.CSRF_COOKIE_NAME, None)
  320. if csrf_cookie:
  321. self.assertEqual(
  322. csrf_cookie.value, self._csrf_id_cookie,
  323. "CSRF cookie was changed on an accepted request"
  324. )
  325. def test_bare_secret_accepted_and_replaced(self):
  326. """
  327. The csrf token is reset from a bare secret.
  328. """
  329. req = self._get_POST_bare_secret_csrf_cookie_request_with_token()
  330. req2 = CsrfViewMiddleware().process_view(req, token_view, (), {})
  331. self.assertIsNone(req2)
  332. resp = token_view(req)
  333. resp = CsrfViewMiddleware().process_response(req, resp)
  334. self.assertIn(settings.CSRF_COOKIE_NAME, resp.cookies, "Cookie was not reset from bare secret")
  335. csrf_cookie = resp.cookies[settings.CSRF_COOKIE_NAME]
  336. self.assertEqual(len(csrf_cookie.value), CSRF_TOKEN_LENGTH)
  337. self._check_token_present(resp, csrf_id=csrf_cookie.value)
  338. @override_settings(DEBUG=True)
  339. def test_https_bad_referer(self):
  340. """
  341. Test that a POST HTTPS request with a bad referer is rejected
  342. """
  343. req = self._get_POST_request_with_token()
  344. req._is_secure_override = True
  345. req.META['HTTP_HOST'] = 'www.example.com'
  346. req.META['HTTP_REFERER'] = 'https://www.evil.org/somepage'
  347. req.META['SERVER_PORT'] = '443'
  348. response = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  349. self.assertContains(
  350. response,
  351. 'Referer checking failed - https://www.evil.org/somepage does not '
  352. 'match any trusted origins.',
  353. status_code=403,
  354. )
  355. @override_settings(DEBUG=True)
  356. def test_https_malformed_referer(self):
  357. """
  358. A POST HTTPS request with a bad referer is rejected.
  359. """
  360. malformed_referer_msg = 'Referer checking failed - Referer is malformed.'
  361. req = self._get_POST_request_with_token()
  362. req._is_secure_override = True
  363. req.META['HTTP_REFERER'] = 'http://http://www.example.com/'
  364. response = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  365. self.assertContains(
  366. response,
  367. 'Referer checking failed - Referer is insecure while host is secure.',
  368. status_code=403,
  369. )
  370. # Empty
  371. req.META['HTTP_REFERER'] = ''
  372. response = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  373. self.assertContains(response, malformed_referer_msg, status_code=403)
  374. # Non-ASCII
  375. req.META['HTTP_REFERER'] = b'\xd8B\xf6I\xdf'
  376. response = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  377. self.assertContains(response, malformed_referer_msg, status_code=403)
  378. # missing scheme
  379. # >>> urlparse('//example.com/')
  380. # ParseResult(scheme='', netloc='example.com', path='/', params='', query='', fragment='')
  381. req.META['HTTP_REFERER'] = '//example.com/'
  382. response = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  383. self.assertContains(response, malformed_referer_msg, status_code=403)
  384. # missing netloc
  385. # >>> urlparse('https://')
  386. # ParseResult(scheme='https', netloc='', path='', params='', query='', fragment='')
  387. req.META['HTTP_REFERER'] = 'https://'
  388. response = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  389. self.assertContains(response, malformed_referer_msg, status_code=403)
  390. @override_settings(ALLOWED_HOSTS=['www.example.com'])
  391. def test_https_good_referer(self):
  392. """
  393. A POST HTTPS request with a good referer is accepted.
  394. """
  395. req = self._get_POST_request_with_token()
  396. req._is_secure_override = True
  397. req.META['HTTP_HOST'] = 'www.example.com'
  398. req.META['HTTP_REFERER'] = 'https://www.example.com/somepage'
  399. req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  400. self.assertIsNone(req2)
  401. @override_settings(ALLOWED_HOSTS=['www.example.com'])
  402. def test_https_good_referer_2(self):
  403. """
  404. A POST HTTPS request with a good referer is accepted where the referer
  405. contains no trailing slash.
  406. """
  407. # See ticket #15617
  408. req = self._get_POST_request_with_token()
  409. req._is_secure_override = True
  410. req.META['HTTP_HOST'] = 'www.example.com'
  411. req.META['HTTP_REFERER'] = 'https://www.example.com'
  412. req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  413. self.assertIsNone(req2)
  414. @override_settings(ALLOWED_HOSTS=['www.example.com'], CSRF_COOKIE_DOMAIN='.example.com', USE_X_FORWARDED_PORT=True)
  415. def test_https_good_referer_behind_proxy(self):
  416. """
  417. A POST HTTPS request is accepted when USE_X_FORWARDED_PORT=True.
  418. """
  419. req = self._get_POST_request_with_token()
  420. req._is_secure_override = True
  421. req.META.update({
  422. 'HTTP_HOST': '10.0.0.2',
  423. 'HTTP_REFERER': 'https://www.example.com/somepage',
  424. 'SERVER_PORT': '8080',
  425. 'HTTP_X_FORWARDED_HOST': 'www.example.com',
  426. 'HTTP_X_FORWARDED_PORT': '443',
  427. })
  428. req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  429. self.assertIsNone(req2)
  430. @override_settings(ALLOWED_HOSTS=['www.example.com'], CSRF_TRUSTED_ORIGINS=['dashboard.example.com'])
  431. def test_https_csrf_trusted_origin_allowed(self):
  432. """
  433. A POST HTTPS request with a referer added to the CSRF_TRUSTED_ORIGINS
  434. setting is accepted.
  435. """
  436. req = self._get_POST_request_with_token()
  437. req._is_secure_override = True
  438. req.META['HTTP_HOST'] = 'www.example.com'
  439. req.META['HTTP_REFERER'] = 'https://dashboard.example.com'
  440. req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  441. self.assertIsNone(req2)
  442. @override_settings(ALLOWED_HOSTS=['www.example.com'], CSRF_TRUSTED_ORIGINS=['.example.com'])
  443. def test_https_csrf_wildcard_trusted_origin_allowed(self):
  444. """
  445. A POST HTTPS request with a referer that matches a CSRF_TRUSTED_ORIGINS
  446. wildcard is accepted.
  447. """
  448. req = self._get_POST_request_with_token()
  449. req._is_secure_override = True
  450. req.META['HTTP_HOST'] = 'www.example.com'
  451. req.META['HTTP_REFERER'] = 'https://dashboard.example.com'
  452. response = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  453. self.assertIsNone(response)
  454. @override_settings(ALLOWED_HOSTS=['www.example.com'], CSRF_COOKIE_DOMAIN='.example.com')
  455. def test_https_good_referer_matches_cookie_domain(self):
  456. """
  457. A POST HTTPS request with a good referer should be accepted from a
  458. subdomain that's allowed by CSRF_COOKIE_DOMAIN.
  459. """
  460. req = self._get_POST_request_with_token()
  461. req._is_secure_override = True
  462. req.META['HTTP_REFERER'] = 'https://foo.example.com/'
  463. req.META['SERVER_PORT'] = '443'
  464. response = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  465. self.assertIsNone(response)
  466. @override_settings(ALLOWED_HOSTS=['www.example.com'], CSRF_COOKIE_DOMAIN='.example.com')
  467. def test_https_good_referer_matches_cookie_domain_with_different_port(self):
  468. """
  469. A POST HTTPS request with a good referer should be accepted from a
  470. subdomain that's allowed by CSRF_COOKIE_DOMAIN and a non-443 port.
  471. """
  472. req = self._get_POST_request_with_token()
  473. req._is_secure_override = True
  474. req.META['HTTP_HOST'] = 'www.example.com'
  475. req.META['HTTP_REFERER'] = 'https://foo.example.com:4443/'
  476. req.META['SERVER_PORT'] = '4443'
  477. response = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  478. self.assertIsNone(response)
  479. @override_settings(CSRF_COOKIE_DOMAIN='.example.com', DEBUG=True)
  480. def test_https_reject_insecure_referer(self):
  481. """
  482. A POST HTTPS request from an insecure referer should be rejected.
  483. """
  484. req = self._get_POST_request_with_token()
  485. req._is_secure_override = True
  486. req.META['HTTP_REFERER'] = 'http://example.com/'
  487. req.META['SERVER_PORT'] = '443'
  488. response = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  489. self.assertContains(
  490. response,
  491. 'Referer checking failed - Referer is insecure while host is secure.',
  492. status_code=403,
  493. )
  494. def test_ensures_csrf_cookie_no_middleware(self):
  495. """
  496. The ensure_csrf_cookie() decorator works without middleware.
  497. """
  498. @ensure_csrf_cookie
  499. def view(request):
  500. # Doesn't insert a token or anything
  501. return HttpResponse(content="")
  502. req = self._get_GET_no_csrf_cookie_request()
  503. resp = view(req)
  504. self.assertTrue(resp.cookies.get(settings.CSRF_COOKIE_NAME, False))
  505. self.assertIn('Cookie', resp.get('Vary', ''))
  506. def test_ensures_csrf_cookie_with_middleware(self):
  507. """
  508. The ensure_csrf_cookie() decorator works with the CsrfViewMiddleware
  509. enabled.
  510. """
  511. @ensure_csrf_cookie
  512. def view(request):
  513. # Doesn't insert a token or anything
  514. return HttpResponse(content="")
  515. req = self._get_GET_no_csrf_cookie_request()
  516. CsrfViewMiddleware().process_view(req, view, (), {})
  517. resp = view(req)
  518. resp2 = CsrfViewMiddleware().process_response(req, resp)
  519. self.assertTrue(resp2.cookies.get(settings.CSRF_COOKIE_NAME, False))
  520. self.assertIn('Cookie', resp2.get('Vary', ''))
  521. def test_ensures_csrf_cookie_no_logging(self):
  522. """
  523. ensure_csrf_cookie() doesn't log warnings (#19436).
  524. """
  525. @ensure_csrf_cookie
  526. def view(request):
  527. # Doesn't insert a token or anything
  528. return HttpResponse(content="")
  529. class TestHandler(logging.Handler):
  530. def emit(self, record):
  531. raise Exception("This shouldn't have happened!")
  532. logger = logging.getLogger('django.request')
  533. test_handler = TestHandler()
  534. old_log_level = logger.level
  535. try:
  536. logger.addHandler(test_handler)
  537. logger.setLevel(logging.WARNING)
  538. req = self._get_GET_no_csrf_cookie_request()
  539. view(req)
  540. finally:
  541. logger.removeHandler(test_handler)
  542. logger.setLevel(old_log_level)
  543. def test_csrf_cookie_age(self):
  544. """
  545. CSRF cookie age can be set using settings.CSRF_COOKIE_AGE.
  546. """
  547. req = self._get_GET_no_csrf_cookie_request()
  548. MAX_AGE = 123
  549. with self.settings(CSRF_COOKIE_NAME='csrfcookie',
  550. CSRF_COOKIE_DOMAIN='.example.com',
  551. CSRF_COOKIE_AGE=MAX_AGE,
  552. CSRF_COOKIE_PATH='/test/',
  553. CSRF_COOKIE_SECURE=True,
  554. CSRF_COOKIE_HTTPONLY=True):
  555. # token_view calls get_token() indirectly
  556. CsrfViewMiddleware().process_view(req, token_view, (), {})
  557. resp = token_view(req)
  558. resp2 = CsrfViewMiddleware().process_response(req, resp)
  559. max_age = resp2.cookies.get('csrfcookie').get('max-age')
  560. self.assertEqual(max_age, MAX_AGE)
  561. def test_csrf_cookie_age_none(self):
  562. """
  563. CSRF cookie age does not have max age set and therefore uses
  564. session-based cookies.
  565. """
  566. req = self._get_GET_no_csrf_cookie_request()
  567. MAX_AGE = None
  568. with self.settings(CSRF_COOKIE_NAME='csrfcookie',
  569. CSRF_COOKIE_DOMAIN='.example.com',
  570. CSRF_COOKIE_AGE=MAX_AGE,
  571. CSRF_COOKIE_PATH='/test/',
  572. CSRF_COOKIE_SECURE=True,
  573. CSRF_COOKIE_HTTPONLY=True):
  574. # token_view calls get_token() indirectly
  575. CsrfViewMiddleware().process_view(req, token_view, (), {})
  576. resp = token_view(req)
  577. resp2 = CsrfViewMiddleware().process_response(req, resp)
  578. max_age = resp2.cookies.get('csrfcookie').get('max-age')
  579. self.assertEqual(max_age, '')
  580. def test_post_data_read_failure(self):
  581. """
  582. #20128 -- IOErrors during POST data reading should be caught and
  583. treated as if the POST data wasn't there.
  584. """
  585. class CsrfPostRequest(HttpRequest):
  586. """
  587. HttpRequest that can raise an IOError when accessing POST data
  588. """
  589. def __init__(self, token, raise_error):
  590. super(CsrfPostRequest, self).__init__()
  591. self.method = 'POST'
  592. self.raise_error = False
  593. self.COOKIES[settings.CSRF_COOKIE_NAME] = token
  594. self.POST['csrfmiddlewaretoken'] = token
  595. self.raise_error = raise_error
  596. def _load_post_and_files(self):
  597. raise IOError('error reading input data')
  598. def _get_post(self):
  599. if self.raise_error:
  600. self._load_post_and_files()
  601. return self._post
  602. def _set_post(self, post):
  603. self._post = post
  604. POST = property(_get_post, _set_post)
  605. token = ('ABC' + self._csrf_id)[:CSRF_TOKEN_LENGTH]
  606. req = CsrfPostRequest(token, raise_error=False)
  607. resp = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  608. self.assertIsNone(resp)
  609. req = CsrfPostRequest(token, raise_error=True)
  610. with patch_logger('django.security.csrf', 'warning') as logger_calls:
  611. resp = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
  612. self.assertEqual(resp.status_code, 403)
  613. self.assertEqual(logger_calls[0], 'Forbidden (%s): ' % REASON_BAD_TOKEN)