3 package Catalyst::Plugin::Authentication;
5 use base qw/Class::Accessor::Fast Class::Data::Inheritable/;
8 __PACKAGE__->mk_accessors(qw/_user/);
9 __PACKAGE__->mk_classdata($_) for qw/_auth_realms/;
18 # this optimization breaks under Template::Toolkit
19 # use user_exists instead
22 # constant->import(have_want => eval { require Want });
25 our $VERSION = "0.10";
27 sub set_authenticated {
28 my ( $c, $user, $realmname ) = @_;
31 $c->request->{user} = $user; # compatibility kludge
34 $realmname = 'default';
37 if ( $c->isa("Catalyst::Plugin::Session")
38 and $c->config->{authentication}{use_session}
39 and $user->supports("session") )
41 $c->save_user_in_session($user, $realmname);
43 $user->auth_realm($realmname);
45 $c->NEXT::set_authenticated($user, $realmname);
48 sub _should_save_user_in_session {
49 my ( $c, $user ) = @_;
51 $c->_auth_sessions_supported
52 and $c->config->{authentication}{use_session}
53 and $user->supports("session");
56 sub _should_load_user_from_session {
57 my ( $c, $user ) = @_;
59 $c->_auth_sessions_supported
60 and $c->config->{authentication}{use_session}
61 and $c->session_is_valid;
64 sub _auth_sessions_supported {
66 $c->isa("Catalyst::Plugin::Session");
76 if ( defined($c->_user) ) {
79 return $c->auth_restore_user;
83 # change this to allow specification of a realm - to verify the user is part of that realm
84 # in addition to verifying that they exist.
87 return defined($c->_user) || defined($c->_user_in_session);
90 # works like user_exists - except only returns true if user
91 # exists AND is in the realm requested.
93 my ($c, $realmname) = @_;
95 if (defined($c->_user)) {
96 return ($c->_user->auth_realm eq $realmname);
97 } elsif (defined($c->_user_in_session)) {
98 return ($c->session->{__user_realm} eq $realmname);
104 sub save_user_in_session {
105 my ( $c, $user, $realmname ) = @_;
107 $c->session->{__user_realm} = $realmname;
109 # we want to ask the store for a user prepared for the session.
110 # but older modules split this functionality between the user and the
111 # store. We try the store first. If not, we use the old method.
112 my $realm = $c->get_auth_realm($realmname);
113 if ($realm->{'store'}->can('for_session')) {
114 $c->session->{__user} = $realm->{'store'}->for_session($c, $user);
116 $c->session->{__user} = $user->for_session;
126 $c->isa("Catalyst::Plugin::Session")
127 and $c->config->{authentication}{use_session}
128 and $c->session_is_valid
130 delete @{ $c->session }{qw/__user __user_realm/};
133 $c->NEXT::logout(@_);
137 my ( $c, $userinfo, $realmname ) = @_;
139 $realmname ||= 'default';
140 my $realm = $c->get_auth_realm($realmname);
141 if ( $realm->{'store'} ) {
142 return $realm->{'store'}->find_user($userinfo, $c);
144 $c->log->debug('find_user: unable to locate a store matching the requested realm');
149 sub _user_in_session {
152 return unless $c->_should_load_user_from_session;
154 return $c->session->{__user};
157 sub auth_restore_user {
158 my ( $c, $frozen_user, $realmname ) = @_;
160 $frozen_user ||= $c->_user_in_session;
161 return unless defined($frozen_user);
163 $realmname ||= $c->session->{__user_realm};
164 return unless $realmname; # FIXME die unless? This is an internal inconsistency
166 my $realm = $c->get_auth_realm($realmname);
167 $c->_user( my $user = $realm->{'store'}->from_session( $c, $frozen_user ) );
169 # this sets the realm the user originated in.
170 $user->auth_realm($realmname);
175 # we can't actually do our setup in setup because the model has not yet been loaded.
176 # So we have to trigger off of setup_finished. :-(
180 $c->_authentication_initialize();
184 ## the actual initialization routine. whee.
185 sub _authentication_initialize {
188 if ($c->_auth_realms) { return };
190 if (!exists($c->config->{'authentication'}) {
191 $c->config->{'authentication'} = {};
194 my $cfg = $c->config->{'authentication'};
202 $c->_auth_realms($realmhash);
204 ## BACKWARDS COMPATIBILITY - if realm is not defined - then we are probably dealing
205 ## with an old-school config. The only caveat here is that we must add a classname
206 if (exists($cfg->{'realms'})) {
208 foreach my $realm (keys %{$cfg->{'realms'}}) {
209 $c->setup_auth_realm($realm, $cfg->{'realms'}{$realm});
212 # if we have a 'default-realm' in the config hash and we don't already
213 # have a realm called 'default', we point default at the realm specified
214 if (exists($cfg->{'default_realm'}) && !$c->get_auth_realm('default')) {
215 $c->_set_default_auth_realm($cfg->{'default_realm'});
218 foreach my $storename (keys %{$cfg->{'stores'}}) {
220 store => $cfg->{'stores'}{$storename},
222 $c->setup_auth_realm($storename, $realmcfg);
229 sub setup_auth_realm {
230 my ($app, $realmname, $config) = @_;
232 $app->log->debug("Setting up $realmname");
233 if (!exists($config->{'store'}{'class'})) {
234 Carp::croak "Couldn't setup the authentication realm named '$realmname', no class defined";
238 my $storeclass = $config->{'store'}{'class'};
240 ## follow catalyst class naming - a + prefix means a fully qualified class, otherwise it's
241 ## taken to mean C::P::A::Store::(specifiedclass)
242 if ($storeclass !~ /^\+(.*)$/ ) {
243 $storeclass = "Catalyst::Plugin::Authentication::Store::${storeclass}";
249 # a little niceness - since most systems seem to use the password credential class,
250 # if no credential class is specified we use password.
251 $config->{credential}{class} ||= "Catalyst::Plugin::Authentication::Credential::Password";
253 my $credentialclass = $config->{'credential'}{'class'};
255 ## follow catalyst class naming - a + prefix means a fully qualified class, otherwise it's
256 ## taken to mean C::P::A::Credential::(specifiedclass)
257 if ($credentialclass !~ /^\+(.*)$/ ) {
258 $credentialclass = "Catalyst::Plugin::Authentication::Credential::${credentialclass}";
260 $credentialclass = $1;
263 # if we made it here - we have what we need to load the classes;
264 Catalyst::Utils::ensure_class_loaded( $credentialclass );
265 Catalyst::Utils::ensure_class_loaded( $storeclass );
267 # BACKWARDS COMPATIBILITY - if the store class does not define find_user, we define it in terms
268 # of get_user and add it to the class. this is because the auth routines use find_user,
269 # and rely on it being present. (this avoids per-call checks)
270 if (!$storeclass->can('find_user')) {
272 *{"${storeclass}::find_user"} = sub {
273 my ($self, $info) = @_;
274 my @rest = @{$info->{rest}} if exists($info->{rest});
275 $self->get_user($info->{id}, @rest);
279 $app->auth_realms->{$realmname}{'store'} = $storeclass->new($config->{'store'}, $app);
280 $app->auth_realms->{$realmname}{'credential'} = $credentialclass->new($config->{'credential'}, $app);
286 return($self->_auth_realms);
290 my ($app, $realmname) = @_;
291 return $app->auth_realms->{$realmname};
295 # Very internal method. Vital Valuable Urgent, Do not touch on pain of death.
296 # Using this method just assigns the default realm to be the value associated
297 # with the realmname provided. It WILL overwrite any real realm called 'default'
298 # so can be very confusing if used improperly. It's used properly already.
299 # Translation: don't use it.
300 sub _set_default_auth_realm {
301 my ($app, $realmname) = @_;
303 if (exists($app->auth_realms->{$realmname})) {
304 $app->auth_realms->{'default'} = $app->auth_realms->{$realmname};
306 return $app->get_auth_realm('default');
310 my ($app, $userinfo, $realmname) = @_;
313 $realmname = 'default';
316 my $realm = $app->get_auth_realm($realmname);
318 ## note to self - make authenticate throw an exception if realm is invalid.
320 if ($realm && exists($realm->{'credential'})) {
321 my $user = $realm->{'credential'}->authenticate($app, $realm->{store}, $userinfo);
323 $app->set_authenticated($user, $realmname);
327 $app->log->debug("The realm requested, '$realmname' does not exist," .
328 " or there is no credential associated with it.")
333 ## BACKWARDS COMPATIBILITY -- Warning: Here be monsters!
335 # What follows are backwards compatibility routines - for use with Stores and Credentials
336 # that have not been updated to work with C::P::Authentication v0.10.
337 # These are here so as to not break people's existing installations, but will go away
338 # in a future version.
340 # The old style of configuration only supports a single store, as each store module
341 # sets itself as the default store upon being loaded. This is the only supported
342 # 'compatibility' mode.
346 my ( $c, $uid, @rest ) = @_;
348 return $c->find_user( {'id' => $uid, 'rest'=>\@rest }, 'default' );
352 ## this should only be called when using old-style authentication plugins. IF this gets
353 ## called in a new-style config - it will OVERWRITE the store of your default realm. Don't do it.
354 ## also - this is a partial setup - because no credential is instantiated... in other words it ONLY
355 ## works with old-style auth plugins and C::P::Authentication in compatibility mode. Trying to combine
356 ## this with a realm-type config will probably crash your app.
357 sub default_auth_store {
360 if ( my $new = shift ) {
361 $self->auth_realms->{'default'}{'store'} = $new;
362 my $storeclass = ref($new);
364 # BACKWARDS COMPATIBILITY - if the store class does not define find_user, we define it in terms
365 # of get_user and add it to the class. this is because the auth routines use find_user,
366 # and rely on it being present. (this avoids per-call checks)
367 if (!$storeclass->can('find_user')) {
369 *{"${storeclass}::find_user"} = sub {
370 my ($self, $info) = @_;
371 my @rest = @{$info->{rest}} if exists($info->{rest});
372 $self->get_user($info->{id}, @rest);
377 return $self->get_auth_realm('default')->{'store'};
380 ## BACKWARDS COMPATIBILITY
381 ## this only ever returns a hash containing 'default' - as that is the only
382 ## supported mode of calling this.
383 sub auth_store_names {
386 my %hash = ( $self->get_auth_realm('default')->{'store'} => 'default' );
390 my ( $self, $name ) = @_;
392 if ($name ne 'default') {
393 Carp::croak "get_auth_store called on non-default realm '$name'. Only default supported in compatibility mode";
395 $self->default_auth_store();
399 sub get_auth_store_name {
400 my ( $self, $store ) = @_;
404 # sub auth_stores is only used internally - here for completeness
408 my %hash = ( 'default' => $self->get_auth_realm('default')->{'store'});
419 Catalyst::Plugin::Authentication - Infrastructure plugin for the Catalyst
420 authentication framework.
429 $c->authenticate({ username => 'myusername', password => 'mypassword' });
430 my $age = $c->user->get('age');
435 The authentication plugin provides generic user support for Catalyst apps. It
436 is the basis for both authentication (checking the user is who they claim to
437 be), and authorization (allowing the user to do what the system authorises
440 Using authentication is split into two parts. A Store is used to actually
441 store the user information, and can store any amount of data related to the
442 user. Credentials are used to verify users, using information from the store,
443 given data from the frontend. A Credential and a Store are paired to form a
444 'Realm'. A Catalyst application using the authentication framework must have
445 at least one realm, and may have several.
447 To implement authentication in a Catalyst application you need to add this
448 module, and specify at least one realm in the configuration.
450 Authentication data can also be stored in a session, if the application
451 is using the L<Catalyst::Plugin::Session> module.
453 B<NOTE> in version 0.10 of this module, the interface to this module changed.
454 Please see L</COMPATIBILITY ROUTINES> for more information.
458 =head2 The Authentication/Authorization Process
460 Web applications typically need to identify a user - to tell the user apart
461 from other users. This is usually done in order to display private information
462 that is only that user's business, or to limit access to the application so
463 that only certain entities can access certain parts.
465 This process is split up into several steps. First you ask the user to identify
466 themselves. At this point you can't be sure that the user is really who they
469 Then the user tells you who they are, and backs this claim with some piece of
470 information that only the real user could give you. For example, a password is
471 a secret that is known to both the user and you. When the user tells you this
472 password you can assume they're in on the secret and can be trusted (ignore
473 identity theft for now). Checking the password, or any other proof is called
474 B<credential verification>.
476 By this time you know exactly who the user is - the user's identity is
477 B<authenticated>. This is where this module's job stops, and your application
478 or other plugins step in.
480 The next logical step is B<authorization>, the process of deciding what a user
481 is (or isn't) allowed to do. For example, say your users are split into two
482 main groups - regular users and administrators. You want to verify that the
483 currently logged in user is indeed an administrator before performing the
484 actions in an administrative part of your application. These decisionsmay be
485 made within your application code using just the information available after
486 authentication, or it may be facilitated by a number of plugins.
488 =head2 The Components In This Framework
492 Configuration of the Catalyst::Plugin::Authentication framework is done in
493 terms of realms. In simplest terms, a realm is a pairing of a Credential
494 verifier and a User storage (Store) backend.
496 An application can have any number of Realms, each of which operates
497 independant of the others. Each realm has a name, which is used to identify it
498 as the target of an authentication request. This name can be anything, such as
499 'users' or 'members'. One realm must be defined as the default_realm, which is
500 used when no realm name is specified. More information about configuring
501 realms is available in the configuration section.
503 =head3 Credential Verifiers
505 When user input is transferred to the L<Catalyst> application (typically via
506 form inputs) the application may pass this information into the authentication
507 system through the $c->authenticate() method. From there, it is passed to the
508 appropriate Credential verifier.
510 These plugins check the data, and ensure that it really proves the user is who
513 =head3 Storage Backends
515 The authentication data also identifies a user, and the Storage backend modules
516 use this data to locate and return a standardized object-oriented
517 representation of a user.
519 When a user is retrieved from a store it is not necessarily authenticated.
520 Credential verifiers accept a set of authentication data and use this
521 information to retrieve the user from the store they are paired with.
523 =head3 The Core Plugin
525 This plugin on its own is the glue, providing realm configuration, session
526 integration, and other goodness for the other plugins.
530 More layers of plugins can be stacked on top of the authentication code. For
531 example, L<Catalyst::Plugin::Session::PerUser> provides an abstraction of
532 browser sessions that is more persistent per users.
533 L<Catalyst::Plugin::Authorization::Roles> provides an accepted way to separate
534 and group users into categories, and then check which categories the current
539 Let's say we were storing users in a simple perl hash. Users are
540 verified by supplying a password which is matched within the hash.
542 This means that our application will begin like this:
550 __PACKAGE__->config->{authentication} =
552 default_realm => 'members',
562 password => "s00p3r",
564 roles => [qw/edit delete/],
567 password => "s3cr3t",
568 roles => [qw/comment/],
577 This tells the authentication plugin what realms are available, which
578 credential and store modules are used, and the configuration of each. With
579 this code loaded, we can now attempt to authenticate users.
581 To show an example of this, let's create an authentication controller:
583 package MyApp::Controller::Auth;
586 my ( $self, $c ) = @_;
588 if ( my $user = $c->req->param("user")
589 and my $password = $c->req->param("password") )
591 if ( $c->authenticate( { username => $user,
592 password => $password } ) ) {
593 $c->res->body( "hello " . $c->user->get("name") );
603 This code should be very readable. If all the necessary fields are supplied,
604 call the L<Catalyst::Plugin::Authentication/authenticate> method in the
605 controller. If it succeeds the user is logged in.
607 The credential verifier will attempt to retrieve the user whose details match
608 the authentication information provided to $c->authenticate(). Once it fetches
609 the user the password is checked and if it matches the user will be
610 B<authenticated> and C<< $c->user >> will contain the user object retrieved
613 In the above case, the default realm is checked, but we could just as easily
614 check an alternate realm. If this were an admin login, for example, we could
615 authenticate on the admin realm by simply changing the $c->authenticate()
618 if ( $c->authenticate( { username => $user,
619 password => $password }, 'admin' )l ) {
620 $c->res->body( "hello " . $c->user->get("name") );
624 Now suppose we want to restrict the ability to edit to a user with 'edit'
627 The restricted action might look like this:
630 my ( $self, $c ) = @_;
632 $c->detach("unauthorized")
633 unless $c->user_exists
634 and $c->user->get('editor') == 'yes';
636 # do something restricted here
639 This is somewhat similar to role based access control.
640 L<Catalyst::Plugin::Authentication::Store::Minimal> treats the roles field as
641 an array of role names. Let's leverage this. Add the role authorization
650 my ( $self, $c ) = @_;
652 $c->detach("unauthorized") unless $c->check_roles("edit");
654 # do something restricted here
657 This is somewhat simpler and will work if you change your store, too, since the
658 role interface is consistent.
660 Let's say your app grew, and you now have 10000 users. It's no longer
661 efficient to maintain a hash of users, so you move this data to a database.
662 You can accomplish this simply by installing the DBIx::Class Store and
663 changing your config:
665 __PACKAGE__->config->{authentication} =
667 default_realm => 'members',
674 class => 'DBIx::Class',
675 user_class => 'MyApp::Users',
676 role_column => 'roles'
682 The authentication system works behind the scenes to load your data from the
683 new source. The rest of your application is completely unchanged.
691 __PACKAGE__->config->{authentication} =
693 default_realm => 'members',
700 class => 'DBIx::Class',
701 user_class => 'MyApp::Users',
702 role_column => 'roles'
710 class => '+MyApp::Authentication::Store::NetAuth',
711 authserver => '192.168.10.17'
720 Whether or not to store the user's logged in state in the session, if the
721 application is also using L<Catalyst::Plugin::Session>. This
722 value is set to true per default.
726 This defines which realm should be used as when no realm is provided to methods
727 that require a realm such as authenticate or find_user.
731 This contains the series of realm configurations you want to use for your app.
732 The only rule here is that there must be at least one. A realm consists of a
733 name, which is used to reference the realm, a credential and a store.
735 Each realm config contains two hashes, one called 'credential' and one called
736 'store', each of which provide configuration details to the respective modules.
737 The contents of these hashes is specific to the module being used, with the
738 exception of the 'class' element, which tells the core Authentication module the
739 classname to instantiate.
741 The 'class' element follows the standard Catalyst mechanism of class
742 specification. If a class is prefixed with a +, it is assumed to be a complete
743 class name. Otherwise it is considered to be a portion of the class name. For
744 credentials, the classname 'B<Password>', for example, is expanded to
745 Catalyst::Plugin::Authentication::Credential::B<Password>. For stores, the
746 classname 'B<storename>' is expanded to:
747 Catalyst::Plugin::Authentication::Store::B<storename>.
757 =item authenticate( $userinfo, $realm )
759 Attempts to authenticate the user using the information in the $userinfo hash
760 reference using the realm $realm. $realm may be omitted, in which case the
761 default realm is checked.
765 Returns the currently logged in user or undef if there is none.
769 Returns true if a user is logged in right now. The difference between
770 user_exists and user is that user_exists will return true if a user is logged
771 in, even if it has not been yet retrieved from the storage backend. If you only
772 need to know if the user is logged in, depending on the storage mechanism this
773 can be much more efficient.
775 =item user_in_realm ( $realm )
777 Works like user_exists, except that it only returns true if a user is both
778 logged in right now and is from the realm provided.
782 Logs the user out, Deletes the currently logged in user from $c->user and the session.
784 =item find_user( $userinfo, $realm )
786 Fetch a particular users details, matching the provided user info, from the realm
791 =head1 INTERNAL METHODS
793 These methods are for Catalyst::Plugin::Authentication B<INTERNAL USE> only.
794 Please do not use them in your own code, whether application or credential /
795 store modules. If you do, you will very likely get the nasty shock of having
796 to fix / rewrite your code when things change. They are documented here only
801 =item set_authenticated ( $user, $realmname )
803 Marks a user as authenticated. This is called from within the authenticate
804 routine when a credential returns a user. $realmname defaults to 'default'
806 =item auth_restore_user ( $user, $realmname )
808 Used to restore a user from the session. In most cases this is called without
809 arguments to restore the user via the session. Can be called with arguments
810 when restoring a user from some other method. Currently not used in this way.
812 =item save_user_in_session ( $user, $realmname )
814 Used to save the user in a session. Saves $user in session, marked as
815 originating in $realmname. Both arguments are required.
819 Returns a hashref containing realmname -> realm instance pairs. Realm
820 instances contain an instantiated store and credential object as the 'store'
821 and 'credential' elements, respectively
823 =item get_auth_realm ( $realmname )
825 Retrieves the realm instance for the realmname provided.
833 This list might not be up to date. Below are modules known to work with the updated
834 API of 0.10 and are therefore compatible with realms.
836 =head2 User Storage Backends
838 L<Catalyst::Plugin::Authentication::Store::Minimal>,
839 L<Catalyst::Plugin::Authentication::Store::DBIx::Class>,
841 =head2 Credential verification
843 L<Catalyst::Plugin::Authentication::Credential::Password>,
847 L<Catalyst::Plugin::Authorization::ACL>,
848 L<Catalyst::Plugin::Authorization::Roles>
850 =head2 Internals Documentation
852 L<Catalyst::Plugin::Authentication::Internals>
856 L<Catalyst::Plugin::Session>,
857 L<Catalyst::Plugin::Session::PerUser>
859 =head1 DON'T SEE ALSO
861 This module along with its sub plugins deprecate a great number of other
862 modules. These include L<Catalyst::Plugin::Authentication::Simple>,
863 L<Catalyst::Plugin::Authentication::CDBI>.
865 At the time of writing these plugins have not yet been replaced or updated, but
866 should be eventually: L<Catalyst::Plugin::Authentication::OpenID>,
867 L<Catalyst::Plugin::Authentication::LDAP>,
868 L<Catalyst::Plugin::Authentication::CDBI::Basic>,
869 L<Catalyst::Plugin::Authentication::Basic::Remote>.
871 =head1 INCOMPATABILITIES
873 The realms based configuration and functionality of the 0.10 update
874 of L<Catalyst::Plugin::Authentication> required a change in the API used by
875 credentials and stores. It has a compatibility mode which allows use of
876 modules that have not yet been updated. This, however, completely mimics the
877 older api and disables the new realm-based features. In other words you can
878 not mix the older credential and store modules with realms, or realm-based
879 configs. The changes required to update modules are relatively minor and are
880 covered in L<Catalyst::Plugin::Authentication::Internals>. We hope that most
881 modules will move to the compatible list above very quickly.
883 =head1 COMPATIBILITY ROUTINES
885 In version 0.10 of L<Catalyst::Plugin::Authentication>, the API
886 changed. For app developers, this change is fairly minor, but for
887 Credential and Store authors, the changes are significant.
889 Please see the documentation in version 0.09 of
890 Catalyst::Plugin::Authentication for a better understanding of how the old API
893 The items below are still present in the plugin, though using them is
894 deprecated. They remain only as a transition tool, for those sites which can
895 not yet be upgraded to use the new system due to local customizations or use
896 of Credential / Store modules that have not yet been updated to work with the
899 These routines should not be used in any application using realms
900 functionality or any of the methods described above. These are for reference
907 This method is used to initiate authentication and user retrieval. Technically
908 this is part of the old Password credential module and it still resides in the
909 L<Password|Catalyst::Plugin::Authentication::Credential::Password> class. It is
910 included here for reference only.
912 =item default_auth_store
914 Return the store whose name is 'default'.
916 This is set to C<< $c->config->{authentication}{store} >> if that value exists,
917 or by using a Store plugin:
919 # load the Minimal authentication store.
920 use Catalyst qw/Authentication Authentication::Store::Minimal/;
922 Sets the default store to
923 L<Catalyst::Plugin::Authentication::Store::Minimal>.
925 =item get_auth_store $name
927 Return the store whose name is $name.
929 =item get_auth_store_name $store
931 Return the name of the store $store.
935 A hash keyed by name, with the stores registered in the app.
937 =item register_auth_stores %stores_by_name
939 Register stores into the application.
947 Yuval Kogman, C<nothingmuch@woobling.org>
949 Jay Kuri, C<jayk@cpan.org>
956 =head1 COPYRIGHT & LICENSE
958 Copyright (c) 2005 the aforementioned authors. All rights
959 reserved. This program is free software; you can redistribute
960 it and/or modify it under the same terms as Perl itself.