[LON-CAPA-cvs] cvs: loncom /auth localauth.pm

[albertel]

albertel		Fri Aug 25 17:35:54 2006 EDT

  Modified files:              
    /loncom/auth	localauth.pm 
  Log:
  - adding some more documentation about how locaauth works
  
  
Index: loncom/auth/localauth.pm
diff -u loncom/auth/localauth.pm:1.2 loncom/auth/localauth.pm:1.3
--- loncom/auth/localauth.pm:1.2	Thu Nov 29 14:12:44 2001
+++ loncom/auth/localauth.pm	Fri Aug 25 17:35:52 2006
@@ -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.3 2006/08/25 21:35:52 albertel Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -29,9 +29,16 @@
 
 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 
+# It is expected to return a 1 if the user is authenticated and a 0 otherwise
 # ----START LOCAL CHANGES HERE ----- DON'T DELETE THIS LINE
 sub localauth {
-   return 0;
+    my ($username,$password,$optional_argument) = @_;
+    return 0;
 }
 # ----END LOCAL CHANGES HERE ----- DON'T DELETE THIS LINE