Added an extra two arguments to the authentication so it returns

the username of the person who authenticated (optionally).

Tom


git-svn-id: http://svn.cactuscode.org/arrangements/CactusConnect/HTTPD/trunk@45 1faa4e14-9dd3-4be0-9f0e-ffe519881164

1 files changed, 7 insertions, 3 deletions

diff --git a/doc/Auth.txt b/doc/Auth.txt
index b1a2b34..cddda88 100644
--- a/doc/Auth.txt
+++ b/doc/Auth.txt
@@ -33,12 +33,16 @@ web page to be encrypted.
 The other function is
 
 int HTTP_AuthenticateBasic(httpRequest *request,
-                           const char *database);
+                           const char *database,
+                           char *user,
+                           int length);
 
 which takes an HTTP request, and a password database, and sees if the
 'Authorization' header field declares a user and password which are in 
 the database.  This function supports the 'Basic' authentication
-scheme supplied by HTTP/1.0.  
+scheme supplied by HTTP/1.0.  It will also, if 'user' is not null,
+pass back the name of the user who authenticated if that isn't longer
+than length.
 
 This function has three possible return codes.
 
@@ -63,7 +67,7 @@ if the configuration supports crypt(3) passwords.
 
 Then when a page comes in, one does
 
-  notauthorised = HTTP_AuthenticateBasic(request, "users");
+  notauthorised = HTTP_AuthenticateBasic(request, "users", NULL, 0);
 
   if(!notauthorised)
   {