Invisible, layered form protection for Django. Honeypot fields, signed timestamps, and a pluggable check pipeline.
Project description
django-formguard
Invisible, layered form protection for Django. Combines honeypot fields, signed timestamps, and a pluggable check pipeline to block bots without user friction. Bots receive a fake success response indistinguishable from a real one.
Installation
pip install django-formguard
Add 'formguard' to your INSTALLED_APPS:
INSTALLED_APPS = [
...
'formguard',
]
Quick Start
1. Define your form
# forms.py
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. Include {{ form.media }} in your template
FormGuard's CSS and JS are declared as widget media. Include {{ form.media }}
in your template's <head> so the honeypot field is hidden and the JS check
runs.
<!-- contact.html -->
<head>
{{ form.media }}
</head>
<body>
<form method="post">
{% csrf_token %}
{{ form }}
<button type="submit">Send</button>
</form>
</body>
3. Check submissions in your view
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):
if self.is_bot(form):
return self.bot_response()
send_email(form.cleaned_data)
return super().form_valid(form)
Function-based views - use the @guard_form decorator:
from formguard.decorators import guard_form
@guard_form(form_class=ContactForm, success_url='/thanks/')
def contact_view(request, form=None):
# only reached if the form is clean (bots were already redirected)
send_email(form.cleaned_data)
return redirect('/thanks/')
The decorator passes the bound form as a form keyword argument. Set
auto_reject=False to annotate the request instead of auto-redirecting:
@guard_form(form_class=ContactForm, success_url='/thanks/', auto_reject=False)
def contact_view(request, form=None):
if getattr(request, 'formguard_reasons', None):
# bot detected, but you decide what to do
return render(request, 'thanks.html')
send_email(form.cleaned_data)
return redirect('/thanks/')
How It Works
FormGuard runs a pipeline of checks against each form submission:
- Field trap - A hidden honeypot field that should always be empty. Bots that fill all visible fields get caught.
- Timing - A signed timestamp records when the form was loaded. Submissions
faster than
FORMGUARD_MIN_SECONDSare flagged. - Signature - The timestamp token is cryptographically signed. Tampered or expired tokens are rejected.
- JS challenge - A JavaScript snippet sets a hidden field value that bots without JS execution can't fake.
All checks are invisible to real users. The honeypot field is hidden via CSS, and the timing/signature checks happen server-side.
Settings
All settings are optional. Defaults work out of the box.
| Setting | Default | Description |
|---|---|---|
FORMGUARD_FIELD_NAME |
'website' |
Honeypot field name (label is derived via .title()) |
FORMGUARD_MIN_SECONDS |
3 |
Minimum seconds before a submission is accepted |
FORMGUARD_MAX_SECONDS |
3600 |
Maximum token age before expiry |
FORMGUARD_SUCCESS_MESSAGE |
None |
Fake success message shown to bots |
FORMGUARD_CHECKS |
['formguard.checks.field_trap', 'formguard.checks.timing', 'formguard.checks.signature', 'formguard.checks.js_challenge'] |
Ordered list of check callables |
Custom Checks
Write a function that takes (request, form) and returns False if the
submission is clean, or a reason string if it should be blocked:
# myapp/checks.py
def rate_limit(request, form):
ip = request.META.get('REMOTE_ADDR')
if is_rate_limited(ip):
return 'rate limited'
return False
Register it in settings:
FORMGUARD_CHECKS = [
'formguard.checks.field_trap',
'formguard.checks.timing',
'formguard.checks.signature',
'formguard.checks.js_challenge',
'myapp.checks.rate_limit',
]
If a custom check raises an exception, it is logged and skipped (fail-open).
Signals
The guard_triggered signal is emitted whenever a submission is flagged:
from formguard.signals import guard_triggered
def on_guard_triggered(sender, request, form, reasons, **kwargs):
# log to monitoring, increment counter, etc.
pass
guard_triggered.connect(on_guard_triggered)
Testing
FormGuard ships test helpers to make testing guarded forms easy:
from formguard.test import GuardedFormTestMixin, make_guard_token
class TestContactView(GuardedFormTestMixin, TestCase):
def test_submission_works(self):
data = {
'name': 'Test',
'email': 'test@example.com',
'message': 'Hello',
**self.guard_data(), # adds valid token + empty honeypot
}
response = self.client.post('/contact/', data)
assert response.status_code == 302
make_guard_token() creates a valid signed token for use in test POST data.
GuardedFormTestMixin.guard_data() returns a dict with all required guard
fields pre-filled.
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file django_formguard-0.1.1.tar.gz.
File metadata
- Download URL: django_formguard-0.1.1.tar.gz
- Upload date:
- Size: 25.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bc85b0aa991fa6667339c2ef4e4923ac8d7ef4e95516da21564ca0597b52ad6d
|
|
| MD5 |
02f7a24eb0e7df841bc4b69b70ca1c35
|
|
| BLAKE2b-256 |
38e7bbfef5ce4c3aca367a8cab39d5c6b75a25ecf5646258cae1c9706a8fe132
|
File details
Details for the file django_formguard-0.1.1-py3-none-any.whl.
File metadata
- Download URL: django_formguard-0.1.1-py3-none-any.whl
- Upload date:
- Size: 20.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
86c9075a753c0f2e600524cc5c0de437dd02562cd720ba8fb04ac0ec75df4fef
|
|
| MD5 |
00076d5d44211e3204e4f528141f94c4
|
|
| BLAKE2b-256 |
13eff88133d25275d4f049b7bc7cab508cbcbe8001ebf259a9290bcbd9e816c3
|
