Skip to main content

A set of template tags (and mixins!) to assist in building CSP-enabled websites.

Project description

django-csp-helpers PyPI

A set of template tags (and mixins!) to assist in building CSP-enabled websites using Django's native CSP support (6.0+) or django-csp.

Install

  1. Add "csp_helpers" to your INSTALLED_APPS:
INSTALLED_APPS = [
    ...
    'csp_helpers',
]

Mixins

django-csp-helpers includes a pair of mixins that can be applied to views and forms to allow for the use of CSP nonces in widgets and form media.

How to use

Simply add CSPViewMixin to your Views, and CSPFormMixin to your Forms or ModelForms. You will need to use both mixins together, they don't work alone.

CSPFormMixin

from csp_helpers.mixins import CSPFormMixin

class ArticleForm(CSPFormMixin, ModelForm):
    ...

CSPViewMixin

from csp_helpers.mixins import CSPViewMixin
from .forms import ArticleForm

class ArticleUpdateView(CSPViewMixin, UpdateView):
    form_class = ArticleForm
    ...

Using only CSPFormMixin

If you are managing your form manually, or not using class-based views, you will not be able to use CSPViewMixin. In these cases, just call your form with csp_nonce as an argument manually, like below.

form = ArticleForm(csp_nonce=request.csp_nonce)

What it does

The django-csp-helpers mixins will modify and extend your views and forms in two ways.

Form Widgets

Form widgets will be patched to inject a CSP nonce into the rendering context for template widgets. You can access this with {{ csp_nonce }} in your widget templates.

Form Media

Form media (CSS and JS) will be included with CSP nonces.

Template Tags

django-csp-helpers also includes a pair of template tags

render_bundle_csp

An exact replacement for the django-webpack-loader render_bundle tag that includes bundles with CSP nonces.

{% load render_bundle_csp %}

{% render_bundle_csp 'main' 'css' %}
{% render_bundle_csp 'main' 'js %}

media_csp

A less advanced version of the form media functionality provided by the mixins above. Simply load this tag and pass it a form, and it will include the form media with CSP nonces.

{% load media_csp %}

{# include form media #}
{% media_csp myform %}

License

This software is released under the MIT license.

Copyright (c) 2019-2026 Luke Rogers

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Project details


Download files

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

Source Distribution

django_csp_helpers-1.0.1.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_csp_helpers-1.0.1-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file django_csp_helpers-1.0.1.tar.gz.

File metadata

  • Download URL: django_csp_helpers-1.0.1.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for django_csp_helpers-1.0.1.tar.gz
Algorithm Hash digest
SHA256 4da212a7ca50e74fc21b1bd82dee2af8311fe7c2276b976e981db41397177962
MD5 ec29e31554ee7e030974c53cdeaf3037
BLAKE2b-256 61eed56d33c2104cd08fd51d5260c87220785ac4b972416bcb2c55f0e97da49f

See more details on using hashes here.

File details

Details for the file django_csp_helpers-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_csp_helpers-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 091fca951ed321b12b7ef17483f201db6be73322be84ff3f938921147ede492d
MD5 6f20472213231dba05607bc897702de3
BLAKE2b-256 a7d333b11042502c826f858e592890ae0f140daaf0125b199bfcad98ff7dbfbe

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page