package Catalyst::Plugin::Authentication;
-
-use base qw/Class::Accessor::Fast/;
-
-__PACKAGE__->mk_accessors(qw/_user/);
-
-use strict;
-use warnings;
-
+use Moose::Role;
use MRO::Compat;
use Tie::RefHash;
use Class::Inspector;
use Catalyst::Authentication::Realm;
+use namespace::autoclean;
+
+has _user => ( is => 'rw' );
- our $VERSION = "0.10012";
+ our $VERSION = "0.10016";
sub set_authenticated {
my ( $c, $user, $realmname ) = @_;
$realmname = 'default';
}
my $realm = $c->get_auth_realm($realmname);
-
+
if (!$realm) {
Catalyst::Exception->throw(
"set_authenticated called with nonexistant realm: '$realmname'.");
}
$user->auth_realm($realm->name);
- $c->persist_user();
-
+ $c->persist_user();
+
$c->maybe::next::method($user, $realmname);
}
# change this to allow specification of a realm - to verify the user is part of that realm
# in addition to verifying that they exist.
sub user_exists {
- my $c = shift;
- return defined($c->_user) || defined($c->find_realm_for_persisted_user);
+ my $c = shift;
+ return defined($c->_user) || defined($c->find_realm_for_persisted_user);
}
- # works like user_exists - except only returns true if user
+ # works like user_exists - except only returns true if user
# exists AND is in the realm requested.
sub user_in_realm {
my ($c, $realmname) = @_;
my ( $c, $user, $realmname ) = @_;
$c->session->{__user_realm} = $realmname;
-
+
# we want to ask the store for a user prepared for the session.
# but older modules split this functionality between the user and the
# store. We try the store first. If not, we use the old method.
my $c = shift;
if ($c->user_exists) {
-
- ## if we have a valid session handler - we store the
- ## realm in the session. If not - we have to hope that
+
+ ## 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->can('session') &&
- $c->config->{'Plugin::Authentication'}{'use_session'} &&
+ if ($c->can('session') &&
+ $c->config->{'Plugin::Authentication'}{'use_session'} &&
$c->session_is_valid) {
-
- $c->session->{'__user_realm'} = $c->_user->auth_realm;
+
+ $c->session->{'__user_realm'} = $c->_user->auth_realm;
}
-
+
my $realm = $c->get_auth_realm($c->_user->auth_realm);
-
+
# used to call $realm->save_user_in_session
$realm->persist_user($c, $c->user);
}
}
- ## this was a short lived method to update user information -
+ ## this was a short lived method to update user information -
## you should use persist_user instead.
sub update_user_in_session {
my $c = shift;
if ($realm) {
$realm->remove_persisted_user($c);
}
-
+
$c->maybe::next::method(@_);
}
sub find_user {
my ( $c, $userinfo, $realmname ) = @_;
-
+
$realmname ||= 'default';
my $realm = $c->get_auth_realm($realmname);
-
+
if (!$realm) {
Catalyst::Exception->throw(
"find_user called with nonexistant realm: '$realmname'.");
return $realm->find_user($userinfo, $c);
}
- ## Consider making this a public method. - would make certain things easier when
+ ## 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->can('session')
and $c->config->{'Plugin::Authentication'}{'use_session'}
- and $c->session_is_valid
+ and $c->session_is_valid
and exists($c->session->{'__user_realm'})) {
-
+
$realm = $c->auth_realms->{$c->session->{'__user_realm'}};
if ($realm->user_is_restorable($c)) {
- return $realm;
+ return $realm;
}
} else {
## we have no choice but to ask each realm whether it has a persisted user.
foreach my $realmname (@{$c->_auth_realm_restore_order}) {
- my $ret = $c->auth_realms->{$realmname}->user_is_restorable($c);
- if ($ret) {
- return $c->auth_realms->{$realmname};
- }
+ my $realm = $c->auth_realms->{$realmname}
+ || Catalyst::Exception->throw("Could not find authentication realm '$realmname'");
+ return $realm
+ if $realm->user_is_restorable($c);
}
}
return undef;
my $realm;
if (defined($realmname)) {
- $realm = $c->get_auth_realm($realmname);
+ $realm = $c->get_auth_realm($realmname);
} else {
$realm = $c->find_realm_for_persisted_user;
}
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) if $user;
-
+
return $user;
}
-# we can't actually do our setup in setup because the model has not yet been loaded.
-# So we have to trigger off of setup_finished. :-(
-sub setup {
+# We can't actually do our setup in setup because the model has not yet been loaded.
+# So we have to trigger before 'setup_finalize'.
+before 'setup_finalize' => sub {
my $app = shift;
+ $app->mk_classdata('_auth_initialized');
$app->_authentication_initialize();
- $app->next::method(@_);
-}
+};
## the actual initialization routine. whee.
sub _authentication_initialize {
## let's avoid recreating / configuring everything if we have already done it, eh?
if ($app->can('_auth_realms')) { return };
- ## make classdata where it is used.
+ ## make classdata where it is used.
$app->mk_classdata( '_auth_realms' => {});
-
- ## the order to attempt restore in - If we don't have session - we have
- ## no way to be sure where a frozen user came from - so we have to
- ## ask each realm if it can restore the user. Unfortunately it is possible
- ## that multiple realms could restore the user from the data we have -
- ## So we have to determine at setup time what order to ask the realms in.
+
+ ## the order to attempt restore in - If we don't have session - we have
+ ## no way to be sure where a frozen user came from - so we have to
+ ## ask each realm if it can restore the user. Unfortunately it is possible
+ ## that multiple realms could restore the user from the data we have -
+ ## So we have to determine at setup time what order to ask the realms in.
## The default is to use the user_restore_priority values defined in the realm
- ## config. if they are not defined - we go by alphabetical order. Note that
+ ## config. if they are not defined - we go by alphabetical order. Note that
## the 'default' realm always gets first chance at it unless it is explicitly
## placed elsewhere by user_restore_priority. Remember this only comes
- ## into play if session is disabled.
-
+ ## into play if session is disabled.
+
$app->mk_classdata( '_auth_realm_restore_order' => []);
my $cfg = $app->config->{'Plugin::Authentication'};
- my $realmshash;
+ my $realmshash;
if (!defined($cfg)) {
if (exists($app->config->{'authentication'})) {
$cfg = $app->config->{'authentication'};
$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'};
- }
+ # 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.
if (!exists($cfg->{'use_session'})) {
$cfg->{'use_session'} = 1;
}
-
- ## if we have a realms hash
+
+ ## 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 %{$realmshash}) {
if (ref($realmshash->{$realm}) eq 'HASH' &&
- (exists($realmshash->{$realm}{credential}) || exists($realmshash->{$realm}{class}))) {
-
- $app->setup_auth_realm($realm, $realmshash->{$realm});
-
- if (exists($realmshash->{$realm}{'user_restore_priority'})) {
- $auth_restore_order{$realm} = $realmshash->{$realm}{'user_restore_priority'};
- } else {
- $auth_restore_order{$realm} = $authcount++;
- }
- }
+ (exists($realmshash->{$realm}{credential}) || exists($realmshash->{$realm}{class}))) {
+
+ $app->setup_auth_realm($realm, $realmshash->{$realm});
+
+ 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 we have a 'default_realm' in the config hash and we don't already
# have a realm called 'default', we point default at the realm specified
if (exists($cfg->{'default_realm'}) && !$app->get_auth_realm('default')) {
if ($app->_set_default_auth_realm($cfg->{'default_realm'})) {
delete($auth_restore_order{$cfg->{'default_realm'}});
}
}
-
+
## if the default realm did not have a defined priority in its config - we put it at the front.
if (!exists($realmshash->{$defaultrealm}{'user_restore_priority'})) {
$auth_restore_order{'default'} = 1;
}
-
+
@{$app->_auth_realm_restore_order} = sort { $auth_restore_order{$a} <=> $auth_restore_order{$b} } keys %auth_restore_order;
-
+
} else {
-
+
## BACKWARDS COMPATIBILITY - if realms is not defined - then we are probably dealing
## with an old-school config. The only caveat here is that we must add a classname
-
- ## also - we have to treat {store} as {stores}{default} - because
- ## while it is not a clear as a valid config in the docs, it
+
+ ## also - we have to treat {store} as {stores}{default} - because
+ ## while it is not a clear as a valid config in the docs, it
## is functional with the old api. Whee!
if (exists($cfg->{'store'}) && !exists($cfg->{'stores'}{'default'})) {
$cfg->{'stores'}{'default'} = $cfg->{'store'};
my $realmcfg = {
store => { class => $cfg->{'stores'}{$storename} },
};
- print STDERR "Foo, ok?\n";
$app->setup_auth_realm($storename, $realmcfg);
}
- }
-
+ }
+
}
# set up realmname.
sub setup_auth_realm {
my ($app, $realmname, $config) = @_;
-
+
my $realmclass = $config->{class};
if( !$realmclass ) {
sub auth_realms {
my $self = shift;
+ $self->_authentication_initialize(); # Ensure _auth_realms created!
return($self->_auth_realms);
}
sub get_auth_realm {
my ($app, $realmname) = @_;
-
return $app->auth_realms->{$realmname};
-
}
# Very internal method. Vital Valuable Urgent, Do not touch on pain of death.
# Using this method just assigns the default realm to be the value associated
# with the realmname provided. It WILL overwrite any real realm called 'default'
- # so can be very confusing if used improperly. It's used properly already.
+ # so can be very confusing if used improperly. It's used properly already.
# Translation: don't use it.
sub _set_default_auth_realm {
my ($app, $realmname) = @_;
-
+
if (exists($app->auth_realms->{$realmname})) {
$app->auth_realms->{'default'} = $app->auth_realms->{$realmname};
}
sub authenticate {
my ($app, $userinfo, $realmname) = @_;
-
+
if (!$realmname) {
$realmname = 'default';
}
-
+
my $realm = $app->get_auth_realm($realmname);
-
+
## note to self - make authenticate throw an exception if realm is invalid.
-
+
if ($realm) {
return $realm->authenticate($app, $userinfo);
} else {
## BACKWARDS COMPATIBILITY -- Warning: Here be monsters!
#
# What follows are backwards compatibility routines - for use with Stores and Credentials
- # that have not been updated to work with C::P::Authentication v0.10.
+ # that have not been updated to work with C::P::Authentication v0.10.
# These are here so as to not break people's existing installations, but will go away
# in a future version.
#
# The old style of configuration only supports a single store, as each store module
- # sets itself as the default store upon being loaded. This is the only supported
- # 'compatibility' mode.
+ # sets itself as the default store upon being loaded. This is the only supported
+ # 'compatibility' mode.
#
sub get_user {
}
if ( my $new = shift ) {
$realm->store($new);
-
+
my $storeclass;
if (ref($new)) {
$storeclass = ref($new);
} else {
$storeclass = $new;
}
-
- # BACKWARDS COMPATIBILITY - if the store class does not define find_user, we define it in terms
- # of get_user and add it to the class. this is because the auth routines use find_user,
+
+ # BACKWARDS COMPATIBILITY - if the store class does not define find_user, we define it in terms
+ # of get_user and add it to the class. this is because the auth routines use find_user,
# and rely on it being present. (this avoids per-call checks)
if (!$storeclass->can('find_user')) {
no strict 'refs';
sub get_auth_store {
my ( $self, $name ) = @_;
-
+
if ($name ne 'default') {
- Carp::croak "get_auth_store called on non-default realm '$name'. Only default supported in compatibility mode";
+ Carp::croak "get_auth_store called on non-default realm '$name'. Only default supported in compatibility mode";
} else {
$self->default_auth_store();
}
/;
# later on ...
- $c->authenticate({ username => 'myusername',
+ $c->authenticate({ username => 'myusername',
password => 'mypassword' });
my $age = $c->user->get('age');
$c->logout;
'Realm'. A Catalyst application using the authentication framework must have
at least one realm, and may have several.
- To implement authentication in a Catalyst application you need to add this
- module, and specify at least one realm in the configuration.
+ To implement authentication in a Catalyst application you need to add this
+ module, and specify at least one realm in the configuration.
- Authentication data can also be stored in a session, if the application
+ Authentication data can also be stored in a session, if the application
is using the L<Catalyst::Plugin::Session> module.
B<NOTE> in version 0.10 of this module, the interface to this module changed.
By this time you know exactly who the user is - the user's identity is
B<authenticated>. This is where this module's job stops, and your application
- or other plugins step in.
+ or other plugins step in.
The next logical step is B<authorization>, the process of deciding what a user
is (or isn't) allowed to do. For example, say your users are split into two
currently logged in user is indeed an administrator before performing the
actions in an administrative part of your application. These decisions may be
made within your application code using just the information available after
- authentication, or it may be facilitated by a number of plugins.
+ authentication, or it may be facilitated by a number of plugins.
=head2 The Components In This Framework
Authentication
/;
- __PACKAGE__->config( 'Plugin::Authentication' =>
- {
+ __PACKAGE__->config( 'Plugin::Authentication' =>
+ {
default => {
credential => {
class => 'Password',
},
store => {
class => 'Minimal',
- users => {
- bob => {
- password => "s00p3r",
- editor => 'yes',
- roles => [qw/edit delete/],
- },
- william => {
- password => "s3cr3t",
- roles => [qw/comment/],
- }
- }
- }
- }
+ users => {
+ bob => {
+ password => "s00p3r",
+ editor => 'yes',
+ roles => [qw/edit delete/],
+ },
+ william => {
+ password => "s3cr3t",
+ roles => [qw/comment/],
+ }
+ }
+ }
+ }
}
);
if ( my $user = $c->req->params->{user}
and my $password = $c->req->params->{password} )
{
- if ( $c->authenticate( { username => $user,
+ if ( $c->authenticate( { username => $user,
password => $password } ) ) {
$c->res->body( "hello " . $c->user->get("name") );
} else {
}
This code should be self-explanatory. If all the necessary fields are supplied,
- call the C<authenticate> method on the context object. If it succeeds the
+ call the C<authenticate> method on the context object. If it succeeds the
user is logged in.
The credential verifier will attempt to retrieve the user whose
authenticate on the admin realm by simply changing the C<< $c->authenticate() >>
call:
- if ( $c->authenticate( { username => $user,
+ if ( $c->authenticate( { username => $user,
password => $password }, 'admin' ) ) {
$c->res->body( "hello " . $c->user->get("name") );
} ...
- Now suppose we want to restrict the ability to edit to a user with an
+ Now suppose we want to restrict the ability to edit to a user with an
'editor' value of yes.
The restricted action might look like this:
verification as user_exists, with the added requirement that if there
is a user, it must have come from the realm specified.)
- The above example is somewhat similar to role based access control.
+ The above example is somewhat similar to role based access control.
L<Catalyst::Authentication::Store::Minimal> treats the roles field as
an array of role names. Let's leverage this. Add the role authorization
plugin:
You can accomplish this simply by installing the L<DBIx::Class|Catalyst::Authentication::Store::DBIx::Class> Store and
changing your config:
- __PACKAGE__->config( 'Plugin::Authentication'} =>
- {
+ __PACKAGE__->config( 'Plugin::Authentication' =>
+ {
default_realm => 'members',
members => {
credential => {
},
store => {
class => 'DBIx::Class',
- user_class => 'MyApp::Users',
- role_column => 'roles'
- }
- }
+ user_model => 'MyApp::Users',
+ role_column => 'roles',
+ }
+ }
}
);
=head1 CONFIGURATION
# example
- __PACKAGE__->config( 'Plugin::Authentication' =>
- {
+ __PACKAGE__->config( 'Plugin::Authentication' =>
+ {
default_realm => 'members',
members => {
},
store => {
class => 'DBIx::Class',
- user_class => 'MyApp::Users',
- role_column => 'roles'
- }
- },
- admins => {
- credential => {
- class => 'Password',
- password_field => 'password',
+ user_model => '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'
- }
- }
+ },
+ store => {
+ class => '+MyApp::Authentication::Store::NetAuth',
+ authserver => '192.168.10.17'
+ }
+ }
}
);
NOTE: Until version 0.10008 of this module, you would need to put all the
- realms inside a "realms" key in the configuration. Please see
+ realms inside a "realms" key in the configuration. Please see
L</COMPATIBILITY CONFIGURATION> for more information
=over 4
=item realm refs
- 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
+ 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.
+ 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
realm config.
- Each realm config contains two hashes, one called 'credential' and one called
+ Each realm config contains two hashes, one called 'credential' and one called
'store', each of which provide configuration details to the respective modules.
- The contents of these hashes is specific to the module being used, with the
+ The contents of these hashes is specific to the module being used, with the
exception of the 'class' element, which tells the core Authentication module the
- classname to instantiate.
+ classname to instantiate.
The 'class' element follows the standard Catalyst mechanism of class
specification. If a class is prefixed with a +, it is assumed to be a complete
=head2 $c->user_in_realm( $realm )
- Works like user_exists, except that it only returns true if a user is both
- logged in right now and was retrieved from the realm provided.
+ Works like user_exists, except that it only returns true if a user is both
+ logged in right now and was retrieved from the realm provided.
=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. It does not delete the session.
=head2 $c->find_user( $userinfo, $realm )
- Fetch a particular users details, matching the provided user info, from the realm
+ Fetch a particular users details, matching the provided user info, from the realm
specified in $realm.
=head2 persist_user()
Under normal circumstances the user data is only saved to the session during
- initial authentication. This call causes the auth system to save the
+ initial authentication. This call causes the auth system to save the
currently authenticated user's data across requests. Useful if you have
changed the user data and want to ensure that future requests reflect the
- most current data. Assumes that at the time of this call, $c->user
+ most current data. Assumes that at the time of this call, $c->user
contains the most current data.
=head2 find_realm_for_persisted_user()
=head1 SEE ALSO
This list might not be up to date. Below are modules known to work with the updated
- API of 0.10 and are therefore compatible with realms.
+ API of 0.10 and are therefore compatible with realms.
=head2 Realms
=head1 INCOMPATABILITIES
- The realms-based configuration and functionality of the 0.10 update
+ The realms-based configuration and functionality of the 0.10 update
of L<Catalyst::Plugin::Authentication> required a change in the API used by
credentials and stores. It has a compatibility mode which allows use of
modules that have not yet been updated. This, however, completely mimics the
- older api and disables the new realm-based features. In other words you cannot
+ older api and disables the new realm-based features. In other words you cannot
mix the older credential and store modules with realms, or realm-based
configs. The changes required to update modules are relatively minor and are
covered in L<Catalyst::Plugin::Authentication::Internals>. We hope that most
=head1 COMPATIBILITY CONFIGURATION
Until version 0.10008 of this module, you needed to put all the
- realms inside a "realms" key in the configuration.
+ realms inside a "realms" key in the configuration.
# example
- __PACKAGE__->config( 'Plugin::Authentication'} =>
- {
+ __PACKAGE__->config( 'Plugin::Authentication' =>
+ {
default_realm => 'members',
realms => {
members => {
In version 0.10 of L<Catalyst::Plugin::Authentication>, the API
changed. For app developers, this change is fairly minor, but for
- Credential and Store authors, the changes are significant.
+ Credential and Store authors, the changes are significant.
Please see the documentation in version 0.09 of
Catalyst::Plugin::Authentication for a better understanding of how the old API
The items below are still present in the plugin, though using them is
deprecated. They remain only as a transition tool, for those sites which can
not yet be upgraded to use the new system due to local customizations or use
- of Credential / Store modules that have not yet been updated to work with the
+ of Credential / Store modules that have not yet been updated to work with the
new API.
These routines should not be used in any application using realms
or by using a Store plugin:
# load the Minimal authentication store.
- use Catalyst qw/Authentication Authentication::Store::Minimal/;
+ use Catalyst qw/Authentication Authentication::Store::Minimal/;
Sets the default store to
L<Catalyst::Plugin::Authentication::Store::Minimal>.
David Kamholz
- Tomas Doran (t0m), C<bobtfish@bobtfish.net>
+ Tomas Doran (t0m), C<bobtfish@bobtfish.net>
+
+ kmx
+
+ Nigel Metheringham
+
+ Florian Ragwitz C<rafl@debian.org>
+
+ Stephan Jauernick C<stephanj@cpan.org>
=head1 COPYRIGHT & LICENSE
- Copyright (c) 2005 the aforementioned authors. All rights
- reserved. This program is free software; you can redistribute
- it and/or modify it under the same terms as Perl itself.
+ Copyright (c) 2005 - 2009
+ the Catalyst::Plugin::Authentication L</AUTHORS>
+ as listed above.
+
+ This program is free software; you can redistribute
+ it and/or modify it under the same terms as Perl itself.
=cut
projects / catagits/Catalyst-Plugin-Authentication.git / commitdiff