1 package Catalyst::Plugin::Authentication;
3 use base qw/Class::Accessor::Fast Class::Data::Inheritable/;
6 __PACKAGE__->mk_accessors(qw/_user/);
14 use Catalyst::Authentication::Realm;
16 # this optimization breaks under Template::Toolkit
17 # use user_exists instead
20 # constant->import(have_want => eval { require Want });
23 our $VERSION = "0.10005";
25 sub set_authenticated {
26 my ( $c, $user, $realmname ) = @_;
29 $c->request->{user} = $user; # compatibility kludge
32 $realmname = 'default';
34 my $realm = $c->get_auth_realm($realmname);
37 Catalyst::Exception->throw(
38 "set_authenticated called with nonexistant realm: '$realmname'.");
41 if ( $c->isa("Catalyst::Plugin::Session")
42 and $c->config->{'Plugin::Authentication'}{'use_session'}
43 and $user->supports("session") )
45 $realm->save_user_in_session($c, $user);
47 $user->auth_realm($realm->name);
49 $c->NEXT::set_authenticated($user, $realmname);
59 if ( defined($c->_user) ) {
62 return $c->auth_restore_user;
66 # change this to allow specification of a realm - to verify the user is part of that realm
67 # in addition to verifying that they exist.
70 return defined($c->_user) || defined($c->_user_in_session);
73 # works like user_exists - except only returns true if user
74 # exists AND is in the realm requested.
76 my ($c, $realmname) = @_;
78 if (defined($c->_user)) {
79 return ($c->_user->auth_realm eq $realmname);
80 } elsif (defined($c->_user_in_session)) {
81 return ($c->session->{__user_realm} eq $realmname);
87 sub __old_save_user_in_session {
88 my ( $c, $user, $realmname ) = @_;
90 $c->session->{__user_realm} = $realmname;
92 # we want to ask the store for a user prepared for the session.
93 # but older modules split this functionality between the user and the
94 # store. We try the store first. If not, we use the old method.
95 my $realm = $c->get_auth_realm($realmname);
96 if ($realm->{'store'}->can('for_session')) {
97 $c->session->{__user} = $realm->{'store'}->for_session($c, $user);
99 $c->session->{__user} = $user->for_session;
109 $c->isa("Catalyst::Plugin::Session")
110 and $c->config->{'Plugin::Authentication'}{'use_session'}
111 and $c->session_is_valid
113 delete @{ $c->session }{qw/__user __user_realm/};
116 $c->NEXT::logout(@_);
120 my ( $c, $userinfo, $realmname ) = @_;
122 $realmname ||= 'default';
123 my $realm = $c->get_auth_realm($realmname);
126 Catalyst::Exception->throw(
127 "find_user called with nonexistant realm: '$realmname'.");
129 return $realm->find_user($userinfo, $c);
133 sub _user_in_session {
137 $c->isa("Catalyst::Plugin::Session")
138 and $c->config->{'Plugin::Authentication'}{'use_session'}
139 and $c->session_is_valid;
141 return $c->session->{__user};
144 sub auth_restore_user {
145 my ( $c, $frozen_user, $realmname ) = @_;
147 $frozen_user ||= $c->_user_in_session;
148 return unless defined($frozen_user);
150 $realmname ||= $c->session->{__user_realm};
151 return unless $realmname; # FIXME die unless? This is an internal inconsistency
153 my $realm = $c->get_auth_realm($realmname);
154 $c->_user( my $user = $realm->from_session( $c, $frozen_user ) );
156 # this sets the realm the user originated in.
157 $user->auth_realm($realmname);
163 # we can't actually do our setup in setup because the model has not yet been loaded.
164 # So we have to trigger off of setup_finished. :-(
168 $app->_authentication_initialize();
169 $app->NEXT::setup(@_);
172 ## the actual initialization routine. whee.
173 sub _authentication_initialize {
176 ## let's avoid recreating / configuring everything if we have already done it, eh?
177 if ($app->can('_auth_realms')) { return };
179 ## make classdata where it is used.
180 $app->mk_classdata( '_auth_realms' => {});
182 my $cfg = $app->config->{'Plugin::Authentication'};
183 if (!defined($cfg)) {
184 if (exists($app->config->{'authentication'})) {
185 $cfg = $app->config->{'authentication'};
186 $app->config->{'Plugin::Authentication'} = $app->config->{'authentication'};
192 # old default was to force use_session on. This must remain for that
193 # reason - but if use_session is already in the config, we respect it's setting.
194 if (!exists($cfg->{'use_session'})) {
195 $cfg->{'use_session'} = 1;
198 if (exists($cfg->{'realms'})) {
199 foreach my $realm (keys %{$cfg->{'realms'}}) {
200 $app->setup_auth_realm($realm, $cfg->{'realms'}{$realm});
202 # if we have a 'default_realm' in the config hash and we don't already
203 # have a realm called 'default', we point default at the realm specified
204 if (exists($cfg->{'default_realm'}) && !$app->get_auth_realm('default')) {
205 $app->_set_default_auth_realm($cfg->{'default_realm'});
209 ## BACKWARDS COMPATIBILITY - if realms is not defined - then we are probably dealing
210 ## with an old-school config. The only caveat here is that we must add a classname
212 ## also - we have to treat {store} as {stores}{default} - because
213 ## while it is not a clear as a valid config in the docs, it
214 ## is functional with the old api. Whee!
215 if (exists($cfg->{'store'}) && !exists($cfg->{'stores'}{'default'})) {
216 $cfg->{'stores'}{'default'} = $cfg->{'store'};
219 foreach my $storename (keys %{$cfg->{'stores'}}) {
221 store => { class => $cfg->{'stores'}{$storename} },
223 $app->setup_auth_realm($storename, $realmcfg);
230 sub setup_auth_realm {
231 my ($app, $realmname, $config) = @_;
233 my $realmclass = $config->{class};
236 $realmclass = 'Catalyst::Authentication::Realm';
237 } elsif ($realmclass !~ /^\+(.*)$/ ) {
238 $realmclass = "Catalyst::Authentication::Realm::${realmclass}";
243 Catalyst::Utils::ensure_class_loaded( $realmclass );
245 my $realm = $realmclass->new($realmname, $config, $app);
247 $app->auth_realms->{$realmname} = $realm;
249 $app->log->debug("realm initialization for '$realmname' failed.");
256 return($self->_auth_realms);
260 my ($app, $realmname) = @_;
261 return $app->auth_realms->{$realmname};
265 # Very internal method. Vital Valuable Urgent, Do not touch on pain of death.
266 # Using this method just assigns the default realm to be the value associated
267 # with the realmname provided. It WILL overwrite any real realm called 'default'
268 # so can be very confusing if used improperly. It's used properly already.
269 # Translation: don't use it.
270 sub _set_default_auth_realm {
271 my ($app, $realmname) = @_;
273 if (exists($app->auth_realms->{$realmname})) {
274 $app->auth_realms->{'default'} = $app->auth_realms->{$realmname};
276 return $app->get_auth_realm('default');
280 my ($app, $userinfo, $realmname) = @_;
283 $realmname = 'default';
286 my $realm = $app->get_auth_realm($realmname);
288 ## note to self - make authenticate throw an exception if realm is invalid.
291 return $realm->authenticate($app, $userinfo);
293 Catalyst::Exception->throw(
294 "authenticate called with nonexistant realm: '$realmname'.");
300 ## BACKWARDS COMPATIBILITY -- Warning: Here be monsters!
302 # What follows are backwards compatibility routines - for use with Stores and Credentials
303 # that have not been updated to work with C::P::Authentication v0.10.
304 # These are here so as to not break people's existing installations, but will go away
305 # in a future version.
307 # The old style of configuration only supports a single store, as each store module
308 # sets itself as the default store upon being loaded. This is the only supported
309 # 'compatibility' mode.
313 my ( $c, $uid, @rest ) = @_;
315 return $c->find_user( {'id' => $uid, 'rest'=>\@rest }, 'default' );
319 ## this should only be called when using old-style authentication plugins. IF this gets
320 ## called in a new-style config - it will OVERWRITE the store of your default realm. Don't do it.
321 ## also - this is a partial setup - because no credential is instantiated... in other words it ONLY
322 ## works with old-style auth plugins and C::P::Authentication in compatibility mode. Trying to combine
323 ## this with a realm-type config will probably crash your app.
324 sub default_auth_store {
327 my $realm = $self->get_auth_realm('default');
329 $realm = $self->setup_auth_realm('default', { class => 'Compatibility' });
331 if ( my $new = shift ) {
336 $storeclass = ref($new);
341 # BACKWARDS COMPATIBILITY - if the store class does not define find_user, we define it in terms
342 # of get_user and add it to the class. this is because the auth routines use find_user,
343 # and rely on it being present. (this avoids per-call checks)
344 if (!$storeclass->can('find_user')) {
346 *{"${storeclass}::find_user"} = sub {
347 my ($self, $info) = @_;
348 my @rest = @{$info->{rest}} if exists($info->{rest});
349 $self->get_user($info->{id}, @rest);
354 return $self->get_auth_realm('default')->store;
357 ## BACKWARDS COMPATIBILITY
358 ## this only ever returns a hash containing 'default' - as that is the only
359 ## supported mode of calling this.
360 sub auth_store_names {
363 my %hash = ( $self->get_auth_realm('default')->store => 'default' );
367 my ( $self, $name ) = @_;
369 if ($name ne 'default') {
370 Carp::croak "get_auth_store called on non-default realm '$name'. Only default supported in compatibility mode";
372 $self->default_auth_store();
376 sub get_auth_store_name {
377 my ( $self, $store ) = @_;
381 # sub auth_stores is only used internally - here for completeness
385 my %hash = ( 'default' => $self->get_auth_realm('default')->store);
396 Catalyst::Plugin::Authentication - Infrastructure plugin for the Catalyst
397 authentication framework.
406 $c->authenticate({ username => 'myusername',
407 password => 'mypassword' });
408 my $age = $c->user->get('age');
413 The authentication plugin provides generic user support for Catalyst apps. It
414 is the basis for both authentication (checking the user is who they claim to
415 be), and authorization (allowing the user to do what the system authorises
418 Using authentication is split into two parts. A Store is used to actually
419 store the user information, and can store any amount of data related to the
420 user. Credentials are used to verify users, using information from the store,
421 given data from the frontend. A Credential and a Store are paired to form a
422 'Realm'. A Catalyst application using the authentication framework must have
423 at least one realm, and may have several.
425 To implement authentication in a Catalyst application you need to add this
426 module, and specify at least one realm in the configuration.
428 Authentication data can also be stored in a session, if the application
429 is using the L<Catalyst::Plugin::Session> module.
431 B<NOTE> in version 0.10 of this module, the interface to this module changed.
432 Please see L</COMPATIBILITY ROUTINES> for more information.
436 =head2 The Authentication/Authorization Process
438 Web applications typically need to identify a user - to tell the user apart
439 from other users. This is usually done in order to display private information
440 that is only that user's business, or to limit access to the application so
441 that only certain entities can access certain parts.
443 This process is split up into several steps. First you ask the user to identify
444 themselves. At this point you can't be sure that the user is really who they
447 Then the user tells you who they are, and backs this claim with some piece of
448 information that only the real user could give you. For example, a password is
449 a secret that is known to both the user and you. When the user tells you this
450 password you can assume they're in on the secret and can be trusted (ignore
451 identity theft for now). Checking the password, or any other proof is called
452 B<credential verification>.
454 By this time you know exactly who the user is - the user's identity is
455 B<authenticated>. This is where this module's job stops, and your application
456 or other plugins step in.
458 The next logical step is B<authorization>, the process of deciding what a user
459 is (or isn't) allowed to do. For example, say your users are split into two
460 main groups - regular users and administrators. You want to verify that the
461 currently logged in user is indeed an administrator before performing the
462 actions in an administrative part of your application. These decisions may be
463 made within your application code using just the information available after
464 authentication, or it may be facilitated by a number of plugins.
466 =head2 The Components In This Framework
470 Configuration of the Catalyst::Plugin::Authentication framework is done in
471 terms of realms. In simplest terms, a realm is a pairing of a Credential
472 verifier and a User storage (Store) backend. As of version 0.10003, realms are
473 now objects that you can create and customize.
475 An application can have any number of Realms, each of which operates
476 independant of the others. Each realm has a name, which is used to identify it
477 as the target of an authentication request. This name can be anything, such as
478 'users' or 'members'. One realm must be defined as the default_realm, which is
479 used when no realm name is specified. More information about configuring
480 realms is available in the configuration section.
482 =head3 Credential Verifiers
484 When user input is transferred to the L<Catalyst> application
485 (typically via form inputs) the application may pass this information
486 into the authentication system through the C<<$c->authenticate()>>
487 method. From there, it is passed to the appropriate Credential
490 These plugins check the data, and ensure that it really proves the user is who
493 Credential verifiers compatible with versions of this module 0.10x and
494 upwards should be in the namespace
495 C<Catalyst::Authentication::Credential>.
497 =head3 Storage Backends
499 The authentication data also identifies a user, and the Storage backend modules
500 use this data to locate and return a standardized object-oriented
501 representation of a user.
503 When a user is retrieved from a store it is not necessarily authenticated.
504 Credential verifiers accept a set of authentication data and use this
505 information to retrieve the user from the store they are paired with.
507 storage backends compatible with versions of this module 0.10x and
508 upwards should be in the namespace
509 C<Catalyst::Authentication::Store>.
511 =head3 The Core Plugin
513 This plugin on its own is the glue, providing realm configuration, session
514 integration, and other goodness for the other plugins.
518 More layers of plugins can be stacked on top of the authentication code. For
519 example, L<Catalyst::Plugin::Session::PerUser> provides an abstraction of
520 browser sessions that is more persistent per user.
521 L<Catalyst::Plugin::Authorization::Roles> provides an accepted way to separate
522 and group users into categories, and then check which categories the current
527 Let's say we were storing users in a simple perl hash. Users are
528 verified by supplying a password which is matched within the hash.
530 This means that our application will begin like this:
538 __PACKAGE__->config->{'Plugin::Authentication'} =
540 default_realm => 'members',
545 password_field => 'password',
546 password_type => 'clear'
552 password => "s00p3r",
554 roles => [qw/edit delete/],
557 password => "s3cr3t",
558 roles => [qw/comment/],
567 This tells the authentication plugin what realms are available, which
568 credential and store modules are used, and the configuration of each. With
569 this code loaded, we can now attempt to authenticate users.
571 To show an example of this, let's create an authentication controller:
573 package MyApp::Controller::Auth;
576 my ( $self, $c ) = @_;
578 if ( my $user = $c->req->param("user")
579 and my $password = $c->req->param("password") )
581 if ( $c->authenticate( { username => $user,
582 password => $password } ) ) {
583 $c->res->body( "hello " . $c->user->get("name") );
593 This code should be self-explanatory. If all the necessary fields are supplied,
594 call the C<authenticate> method on the context object. If it succeeds the
597 The credential verifier will attempt to retrieve the user whose
598 details match the authentication information provided to
599 C<<$c->authenticate()>>. Once it fetches the user the password is
600 checked and if it matches the user will be B<authenticated> and
601 C<<$c->user>> will contain the user object retrieved from the store.
603 In the above case, the default realm is checked, but we could just as easily
604 check an alternate realm. If this were an admin login, for example, we could
605 authenticate on the admin realm by simply changing the C<<$c->authenticate()>>
608 if ( $c->authenticate( { username => $user,
609 password => $password }, 'admin' ) ) {
610 $c->res->body( "hello " . $c->user->get("name") );
614 Now suppose we want to restrict the ability to edit to a user with an
615 'editor' value of yes.
617 The restricted action might look like this:
620 my ( $self, $c ) = @_;
622 $c->detach("unauthorized")
623 unless $c->user_exists
624 and $c->user->get('editor') eq 'yes';
626 # do something restricted here
629 (Note that if you have multiple realms, you can use
630 C<<$c->user_in_realm('realmname')>>) in place of
631 C<<$c->user_exists();>> This will essentially perform the same
632 verification as user_exists, with the added requirement that if there
633 is a user, it must have come from the realm specified.)
635 The above example is somewhat similar to role based access control.
636 L<Catalyst::Authentication::Store::Minimal> treats the roles field as
637 an array of role names. Let's leverage this. Add the role authorization
646 my ( $self, $c ) = @_;
648 $c->detach("unauthorized") unless $c->check_roles("edit");
650 # do something restricted here
653 This is somewhat simpler and will work if you change your store, too, since the
654 role interface is consistent.
656 Let's say your app grew, and you now have 10000 users. It's no longer
657 efficient to maintain a hash of users, so you move this data to a database.
658 You can accomplish this simply by installing the L<DBIx::Class|Catalyst::Authentication::Store::DBIx::Class> Store and
659 changing your config:
661 __PACKAGE__->config->{'Plugin::Authentication'} =
663 default_realm => 'members',
668 password_field => 'password',
669 password_type => 'clear'
672 class => 'DBIx::Class',
673 user_class => 'MyApp::Users',
674 role_column => 'roles'
680 The authentication system works behind the scenes to load your data from the
681 new source. The rest of your application is completely unchanged.
687 __PACKAGE__->config->{'Plugin::Authentication'} =
689 default_realm => 'members',
694 password_field => 'password',
695 password_type => 'clear'
698 class => 'DBIx::Class',
699 user_class => 'MyApp::Users',
700 role_column => 'roles'
706 password_field => 'password',
707 password_type => 'clear'
710 class => '+MyApp::Authentication::Store::NetAuth',
711 authserver => '192.168.10.17'
722 Whether or not to store the user's logged in state in the session, if the
723 application is also using L<Catalyst::Plugin::Session>. This
724 value is set to true per default.
728 This defines which realm should be used as when no realm is provided to methods
729 that require a realm such as authenticate or find_user.
733 This contains the series of realm configurations you want to use for your app.
734 The only rule here is that there must be at least one. A realm consists of a
735 name, which is used to reference the realm, a credential and a store.
737 You can also specify a realm class to instantiate instead of the default
738 L<Catalyst::Authentication::Realm> class using the 'class' element within the
741 Each realm config contains two hashes, one called 'credential' and one called
742 'store', each of which provide configuration details to the respective modules.
743 The contents of these hashes is specific to the module being used, with the
744 exception of the 'class' element, which tells the core Authentication module the
745 classname to instantiate.
747 The 'class' element follows the standard Catalyst mechanism of class
748 specification. If a class is prefixed with a +, it is assumed to be a complete
749 class name. Otherwise it is considered to be a portion of the class name. For
750 credentials, the classname 'B<Password>', for example, is expanded to
751 Catalyst::Authentication::Credential::B<Password>. For stores, the
752 classname 'B<storename>' is expanded to:
753 Catalyst::Authentication::Store::B<storename>.
759 =head2 $c->authenticate( $userinfo, [ $realm ])
761 Attempts to authenticate the user using the information in the $userinfo hash
762 reference using the realm $realm. $realm may be omitted, in which case the
763 default realm is checked.
767 Returns the currently logged in user or undef if there is none.
769 =head2 $c->user_exists( )
771 Returns true if a user is logged in right now. The difference between
772 user_exists and user is that user_exists will return true if a user is logged
773 in, even if it has not been yet retrieved from the storage backend. If you only
774 need to know if the user is logged in, depending on the storage mechanism this
775 can be much more efficient.
777 =head2 $c->user_in_realm( $realm )
779 Works like user_exists, except that it only returns true if a user is both
780 logged in right now and was retrieved from the realm provided.
784 Logs the user out, Deletes the currently logged in user from C<<$c->user>> and the session.
786 =head2 $c->find_user( $userinfo, $realm )
788 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
799 =head2 $c->set_authenticated( $user, $realmname )
801 Marks a user as authenticated. This is called from within the authenticate
802 routine when a credential returns a user. $realmname defaults to 'default'
804 =head2 $c->auth_restore_user( $user, $realmname )
806 Used to restore a user from the session. In most cases this is called without
807 arguments to restore the user via the session. Can be called with arguments
808 when restoring a user from some other method. Currently not used in this way.
810 =head2 $c->save_user_in_session( $user, $realmname )
812 Used to save the user in a session. Saves $user in session, marked as
813 originating in $realmname. Both arguments are required.
815 =head2 $c->auth_realms( )
817 Returns a hashref containing realmname -> realm instance pairs. Realm
818 instances contain an instantiated store and credential object as the 'store'
819 and 'credential' elements, respectively
821 =head2 $c->get_auth_realm( $realmname )
823 Retrieves the realm instance for the realmname provided.
827 This list might not be up to date. Below are modules known to work with the updated
828 API of 0.10 and are therefore compatible with realms.
832 L<Catalyst::Authentication::Realm>
834 =head2 User Storage Backends
836 L<Catalyst::Authentication::Store::Minimal>,
837 L<Catalyst::Authentication::Store::DBIx::Class>,
839 =head2 Credential verification
841 L<Catalyst::Authentication::Credential::Password>,
845 L<Catalyst::Plugin::Authorization::ACL>,
846 L<Catalyst::Plugin::Authorization::Roles>
848 =head2 Internals Documentation
850 L<Catalyst::Plugin::Authentication::Internals>
854 L<Catalyst::Plugin::Session>,
855 L<Catalyst::Plugin::Session::PerUser>
857 =head1 DON'T SEE ALSO
859 This module along with its sub plugins deprecate a great number of other
860 modules. These include L<Catalyst::Plugin::Authentication::Simple>,
861 L<Catalyst::Plugin::Authentication::CDBI>.
863 At the time of writing these plugins have not yet been replaced or updated, but
864 should be eventually: L<Catalyst::Plugin::Authentication::OpenID>,
865 L<Catalyst::Plugin::Authentication::LDAP>,
866 L<Catalyst::Plugin::Authentication::CDBI::Basic>,
867 L<Catalyst::Plugin::Authentication::Basic::Remote>.
869 =head1 INCOMPATABILITIES
871 The realms based configuration and functionality of the 0.10 update
872 of L<Catalyst::Plugin::Authentication> required a change in the API used by
873 credentials and stores. It has a compatibility mode which allows use of
874 modules that have not yet been updated. This, however, completely mimics the
875 older api and disables the new realm-based features. In other words you can
876 not mix the older credential and store modules with realms, or realm-based
877 configs. The changes required to update modules are relatively minor and are
878 covered in L<Catalyst::Plugin::Authentication::Internals>. We hope that most
879 modules will move to the compatible list above very quickly.
881 =head1 COMPATIBILITY ROUTINES
883 In version 0.10 of L<Catalyst::Plugin::Authentication>, the API
884 changed. For app developers, this change is fairly minor, but for
885 Credential and Store authors, the changes are significant.
887 Please see the documentation in version 0.09 of
888 Catalyst::Plugin::Authentication for a better understanding of how the old API
891 The items below are still present in the plugin, though using them is
892 deprecated. They remain only as a transition tool, for those sites which can
893 not yet be upgraded to use the new system due to local customizations or use
894 of Credential / Store modules that have not yet been updated to work with the
897 These routines should not be used in any application using realms
898 functionality or any of the methods described above. These are for reference
903 This method is used to initiate authentication and user retrieval. Technically
904 this is part of the old Password credential module and it still resides in the
905 L<Password|Catalyst::Plugin::Authentication::Credential::Password> class. It is
906 included here for reference only.
908 =head2 $c->default_auth_store( )
910 Return the store whose name is 'default'.
912 This is set to C<< $c->config->{'Plugin::Authentication'}{store} >> if that value exists,
913 or by using a Store plugin:
915 # load the Minimal authentication store.
916 use Catalyst qw/Authentication Authentication::Store::Minimal/;
918 Sets the default store to
919 L<Catalyst::Plugin::Authentication::Store::Minimal>.
921 =head2 $c->get_auth_store( $name )
923 Return the store whose name is $name.
925 =head2 $c->get_auth_store_name( $store )
927 Return the name of the store $store.
929 =head2 $c->auth_stores( )
931 A hash keyed by name, with the stores registered in the app.
933 =head2 $c->register_auth_stores( %stores_by_name )
935 Register stores into the application.
937 =head2 $c->auth_store_names( )
939 =head2 $c->get_user( )
943 =head2 $c->setup_auth_realm( )
947 Yuval Kogman, C<nothingmuch@woobling.org>
949 Jay Kuri, C<jayk@cpan.org>
955 =head1 COPYRIGHT & LICENSE
957 Copyright (c) 2005 the aforementioned authors. All rights
958 reserved. This program is free software; you can redistribute
959 it and/or modify it under the same terms as Perl itself.