use Tie::RefHash;
use Class::Inspector;
+use Catalyst::Authentication::Realm;
# this optimization breaks under Template::Toolkit
# use user_exists instead
# constant->import(have_want => eval { require Want });
#}
-our $VERSION = "0.10002";
+our $VERSION = "0.10005";
sub set_authenticated {
my ( $c, $user, $realmname ) = @_;
if (!$realmname) {
$realmname = 'default';
}
+ my $realm = $c->get_auth_realm($realmname);
+
+ if (!$realm) {
+ Catalyst::Exception->throw(
+ "set_authenticated called with nonexistant realm: '$realmname'.");
+ }
if ( $c->isa("Catalyst::Plugin::Session")
- and $c->config->{authentication}{use_session}
+ and $c->config->{'Plugin::Authentication'}{'use_session'}
and $user->supports("session") )
{
- $c->save_user_in_session($user, $realmname);
+ $realm->save_user_in_session($c, $user);
}
- $user->auth_realm($realmname);
+ $user->auth_realm($realm->name);
$c->NEXT::set_authenticated($user, $realmname);
}
}
}
-sub save_user_in_session {
+sub __old_save_user_in_session {
my ( $c, $user, $realmname ) = @_;
$c->session->{__user_realm} = $realmname;
if (
$c->isa("Catalyst::Plugin::Session")
- and $c->config->{authentication}{use_session}
+ and $c->config->{'Plugin::Authentication'}{'use_session'}
and $c->session_is_valid
) {
delete @{ $c->session }{qw/__user __user_realm/};
$realmname ||= 'default';
my $realm = $c->get_auth_realm($realmname);
- if ( $realm->{'store'} ) {
- return $realm->{'store'}->find_user($userinfo, $c);
- } else {
- $c->log->debug('find_user: unable to locate a store matching the requested realm');
+
+ if (!$realm) {
+ Catalyst::Exception->throw(
+ "find_user called with nonexistant realm: '$realmname'.");
}
+ return $realm->find_user($userinfo, $c);
}
return unless
$c->isa("Catalyst::Plugin::Session")
- and $c->config->{authentication}{use_session}
+ and $c->config->{'Plugin::Authentication'}{'use_session'}
and $c->session_is_valid;
return $c->session->{__user};
return unless $realmname; # FIXME die unless? This is an internal inconsistency
my $realm = $c->get_auth_realm($realmname);
- $c->_user( my $user = $realm->{'store'}->from_session( $c, $frozen_user ) );
+ $c->_user( my $user = $realm->from_session( $c, $frozen_user ) );
# this sets the realm the user originated in.
$user->auth_realm($realmname);
## make classdata where it is used.
$app->mk_classdata( '_auth_realms' => {});
- my $cfg = $app->config->{'authentication'} ||= {};
+ my $cfg = $app->config->{'Plugin::Authentication'};
+ if (!defined($cfg)) {
+ if (exists($app->config->{'authentication'})) {
+ $cfg = $app->config->{'authentication'};
+ $app->config->{'Plugin::Authentication'} = $app->config->{'authentication'};
+ } else {
+ $cfg = {};
+ }
+ }
- $cfg->{use_session} = 1;
+ # 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 it's setting.
+ if (!exists($cfg->{'use_session'})) {
+ $cfg->{'use_session'} = 1;
+ }
if (exists($cfg->{'realms'})) {
foreach my $realm (keys %{$cfg->{'realms'}}) {
$app->setup_auth_realm($realm, $cfg->{'realms'}{$realm});
}
- # 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')) {
$app->_set_default_auth_realm($cfg->{'default_realm'});
sub setup_auth_realm {
my ($app, $realmname, $config) = @_;
- $app->log->debug("Setting up auth realm $realmname") if $app->debug;
- if (!exists($config->{'store'}{'class'})) {
- Carp::croak "Couldn't setup the authentication realm named '$realmname', no class defined";
- }
-
- # use the
- my $storeclass = $config->{'store'}{'class'};
-
- ## follow catalyst class naming - a + prefix means a fully qualified class, otherwise it's
- ## taken to mean C::P::A::Store::(specifiedclass)
- if ($storeclass !~ /^\+(.*)$/ ) {
- $storeclass = "Catalyst::Plugin::Authentication::Store::${storeclass}";
+ my $realmclass = $config->{class};
+
+ if( !$realmclass ) {
+ $realmclass = 'Catalyst::Authentication::Realm';
+ } elsif ($realmclass !~ /^\+(.*)$/ ) {
+ $realmclass = "Catalyst::Authentication::Realm::${realmclass}";
} else {
- $storeclass = $1;
+ $realmclass = $1;
}
-
- # a little niceness - since most systems seem to use the password credential class,
- # if no credential class is specified we use password.
- $config->{credential}{class} ||= '+Catalyst::Plugin::Authentication::Credential::Password';
+ Catalyst::Utils::ensure_class_loaded( $realmclass );
- my $credentialclass = $config->{'credential'}{'class'};
-
- ## follow catalyst class naming - a + prefix means a fully qualified class, otherwise it's
- ## taken to mean C::P::A::Credential::(specifiedclass)
- if ($credentialclass !~ /^\+(.*)$/ ) {
- $credentialclass = "Catalyst::Plugin::Authentication::Credential::${credentialclass}";
- } else {
- $credentialclass = $1;
- }
-
- # if we made it here - we have what we need to load the classes;
- Catalyst::Utils::ensure_class_loaded( $credentialclass );
- Catalyst::Utils::ensure_class_loaded( $storeclass );
-
- # 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';
- *{"${storeclass}::find_user"} = sub {
- my ($self, $info) = @_;
- my @rest = @{$info->{rest}} if exists($info->{rest});
- $self->get_user($info->{id}, @rest);
- };
- }
-
- ## a little cruft to stay compatible with some poorly written stores / credentials
- ## we'll remove this soon.
- if ($storeclass->can('new')) {
- $app->auth_realms->{$realmname}{'store'} = $storeclass->new($config->{'store'}, $app);
- } else {
- $app->log->error("THIS IS DEPRECATED: $storeclass has no new() method - Attempting to use uninstantiated");
- $app->auth_realms->{$realmname}{'store'} = $storeclass;
- }
- if ($credentialclass->can('new')) {
- $app->auth_realms->{$realmname}{'credential'} = $credentialclass->new($config->{'credential'}, $app);
+ my $realm = $realmclass->new($realmname, $config, $app);
+ if ($realm) {
+ $app->auth_realms->{$realmname} = $realm;
} else {
- $app->log->error("THIS IS DEPRECATED: $credentialclass has no new() method - Attempting to use uninstantiated");
- $app->auth_realms->{$realmname}{'credential'} = $credentialclass;
+ $app->log->debug("realm initialization for '$realmname' failed.");
}
+ return $realm;
}
sub auth_realms {
## note to self - make authenticate throw an exception if realm is invalid.
- if ($realm && exists($realm->{'credential'})) {
- my $user = $realm->{'credential'}->authenticate($app, $realm->{store}, $userinfo);
- if (ref($user)) {
- $app->set_authenticated($user, $realmname);
- return $user;
- }
+ if ($realm) {
+ return $realm->authenticate($app, $userinfo);
} else {
- $app->log->debug("The realm requested, '$realmname' does not exist," .
- " or there is no credential associated with it.")
+ Catalyst::Exception->throw(
+ "authenticate called with nonexistant realm: '$realmname'.");
+
}
return undef;
}
sub default_auth_store {
my $self = shift;
+ my $realm = $self->get_auth_realm('default');
+ if (!$realm) {
+ $realm = $self->setup_auth_realm('default', { class => 'Compatibility' });
+ }
if ( my $new = shift ) {
- $self->auth_realms->{'default'}{'store'} = $new;
+ $realm->store($new);
my $storeclass;
if (ref($new)) {
}
}
- return $self->get_auth_realm('default')->{'store'};
+ return $self->get_auth_realm('default')->store;
}
## BACKWARDS COMPATIBILITY
sub auth_store_names {
my $self = shift;
- my %hash = ( $self->get_auth_realm('default')->{'store'} => 'default' );
+ my %hash = ( $self->get_auth_realm('default')->store => 'default' );
}
sub get_auth_store {
sub auth_stores {
my $self = shift;
- my %hash = ( 'default' => $self->get_auth_realm('default')->{'store'});
+ my %hash = ( 'default' => $self->get_auth_realm('default')->store);
}
__PACKAGE__;
Configuration of the Catalyst::Plugin::Authentication framework is done in
terms of realms. In simplest terms, a realm is a pairing of a Credential
-verifier and a User storage (Store) backend.
+verifier and a User storage (Store) backend. As of version 0.10003, realms are
+now objects that you can create and customize.
An application can have any number of Realms, each of which operates
independant of the others. Each realm has a name, which is used to identify it
=head3 Credential Verifiers
-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->authenticate() method. From there, it is passed to the
-appropriate Credential verifier.
+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()>>
+method. From there, it is passed to the appropriate Credential
+verifier.
These plugins check the data, and ensure that it really proves the user is who
they claim to be.
+Credential verifiers compatible with versions of this module 0.10x and
+upwards should be in the namespace
+C<Catalyst::Authentication::Credential>.
+
=head3 Storage Backends
The authentication data also identifies a user, and the Storage backend modules
Credential verifiers accept a set of authentication data and use this
information to retrieve the user from the store they are paired with.
+storage backends compatible with versions of this module 0.10x and
+upwards should be in the namespace
+C<Catalyst::Authentication::Store>.
+
=head3 The Core Plugin
This plugin on its own is the glue, providing realm configuration, session
More layers of plugins can be stacked on top of the authentication code. For
example, L<Catalyst::Plugin::Session::PerUser> provides an abstraction of
-browser sessions that is more persistent per users.
+browser sessions that is more persistent per user.
L<Catalyst::Plugin::Authorization::Roles> provides an accepted way to separate
and group users into categories, and then check which categories the current
user belongs to.
Authentication
/;
- __PACKAGE__->config->{authentication} =
+ __PACKAGE__->config->{'Plugin::Authentication'} =
{
default_realm => 'members',
realms => {
sub login : Local {
my ( $self, $c ) = @_;
- if ( my $user = $c->req->param("user")
+ if ( my $user = $c->req->param("user")
and my $password = $c->req->param("password") )
{
if ( $c->authenticate( { username => $user,
}
}
-This code should be very readable. If all the necessary fields are supplied,
-call the "authenticate" method from the controller. If it succeeds the
+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
user is logged in.
-The credential verifier will attempt to retrieve the user whose details match
-the authentication information provided to $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.
+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
+checked and if it matches the user will be B<authenticated> and
+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->authenticate()
+authenticate on the admin realm by simply changing the C<<$c->authenticate()>>
call:
if ( $c->authenticate( { username => $user,
- password => $password }, 'admin' )l ) {
+ password => $password }, 'admin' ) ) {
$c->res->body( "hello " . $c->user->get("name") );
} ...
# do something restricted here
}
-(Note that if you have multiple realms, you can use $c->user_in_realm('realmname')
-in place of $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.)
+(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
+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.
-L<Catalyst::Plugin::Authentication::Store::Minimal> treats the roles field as
+L<Catalyst::Authentication::Store::Minimal> treats the roles field as
an array of role names. Let's leverage this. Add the role authorization
plugin:
Let's say your app grew, and you now have 10000 users. It's no longer
efficient to maintain a hash of users, so you move this data to a database.
-You can accomplish this simply by installing the DBIx::Class Store and
+You can accomplish this simply by installing the L<DBIx::Class|Catalyst::Authentication::Store::DBIx::Class> Store and
changing your config:
- __PACKAGE__->config->{authentication} =
+ __PACKAGE__->config->{'Plugin::Authentication'} =
{
default_realm => 'members',
realms => {
=head1 CONFIGURATION
-=over 4
-
# example
- __PACKAGE__->config->{authentication} =
+ __PACKAGE__->config->{'Plugin::Authentication'} =
{
default_realm => 'members',
realms => {
}
};
+=over 4
+
=item use_session
Whether or not to store the user's logged in state in the session, if the
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 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
'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
specification. If a class is prefixed with a +, it is assumed to be a complete
class name. Otherwise it is considered to be a portion of the class name. For
credentials, the classname 'B<Password>', for example, is expanded to
-Catalyst::Plugin::Authentication::Credential::B<Password>. For stores, the
+Catalyst::Authentication::Credential::B<Password>. For stores, the
classname 'B<storename>' is expanded to:
-Catalyst::Plugin::Authentication::Store::B<storename>.
-
+Catalyst::Authentication::Store::B<storename>.
=back
-
=head1 METHODS
-=over 4
-
-=item authenticate( $userinfo, $realm )
+=head2 $c->authenticate( $userinfo, [ $realm ])
Attempts to authenticate the user using the information in the $userinfo hash
reference using the realm $realm. $realm may be omitted, in which case the
default realm is checked.
-=item user
+=head2 $c->user( )
Returns the currently logged in user or undef if there is none.
-=item user_exists
+=head2 $c->user_exists( )
Returns true if a user is logged in right now. The difference between
user_exists and user is that user_exists will return true if a user is logged
need to know if the user is logged in, depending on the storage mechanism this
can be much more efficient.
-=item user_in_realm ( $realm )
+=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.
-=item logout
+=head2 $c->logout( )
-Logs the user out, Deletes the currently logged in user from $c->user and the session.
+Logs the user out, Deletes the currently logged in user from C<<$c->user>> and the session.
-=item find_user( $userinfo, $realm )
+=head2 $c->find_user( $userinfo, $realm )
Fetch a particular users details, matching the provided user info, from the realm
specified in $realm.
-=back
-
=head1 INTERNAL METHODS
These methods are for Catalyst::Plugin::Authentication B<INTERNAL USE> only.
to fix / rewrite your code when things change. They are documented here only
for reference.
-=over 4
-
-=item set_authenticated ( $user, $realmname )
+=head2 $c->set_authenticated( $user, $realmname )
Marks a user as authenticated. This is called from within the authenticate
routine when a credential returns a user. $realmname defaults to 'default'
-=item auth_restore_user ( $user, $realmname )
+=head2 $c->auth_restore_user( $user, $realmname )
Used to restore a user from the session. In most cases this is called without
arguments to restore the user via the session. Can be called with arguments
when restoring a user from some other method. Currently not used in this way.
-=item save_user_in_session ( $user, $realmname )
+=head2 $c->save_user_in_session( $user, $realmname )
Used to save the user in a session. Saves $user in session, marked as
originating in $realmname. Both arguments are required.
-=item auth_realms
+=head2 $c->auth_realms( )
Returns a hashref containing realmname -> realm instance pairs. Realm
instances contain an instantiated store and credential object as the 'store'
and 'credential' elements, respectively
-=item get_auth_realm ( $realmname )
+=head2 $c->get_auth_realm( $realmname )
Retrieves the realm instance for the realmname provided.
-=item
-
-=back
-
=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.
+=head2 Realms
+
+L<Catalyst::Authentication::Realm>
+
=head2 User Storage Backends
-L<Catalyst::Plugin::Authentication::Store::Minimal>,
-L<Catalyst::Plugin::Authentication::Store::DBIx::Class>,
+L<Catalyst::Authentication::Store::Minimal>,
+L<Catalyst::Authentication::Store::DBIx::Class>,
=head2 Credential verification
-L<Catalyst::Plugin::Authentication::Credential::Password>,
+L<Catalyst::Authentication::Credential::Password>,
=head2 Authorization
functionality or any of the methods described above. These are for reference
purposes only.
-=over 4
-
-=item login
+=head2 $c->login( )
This method is used to initiate authentication and user retrieval. Technically
this is part of the old Password credential module and it still resides in the
L<Password|Catalyst::Plugin::Authentication::Credential::Password> class. It is
included here for reference only.
-=item default_auth_store
+=head2 $c->default_auth_store( )
Return the store whose name is 'default'.
-This is set to C<< $c->config->{authentication}{store} >> if that value exists,
+This is set to C<< $c->config->{'Plugin::Authentication'}{store} >> if that value exists,
or by using a Store plugin:
# load the Minimal authentication store.
Sets the default store to
L<Catalyst::Plugin::Authentication::Store::Minimal>.
-=item get_auth_store $name
+=head2 $c->get_auth_store( $name )
Return the store whose name is $name.
-=item get_auth_store_name $store
+=head2 $c->get_auth_store_name( $store )
Return the name of the store $store.
-=item auth_stores
+=head2 $c->auth_stores( )
A hash keyed by name, with the stores registered in the app.
-=item register_auth_stores %stores_by_name
+=head2 $c->register_auth_stores( %stores_by_name )
Register stores into the application.
-=back
+=head2 $c->auth_store_names( )
+
+=head2 $c->get_user( )
+=head2 $c->setup( )
+=head2 $c->setup_auth_realm( )
=head1 AUTHORS
David Kamholz
-
=head1 COPYRIGHT & LICENSE
Copyright (c) 2005 the aforementioned authors. All rights
projects / catagits/Catalyst-Plugin-Authentication.git / blobdiff