Skip to main content

Django Perimeter

Perimeter is a Django app that provides middleware that allows you to 'secure the perimeter' of your django site outside of any existing auth process that you have.

Compatibility

This package now requires Python 3.12+ and Django 5.2-6.0.

For previous versions please refer to the relevant branch.

Why?

Most django sites have some kind of user registration and security model - a login process, decorators to secure certain URLs, user accounts - everything that comes with django.contrib.auth and associated apps.

Sometimes, however, you want to simply secure the entire site to prevent prying eyes - the classic example being before a site goes live. You want to erect a secure perimeter fence around the entire thing. If you have control over your front-end web server (e.g. Apache, Nginx) then this can be used to do this using their in-built access control features. However, if you are running your app on a hosting platform you may not have admin access to these parts. Even if you do have control over your webserver, you may not want to be re-configuring it every time you want to grant someone access.

That's when you need Perimeter.

Perimeter provides simple tokenised access control over your entire Django site (everything, including the admin site and login pages).

How does it work?

Once you have installed and enabled Perimeter, everyone requiring access will need an authorisation token (not authentication - there is nothing inherent in Perimeter to prevent people swapping / sharing tokens - that is an accepted use case).

Perimeter runs as middleware that will inspect the user's session for a token. If they have a valid token, then they continue to use the site uninterrupted. If they do not have a token, or the token is invalid (expired or set to inactive), then they are redirected to the Perimeter 'Gateway', where they must enter a valid token, along with their name and email (for auditing purposes - this is stored in the database).

To create a new token you need to head to the admin site, and create a new token under the Perimeter app. If you have PERIMETER_ENABLED set to True already you won't be able to access the admin site (as Perimeter covers everything except for the perimeter 'gateway' form), and so there is a management command (create_access_token) that you can use to create your first token. (This is analagous to the Django setup process where it prompts you to create a superuser.)

Setup

  1. Add "perimeter" to your installed apps.
  2. Add "perimeter.middleware.PerimeterAccessMiddleware" to the list of MIDDLEWARE_CLASSES
  3. Add the perimeter urls, including the "perimeter" namespace.
  4. Add PERIMETER_ENABLED = True to your settings file. This setting can be used to enable or disable Perimeter in different environments.

Settings:

    PERIMETER_ENABLED = True

    INSTALLED_APPS = (
        ...
        "perimeter",
        ...
    )

    # Perimeter's middleware must be after SessionMiddleware as it relies on
    # request.session
    MIDDLEWARE_CLASSES = [
        ...
        "django.contrib.sessions.middleware.SessionMiddleware",
        "perimeter.middleware.PerimeterAccessMiddleware",
        ...
    ]

Site urls:

    # in site urls
    urlpatterns = [
        ...
        # NB you must include the namespace, as it is referenced in the app
        path("perimeter/", include("perimeter.urls", namespace="perimeter")),
        ...
    ]

Tests

The app has a suite of tests, and a tox.ini file configured to run them when using tox (recommended).

Metadata

Release files for django-perimeter 0.19.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-perimeter 0.19.0
File Size Uploaded Provenance Actions
django_perimeter-0.19.0.tar.gz 12.2 kB Without provenance Details for django_perimeter-0.19.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for django-perimeter 0.19.0
File Interpreter ABI Platform Actions
django_perimeter-0.19.0-py3-none-any.whl Python 3 none any Details for django_perimeter-0.19.0-py3-none-any.whl

Total release size: 29.9 kB

Release files / django_perimeter-0.19.0.tar.gz

Download URL django_perimeter-0.19.0.tar.gz
Size 12.2 kB
Tags Source
SHA-256 checksum
How to use checksums
64a7cb07ddcc12318846b450398a2eeffd1610a394bc768353339fb56965288b
BLAKE2b-256 checksum
How to use checksums
8d7f7add9f356763857d37ef6064f507d2f7940d6d4c002b6469ca0fc5e584c7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.3 CPython/3.13.3 Darwin/24.6.0

Release files / django_perimeter-0.19.0-py3-none-any.whl

Download URL django_perimeter-0.19.0-py3-none-any.whl
Size 17.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
62ca53ab7084bf607c6b91d5b8e10330cc56de333986562de3de8c42d4182d4f
BLAKE2b-256 checksum
How to use checksums
59b689256a45ce8a96c0dabf3ccc4c1da55848097ccf8ab366dc696c224ba1d7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.3 CPython/3.13.3 Darwin/24.6.0

Security for django-perimeter 0.19.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.19.0 This release

2 release files No provenance

0.4.1

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page