Skip to main content

Invisible, layered form protection for Django. Honeypot fields, signed timestamps, and a pluggable check pipeline.

Project description

django-formguard

Invisible form protection for Django. A pluggable check pipeline that catches bots without any user interaction.

How It Works

FormGuard runs a series of checks against each form submission:

  1. Field trap - hidden honeypot field that bots fill in
  2. Token - signed timestamp that catches fast or tampered submissions
  3. JS challenge - nonce computation that requires JavaScript execution
  4. Interaction proof - detects real user input (accessible to screen readers)

All checks are invisible to real users. Check failures are handled as standard form validation errors, with an optional stealth-reject mode for honeypot-style protection.

FormGuard is extensible - new checks can be added easily. See Custom Checks.

Installation

pip install django-formguard

Add 'formguard' to your INSTALLED_APPS:

INSTALLED_APPS = [
    ...
    'formguard',
]

Quick Start

1. Set up your form

Add GuardedFormMixin to your form.

from django import forms
from formguard.forms import GuardedFormMixin

class ContactForm(GuardedFormMixin, forms.Form):
    name = forms.CharField()
    email = forms.EmailField()
    message = forms.CharField(widget=forms.Textarea)

2. Set up your template

Include {{ form.media }} in your <head> so the honeypot CSS and JS checks load.

<head>
    {{ form.media }}
</head>
<body>
    <form method="post">
        {% csrf_token %}
        {{ form }}
        <button type="submit">Send</button>
    </form>
</body>

If you render fields manually, use {{ form.guard_fields }} to include all guard fields.

3. Check submissions in your view

Guard checks run inside is_valid(), so your view uses standard Django patterns.

Class-based views - use GuardedFormViewMixin:

from django.views.generic import FormView
from formguard.views import GuardedFormViewMixin

class ContactView(GuardedFormViewMixin, FormView):
    form_class = ContactForm
    template_name = 'contact.html'
    success_url = '/thanks/'

    def form_valid(self, form):
        send_email(form.cleaned_data)
        return super().form_valid(form)

The mixin passes request to the form automatically. If a check fails, the form re-renders with errors. Set stealth_reject = True on the view to redirect bots to a fake success page instead.

Function-based views - pass request when constructing the form:

def contact_view(request):
    form = ContactForm(request.POST or None, request=request)
    if request.method == 'POST' and form.is_valid():
        send_email(form.cleaned_data)
        return redirect('/thanks/')
    return render(request, 'contact.html', {'form': form})

Settings

All settings are optional. Defaults work out of the box. All four built-in checks are enabled by default.

# add a custom check alongside the defaults
from formguard.conf import DEFAULTS
FORMGUARD_CHECKS = DEFAULTS['CHECKS'] + [
    'myapp.checks.TurnstileCheck',
]

# tune the built-in checks
FORMGUARD_FIELD_TRAP_FIELD_NAME = 'website'  # default
FORMGUARD_TOKEN_MIN_SECONDS = 3              # default
FORMGUARD_TOKEN_MAX_SECONDS = 3600           # default

Further Reading

  • Custom Checks - write your own checks (CAPTCHA, rate limiting, etc.)
  • Advanced Usage - per-form checks, stealth reject, FBV pattern
  • Testing - test helpers for guarded forms
  • Signals - hook into bot detection events

CSP Compatibility

FormGuard uses external static files for CSS and JS (no inline styles or scripts), so it works with Content Security Policy out of the box when 'self' is in your script-src and style-src.

For strict nonce-based CSP policies, use django-csp-helpers to add nonces to the {{ form.media }} output.

License

This software is released under the MIT license.

Copyright (c) 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_formguard-0.4.0.tar.gz (39.8 kB view details)

Uploaded Source

Built Distribution

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

django_formguard-0.4.0-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

Details for the file django_formguard-0.4.0.tar.gz.

File metadata

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

File hashes

Hashes for django_formguard-0.4.0.tar.gz
Algorithm Hash digest
SHA256 b620106de5b0e8ce402b61808ebb8f4d3a36b50834c72bf9ff78ea96a3b55f0c
MD5 275aefa0658d3c878b772d2856473544
BLAKE2b-256 fe829f04e9c3513551997f66c4d3a87bb58bdf31ec496ff3f18a57cd1f4fa14e

See more details on using hashes here.

File details

Details for the file django_formguard-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_formguard-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 69cd8733226c667caec1f1ed58b807f49ea142521af37c39ff703a51ff772175
MD5 f90353e3bd46f4afe702581eb55d18ab
BLAKE2b-256 b984c42b9d2b141d5a2bfc0ae71773f7c6794c376793dab447777aefc6d5b68e

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