Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Keep the black night at bay

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 example_project
Octocat-spinner-32 moat
Octocat-spinner-32 .gitignore
Octocat-spinner-32 README.rst
Octocat-spinner-32 requirements.txt
Octocat-spinner-32 setup.py
README.rst

django-moat

django-moat is a mini-app adds an additional layer of authentication via HTTP Basic Auth. It's primary use case is to prevent access staging, development, or otherwise private sites on the public internet. It is equivalent to configuring Basic Auth on your webserver (Apache, nginx) but works in environments where that is not possible (heroku).

Installation

From PyPi

pip install django-moat

To install from source

pip install -e git+https://github.com/amrox/django-moat#egg=django-moat

Configuration

Add moat.middleware.MoatMiddleware to your MIDDLEWARE_CLASSES:

MIDDLEWARE_CLASSES = (
    # Existing middleware classes
    "moat.middleware.MoatMiddleware",
)

moat has several configuration variable you may put in your settings.py

MOAT_ENABLED

Enable or disable moat. (True or False)

MOAT_ENABLED = True
HTTP_AUTH_REALM

Set Basic Auth Realm

HTTP_AUTH_REALM = 'App Staging'
MOAT_ALWAYS_ALLOW_VIEWS

A list of views to allow through moat

MOAT_ALWAYS_ALLOW_VIEWS = ['myapp.views.home']
MOAT_ALWAYS_ALLOW_MODULES

A list of modules to allow through moat

MOAT_ALWAYS_ALLOW_MODULES = ['oauth_provider.views']
MOAT_ALWAYS_ALLOW_URLS

A list of regex of urls to allow through moat

MOAT_ALWAYS_ALLOW_URLS = ['^/$', '^/blog/.*$']
MOAT_ALLOW_ADMIN

Let the admin site through moat. Default: False.

MOAT_ALLOW_ADMIN = True
MOAT_DEBUG_DISABLE_HTTPS

Disable HTTPS. For testing purposes only. Don't ship with this on.

MOAT_DEBUG_DISABLE_HTTPS = True

Finally you may want to set the SESSION_EXPIRE_AT_BROWSER_CLOSE setting.

Usage

Your site now requires that your authenticate with a staff-level user before accessing any non-whitelisted view. It is recommended that your add a dedicate staff-level user in the django admin for moat authentication.

By default, the admin views will be blocked by moat. You'll either need to create a user with django-admin.py, or set MOAT_ALLOW_ADMIN to True.

Acknowledgements

Code borrowed from:

Thanks to Ryan Balfanz for suggesting the name moat.

Something went wrong with that request. Please try again.