summaryrefslogtreecommitdiff
path: root/docs/narr/security.rst
diff options
context:
space:
mode:
authorMichael Merickel <michael@merickel.org>2019-10-17 19:25:37 -0500
committerGitHub <noreply@github.com>2019-10-17 19:25:37 -0500
commit2153b4b878d77aa0cb5b79805dd185d133c26451 (patch)
tree51c0724f4633027ed53fb208a9a7af962bc8c153 /docs/narr/security.rst
parent4ec5d21033fbf27b4128feeef8627a7401c71951 (diff)
parentc67cc8722e3b26b729c3fed75db51395b56ac8a0 (diff)
downloadpyramid-2153b4b878d77aa0cb5b79805dd185d133c26451.tar.gz
pyramid-2153b4b878d77aa0cb5b79805dd185d133c26451.tar.bz2
pyramid-2153b4b878d77aa0cb5b79805dd185d133c26451.zip
Merge pull request #3521 from mmerickel/remove-check-csrf-predicate
remove check_csrf view predicate
Diffstat (limited to 'docs/narr/security.rst')
-rw-r--r--docs/narr/security.rst23
1 files changed, 0 insertions, 23 deletions
diff --git a/docs/narr/security.rst b/docs/narr/security.rst
index bea331993..9d45dfb6a 100644
--- a/docs/narr/security.rst
+++ b/docs/narr/security.rst
@@ -892,26 +892,3 @@ If CSRF checks fail then a :class:`pyramid.exceptions.BadCSRFToken` or
exception may be caught and handled by an :term:`exception view` but, by
default, will result in a ``400 Bad Request`` response being sent to the
client.
-
-Checking CSRF Tokens with a View Predicate
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. deprecated:: 1.7
- Use the ``require_csrf`` option or read :ref:`auto_csrf_checking` instead
- to have :class:`pyramid.exceptions.BadCSRFToken` exceptions raised.
-
-A convenient way to require a valid CSRF token for a particular view is to
-include ``check_csrf=True`` as a view predicate. See
-:meth:`pyramid.config.Configurator.add_view`.
-
-.. code-block:: python
-
- @view_config(request_method='POST', check_csrf=True, ...)
- def myview(request):
- # ...
-
-.. note::
- A mismatch of a CSRF token is treated like any other predicate miss, and the
- predicate system, when it doesn't find a view, raises ``HTTPNotFound``
- instead of ``HTTPBadRequest``, so ``check_csrf=True`` behavior is different
- from calling :func:`pyramid.csrf.check_csrf_token`.