loncom/auth/localauth.pm - diff

Return to localauth.pm CVS log

Up to [LON-CAPA] / loncom / auth

-version 1.5, 2007/01/19 02:57:33
+version 1.6, 2008/11/07 17:52:45
  Line 26
  #
  # 8/24 Guy Albertelli
+ =pod
+ =head1 NAME
+ localauth
+ =head1 SYNOPSIS
+ The localauth routine receives
+  - the typed in username
+  - the typed in password
+  - the optional information that was stored when the authentication mechanism was specified
+ =head1 OVERVIEW
+ 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.
+ =cut
  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 {
      my ($username,$password,$optional_argument,$domain) = @_;