use base qw/Class::Accessor::Fast Class::Data::Inheritable/;
-BEGIN {
- __PACKAGE__->mk_accessors(qw/_user/);
-}
+__PACKAGE__->mk_accessors(qw/_user/);
use strict;
use warnings;
+use MRO::Compat;
use Tie::RefHash;
use Class::Inspector;
use Catalyst::Authentication::Realm;
-
-our $VERSION = "0.10007_01";
+our $VERSION = "0.10011";
sub set_authenticated {
my ( $c, $user, $realmname ) = @_;
$c->persist_user();
- $c->NEXT::set_authenticated($user, $realmname);
+ $c->maybe::next::method($user, $realmname);
}
sub user {
# in addition to verifying that they exist.
sub user_exists {
my $c = shift;
- return defined($c->_user) || defined($c->_find_realm_for_persisted_user);
+ return defined($c->_user) || defined($c->find_realm_for_persisted_user);
}
# works like user_exists - except only returns true if user
if (defined($c->_user)) {
return ($c->_user->auth_realm eq $realmname);
} else {
- my $realm = $c->_find_realm_for_persisted_user;
+ my $realm = $c->find_realm_for_persisted_user;
if ($realm) {
return ($realm->name eq $realmname);
} else {
## if we have a valid session handler - we store the
## realm in the session. If not - we have to hope that
## the realm can recognize its frozen user somehow.
- if ($c->isa("Catalyst::Plugin::Session") &&
+ if ($c->can('session') &&
$c->config->{'Plugin::Authentication'}{'use_session'} &&
$c->session_is_valid) {
$c->user(undef);
- my $realm = $c->_find_realm_for_persisted_user;
+ my $realm = $c->find_realm_for_persisted_user;
if ($realm) {
$realm->remove_persisted_user($c);
}
- $c->NEXT::logout(@_);
+ $c->maybe::next::method(@_);
}
sub find_user {
return $realm->find_user($userinfo, $c);
}
-
-sub _find_realm_for_persisted_user {
+## Consider making this a public method. - would make certain things easier when
+## dealing with things pre-auth restore.
+sub find_realm_for_persisted_user {
my $c = shift;
my $realm;
- if ($c->isa("Catalyst::Plugin::Session")
+ if ($c->can('session')
and $c->config->{'Plugin::Authentication'}{'use_session'}
and $c->session_is_valid
and exists($c->session->{'__user_realm'})) {
if (defined($realmname)) {
$realm = $c->get_auth_realm($realmname);
} else {
- $realm = $c->_find_realm_for_persisted_user;
+ $realm = $c->find_realm_for_persisted_user;
}
- return unless $realm; # FIXME die unless? This is an internal inconsistency
-
+ return undef unless $realm; # FIXME die unless? This is an internal inconsistency
+
$c->_user( my $user = $realm->restore_user( $c, $frozen_user ) );
# this sets the realm the user originated in.
- $user->auth_realm($realm->name);
+ $user->auth_realm($realm->name) if $user;
return $user;
my $app = shift;
$app->_authentication_initialize();
- $app->NEXT::setup(@_);
+ $app->next::method(@_);
}
## the actual initialization routine. whee.
## into play if session is disabled.
$app->mk_classdata( '_auth_realm_restore_order' => []);
-
+
my $cfg = $app->config->{'Plugin::Authentication'};
+ my $realmshash;
if (!defined($cfg)) {
if (exists($app->config->{'authentication'})) {
$cfg = $app->config->{'authentication'};
} else {
$cfg = {};
}
- }
+ } else {
+ # the realmshash contains the various configured realms. By default this is
+ # the main $app->config->{'Plugin::Authentication'} hash - but if that is
+ # not defined, or there is a subkey {'realms'} then we use that.
+ $realmshash = $cfg;
+ }
+
+ ## If we have a sub-key of {'realms'} then we use that for realm configuration
+ if (exists($cfg->{'realms'})) {
+ $realmshash = $cfg->{'realms'};
+ }
# old default was to force use_session on. This must remain for that
# reason - but if use_session is already in the config, we respect its setting.
$cfg->{'use_session'} = 1;
}
- if (exists($cfg->{'realms'})) {
+ ## if we have a realms hash
+ if (ref($realmshash) eq 'HASH') {
my %auth_restore_order;
my $authcount = 2;
my $defaultrealm = 'default';
-
- foreach my $realm (sort keys %{$cfg->{'realms'}}) {
+
+ foreach my $realm (sort keys %{$realmshash}) {
+ if (ref($realmshash->{$realm}) eq 'HASH' &&
+ (exists($realmshash->{$realm}{credential}) || exists($realmshash->{$realm}{class}))) {
+
+ $app->setup_auth_realm($realm, $realmshash->{$realm});
- $app->setup_auth_realm($realm, $cfg->{'realms'}{$realm});
-
- if (exists($cfg->{'realms'}{$realm}{'user_restore_priority'})) {
- $auth_restore_order{$realm} = $cfg->{'realms'}{$realm}{'user_restore_priority'};
- } else {
- $auth_restore_order{$realm} = $authcount++;
- }
+ if (exists($realmshash->{$realm}{'user_restore_priority'})) {
+ $auth_restore_order{$realm} = $realmshash->{$realm}{'user_restore_priority'};
+ } else {
+ $auth_restore_order{$realm} = $authcount++;
+ }
+ }
}
# if we have a 'default_realm' in the config hash and we don't already
}
## if the default realm did not have a defined priority in its config - we put it at the front.
- if (!exists($cfg->{'realms'}{$defaultrealm}{'user_restore_priority'})) {
+ if (!exists($realmshash->{$defaultrealm}{'user_restore_priority'})) {
$auth_restore_order{'default'} = 1;
}
When user input is transferred to the L<Catalyst> application
(typically via form inputs) the application may pass this information
-into the authentication system through the C<<$c->authenticate()>>
+into the authentication system through the C<< $c->authenticate() >>
method. From there, it is passed to the appropriate Credential
verifier.
__PACKAGE__->config->{'Plugin::Authentication'} =
{
- default_realm => 'members',
- realms => {
- members => {
- credential => {
- class => 'Password',
- password_field => 'password',
- password_type => 'clear'
- },
- store => {
- class => 'Minimal',
- users => {
- bob => {
- password => "s00p3r",
- editor => 'yes',
- roles => [qw/edit delete/],
- },
- william => {
- password => "s3cr3t",
- roles => [qw/comment/],
- }
- }
- }
- }
- }
+ default => {
+ credential => {
+ class => 'Password',
+ password_field => 'password',
+ password_type => 'clear'
+ },
+ store => {
+ class => 'Minimal',
+ users => {
+ bob => {
+ password => "s00p3r",
+ editor => 'yes',
+ roles => [qw/edit delete/],
+ },
+ william => {
+ password => "s3cr3t",
+ roles => [qw/comment/],
+ }
+ }
+ }
+ }
};
-
This tells the authentication plugin what realms are available, which
credential and store modules are used, and the configuration of each. With
The credential verifier will attempt to retrieve the user whose
details match the authentication information provided to
-C<<$c->authenticate()>>. Once it fetches the user the password is
+C<< $c->authenticate() >>. Once it fetches the user the password is
checked and if it matches the user will be B<authenticated> and
-C<<$c->user>> will contain the user object retrieved from the store.
+C<< $c->user >> will contain the user object retrieved from the store.
In the above case, the default realm is checked, but we could just as easily
check an alternate realm. If this were an admin login, for example, we could
-authenticate on the admin realm by simply changing the C<<$c->authenticate()>>
+authenticate on the admin realm by simply changing the C<< $c->authenticate() >>
call:
if ( $c->authenticate( { username => $user,
}
(Note that if you have multiple realms, you can use
-C<<$c->user_in_realm('realmname')>>) in place of
-C<<$c->user_exists();>> This will essentially perform the same
+C<< $c->user_in_realm('realmname') >> in place of
+C<< $c->user_exists(); >> This will essentially perform the same
verification as user_exists, with the added requirement that if there
is a user, it must have come from the realm specified.)
__PACKAGE__->config->{'Plugin::Authentication'} =
{
default_realm => 'members',
- realms => {
- members => {
- credential => {
- class => 'Password',
- password_field => 'password',
- password_type => 'clear'
- },
- store => {
- class => 'DBIx::Class',
- user_class => 'MyApp::Users',
- role_column => 'roles'
- }
- }
- }
- };
-
-The authentication system works behind the scenes to load your data from the
-new source. The rest of your application is completely unchanged.
-
-
-=head1 CONFIGURATION
-
- # example
- __PACKAGE__->config->{'Plugin::Authentication'} =
- {
- default_realm => 'members',
- realms => {
members => {
credential => {
class => 'Password',
user_class => 'MyApp::Users',
role_column => 'roles'
}
- },
- admins => {
- credential => {
- class => 'Password',
- password_field => 'password',
- password_type => 'clear'
- },
- store => {
- class => '+MyApp::Authentication::Store::NetAuth',
- authserver => '192.168.10.17'
- }
}
-
- }
+ };
+
+The authentication system works behind the scenes to load your data from the
+new source. The rest of your application is completely unchanged.
+
+
+=head1 CONFIGURATION
+
+ # example
+ __PACKAGE__->config->{'Plugin::Authentication'} =
+ {
+ default_realm => 'members',
+
+ members => {
+ credential => {
+ class => 'Password',
+ password_field => 'password',
+ password_type => 'clear'
+ },
+ store => {
+ class => 'DBIx::Class',
+ user_class => 'MyApp::Users',
+ role_column => 'roles'
+ }
+ },
+ admins => {
+ credential => {
+ class => 'Password',
+ password_field => 'password',
+ password_type => 'clear'
+ },
+ store => {
+ class => '+MyApp::Authentication::Store::NetAuth',
+ authserver => '192.168.10.17'
+ }
+ }
};
=over 4
This defines which realm should be used as when no realm is provided to methods
that require a realm such as authenticate or find_user.
-=item realms
+=item realm refs
-This contains the series of realm configurations you want to use for your app.
-The only rule here is that there must be at least one. A realm consists of a
-name, which is used to reference the realm, a credential and a store.
+The Plugin::Authentication config hash contains the series of realm
+configurations you want to use for your app. The only rule here is
+that there must be at least one. A realm consists of a name, which is used
+to reference the realm, a credential and a store. You may also put your
+realm configurations within a subelement called 'realms' if you desire to
+separate them from the remainder of your configuration. Note that if you use
+a 'realms' subelement, you must put ALL of your realms within it.
You can also specify a realm class to instantiate instead of the default
L<Catalyst::Authentication::Realm> class using the 'class' element within the
=head2 $c->logout( )
-Logs the user out. Deletes the currently logged in user from C<<$c->user>> and the session.
+Logs the user out. Deletes the currently logged in user from C<< $c->user >> and the session.
=head2 $c->find_user( $userinfo, $realm )
most current data. Assumes that at the time of this call, $c->user
contains the most current data.
+=head2 find_realm_for_persisted_user()
+
+Private method, do not call from user code!
+
=head1 INTERNAL METHODS
These methods are for Catalyst::Plugin::Authentication B<INTERNAL USE> only.
David Kamholz
+Tomas Doran (t0m), C<bobtfish@bobtfish.net>
+
=head1 COPYRIGHT & LICENSE
Copyright (c) 2005 the aforementioned authors. All rights
projects / catagits/Catalyst-Plugin-Authentication.git / blobdiff