summaryrefslogtreecommitdiff
path: root/wsgitools/middlewares.py
diff options
context:
space:
mode:
authorHelmut Grohne <helmut@subdivi.de>2011-07-22 20:47:46 +0200
committerHelmut Grohne <helmut@subdivi.de>2011-07-22 20:47:46 +0200
commit183aa59e609138653ad8107552ce66c7a9e47405 (patch)
tree7bb6afd4dd379bf29cadaa8ce1203133b8c0e371 /wsgitools/middlewares.py
parent1966bf28d296e6b0d4e08c8f140ed12fc2960f60 (diff)
downloadwsgitools-183aa59e609138653ad8107552ce66c7a9e47405.tar.gz
BasicAuthMiddleware docstring: mention REMOTE_USER
Diffstat (limited to 'wsgitools/middlewares.py')
-rw-r--r--wsgitools/middlewares.py4
1 files changed, 3 insertions, 1 deletions
diff --git a/wsgitools/middlewares.py b/wsgitools/middlewares.py
index 709304f..c3f2871 100644
--- a/wsgitools/middlewares.py
+++ b/wsgitools/middlewares.py
@@ -313,7 +313,9 @@ class DictAuthChecker:
__all__.append("BasicAuthMiddleware")
class BasicAuthMiddleware:
- """Middleware implementing HTTP Basic Auth."""
+ """Middleware implementing HTTP Basic Auth. Upon forwarding the request to
+ the warpped application the environ dictionary is augmented by a REMOTE_USER
+ key."""
def __init__(self, app, check_function, realm='www', app401=None):
"""
@param app: is a WSGI application.