mirror of
https://github.com/Hopiu/django.git
synced 2026-05-21 13:32:02 +00:00
097e3a70c1
Black 23.1.0 is released which, as the first release of the year, introduces the 2023 stable style. This incorporates most of last year's preview style. https://github.com/psf/black/releases/tag/23.1.0
59 lines
2 KiB
Python
59 lines
2 KiB
Python
from functools import wraps
|
|
|
|
from django.middleware.csrf import CsrfViewMiddleware, get_token
|
|
from django.utils.decorators import decorator_from_middleware
|
|
|
|
csrf_protect = decorator_from_middleware(CsrfViewMiddleware)
|
|
csrf_protect.__name__ = "csrf_protect"
|
|
csrf_protect.__doc__ = """
|
|
This decorator adds CSRF protection in exactly the same way as
|
|
CsrfViewMiddleware, but it can be used on a per view basis. Using both, or
|
|
using the decorator multiple times, is harmless and efficient.
|
|
"""
|
|
|
|
|
|
class _EnsureCsrfToken(CsrfViewMiddleware):
|
|
# Behave like CsrfViewMiddleware but don't reject requests or log warnings.
|
|
def _reject(self, request, reason):
|
|
return None
|
|
|
|
|
|
requires_csrf_token = decorator_from_middleware(_EnsureCsrfToken)
|
|
requires_csrf_token.__name__ = "requires_csrf_token"
|
|
requires_csrf_token.__doc__ = """
|
|
Use this decorator on views that need a correct csrf_token available to
|
|
RequestContext, but without the CSRF protection that csrf_protect
|
|
enforces.
|
|
"""
|
|
|
|
|
|
class _EnsureCsrfCookie(CsrfViewMiddleware):
|
|
def _reject(self, request, reason):
|
|
return None
|
|
|
|
def process_view(self, request, callback, callback_args, callback_kwargs):
|
|
retval = super().process_view(request, callback, callback_args, callback_kwargs)
|
|
# Force process_response to send the cookie
|
|
get_token(request)
|
|
return retval
|
|
|
|
|
|
ensure_csrf_cookie = decorator_from_middleware(_EnsureCsrfCookie)
|
|
ensure_csrf_cookie.__name__ = "ensure_csrf_cookie"
|
|
ensure_csrf_cookie.__doc__ = """
|
|
Use this decorator to ensure that a view sets a CSRF cookie, whether or not it
|
|
uses the csrf_token template tag, or the CsrfViewMiddleware is used.
|
|
"""
|
|
|
|
|
|
def csrf_exempt(view_func):
|
|
"""Mark a view function as being exempt from the CSRF view protection."""
|
|
|
|
# view_func.csrf_exempt = True would also work, but decorators are nicer
|
|
# if they don't have side effects, so return a new function.
|
|
@wraps(view_func)
|
|
def wrapper_view(*args, **kwargs):
|
|
return view_func(*args, **kwargs)
|
|
|
|
wrapper_view.csrf_exempt = True
|
|
return wrapper_view
|