123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471 |
- # -*- coding: utf-8 -*-
- from __future__ import unicode_literals
- import logging
- from django.conf import settings
- from django.http import HttpRequest, HttpResponse
- from django.middleware.csrf import CsrfViewMiddleware, CSRF_KEY_LENGTH
- from django.template import RequestContext, Template
- from django.template.context_processors import csrf
- from django.test import TestCase, override_settings
- from django.views.decorators.csrf import csrf_exempt, requires_csrf_token, ensure_csrf_cookie
- # Response/views used for CsrfResponseMiddleware and CsrfViewMiddleware tests
- def post_form_response():
- resp = HttpResponse(content="""
- <html><body><h1>\u00a1Unicode!<form method="post"><input type="text" /></form></body></html>
- """, mimetype="text/html")
- return resp
- def post_form_view(request):
- """A view that returns a POST form (without a token)"""
- return post_form_response()
- # Response/views used for template tag tests
- def token_view(request):
- """A view that uses {% csrf_token %}"""
- context = RequestContext(request, processors=[csrf])
- template = Template("{% csrf_token %}")
- return HttpResponse(template.render(context))
- def non_token_view_using_request_processor(request):
- """
- A view that doesn't use the token, but does use the csrf view processor.
- """
- context = RequestContext(request, processors=[csrf])
- template = Template("")
- return HttpResponse(template.render(context))
- class TestingHttpRequest(HttpRequest):
- """
- A version of HttpRequest that allows us to change some things
- more easily
- """
- def is_secure(self):
- return getattr(self, '_is_secure_override', False)
- class CsrfViewMiddlewareTest(TestCase):
- # The csrf token is potentially from an untrusted source, so could have
- # characters that need dealing with.
- _csrf_id_cookie = b"<1>\xc2\xa1"
- _csrf_id = "1"
- def _get_GET_no_csrf_cookie_request(self):
- return TestingHttpRequest()
- def _get_GET_csrf_cookie_request(self):
- req = TestingHttpRequest()
- req.COOKIES[settings.CSRF_COOKIE_NAME] = self._csrf_id_cookie
- return req
- def _get_POST_csrf_cookie_request(self):
- req = self._get_GET_csrf_cookie_request()
- req.method = "POST"
- return req
- def _get_POST_no_csrf_cookie_request(self):
- req = self._get_GET_no_csrf_cookie_request()
- req.method = "POST"
- return req
- def _get_POST_request_with_token(self):
- req = self._get_POST_csrf_cookie_request()
- req.POST['csrfmiddlewaretoken'] = self._csrf_id
- return req
- def _check_token_present(self, response, csrf_id=None):
- self.assertContains(response, "name='csrfmiddlewaretoken' value='%s'" % (csrf_id or self._csrf_id))
- def test_process_view_token_too_long(self):
- """
- Check that if the token is longer than expected, it is ignored and
- a new token is created.
- """
- req = self._get_GET_no_csrf_cookie_request()
- req.COOKIES[settings.CSRF_COOKIE_NAME] = 'x' * 10000000
- CsrfViewMiddleware().process_view(req, token_view, (), {})
- resp = token_view(req)
- resp2 = CsrfViewMiddleware().process_response(req, resp)
- csrf_cookie = resp2.cookies.get(settings.CSRF_COOKIE_NAME, False)
- self.assertEqual(len(csrf_cookie.value), CSRF_KEY_LENGTH)
- def test_process_response_get_token_used(self):
- """
- When get_token is used, check that the cookie is created and headers
- patched.
- """
- req = self._get_GET_no_csrf_cookie_request()
- # Put tests for CSRF_COOKIE_* settings here
- with self.settings(CSRF_COOKIE_NAME='myname',
- CSRF_COOKIE_DOMAIN='.example.com',
- CSRF_COOKIE_PATH='/test/',
- CSRF_COOKIE_SECURE=True,
- CSRF_COOKIE_HTTPONLY=True):
- # token_view calls get_token() indirectly
- CsrfViewMiddleware().process_view(req, token_view, (), {})
- resp = token_view(req)
- resp2 = CsrfViewMiddleware().process_response(req, resp)
- csrf_cookie = resp2.cookies.get('myname', False)
- self.assertNotEqual(csrf_cookie, False)
- self.assertEqual(csrf_cookie['domain'], '.example.com')
- self.assertEqual(csrf_cookie['secure'], True)
- self.assertEqual(csrf_cookie['httponly'], True)
- self.assertEqual(csrf_cookie['path'], '/test/')
- self.assertIn('Cookie', resp2.get('Vary', ''))
- def test_process_response_get_token_not_used(self):
- """
- Check that if get_token() is not called, the view middleware does not
- add a cookie.
- """
- # This is important to make pages cacheable. Pages which do call
- # get_token(), assuming they use the token, are not cacheable because
- # the token is specific to the user
- req = self._get_GET_no_csrf_cookie_request()
- # non_token_view_using_request_processor does not call get_token(), but
- # does use the csrf request processor. By using this, we are testing
- # that the view processor is properly lazy and doesn't call get_token()
- # until needed.
- CsrfViewMiddleware().process_view(req, non_token_view_using_request_processor, (), {})
- resp = non_token_view_using_request_processor(req)
- resp2 = CsrfViewMiddleware().process_response(req, resp)
- csrf_cookie = resp2.cookies.get(settings.CSRF_COOKIE_NAME, False)
- self.assertEqual(csrf_cookie, False)
- # Check the request processing
- def test_process_request_no_csrf_cookie(self):
- """
- Check that if no CSRF cookies is present, the middleware rejects the
- incoming request. This will stop login CSRF.
- """
- req = self._get_POST_no_csrf_cookie_request()
- req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
- self.assertEqual(403, req2.status_code)
- def test_process_request_csrf_cookie_no_token(self):
- """
- Check that if a CSRF cookie is present but no token, the middleware
- rejects the incoming request.
- """
- req = self._get_POST_csrf_cookie_request()
- req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
- self.assertEqual(403, req2.status_code)
- def test_process_request_csrf_cookie_and_token(self):
- """
- Check that if both a cookie and a token is present, the middleware lets it through.
- """
- req = self._get_POST_request_with_token()
- req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
- self.assertEqual(None, req2)
- def test_process_request_csrf_cookie_no_token_exempt_view(self):
- """
- Check that if a CSRF cookie is present and no token, but the csrf_exempt
- decorator has been applied to the view, the middleware lets it through
- """
- req = self._get_POST_csrf_cookie_request()
- req2 = CsrfViewMiddleware().process_view(req, csrf_exempt(post_form_view), (), {})
- self.assertEqual(None, req2)
- def test_csrf_token_in_header(self):
- """
- Check that we can pass in the token in a header instead of in the form
- """
- req = self._get_POST_csrf_cookie_request()
- req.META['HTTP_X_CSRFTOKEN'] = self._csrf_id
- req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
- self.assertEqual(None, req2)
- def test_put_and_delete_rejected(self):
- """
- Tests that HTTP PUT and DELETE methods have protection
- """
- req = TestingHttpRequest()
- req.method = 'PUT'
- req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
- self.assertEqual(403, req2.status_code)
- req = TestingHttpRequest()
- req.method = 'DELETE'
- req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
- self.assertEqual(403, req2.status_code)
- def test_put_and_delete_allowed(self):
- """
- Tests that HTTP PUT and DELETE methods can get through with
- X-CSRFToken and a cookie
- """
- req = self._get_GET_csrf_cookie_request()
- req.method = 'PUT'
- req.META['HTTP_X_CSRFTOKEN'] = self._csrf_id
- req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
- self.assertEqual(None, req2)
- req = self._get_GET_csrf_cookie_request()
- req.method = 'DELETE'
- req.META['HTTP_X_CSRFTOKEN'] = self._csrf_id
- req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
- self.assertEqual(None, req2)
- # Tests for the template tag method
- def test_token_node_no_csrf_cookie(self):
- """
- Check that CsrfTokenNode works when no CSRF cookie is set
- """
- req = self._get_GET_no_csrf_cookie_request()
- resp = token_view(req)
- self.assertEqual(resp.content, b'')
- def test_token_node_empty_csrf_cookie(self):
- """
- Check that we get a new token if the csrf_cookie is the empty string
- """
- req = self._get_GET_no_csrf_cookie_request()
- req.COOKIES[settings.CSRF_COOKIE_NAME] = b""
- CsrfViewMiddleware().process_view(req, token_view, (), {})
- resp = token_view(req)
- self.assertNotEqual("", resp.content)
- def test_token_node_with_csrf_cookie(self):
- """
- Check that CsrfTokenNode works when a CSRF cookie is set
- """
- req = self._get_GET_csrf_cookie_request()
- CsrfViewMiddleware().process_view(req, token_view, (), {})
- resp = token_view(req)
- self._check_token_present(resp)
- def test_get_token_for_exempt_view(self):
- """
- Check that get_token still works for a view decorated with 'csrf_exempt'.
- """
- req = self._get_GET_csrf_cookie_request()
- CsrfViewMiddleware().process_view(req, csrf_exempt(token_view), (), {})
- resp = token_view(req)
- self._check_token_present(resp)
- def test_get_token_for_requires_csrf_token_view(self):
- """
- Check that get_token works for a view decorated solely with requires_csrf_token
- """
- req = self._get_GET_csrf_cookie_request()
- resp = requires_csrf_token(token_view)(req)
- self._check_token_present(resp)
- def test_token_node_with_new_csrf_cookie(self):
- """
- Check that CsrfTokenNode works when a CSRF cookie is created by
- the middleware (when one was not already present)
- """
- req = self._get_GET_no_csrf_cookie_request()
- CsrfViewMiddleware().process_view(req, token_view, (), {})
- resp = token_view(req)
- resp2 = CsrfViewMiddleware().process_response(req, resp)
- csrf_cookie = resp2.cookies[settings.CSRF_COOKIE_NAME]
- self._check_token_present(resp, csrf_id=csrf_cookie.value)
- @override_settings(ALLOWED_HOSTS=['www.example.com'])
- def test_https_bad_referer(self):
- """
- Test that a POST HTTPS request with a bad referer is rejected
- """
- req = self._get_POST_request_with_token()
- req._is_secure_override = True
- req.META['HTTP_HOST'] = 'www.example.com'
- req.META['HTTP_REFERER'] = 'https://www.evil.org/somepage'
- req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
- self.assertNotEqual(None, req2)
- self.assertEqual(403, req2.status_code)
- @override_settings(ALLOWED_HOSTS=['www.example.com'])
- def test_https_malformed_referer(self):
- """
- Test that a POST HTTPS request with a bad referer is rejected
- """
- req = self._get_POST_request_with_token()
- req._is_secure_override = True
- req.META['HTTP_HOST'] = 'www.example.com'
- req.META['HTTP_REFERER'] = 'http://http://www.example.com/'
- req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
- self.assertNotEqual(None, req2)
- self.assertEqual(403, req2.status_code)
- @override_settings(ALLOWED_HOSTS=['www.example.com'])
- def test_https_good_referer(self):
- """
- Test that a POST HTTPS request with a good referer is accepted
- """
- req = self._get_POST_request_with_token()
- req._is_secure_override = True
- req.META['HTTP_HOST'] = 'www.example.com'
- req.META['HTTP_REFERER'] = 'https://www.example.com/somepage'
- req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
- self.assertEqual(None, req2)
- @override_settings(ALLOWED_HOSTS=['www.example.com'])
- def test_https_good_referer_2(self):
- """
- Test that a POST HTTPS request with a good referer is accepted
- where the referer contains no trailing slash
- """
- # See ticket #15617
- req = self._get_POST_request_with_token()
- req._is_secure_override = True
- req.META['HTTP_HOST'] = 'www.example.com'
- req.META['HTTP_REFERER'] = 'https://www.example.com'
- req2 = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
- self.assertEqual(None, req2)
- def test_ensures_csrf_cookie_no_middleware(self):
- """
- Tests that ensures_csrf_cookie decorator fulfils its promise
- with no middleware
- """
- @ensure_csrf_cookie
- def view(request):
- # Doesn't insert a token or anything
- return HttpResponse(content="")
- req = self._get_GET_no_csrf_cookie_request()
- resp = view(req)
- self.assertTrue(resp.cookies.get(settings.CSRF_COOKIE_NAME, False))
- self.assertIn('Cookie', resp.get('Vary', ''))
- def test_ensures_csrf_cookie_with_middleware(self):
- """
- Tests that ensures_csrf_cookie decorator fulfils its promise
- with the middleware enabled.
- """
- @ensure_csrf_cookie
- def view(request):
- # Doesn't insert a token or anything
- return HttpResponse(content="")
- req = self._get_GET_no_csrf_cookie_request()
- CsrfViewMiddleware().process_view(req, view, (), {})
- resp = view(req)
- resp2 = CsrfViewMiddleware().process_response(req, resp)
- self.assertTrue(resp2.cookies.get(settings.CSRF_COOKIE_NAME, False))
- self.assertIn('Cookie', resp2.get('Vary', ''))
- def test_ensures_csrf_cookie_no_logging(self):
- """
- Tests that ensure_csrf_cookie doesn't log warnings. See #19436.
- """
- @ensure_csrf_cookie
- def view(request):
- # Doesn't insert a token or anything
- return HttpResponse(content="")
- class TestHandler(logging.Handler):
- def emit(self, record):
- raise Exception("This shouldn't have happened!")
- logger = logging.getLogger('django.request')
- test_handler = TestHandler()
- old_log_level = logger.level
- try:
- logger.addHandler(test_handler)
- logger.setLevel(logging.WARNING)
- req = self._get_GET_no_csrf_cookie_request()
- view(req)
- finally:
- logger.removeHandler(test_handler)
- logger.setLevel(old_log_level)
- def test_csrf_cookie_age(self):
- """
- Test to verify CSRF cookie age can be set using
- settings.CSRF_COOKIE_AGE.
- """
- req = self._get_GET_no_csrf_cookie_request()
- MAX_AGE = 123
- with self.settings(CSRF_COOKIE_NAME='csrfcookie',
- CSRF_COOKIE_DOMAIN='.example.com',
- CSRF_COOKIE_AGE=MAX_AGE,
- CSRF_COOKIE_PATH='/test/',
- CSRF_COOKIE_SECURE=True,
- CSRF_COOKIE_HTTPONLY=True):
- # token_view calls get_token() indirectly
- CsrfViewMiddleware().process_view(req, token_view, (), {})
- resp = token_view(req)
- resp2 = CsrfViewMiddleware().process_response(req, resp)
- max_age = resp2.cookies.get('csrfcookie').get('max-age')
- self.assertEqual(max_age, MAX_AGE)
- def test_csrf_cookie_age_none(self):
- """
- Test to verify CSRF cookie age does not have max age set and therefore
- uses session-based cookies.
- """
- req = self._get_GET_no_csrf_cookie_request()
- MAX_AGE = None
- with self.settings(CSRF_COOKIE_NAME='csrfcookie',
- CSRF_COOKIE_DOMAIN='.example.com',
- CSRF_COOKIE_AGE=MAX_AGE,
- CSRF_COOKIE_PATH='/test/',
- CSRF_COOKIE_SECURE=True,
- CSRF_COOKIE_HTTPONLY=True):
- # token_view calls get_token() indirectly
- CsrfViewMiddleware().process_view(req, token_view, (), {})
- resp = token_view(req)
- resp2 = CsrfViewMiddleware().process_response(req, resp)
- max_age = resp2.cookies.get('csrfcookie').get('max-age')
- self.assertEqual(max_age, '')
- def test_post_data_read_failure(self):
- """
- #20128 -- IOErrors during POST data reading should be caught and
- treated as if the POST data wasn't there.
- """
- class CsrfPostRequest(HttpRequest):
- """
- HttpRequest that can raise an IOError when accessing POST data
- """
- def __init__(self, token, raise_error):
- super(CsrfPostRequest, self).__init__()
- self.method = 'POST'
- self.raise_error = False
- self.COOKIES[settings.CSRF_COOKIE_NAME] = token
- self.POST['csrfmiddlewaretoken'] = token
- self.raise_error = raise_error
- def _load_post_and_files(self):
- raise IOError('error reading input data')
- def _get_post(self):
- if self.raise_error:
- self._load_post_and_files()
- return self._post
- def _set_post(self, post):
- self._post = post
- POST = property(_get_post, _set_post)
- token = 'ABC'
- req = CsrfPostRequest(token, raise_error=False)
- resp = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
- self.assertEqual(resp, None)
- req = CsrfPostRequest(token, raise_error=True)
- resp = CsrfViewMiddleware().process_view(req, post_form_view, (), {})
- self.assertEqual(resp.status_code, 403)
|