--- loncom/auth/localauth.pm	2001/11/29 19:12:44	1.2
+++ loncom/auth/localauth.pm	2007/01/19 02:57:33	1.5
@@ -1,6 +1,6 @@
 # The LON-CAPA dummy localauthentication mechnism
 #
-# $Id: localauth.pm,v 1.2 2001/11/29 19:12:44 www Exp $
+# $Id: localauth.pm,v 1.5 2007/01/19 02:57:33 albertel Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -29,9 +29,19 @@
 
 package localauth;
 
+# The localauth routine receives
+# - the typed in username
+# - the typed in password
+# - the optional information that was stored when the authentication 
+#   mechanism was specified 
+# - the domain that was typed in
+# It is expected to return a 1 if the user is authenticated and a 0 otherwise
+# it can optionally return a negative value for an error condition. This
+# negative value will get logged along with the user that caused it
 # ----START LOCAL CHANGES HERE ----- DON'T DELETE THIS LINE
 sub localauth {
-   return 0;
+    my ($username,$password,$optional_argument,$domain) = @_;
+    return 0;
 }
 # ----END LOCAL CHANGES HERE ----- DON'T DELETE THIS LINE