summaryrefslogtreecommitdiff
path: root/docs/api/csrf.rst
diff options
context:
space:
mode:
authorMichael Merickel <michael@merickel.org>2017-04-30 18:26:11 -0500
committerGitHub <noreply@github.com>2017-04-30 18:26:11 -0500
commit80973f86368ee9bc8f7d8c87d32207cec83d9310 (patch)
treeabf20accdb77f6127a5480bf023231c7b0b6706b /docs/api/csrf.rst
parent87af11c5e33b8c03d57a8b571f0b152efe866af1 (diff)
parent9c15a8eac2848cc7a81f174ecf7a6c63be323f51 (diff)
downloadpyramid-80973f86368ee9bc8f7d8c87d32207cec83d9310.tar.gz
pyramid-80973f86368ee9bc8f7d8c87d32207cec83d9310.tar.bz2
pyramid-80973f86368ee9bc8f7d8c87d32207cec83d9310.zip
Merge pull request #3019 from mmerickel/fixes/csrf-decoupling-2854
Decouple CSRF protection from the session machinery (replaced #2854)
Diffstat (limited to 'docs/api/csrf.rst')
-rw-r--r--docs/api/csrf.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/api/csrf.rst b/docs/api/csrf.rst
new file mode 100644
index 000000000..38501546e
--- /dev/null
+++ b/docs/api/csrf.rst
@@ -0,0 +1,23 @@
+.. _csrf_module:
+
+:mod:`pyramid.csrf`
+-------------------
+
+.. automodule:: pyramid.csrf
+
+ .. autoclass:: LegacySessionCSRFStoragePolicy
+ :members:
+
+ .. autoclass:: SessionCSRFStoragePolicy
+ :members:
+
+ .. autoclass:: CookieCSRFStoragePolicy
+ :members:
+
+ .. autofunction:: get_csrf_token
+
+ .. autofunction:: new_csrf_token
+
+ .. autofunction:: check_csrf_origin
+
+ .. autofunction:: check_csrf_token