Skip to main content

A Django Middleware to enable use of CIDR IP ranges in ALLOWED_HOSTS.

Project description

https://badge.fury.io/py/django-allow-cidr.svg https://github.com/mozmeao/django-allow-cidr/actions/workflows/ci.yml/badge.svg

A Django Middleware to enable use of CIDR IP ranges in ALLOWED_HOSTS.

Quickstart

Install Django Allow CIDR:

pip install django-allow-cidr

Add the Middleware to your MIDDLEWARE settings. It should be the first in the list:

MIDDLEWARE = (
    'allow_cidr.middleware.AllowCIDRMiddleware',
    ...
)

Add the ALLOWED_CIDR_NETS setting:

ALLOWED_CIDR_NETS = ['192.168.1.0/24']

Profit!

Features

  • The normal ALLOWED_HOSTS values will also work as intended. This Middleware is intended to augment, not replace, the normal Django function.

  • If you do define ALLOWED_CIDR_NETS and it has values, the middleware will capture what you have in ALLOWED_HOSTS, set ALLOWED_HOSTS to [‘*’] and take over validation of host headers.

  • The ALLOWED_CIDR_NETS values can be any valid network definition for the netaddr package.

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Pushing to PyPI

Cutting a new Github Release will trigger CI checks, followed by an automatic release to PyPI, using the release version. Please make sure that your Github Release version matches the project version in __init__.py.

For more details see the release job in .github/workflows/ci.yml.

Credits

Tools used in rendering this package:

History

0.5.0 (2022-07-09)

  • Replace the netaddr dependency with Python 3’s ipaddress - thanks @n1ngu!

  • Update GH actions to release to PyPI

0.4.1 (2022-06-13)

  • Use packaging.version to avoid distutils deprecated module - thanks @adamantike!

0.4.0 (2022-02-22)

  • Drop Django support for non-LTS and non-latest Django (so, removing 1.x, 2.0, 2.1, 3.0, 3.1)

  • Drop support for older Python releases (2.x, 3.5)

  • Add Django 4.0 to tox’s test matrix

  • Add Python 3.7 through 3.10 to tox’s test matrix; 3.6 to 3.10 are now the only tested versions

  • Switch CI to Github Actions

0.3.1 (2018-07-31)

  • Fix issue #6: Accept passed in get_response function for Middleware in Django >= 1.10.

  • Publish updated docs that fix the ALLOWED_CIDR_NETS typo.

0.3.0 (2018-02-21)

  • Disable middleware if ALLOWED_HOSTS is set to [‘*’].

0.2.0 (2018-02-21)

  • Handle host names with ports (Thanks Giorgos!).

0.1.0 (2018-02-16)

  • First release on PyPI.

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-allow-cidr-0.5.0.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

django_allow_cidr-0.5.0-py2.py3-none-any.whl (4.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-allow-cidr-0.5.0.tar.gz.

File metadata

  • Download URL: django-allow-cidr-0.5.0.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for django-allow-cidr-0.5.0.tar.gz
Algorithm Hash digest
SHA256 d17347e75d6c02864022f52ed608775a5e9ab144d1a82bb40853714f125f5d87
MD5 658af551636f3d7c9fb778d2f60ef798
BLAKE2b-256 a036b57a1b773b0afa82680473e34f6baa176e4c00691bf7d8204c0fd87f74a7

See more details on using hashes here.

File details

Details for the file django_allow_cidr-0.5.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_allow_cidr-0.5.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2fd88ffe697caf0c1d0fd147b88cf44d81282c069bbc475166a2ff1637ad9155
MD5 e8ed5e9fc9f1c6e6df1ab5921c582123
BLAKE2b-256 68c3c5d49d9829175d2edb4d3661880634284ec281a4970d71a91cf5e2ccfe13

See more details on using hashes here.

Supported by

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