Changes between Version 6 and Version 7 of AuthFramework

Timestamp:

Aug 6, 2008, 8:30:44 PM (16 years ago)

Author:

cmlenz

Comment:

--

AuthFramework

@@ -51 +51 @@
 
 This mode allows the use of HTTP authentication without having to protect the entire URL namespace. Only one or more sub-resources (such as `/login`) are protected by HTTP authentication. When the user visits a protected URL, Diva sets a cookie (in the same manner as with form-based authentication), thereby enabling resources outside of the protected area to identify the user and apply her permissions.
+
+== Integration and Utilities ==
+
+=== Development Server Integration ===
+
+As HTTP authentication is generally performed by the web server, testing a web app relying on HTTP authentication is often inconvenient. The Diva DevelopmentServer makes it easy by providing built-in support for HTTP Digest authentication, which can be enabled simply by specifying a couple of command-line options:
+
+{{{
+$ ./geddit/app.py --help
+Usage: app.py [options]
+
+Options:
+  -h, --help            show this help message and exit
+  -O name=value         set a configuration option
+  -b HOST, --host=HOST  hostname or IP address to bind to (default 127.0.0.1)
+  -p PORT, --port=PORT  port number to listen to (default 8080)
+  -r, --auto-reload     automatically restart after code changes (default off)
+
+  Authentication:
+    -D FILE, --digest=FILE
+                        path to a htdigest file to use for authentication
+    --realm=REALM       name of the authentication realm (default "Geddit")
+    --protect=PATH      path(s) to protect by authentication
+
+  Logging:
+    -v, --verbose       print as much as possible
+    -q, --quiet         print as little as possible
+}}}
+
+The `--digest` option is used to specify the text file containing the credentials, in a format compatible with the [http://httpd.apache.org/docs/2.2/programs/htdigest.html Apache htdigest tool]. The `--realm` option can be used to specify a different realm, where the default is the name of the `Application` class. This realm needs to match the realm used in the digest file.
+
+Finally, the `--protect` option can be used to require authentication only on the specified sub-resources. When the `--protect` option is not provided, the whole URI space will require authentication. When it is specified, authentication is only required on the specified paths. To protect more than one path, simply specifiy the option as often as you need.
+
+For example:
+
+{{{
+$ ./geddit/app.py -rv --digest auth.digest --protect /login
+}}}
+
+=== Password Management Utilities ===
+