django-ip-restriction 0.1.2

A Django middleware to restrict incoming IPs to a Django project.

Django IP Restriction

Department of International Trade Django IP Whitelist. A Django middleware to restrict incoming IPs to a Django project to a list of allowed IPs or IP ranges, or to authenticated users. Access to the admin login screen are not restricted, so that users can then authenticate, and bypass the IP restriction for the rest of the site.

Requirements

• Python >= 3.0

• Django >= 1.9

Quick start

1. Install the package:

   $ pip install django-ip-restriction

2. Add the middleware to your MIDDLEWARE_CLASSES setting:

   MIDDLEWARE_CLASSES = [
       ...
       'ip_restriction.IpWhitelister',
   ]

Configuring

Turning on or off, and configuring the IP whitelist is done either via variables in your Django settings, or via environment variables. Values in Django settings take preference over values in the environment.

Turning on/off the middleware is done via RESTRICT_IPS, and the default value is False. Either set this variable to True in Django settings, or set a truthy value (e.g. ‘true’, ‘1’) in your environment.

Individual IPs can be whitelisted via ALLOWED_IPS, which is either a list of IP strings in Django settings, or a comma-separated list of IPs in the environment, e.g the following 2 are equivalent:

# in bash (spaces are disregarded, trailing commas are OK)
export ALLOWED_IPS='192.168.0.1, 192.168.0.2,192.168.0.3,'

# in settings.py (will override the above environment variable)
ALLOWED_IPS = ['192.168.0.1', '192.168.0.2', '192.168.0.3']

IP ranges can be whitelisted via ALLOWED_IP_RANGES, which is either a list of IP range strings (CIDR notation) in Django settings, or a comma-separated list of IP ranges in the environment, e.g.:

# in bash
export ALLOWED_IP_RANGES='192.168.0.0/8, 127.0.0.0/2'

# in settings.py
ALLOWED_IPS = ['192.168.0.0/8', '127.0.0.0/2']

Contributing

Contributions are welcome. Please follow the guidelines below to make life easier:

• Fork the repo, branch off release, make changes, then make a pull request (PR) to release on the main repo

• Include tests for bug fixes or new features

• Include documentation for any new features

• Please limit changes for a PR to a single feature, or a single bugfix

  • Make multiple PRs for multiple discrete changes

• Please squash commits - ideally a single commit, but at least to a sensible minimum

  • If a PR reasonably should have multiple commits, consider if it should actually be separate PRs

License

MIT licensed. See the bundled LICENSE file for more details.

TODO

• Allow the IP restriction to work in a blacklisting mode, rather than just a whitelisting mode

• Get continuous integration to run on multiple python versions from 3.0+

  • Currently only running on 3.5.0

  • Utilise parallelism

• Run tests on multiple Django versions

  • Currently only running against Django 1.9

  • Utilise parallelism