Skip to content

Latest commit

 

History

History
70 lines (42 loc) · 2.27 KB

README.md

File metadata and controls

70 lines (42 loc) · 2.27 KB

django-banish

django-banish is a Django middleware app to banish user agents by IP address or User Agent Header. It also supports basic abuse prevention by automatically banning users if they exceed a certain number of requests per minute, which is likely some form of attack or attempted denial of service.

Django-banish stores all 'banishments' in memory to avoid database lookups on every request. It requires memcached, especially for the IP abuse monitoring feature.

django-banish was previously called django-ipban and hosted on google-code. That code should be ignored - In 2010 it was dusted off and given a new life at github.

Installation

Requirements:

  • Python 2.5+
  • Django
  • Memcache

Get django-banish

Get the source:

Browse the source on GitHub: http://github.com/yourabi/django-banish

Clone with Git: $ git clone git://github.com/yourabi/django-banish

Install via easy_install or pip easy_install django-banish pip install django-banish

Setup

Install django-banish. Make sure it is on your PYTHONPATH or in your django project directory.

In your django project settings.py you must set the following options:

1) Add 'banish.middleware.BanishMiddleware' to MIDDLEWARE_CLASSES

2) Add 'banish' to INSTALLED_APPS

3) Add BANISH_ENABLED = True to enable Django-Banish (handy if you lock yourself out, you can just set this to False)

4) ADD BANISH_EMPTY_UA = True|False to specify wether requests without a USER_AGENT header will be banned.

5) Optionally set BANISH_ABUSE_THRESHOLD (default is 75) to the threshold of requests per minute

6) Optionally set BANISH_MESSAGE (default is "You are banned.") to change default message for banned user.

7) Optionally set DJANGO_BANISH_CACHE to the name of the cache from settings.CACHES you want to use. Will you 'default' cache by default. If your cache is in-memory/per process you'll want to add a cache shared application wide to settings.CACHES and specify it here.

Issues

Find a bug? Want a feature? Submit an issue here. Patches welcome!

License

django-banish is released under the Apache Software License, Version 2.0

Authors