summaryrefslogtreecommitdiff
path: root/docs/narr
diff options
context:
space:
mode:
authorKiss György <kissgyorgy@me.com>2015-05-30 16:15:11 +0200
committerKiss György <kissgyorgy@me.com>2015-05-30 22:48:22 +0200
commit7cb892010592f52cb754c428f648390043ac75a5 (patch)
tree1ffa9fbb5d630f6c5c801c1bec5916c39b097c35 /docs/narr
parentae76669776f3fd26a5ff5e189c821d4081280e6e (diff)
downloadpyramid-7cb892010592f52cb754c428f648390043ac75a5.tar.gz
pyramid-7cb892010592f52cb754c428f648390043ac75a5.tar.bz2
pyramid-7cb892010592f52cb754c428f648390043ac75a5.zip
Added notes on check_csrf view predicate. Also it is an add_view parameter, not add_route.
Diffstat (limited to 'docs/narr')
-rw-r--r--docs/narr/sessions.rst14
1 files changed, 10 insertions, 4 deletions
diff --git a/docs/narr/sessions.rst b/docs/narr/sessions.rst
index 5c103405a..f37cc3c7d 100644
--- a/docs/narr/sessions.rst
+++ b/docs/narr/sessions.rst
@@ -56,7 +56,7 @@ by using the :meth:`pyramid.config.Configurator.set_session_factory` method.
config = Configurator()
config.set_session_factory(my_session_factory)
-.. warning::
+.. warning::
By default the :func:`~pyramid.session.SignedCookieSessionFactory`
implementation is *unencrypted*. You should not use it
@@ -112,7 +112,7 @@ Extra attributes:
An integer timestamp indicating the time that this session was created.
``new``
- A boolean. If ``new`` is True, this session is new. Otherwise, it has
+ A boolean. If ``new`` is True, this session is new. Otherwise, it has
been constituted from data that was already serialized.
Extra methods:
@@ -225,7 +225,7 @@ method:
request.session.flash('mymessage')
The ``flash()`` method appends a message to a flash queue, creating the queue
-if necessary.
+if necessary.
``flash()`` accepts three arguments:
@@ -406,7 +406,7 @@ Checking CSRF Tokens With A View Predicate
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_route`.
+See :meth:`pyramid.config.Configurator.add_view`.
.. code-block:: python
@@ -414,6 +414,12 @@ See :meth:`pyramid.config.Configurator.add_route`.
def myview(request):
...
+.. note::
+ A mismatch of 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.session.check_csrf_token`.
+
Using the ``session.new_csrf_token`` Method
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~