summaryrefslogtreecommitdiff
path: root/testenv/conf/authentication.py
diff options
context:
space:
mode:
Diffstat (limited to 'testenv/conf/authentication.py')
-rw-r--r--testenv/conf/authentication.py13
1 files changed, 13 insertions, 0 deletions
diff --git a/testenv/conf/authentication.py b/testenv/conf/authentication.py
index 58cbaff0..c87994ad 100644
--- a/testenv/conf/authentication.py
+++ b/testenv/conf/authentication.py
@@ -1,5 +1,18 @@
from conf import rule
+""" Rule: Authentication
+This file defines an authentication rule which when applied to any file will
+cause the server to prompt the client for the required authentication details
+before serving it.
+auth_type must be either of: Basic, Digest, Both or Both-inline
+When auth_type is Basic or Digest, the server asks for the respective
+authentication in its response. When auth_type is Both, the server sends two
+Authenticate headers, one requesting Basic and the other requesting Digest
+authentication. If auth_type is Both-inline, the server sends only one
+Authenticate header, but lists both Basic and Digest as supported mechanisms in
+that.
+"""
+
@rule()
class Authentication: