Skip to main content

A Django app that implements IP-based blocklisting.

Project description

Django-blocklist

This is a Django app that implements IP-based blocklisting. Its BlocklistMiddleware performs the blocking, and its clean_blocklist management command deletes entries which have satisfied the cooldown period. Entries also have a reason field, used in reporting. There are utility functions to add/remove IPs, an admin, and several management commands.

This app is primarily for situations where server-level blocking is not available, e.g. on platform-as-a-service hosts like PythonAnywhere or Heroku. Being an application-layer solution, it's not as performant as blocking via firewall or web server process, but is suitable for moderate traffic sites. It also offers better integration with the application stack, for easier management.

Quick start

  1. The PyPI package name is django-blocklist; add that to your requirements.txt or otherwise install it into your project's Python environment.

  2. Add "django_blocklist" to your INSTALLED_APPS setting like this:

     INSTALLED_APPS = [
     ...
     "django_blocklist"
     ]
    
  3. Add the middleware like this:

    MIDDLEWARE = [
        ...
       "django_blocklist.middleware.BlocklistMiddleware"
    ]
    
  4. Run python manage.py migrate to create the blocklist_blockedip table.

  5. Add IPs to the list (via management commands, utils.add_to_blocklist, or the admin).

  6. Set up a cron job or equivalent to run manage.py clean_blocklist daily.

Management commands

Django-blocklist includes several management commands:

  • add_to_blocklist — (one or more IPs)
  • remove_from_blocklist — (one or more IPs)
  • search_blocklist — look for an IP in the list; in addition to info on stdout, returns an exit code of 0 if successful
  • update_blocklist — change the reason or cooldown values for existing entries
  • import_blocklist — convenience command for importing IPs from a file
  • report_blocklist — information on the current entries
  • clean_blocklist — remove entries that have fulfilled their cooldown period

The --help for each of these details its available options.

For exporting or importing BlockedIP entries, use Django's built-in dumpdata and loaddata management commands.

Configuration

You can customize the following settings via a BLOCKLIST_CONFIG dict in your project settings:

  • cooldown — Days to expire, for new entries; default 7
  • cache-ttl — Seconds that utils functions cache the full list; default 60
  • denial-template — For the denial response; an f-string with {ip} and {cooldown} placeholders

Reporting

The report_blocklist command gives information about the current collection of IPs, including:

  • Number of listed IPs
  • Total number of blocked requests from listed IPs
  • Number of IPs active in last 24 hours
  • Number of stale IPs (added over 24h ago and not seen since)
  • Five IPs with highest block count
  • Five IPs most recently blocked
  • Longest running entry
  • IP counts by reason

Utility methods

The utils module defines two convenience functions for updating the list from your application code:

  • add_to_blocklist(ips: set, reason="") adds IPs to the blocklist
  • remove_from_blocklist(ip: str) removes an entry, returning True if successful

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-blocklist-1.2.0.tar.gz (13.3 kB view hashes)

Uploaded source

Built Distribution

django_blocklist-1.2.0-py3-none-any.whl (19.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page