3 package Catalyst::Plugin::Authentication;
5 use base qw/Class::Accessor::Fast Class::Data::Inheritable/;
8 __PACKAGE__->mk_accessors(qw/_user/);
17 # this optimization breaks under Template::Toolkit
18 # use user_exists instead
21 # constant->import(have_want => eval { require Want });
24 our $VERSION = "0.10000";
26 sub set_authenticated {
27 my ( $c, $user, $realmname ) = @_;
30 $c->request->{user} = $user; # compatibility kludge
33 $realmname = 'default';
36 if ( $c->isa("Catalyst::Plugin::Session")
37 and $c->config->{authentication}{use_session}
38 and $user->supports("session") )
40 $c->save_user_in_session($user, $realmname);
42 $user->auth_realm($realmname);
43 $user->store(ref($c->auth_realms->{$realmname}{'store'}));
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);
171 ## compatibility - some pre 0.10 store / credentials may need the store name,
172 ## this is not used by the current api in any form.
173 $user->store(ref($c->auth_realms->{$realmname}{'store'}));
179 # we can't actually do our setup in setup because the model has not yet been loaded.
180 # So we have to trigger off of setup_finished. :-(
184 $app->_authentication_initialize();
185 $app->NEXT::setup(@_);
188 ## the actual initialization routine. whee.
189 sub _authentication_initialize {
192 ## let's avoid recreating / configuring everything if we have already done it, eh?
193 if ($app->can('_auth_realms')) { return };
195 ## make classdata where it is used.
196 $app->mk_classdata( '_auth_realms' => {});
198 my $cfg = $app->config->{'authentication'} ||= {};
200 $cfg->{use_session} = 1;
202 if (exists($cfg->{'realms'})) {
203 foreach my $realm (keys %{$cfg->{'realms'}}) {
204 $app->setup_auth_realm($realm, $cfg->{'realms'}{$realm});
206 # if we have a 'default-realm' in the config hash and we don't already
207 # have a realm called 'default', we point default at the realm specified
208 if (exists($cfg->{'default_realm'}) && !$app->get_auth_realm('default')) {
209 $app->_set_default_auth_realm($cfg->{'default_realm'});
213 ## BACKWARDS COMPATIBILITY - if realms is not defined - then we are probably dealing
214 ## with an old-school config. The only caveat here is that we must add a classname
216 ## also - we have to treat {store} as {stores}{default} - because
217 ## while it is not a clear as a valid config in the docs, it
218 ## is functional with the old api. Whee!
219 if (exists($cfg->{'store'}) && !exists($cfg->{'stores'}{'default'})) {
220 $cfg->{'stores'}{'default'} = $cfg->{'store'};
223 foreach my $storename (keys %{$cfg->{'stores'}}) {
225 store => { class => $cfg->{'stores'}{$storename} },
227 $app->setup_auth_realm($storename, $realmcfg);
234 sub setup_auth_realm {
235 my ($app, $realmname, $config) = @_;
237 $app->log->debug("Setting up auth realm $realmname") if $app->debug;
238 if (!exists($config->{'store'}{'class'})) {
239 Carp::croak "Couldn't setup the authentication realm named '$realmname', no class defined";
243 my $storeclass = $config->{'store'}{'class'};
245 ## follow catalyst class naming - a + prefix means a fully qualified class, otherwise it's
246 ## taken to mean C::P::A::Store::(specifiedclass)
247 if ($storeclass !~ /^\+(.*)$/ ) {
248 $storeclass = "Catalyst::Plugin::Authentication::Store::${storeclass}";
254 # a little niceness - since most systems seem to use the password credential class,
255 # if no credential class is specified we use password.
256 $config->{credential}{class} ||= '+Catalyst::Plugin::Authentication::Credential::Password';
258 my $credentialclass = $config->{'credential'}{'class'};
260 ## follow catalyst class naming - a + prefix means a fully qualified class, otherwise it's
261 ## taken to mean C::P::A::Credential::(specifiedclass)
262 if ($credentialclass !~ /^\+(.*)$/ ) {
263 $credentialclass = "Catalyst::Plugin::Authentication::Credential::${credentialclass}";
265 $credentialclass = $1;
268 # if we made it here - we have what we need to load the classes;
269 Catalyst::Utils::ensure_class_loaded( $credentialclass );
270 Catalyst::Utils::ensure_class_loaded( $storeclass );
272 # BACKWARDS COMPATIBILITY - if the store class does not define find_user, we define it in terms
273 # of get_user and add it to the class. this is because the auth routines use find_user,
274 # and rely on it being present. (this avoids per-call checks)
275 if (!$storeclass->can('find_user')) {
277 *{"${storeclass}::find_user"} = sub {
278 my ($self, $info) = @_;
279 my @rest = @{$info->{rest}} if exists($info->{rest});
280 $self->get_user($info->{id}, @rest);
284 ## a little cruft to stay compatible with some poorly written stores / credentials
285 ## we'll remove this soon.
286 if ($storeclass->can('new')) {
287 $app->auth_realms->{$realmname}{'store'} = $storeclass->new($config->{'store'}, $app);
289 $app->log->error("THIS IS DEPRECATED: $storeclass has no new() method - Attempting to use uninstantiated");
290 $app->auth_realms->{$realmname}{'store'} = $storeclass;
292 if ($credentialclass->can('new')) {
293 $app->auth_realms->{$realmname}{'credential'} = $credentialclass->new($config->{'credential'}, $app);
295 $app->log->error("THIS IS DEPRECATED: $credentialclass has no new() method - Attempting to use uninstantiated");
296 $app->auth_realms->{$realmname}{'credential'} = $credentialclass;
302 return($self->_auth_realms);
306 my ($app, $realmname) = @_;
307 return $app->auth_realms->{$realmname};
311 # Very internal method. Vital Valuable Urgent, Do not touch on pain of death.
312 # Using this method just assigns the default realm to be the value associated
313 # with the realmname provided. It WILL overwrite any real realm called 'default'
314 # so can be very confusing if used improperly. It's used properly already.
315 # Translation: don't use it.
316 sub _set_default_auth_realm {
317 my ($app, $realmname) = @_;
319 if (exists($app->auth_realms->{$realmname})) {
320 $app->auth_realms->{'default'} = $app->auth_realms->{$realmname};
322 return $app->get_auth_realm('default');
326 my ($app, $userinfo, $realmname) = @_;
329 $realmname = 'default';
332 my $realm = $app->get_auth_realm($realmname);
334 ## note to self - make authenticate throw an exception if realm is invalid.
336 if ($realm && exists($realm->{'credential'})) {
337 my $user = $realm->{'credential'}->authenticate($app, $realm->{store}, $userinfo);
339 $app->set_authenticated($user, $realmname);
343 $app->log->debug("The realm requested, '$realmname' does not exist," .
344 " or there is no credential associated with it.")
349 ## BACKWARDS COMPATIBILITY -- Warning: Here be monsters!
351 # What follows are backwards compatibility routines - for use with Stores and Credentials
352 # that have not been updated to work with C::P::Authentication v0.10.
353 # These are here so as to not break people's existing installations, but will go away
354 # in a future version.
356 # The old style of configuration only supports a single store, as each store module
357 # sets itself as the default store upon being loaded. This is the only supported
358 # 'compatibility' mode.
362 my ( $c, $uid, @rest ) = @_;
364 return $c->find_user( {'id' => $uid, 'rest'=>\@rest }, 'default' );
368 ## this should only be called when using old-style authentication plugins. IF this gets
369 ## called in a new-style config - it will OVERWRITE the store of your default realm. Don't do it.
370 ## also - this is a partial setup - because no credential is instantiated... in other words it ONLY
371 ## works with old-style auth plugins and C::P::Authentication in compatibility mode. Trying to combine
372 ## this with a realm-type config will probably crash your app.
373 sub default_auth_store {
376 if ( my $new = shift ) {
377 $self->auth_realms->{'default'}{'store'} = $new;
381 $storeclass = ref($new);
386 # BACKWARDS COMPATIBILITY - if the store class does not define find_user, we define it in terms
387 # of get_user and add it to the class. this is because the auth routines use find_user,
388 # and rely on it being present. (this avoids per-call checks)
389 if (!$storeclass->can('find_user')) {
391 *{"${storeclass}::find_user"} = sub {
392 my ($self, $info) = @_;
393 my @rest = @{$info->{rest}} if exists($info->{rest});
394 $self->get_user($info->{id}, @rest);
399 return $self->get_auth_realm('default')->{'store'};
402 ## BACKWARDS COMPATIBILITY
403 ## this only ever returns a hash containing 'default' - as that is the only
404 ## supported mode of calling this.
405 sub auth_store_names {
408 my %hash = ( $self->get_auth_realm('default')->{'store'} => 'default' );
412 my ( $self, $name ) = @_;
414 if ($name ne 'default') {
415 Carp::croak "get_auth_store called on non-default realm '$name'. Only default supported in compatibility mode";
417 $self->default_auth_store();
421 sub get_auth_store_name {
422 my ( $self, $store ) = @_;
426 # sub auth_stores is only used internally - here for completeness
430 my %hash = ( 'default' => $self->get_auth_realm('default')->{'store'});
441 Catalyst::Plugin::Authentication - Infrastructure plugin for the Catalyst
442 authentication framework.
451 $c->authenticate({ username => 'myusername',
452 password => 'mypassword' });
453 my $age = $c->user->get('age');
458 The authentication plugin provides generic user support for Catalyst apps. It
459 is the basis for both authentication (checking the user is who they claim to
460 be), and authorization (allowing the user to do what the system authorises
463 Using authentication is split into two parts. A Store is used to actually
464 store the user information, and can store any amount of data related to the
465 user. Credentials are used to verify users, using information from the store,
466 given data from the frontend. A Credential and a Store are paired to form a
467 'Realm'. A Catalyst application using the authentication framework must have
468 at least one realm, and may have several.
470 To implement authentication in a Catalyst application you need to add this
471 module, and specify at least one realm in the configuration.
473 Authentication data can also be stored in a session, if the application
474 is using the L<Catalyst::Plugin::Session> module.
476 B<NOTE> in version 0.10 of this module, the interface to this module changed.
477 Please see L</COMPATIBILITY ROUTINES> for more information.
481 =head2 The Authentication/Authorization Process
483 Web applications typically need to identify a user - to tell the user apart
484 from other users. This is usually done in order to display private information
485 that is only that user's business, or to limit access to the application so
486 that only certain entities can access certain parts.
488 This process is split up into several steps. First you ask the user to identify
489 themselves. At this point you can't be sure that the user is really who they
492 Then the user tells you who they are, and backs this claim with some piece of
493 information that only the real user could give you. For example, a password is
494 a secret that is known to both the user and you. When the user tells you this
495 password you can assume they're in on the secret and can be trusted (ignore
496 identity theft for now). Checking the password, or any other proof is called
497 B<credential verification>.
499 By this time you know exactly who the user is - the user's identity is
500 B<authenticated>. This is where this module's job stops, and your application
501 or other plugins step in.
503 The next logical step is B<authorization>, the process of deciding what a user
504 is (or isn't) allowed to do. For example, say your users are split into two
505 main groups - regular users and administrators. You want to verify that the
506 currently logged in user is indeed an administrator before performing the
507 actions in an administrative part of your application. These decisions may be
508 made within your application code using just the information available after
509 authentication, or it may be facilitated by a number of plugins.
511 =head2 The Components In This Framework
515 Configuration of the Catalyst::Plugin::Authentication framework is done in
516 terms of realms. In simplest terms, a realm is a pairing of a Credential
517 verifier and a User storage (Store) backend.
519 An application can have any number of Realms, each of which operates
520 independant of the others. Each realm has a name, which is used to identify it
521 as the target of an authentication request. This name can be anything, such as
522 'users' or 'members'. One realm must be defined as the default_realm, which is
523 used when no realm name is specified. More information about configuring
524 realms is available in the configuration section.
526 =head3 Credential Verifiers
528 When user input is transferred to the L<Catalyst> application (typically via
529 form inputs) the application may pass this information into the authentication
530 system through the $c->authenticate() method. From there, it is passed to the
531 appropriate Credential verifier.
533 These plugins check the data, and ensure that it really proves the user is who
536 =head3 Storage Backends
538 The authentication data also identifies a user, and the Storage backend modules
539 use this data to locate and return a standardized object-oriented
540 representation of a user.
542 When a user is retrieved from a store it is not necessarily authenticated.
543 Credential verifiers accept a set of authentication data and use this
544 information to retrieve the user from the store they are paired with.
546 =head3 The Core Plugin
548 This plugin on its own is the glue, providing realm configuration, session
549 integration, and other goodness for the other plugins.
553 More layers of plugins can be stacked on top of the authentication code. For
554 example, L<Catalyst::Plugin::Session::PerUser> provides an abstraction of
555 browser sessions that is more persistent per users.
556 L<Catalyst::Plugin::Authorization::Roles> provides an accepted way to separate
557 and group users into categories, and then check which categories the current
562 Let's say we were storing users in a simple perl hash. Users are
563 verified by supplying a password which is matched within the hash.
565 This means that our application will begin like this:
573 __PACKAGE__->config->{authentication} =
575 default_realm => 'members',
580 password_field => 'password',
581 password_type => 'clear'
587 password => "s00p3r",
589 roles => [qw/edit delete/],
592 password => "s3cr3t",
593 roles => [qw/comment/],
602 This tells the authentication plugin what realms are available, which
603 credential and store modules are used, and the configuration of each. With
604 this code loaded, we can now attempt to authenticate users.
606 To show an example of this, let's create an authentication controller:
608 package MyApp::Controller::Auth;
611 my ( $self, $c ) = @_;
613 if ( my $user = $c->req->param("user")
614 and my $password = $c->req->param("password") )
616 if ( $c->authenticate( { username => $user,
617 password => $password } ) ) {
618 $c->res->body( "hello " . $c->user->get("name") );
628 This code should be very readable. If all the necessary fields are supplied,
629 call the "authenticate" method from the controller. If it succeeds the
632 The credential verifier will attempt to retrieve the user whose details match
633 the authentication information provided to $c->authenticate(). Once it fetches
634 the user the password is checked and if it matches the user will be
635 B<authenticated> and C<< $c->user >> will contain the user object retrieved
638 In the above case, the default realm is checked, but we could just as easily
639 check an alternate realm. If this were an admin login, for example, we could
640 authenticate on the admin realm by simply changing the $c->authenticate()
643 if ( $c->authenticate( { username => $user,
644 password => $password }, 'admin' )l ) {
645 $c->res->body( "hello " . $c->user->get("name") );
649 Now suppose we want to restrict the ability to edit to a user with an
650 'editor' value of yes.
652 The restricted action might look like this:
655 my ( $self, $c ) = @_;
657 $c->detach("unauthorized")
658 unless $c->user_exists
659 and $c->user->get('editor') eq 'yes';
661 # do something restricted here
664 (Note that if you have multiple realms, you can use $c->user_in_realm('realmname')
665 in place of $c->user_exists(); This will essentially perform the same
666 verification as user_exists, with the added requirement that if there is a
667 user, it must have come from the realm specified.)
669 The above example is somewhat similar to role based access control.
670 L<Catalyst::Plugin::Authentication::Store::Minimal> treats the roles field as
671 an array of role names. Let's leverage this. Add the role authorization
680 my ( $self, $c ) = @_;
682 $c->detach("unauthorized") unless $c->check_roles("edit");
684 # do something restricted here
687 This is somewhat simpler and will work if you change your store, too, since the
688 role interface is consistent.
690 Let's say your app grew, and you now have 10000 users. It's no longer
691 efficient to maintain a hash of users, so you move this data to a database.
692 You can accomplish this simply by installing the DBIx::Class Store and
693 changing your config:
695 __PACKAGE__->config->{authentication} =
697 default_realm => 'members',
702 password_field => 'password',
703 password_type => 'clear'
706 class => 'DBIx::Class',
707 user_class => 'MyApp::Users',
708 role_column => 'roles'
714 The authentication system works behind the scenes to load your data from the
715 new source. The rest of your application is completely unchanged.
723 __PACKAGE__->config->{authentication} =
725 default_realm => 'members',
730 password_field => 'password',
731 password_type => 'clear'
734 class => 'DBIx::Class',
735 user_class => 'MyApp::Users',
736 role_column => 'roles'
742 password_field => 'password',
743 password_type => 'clear'
746 class => '+MyApp::Authentication::Store::NetAuth',
747 authserver => '192.168.10.17'
756 Whether or not to store the user's logged in state in the session, if the
757 application is also using L<Catalyst::Plugin::Session>. This
758 value is set to true per default.
762 This defines which realm should be used as when no realm is provided to methods
763 that require a realm such as authenticate or find_user.
767 This contains the series of realm configurations you want to use for your app.
768 The only rule here is that there must be at least one. A realm consists of a
769 name, which is used to reference the realm, a credential and a store.
771 Each realm config contains two hashes, one called 'credential' and one called
772 'store', each of which provide configuration details to the respective modules.
773 The contents of these hashes is specific to the module being used, with the
774 exception of the 'class' element, which tells the core Authentication module the
775 classname to instantiate.
777 The 'class' element follows the standard Catalyst mechanism of class
778 specification. If a class is prefixed with a +, it is assumed to be a complete
779 class name. Otherwise it is considered to be a portion of the class name. For
780 credentials, the classname 'B<Password>', for example, is expanded to
781 Catalyst::Plugin::Authentication::Credential::B<Password>. For stores, the
782 classname 'B<storename>' is expanded to:
783 Catalyst::Plugin::Authentication::Store::B<storename>.
793 =item authenticate( $userinfo, $realm )
795 Attempts to authenticate the user using the information in the $userinfo hash
796 reference using the realm $realm. $realm may be omitted, in which case the
797 default realm is checked.
801 Returns the currently logged in user or undef if there is none.
805 Returns true if a user is logged in right now. The difference between
806 user_exists and user is that user_exists will return true if a user is logged
807 in, even if it has not been yet retrieved from the storage backend. If you only
808 need to know if the user is logged in, depending on the storage mechanism this
809 can be much more efficient.
811 =item user_in_realm ( $realm )
813 Works like user_exists, except that it only returns true if a user is both
814 logged in right now and was retrieved from the realm provided.
818 Logs the user out, Deletes the currently logged in user from $c->user and the session.
820 =item find_user( $userinfo, $realm )
822 Fetch a particular users details, matching the provided user info, from the realm
827 =head1 INTERNAL METHODS
829 These methods are for Catalyst::Plugin::Authentication B<INTERNAL USE> only.
830 Please do not use them in your own code, whether application or credential /
831 store modules. If you do, you will very likely get the nasty shock of having
832 to fix / rewrite your code when things change. They are documented here only
837 =item set_authenticated ( $user, $realmname )
839 Marks a user as authenticated. This is called from within the authenticate
840 routine when a credential returns a user. $realmname defaults to 'default'
842 =item auth_restore_user ( $user, $realmname )
844 Used to restore a user from the session. In most cases this is called without
845 arguments to restore the user via the session. Can be called with arguments
846 when restoring a user from some other method. Currently not used in this way.
848 =item save_user_in_session ( $user, $realmname )
850 Used to save the user in a session. Saves $user in session, marked as
851 originating in $realmname. Both arguments are required.
855 Returns a hashref containing realmname -> realm instance pairs. Realm
856 instances contain an instantiated store and credential object as the 'store'
857 and 'credential' elements, respectively
859 =item get_auth_realm ( $realmname )
861 Retrieves the realm instance for the realmname provided.
869 This list might not be up to date. Below are modules known to work with the updated
870 API of 0.10 and are therefore compatible with realms.
872 =head2 User Storage Backends
874 L<Catalyst::Plugin::Authentication::Store::Minimal>,
875 L<Catalyst::Plugin::Authentication::Store::DBIx::Class>,
877 =head2 Credential verification
879 L<Catalyst::Plugin::Authentication::Credential::Password>,
883 L<Catalyst::Plugin::Authorization::ACL>,
884 L<Catalyst::Plugin::Authorization::Roles>
886 =head2 Internals Documentation
888 L<Catalyst::Plugin::Authentication::Internals>
892 L<Catalyst::Plugin::Session>,
893 L<Catalyst::Plugin::Session::PerUser>
895 =head1 DON'T SEE ALSO
897 This module along with its sub plugins deprecate a great number of other
898 modules. These include L<Catalyst::Plugin::Authentication::Simple>,
899 L<Catalyst::Plugin::Authentication::CDBI>.
901 At the time of writing these plugins have not yet been replaced or updated, but
902 should be eventually: L<Catalyst::Plugin::Authentication::OpenID>,
903 L<Catalyst::Plugin::Authentication::LDAP>,
904 L<Catalyst::Plugin::Authentication::CDBI::Basic>,
905 L<Catalyst::Plugin::Authentication::Basic::Remote>.
907 =head1 INCOMPATABILITIES
909 The realms based configuration and functionality of the 0.10 update
910 of L<Catalyst::Plugin::Authentication> required a change in the API used by
911 credentials and stores. It has a compatibility mode which allows use of
912 modules that have not yet been updated. This, however, completely mimics the
913 older api and disables the new realm-based features. In other words you can
914 not mix the older credential and store modules with realms, or realm-based
915 configs. The changes required to update modules are relatively minor and are
916 covered in L<Catalyst::Plugin::Authentication::Internals>. We hope that most
917 modules will move to the compatible list above very quickly.
919 =head1 COMPATIBILITY ROUTINES
921 In version 0.10 of L<Catalyst::Plugin::Authentication>, the API
922 changed. For app developers, this change is fairly minor, but for
923 Credential and Store authors, the changes are significant.
925 Please see the documentation in version 0.09 of
926 Catalyst::Plugin::Authentication for a better understanding of how the old API
929 The items below are still present in the plugin, though using them is
930 deprecated. They remain only as a transition tool, for those sites which can
931 not yet be upgraded to use the new system due to local customizations or use
932 of Credential / Store modules that have not yet been updated to work with the
935 These routines should not be used in any application using realms
936 functionality or any of the methods described above. These are for reference
943 This method is used to initiate authentication and user retrieval. Technically
944 this is part of the old Password credential module and it still resides in the
945 L<Password|Catalyst::Plugin::Authentication::Credential::Password> class. It is
946 included here for reference only.
948 =item default_auth_store
950 Return the store whose name is 'default'.
952 This is set to C<< $c->config->{authentication}{store} >> if that value exists,
953 or by using a Store plugin:
955 # load the Minimal authentication store.
956 use Catalyst qw/Authentication Authentication::Store::Minimal/;
958 Sets the default store to
959 L<Catalyst::Plugin::Authentication::Store::Minimal>.
961 =item get_auth_store $name
963 Return the store whose name is $name.
965 =item get_auth_store_name $store
967 Return the name of the store $store.
971 A hash keyed by name, with the stores registered in the app.
973 =item register_auth_stores %stores_by_name
975 Register stores into the application.
983 Yuval Kogman, C<nothingmuch@woobling.org>
985 Jay Kuri, C<jayk@cpan.org>
992 =head1 COPYRIGHT & LICENSE
994 Copyright (c) 2005 the aforementioned authors. All rights
995 reserved. This program is free software; you can redistribute
996 it and/or modify it under the same terms as Perl itself.