Skip to main content

Django middleware that works with session-csrf and sends a CSRF token cookie.

Project description

What is this?

django-session-csrf-cookie is Django middleware that provides a CSRF token cookie when using django-session-csrf. By design, django-session-csrf does not require a CSRF token cookie, but such a cookie is useful for AJAX requests and other web APIs, since it allows the client to get the CSRF token without parsing HTML. (Note that the cookie is not used by the server for any purpose, so the security hole django-session-csrf was designed to fix is still fixed.)

Installation

From PyPI:

pip install django-session-csrf-cookie

From github:

git clone git://github.com/trustcentric/django-session-csrf-cookie.git

Add session_csrf_cookie.CsrfCookieMiddleware to your MIDDLEWARE_CLASSES below session_csrf.CsrfMiddleware:

MIDDLEWARE_CLASSES = (
    ...
    'session_csrf.CsrfMiddleware',
    'session_csrf_cookie.CsrfCookieMiddleware',
    ...
)

Add session_csrf_cookie to INSTALLED_APPS.

Settings

session-csrf-cookie-middleware can be controlled using the following settings:

CSRF_COOKIE_NAME

The name used for the CSRF token cookie.

Default: csrftoken

CSRF_COOKIE_DOMAIN

The domain to be used when setting the CSRF cookie.

Default: None

CSRF_COOKIE_SECURE

Whether to use a secure cookie for the CSRF cookie.

Default: False

CSRF_COOKIE_HTTPONLY

Whether to set the HTTPOnly flag on the CSRF cookie.

Default: False

Project details


Release history Release notifications

This version
History Node

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django-session-csrf-cookie-0.1.tar.gz (3.7 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page