Skip to main content

Simple wsgi middleware to provide basic http auth

Project description

Really simple wsgi middleware to provide basic http auth. It is intented to work with environment variables. This makes it simple to use in a docker context.

Status

https://readthedocs.org/projects/wsgi-basic-auth/badge/?version=latest https://travis-ci.org/mvantellingen/wsgi-basic-auth.svg?branch=master https://ci.appveyor.com/api/projects/status/im609ng9h29vt89r?svg=true http://codecov.io/github/mvantellingen/wsgi-basic-auth/coverage.svg?branch=master https://img.shields.io/pypi/v/wsgi-basic-auth.svg

Getting started

Using this module is really simple. In Django for example edit the wsgi.py file and add the following to the end of the file.

from wsgi_basic_auth import BasicAuth
application = BasicAuth(application)

Now run docker with the env variable WSGI_AUTH_CREDENTIALS=foo:bar and you have to authenticate with username foo and password bar. Multiple credentials are separated with a | (pipe) character.

To exclude specific paths for healthchecks (e.g. the Amazon ELB healthchecks) specify the environment variable WSGI_AUTH_EXCLUDE_PATHS=/api/healthchecks. Here multiple paths can be separated with the ; char.

To include only specific paths specify the environment variable WSGI_AUTH_EXCLUDE_PATHS. Here multiple paths can be separated with the ; char.

You can use both include and exclude paths together for example: WSGI_AUTH_INCLUDE_PATHS=/foo WSGI_AUTH_EXCLUDE_PATHS=/foo/bar This will force Basic Auth on all paths under /foo except /foo/bar

Installation

You can install the latest version using pip:

pip install wsgi-basic-auth

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

wsgi-basic-auth-isl-1.0.4.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

wsgi_basic_auth_isl-1.0.4-py2.py3-none-any.whl (5.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file wsgi-basic-auth-isl-1.0.4.tar.gz.

File metadata

File hashes

Hashes for wsgi-basic-auth-isl-1.0.4.tar.gz
Algorithm Hash digest
SHA256 40f6e21c5bfc3e4053f3c2be1b556a584e39b4f2d3d22b28601d3910929aea95
MD5 1113d2ee353bfcfb98ed83dd77f71d34
BLAKE2b-256 cd5c9fa288046660ba099223f864c23f9c142c092e92c614c958868c5f0ae68c

See more details on using hashes here.

File details

Details for the file wsgi_basic_auth_isl-1.0.4-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for wsgi_basic_auth_isl-1.0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6e525f521e2257df00e34316b5503397ce93dca0e453c12cbd7044e55a3a606b
MD5 0fc0ae2bfd9afd4d8fccf3a092f90302
BLAKE2b-256 78d9da2ea2ae0bd973904c574188f2c42d894046e1aac9033d54da19bb1699ea

See more details on using hashes here.

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