Chris/webperl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

AuthMethods can return extra data to pass to the post_authenticate.

Browse Source
This commit is contained in:
Chris 2014-06-12 13:13:54 +01:00
parent 426a053d92
commit a6ce3121fd
3 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Webperl/AppUser.pm
View File

@ -294,7 +294,7 @@ sub pre_authenticate {
} }
## @method $ post_authenticate($username, $password, $auth, $authmethod) ## @method $ post_authenticate($username, $password, $auth, $authmethod, $extradata)
# Perform any system-specific post-authentication tasks on the specified # Perform any system-specific post-authentication tasks on the specified
# user's data. This function allows each system to tailor post-auth tasks # user's data. This function allows each system to tailor post-auth tasks
# to the requirements of the system. This function is only called if # to the requirements of the system. This function is only called if
@ -313,6 +313,7 @@ sub pre_authenticate {
# @param password The password the user authenticated with. # @param password The password the user authenticated with.
# @param auth A reference to the auth object calling this. # @param auth A reference to the auth object calling this.
# @param authmethod The id of the authmethod to set for the user. # @param authmethod The id of the authmethod to set for the user.
# @param extradata An optional reference to a hash containin extra data to set.
# @return A reference to a hash containing the user's data on success, # @return A reference to a hash containing the user's data on success,
# undef otherwise. If this returns undef, an error message will be # undef otherwise. If this returns undef, an error message will be
# set in the specified auth's errstr field. # set in the specified auth's errstr field.
@ -322,6 +323,7 @@ sub post_authenticate {
my $password = shift; my $password = shift;
my $auth = shift; my $auth = shift;
my $authmethod = shift; my $authmethod = shift;
my $extradata = shift;
$self -> clear_error(); $self -> clear_error();

7
Webperl/Auth.pm
View File

@ -210,6 +210,7 @@ sub valid_user {
my $username = shift; my $username = shift;
my $password = shift; my $password = shift;
my $valid = 0; my $valid = 0;
my $extradata;
my $methodimpl; my $methodimpl;
# clean up the password # clean up the password
@ -235,7 +236,7 @@ sub valid_user {
or return undef; or return undef;
# Check whether the user can authenticate if the implementation was found # Check whether the user can authenticate if the implementation was found
$valid = $methodimpl -> authenticate($username, $password, $self); ($valid, $extradata) = $methodimpl -> authenticate($username, $password, $self);
# errors should halt auth attempts # errors should halt auth attempts
return undef if(!defined($valid)); return undef if(!defined($valid));
@ -248,7 +249,7 @@ sub valid_user {
my $methodimpl = $self -> get_authmethod_module($trymethod) my $methodimpl = $self -> get_authmethod_module($trymethod)
or return undef; or return undef;
$valid = $methodimpl -> authenticate($username, $password, $self); ($valid, $extradata) = $methodimpl -> authenticate($username, $password, $self);
# If this method worked, record it. # If this method worked, record it.
$authmethod = $trymethod if($valid); $authmethod = $trymethod if($valid);
@ -261,7 +262,7 @@ sub valid_user {
# If one of the auth methods succeeded in validating the user, record it # If one of the auth methods succeeded in validating the user, record it
# invoke the app standard post-auth for the user, and return the user's # invoke the app standard post-auth for the user, and return the user's
# database record. # database record.
return $self -> {"app"} -> post_authenticate($username, $password, $self, $authmethod) return $self -> {"app"} -> post_authenticate($username, $password, $self, $authmethod, $extradata)
if($valid); if($valid);
# Authentication failed. # Authentication failed.

8
Webperl/AuthMethod.pm
View File

@ -122,7 +122,7 @@ sub create_user {
} }
## @method $ authenticate($username, $password, $auth) ## @method @ authenticate($username, $password, $auth)
# Authenticate a user based on the credentials supplied. This will attempt # Authenticate a user based on the credentials supplied. This will attempt
# to determine whether the user's credentials are valid, and will return # to determine whether the user's credentials are valid, and will return
# true if they are, or false if they are not or a problem occured while # true if they are, or false if they are not or a problem occured while
@ -133,7 +133,11 @@ sub create_user {
# @param auth A reference to the Auth object calling this function, # @param auth A reference to the Auth object calling this function,
# if any errors are encountered while performing the # if any errors are encountered while performing the
# authentication, they will be set in $auth -> {"errstr"}. # authentication, they will be set in $auth -> {"errstr"}.
# @return true if the user's credentials are valid, false otherwise. # @return true if the user's credentials are valid, false otherwise. Some
# AuthMethods may also return an additional value: a reference to a
# hash containing values to set for the user. Keys may be system-specific,
# and may require a custom AppUser implementation to use properly, but
# recommended keys are "email" and "realname", but other fields may be included.
sub authenticate { sub authenticate {
my $self = shift; my $self = shift;
my $username = shift; my $username = shift;