summaryrefslogtreecommitdiff
path: root/docs/narr/viewconfig.rst
diff options
context:
space:
mode:
authorBert JW Regeer <bertjw@regeer.org>2016-04-14 10:47:00 -0600
committerBert JW Regeer <bertjw@regeer.org>2016-04-14 10:47:00 -0600
commitaac7a47497ad4a4cd1c5f0ca0d19bd1de460a281 (patch)
tree7663f087713be5487846663a0b64e086f60f8de3 /docs/narr/viewconfig.rst
parent4c6592734ffb5eace320d8e92e33c5866f111749 (diff)
parent88637857ca84eb74fd318ad1bf8c4464e50ae662 (diff)
downloadpyramid-aac7a47497ad4a4cd1c5f0ca0d19bd1de460a281.tar.gz
pyramid-aac7a47497ad4a4cd1c5f0ca0d19bd1de460a281.tar.bz2
pyramid-aac7a47497ad4a4cd1c5f0ca0d19bd1de460a281.zip
Merge branch 'master' into feature/json_exceptions
Diffstat (limited to 'docs/narr/viewconfig.rst')
-rw-r--r--docs/narr/viewconfig.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/narr/viewconfig.rst b/docs/narr/viewconfig.rst
index 0bd52b6e2..e645185f5 100644
--- a/docs/narr/viewconfig.rst
+++ b/docs/narr/viewconfig.rst
@@ -192,6 +192,32 @@ Non-Predicate Arguments
only influence ``Cache-Control`` headers, pass a tuple as ``http_cache`` with
the first element of ``None``, i.e., ``(None, {'public':True})``.
+
+``require_csrf``
+
+ CSRF checks only affect POST requests. Any other request methods will pass
+ untouched. This option is used in combination with the
+ ``pyramid.require_default_csrf`` setting to control which request parameters
+ are checked for CSRF tokens.
+
+ This feature requires a configured :term:`session factory`.
+
+ If this option is set to ``True`` then CSRF checks will be enabled for POST
+ requests to this view. The required token will be whatever was specified by
+ the ``pyramid.require_default_csrf`` setting, or will fallback to
+ ``csrf_token``.
+
+ If this option is set to a string then CSRF checks will be enabled and it
+ will be used as the required token regardless of the
+ ``pyramid.require_default_csrf`` setting.
+
+ If this option is set to ``False`` then CSRF checks will be disabled
+ regardless of the ``pyramid.require_default_csrf`` setting.
+
+ See :ref:`auto_csrf_checking` for more information.
+
+ .. versionadded:: 1.7
+
``wrapper``
The :term:`view name` of a different :term:`view configuration` which will
receive the response body of this view as the ``request.wrapped_body``