To take advantage of CSRF protection in your views, follow these steps:
\nThe CSRF middleware is activated by default in the MIDDLEWARE\nsetting. If you override that setting, remember that\n'django.middleware.csrf.CsrfViewMiddleware' should come before any view\nmiddleware that assume that CSRF attacks have been dealt with.
If you disabled it, which is not recommended, you can use\ncsrf_protect() on particular views\nyou want to protect (see below).
In any template that uses a POST form, use the csrf_token tag inside\nthe <form> element if the form is for an internal URL, e.g.:
<form method="post">{% csrf_token %}\nThis should not be done for POST forms that target external URLs, since\nthat would cause the CSRF token to be leaked, leading to a vulnerability.
\nIn the corresponding view functions, ensure that\nRequestContext is used to render the response so\nthat {% csrf_token %} will work properly. If you’re using the\nrender() function, generic views, or contrib apps,\nyou are covered already since these all use RequestContext.
While the above method can be used for AJAX POST requests, it has some\ninconveniences: you have to remember to pass the CSRF token in as POST data with\nevery POST request. For this reason, there is an alternative method: on each\nXMLHttpRequest, set a custom X-CSRFToken header (as specified by the\nCSRF_HEADER_NAME setting) to the value of the CSRF token. This is\noften easier because many JavaScript frameworks provide hooks that allow\nheaders to be set on every request.
First, you must get the CSRF token. How to do that depends on whether or not\nthe CSRF_USE_SESSIONS and CSRF_COOKIE_HTTPONLY settings\nare enabled.
Finally, you’ll need to set the header on your AJAX request. Using the\nfetch() API:
\nconst request = new Request(\n /* URL */,\n {\n method: 'POST',\n headers: {'X-CSRFToken': csrftoken},\n mode: 'same-origin' // Do not send CSRF token to another domain.\n }\n);\nfetch(request).then(function(response) {\n // ...\n});\nDjango’s Jinja2 template backend\nadds {{ csrf_input }} to the context of all templates which is equivalent\nto {% csrf_token %} in the Django template language. For example:
<form method="post">{{ csrf_input }}\nRather than adding CsrfViewMiddleware as a blanket protection, you can use\nthe csrf_protect() decorator, which has\nexactly the same functionality, on particular views that need the protection.\nIt must be used both on views that insert the CSRF token in the output, and\non those that accept the POST form data. (These are often the same view\nfunction, but not always).
Use of the decorator by itself is not recommended, since if you forget to\nuse it, you will have a security hole. The ‘belt and braces’ strategy of using\nboth is fine, and will incur minimal overhead.
\nBy default, a ‘403 Forbidden’ response is sent to the user if an incoming\nrequest fails the checks performed by CsrfViewMiddleware. This should\nusually only be seen when there is a genuine Cross Site Request Forgery, or\nwhen, due to a programming error, the CSRF token has not been included with a\nPOST form.
The error page, however, is not very friendly, so you may want to provide your\nown view for handling this condition. To do this, set the\nCSRF_FAILURE_VIEW setting.
CSRF failures are logged as warnings to the django.security.csrf logger.
\nIf the csrf_token template tag is used by a template (or the\nget_token function is called some other way), CsrfViewMiddleware will\nadd a cookie and a Vary: Cookie header to the response. This means that the\nmiddleware will play well with the cache middleware if it is used as instructed\n(UpdateCacheMiddleware goes before all other middleware).
However, if you use cache decorators on individual views, the CSRF middleware\nwill not yet have been able to set the Vary header or the CSRF cookie, and the\nresponse will be cached without either one. In this case, on any views that\nwill require a CSRF token to be inserted you should use the\ndjango.views.decorators.csrf.csrf_protect() decorator first:
from django.views.decorators.cache import cache_page\nfrom django.views.decorators.csrf import csrf_protect\n\n\n@cache_page(60 * 15)\n@csrf_protect\ndef my_view(request): ...\nIf you are using class-based views, you can refer to Decorating\nclass-based views.
\nThe CsrfViewMiddleware will usually be a big hindrance to testing view\nfunctions, due to the need for the CSRF token which must be sent with every POST\nrequest. For this reason, Django’s HTTP client for tests has been modified to\nset a flag on requests which relaxes the middleware and the csrf_protect\ndecorator so that they no longer rejects requests. In every other respect\n(e.g. sending cookies etc.), they behave the same.
If, for some reason, you want the test client to perform CSRF\nchecks, you can create an instance of the test client that enforces\nCSRF checks:
\n>>> from django.test import Client\n>>> csrf_client = Client(enforce_csrf_checks=True)\nCertain views can have unusual requirements that mean they don’t fit the normal\npattern envisaged here. A number of utilities can be useful in these\nsituations. The scenarios they might be needed in are described in the following\nsection.
\nMost views requires CSRF protection, but a few do not.
\nSolution: rather than disabling the middleware and applying csrf_protect to\nall the views that need it, enable the middleware and use\ncsrf_exempt().
CsrfViewMiddleware.process_view() is not usedLink to this heading#There are cases when CsrfViewMiddleware.process_view may not have run\nbefore your view is run - 404 and 500 handlers, for example - but you still\nneed the CSRF token in a form.
Solution: use requires_csrf_token()
There may be some views that are unprotected and have been exempted by\ncsrf_exempt, but still need to include the CSRF token.
Solution: use csrf_exempt() followed by\nrequires_csrf_token(). (i.e. requires_csrf_token\nshould be the innermost decorator).
A view needs CSRF protection under one set of conditions only, and mustn’t have\nit for the rest of the time.
\nSolution: use csrf_exempt() for the whole\nview function, and csrf_protect() for the\npath within it that needs protection. Example:
from django.views.decorators.csrf import csrf_exempt, csrf_protect\n\n\n@csrf_exempt\ndef my_view(request):\n @csrf_protect\n def protected_path(request):\n do_something()\n\n if some_condition():\n return protected_path(request)\n else:\n do_something_else()\nA page makes a POST request via AJAX, and the page does not have an HTML form\nwith a csrf_token that would cause the required CSRF cookie to be sent.
Solution: use ensure_csrf_cookie() on the\nview that sends the page.
Because it is possible for the developer to turn off the CsrfViewMiddleware,\nall relevant views in contrib apps use the csrf_protect decorator to ensure\nthe security of these applications against CSRF. It is recommended that the\ndevelopers of other reusable apps that want the same guarantees also use the\ncsrf_protect decorator on their views.