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.7.1 (2023-07-10)

  • Update setup.cfg to rename deprecated licence_file param

0.7.0 (2023-07-10)

  • Add IPv6 support - thanks @rissson!

  • Add Django 4.2 to CI; freshen up CI config

0.6.0 (2023-01-05)

  • Drop dev-related dependencies (incl vulnerable version of wheel, which was not installed in general use)

  • Remove redundant code from setup.py now we’re auto-publishing via Github

  • Update testing matrix: Drop Python 3.6; add Python 3.11; add Django 4.1

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.7.1.tar.gz (7.0 kB view hashes)

Uploaded Source

Built Distribution

django_allow_cidr-0.7.1-py2.py3-none-any.whl (5.0 kB view hashes)

Uploaded Python 2 Python 3

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