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;
17 our $VERSION = "0.11000";
19 sub set_authenticated {
20 my ( $c, $user, $realmname ) = @_;
23 $c->request->{user} = $user; # compatibility kludge
26 $realmname = 'default';
28 my $realm = $c->get_auth_realm($realmname);
31 Catalyst::Exception->throw(
32 "set_authenticated called with nonexistant realm: '$realmname'.");
34 $user->auth_realm($realm->name);
38 $c->NEXT::set_authenticated($user, $realmname);
48 if ( defined($c->_user) ) {
51 return $c->auth_restore_user;
55 # change this to allow specification of a realm - to verify the user is part of that realm
56 # in addition to verifying that they exist.
59 return defined($c->_user) || defined($c->_find_realm_for_persisted_user);
62 # works like user_exists - except only returns true if user
63 # exists AND is in the realm requested.
65 my ($c, $realmname) = @_;
67 if (defined($c->_user)) {
68 return ($c->_user->auth_realm eq $realmname);
70 my $realm = $c->_find_realm_for_persisted_user;
72 return ($realm->name eq $realmname);
79 sub __old_save_user_in_session {
80 my ( $c, $user, $realmname ) = @_;
82 $c->session->{__user_realm} = $realmname;
84 # we want to ask the store for a user prepared for the session.
85 # but older modules split this functionality between the user and the
86 # store. We try the store first. If not, we use the old method.
87 my $realm = $c->get_auth_realm($realmname);
88 if ($realm->{'store'}->can('for_session')) {
89 $c->session->{__user} = $realm->{'store'}->for_session($c, $user);
91 $c->session->{__user} = $user->for_session;
98 if ($c->user_exists) {
100 ## if we have a valid session handler - we store the
101 ## realm in the session. If not - we have to hope that
102 ## the realm can recognize it's frozen user somehow.
103 if ($c->isa("Catalyst::Plugin::Session") &&
104 $c->config->{'Plugin::Authentication'}{'use_session'} &&
105 $c->session_is_valid) {
107 $c->session->{'__user_realm'} = $c->_user->auth_realm;
110 my $realm = $c->get_auth_realm($c->_user->auth_realm);
112 # used to call $realm->save_user_in_session
113 $realm->persist_user($c, $c->user);
118 ## this was a short lived method to update user information -
119 ## you should use persist_user instead.
120 sub update_user_in_session {
123 return $c->persist_user;
131 my $realm = $c->_find_realm_for_persisted_user;
133 $realm->remove_persisted_user($c);
136 $c->NEXT::logout(@_);
140 my ( $c, $userinfo, $realmname ) = @_;
142 $realmname ||= 'default';
143 my $realm = $c->get_auth_realm($realmname);
146 Catalyst::Exception->throw(
147 "find_user called with nonexistant realm: '$realmname'.");
149 return $realm->find_user($userinfo, $c);
153 sub _find_realm_for_persisted_user {
157 if ($c->isa("Catalyst::Plugin::Session")
158 and $c->config->{'Plugin::Authentication'}{'use_session'}
159 and $c->session_is_valid
160 and exists($c->session->{'__user_realm'})) {
162 $realm = $c->auth_realms->{$c->session->{'__user_realm'}};
163 if ($realm->user_is_restorable($c)) {
167 ## we have no choice but to ask each realm whether it has a persisted user.
168 foreach my $realmname (@{$c->_auth_realm_restore_order}) {
169 my $ret = $c->auth_realms->{$realmname}->user_is_restorable($c);
171 return $c->auth_realms->{$realmname};
178 sub auth_restore_user {
179 my ( $c, $frozen_user, $realmname ) = @_;
182 if (defined($realmname)) {
183 $realm = $c->get_auth_realm($realmname);
185 $realm = $c->_find_realm_for_persisted_user;
187 return unless $realm; # FIXME die unless? This is an internal inconsistency
189 $c->_user( my $user = $realm->restore_user( $c, $frozen_user ) );
191 # this sets the realm the user originated in.
192 $user->auth_realm($realm->name);
198 # we can't actually do our setup in setup because the model has not yet been loaded.
199 # So we have to trigger off of setup_finished. :-(
203 $app->_authentication_initialize();
204 $app->NEXT::setup(@_);
207 ## the actual initialization routine. whee.
208 sub _authentication_initialize {
211 ## let's avoid recreating / configuring everything if we have already done it, eh?
212 if ($app->can('_auth_realms')) { return };
214 ## make classdata where it is used.
215 $app->mk_classdata( '_auth_realms' => {});
217 ## the order to attempt restore in - If we don't have session - we have
218 ## no way to be sure where a frozen user came from - so we have to
219 ## ask each realm if it can restore the user. Unfortunately it is possible
220 ## that multiple realms could restore the user from the data we have -
221 ## So we have to determine at setup time what order to ask the realms in.
222 ## The default is to use the user_restore_priority values defined in the realm
223 ## config. if they are not defined - we go by alphabetical order. Note that
224 ## the 'default' realm always gets first chance at it unless it is explicitly
225 ## placed elsewhere by user_restore_priority. Remember this only comes
226 ## into play if session is disabled.
228 $app->mk_classdata( '_auth_realm_restore_order' => []);
230 my $cfg = $app->config->{'Plugin::Authentication'};
231 if (!defined($cfg)) {
232 if (exists($app->config->{'authentication'})) {
233 $cfg = $app->config->{'authentication'};
234 $app->config->{'Plugin::Authentication'} = $app->config->{'authentication'};
240 # old default was to force use_session on. This must remain for that
241 # reason - but if use_session is already in the config, we respect it's setting.
242 if (!exists($cfg->{'use_session'})) {
243 $cfg->{'use_session'} = 1;
246 if (exists($cfg->{'realms'})) {
248 my %auth_restore_order;
250 my $defaultrealm = 'default';
252 foreach my $realm (sort keys %{$cfg->{'realms'}}) {
254 $app->setup_auth_realm($realm, $cfg->{'realms'}{$realm});
256 if (exists($cfg->{'realms'}{$realm}{'user_restore_priority'})) {
257 $auth_restore_order{$realm} = $cfg->{'realms'}{$realm}{'user_restore_priority'};
259 $auth_restore_order{$realm} = $authcount++;
263 # if we have a 'default_realm' in the config hash and we don't already
264 # have a realm called 'default', we point default at the realm specified
265 if (exists($cfg->{'default_realm'}) && !$app->get_auth_realm('default')) {
266 if ($app->_set_default_auth_realm($cfg->{'default_realm'})) {
267 $defaultrealm = $cfg->{'default_realm'};
268 $auth_restore_order{'default'} = $auth_restore_order{$cfg->{'default_realm'}};
269 delete($auth_restore_order{$cfg->{'default_realm'}});
273 ## if the default realm did not have a defined priority in it's config - we put it at the front.
274 if (!exists($cfg->{'realms'}{$defaultrealm}{'user_restore_priority'})) {
275 $auth_restore_order{'default'} = 1;
278 @{$app->_auth_realm_restore_order} = sort { $auth_restore_order{$a} <=> $auth_restore_order{$b} } keys %auth_restore_order;
282 ## BACKWARDS COMPATIBILITY - if realms is not defined - then we are probably dealing
283 ## with an old-school config. The only caveat here is that we must add a classname
285 ## also - we have to treat {store} as {stores}{default} - because
286 ## while it is not a clear as a valid config in the docs, it
287 ## is functional with the old api. Whee!
288 if (exists($cfg->{'store'}) && !exists($cfg->{'stores'}{'default'})) {
289 $cfg->{'stores'}{'default'} = $cfg->{'store'};
292 push @{$app->_auth_realm_restore_order}, 'default';
293 foreach my $storename (keys %{$cfg->{'stores'}}) {
295 store => { class => $cfg->{'stores'}{$storename} },
297 print STDERR "Foo, ok?\n";
298 $app->setup_auth_realm($storename, $realmcfg);
305 sub setup_auth_realm {
306 my ($app, $realmname, $config) = @_;
308 my $realmclass = $config->{class};
311 $realmclass = 'Catalyst::Authentication::Realm';
312 } elsif ($realmclass !~ /^\+(.*)$/ ) {
313 $realmclass = "Catalyst::Authentication::Realm::${realmclass}";
318 Catalyst::Utils::ensure_class_loaded( $realmclass );
320 my $realm = $realmclass->new($realmname, $config, $app);
322 $app->auth_realms->{$realmname} = $realm;
324 $app->log->debug("realm initialization for '$realmname' failed.");
331 return($self->_auth_realms);
335 my ($app, $realmname) = @_;
337 return $app->auth_realms->{$realmname};
342 # Very internal method. Vital Valuable Urgent, Do not touch on pain of death.
343 # Using this method just assigns the default realm to be the value associated
344 # with the realmname provided. It WILL overwrite any real realm called 'default'
345 # so can be very confusing if used improperly. It's used properly already.
346 # Translation: don't use it.
347 sub _set_default_auth_realm {
348 my ($app, $realmname) = @_;
350 if (exists($app->auth_realms->{$realmname})) {
351 $app->auth_realms->{'default'} = $app->auth_realms->{$realmname};
353 return $app->get_auth_realm('default');
357 my ($app, $userinfo, $realmname) = @_;
360 $realmname = 'default';
363 my $realm = $app->get_auth_realm($realmname);
365 ## note to self - make authenticate throw an exception if realm is invalid.
368 return $realm->authenticate($app, $userinfo);
370 Catalyst::Exception->throw(
371 "authenticate called with nonexistant realm: '$realmname'.");
377 ## BACKWARDS COMPATIBILITY -- Warning: Here be monsters!
379 # What follows are backwards compatibility routines - for use with Stores and Credentials
380 # that have not been updated to work with C::P::Authentication v0.10.
381 # These are here so as to not break people's existing installations, but will go away
382 # in a future version.
384 # The old style of configuration only supports a single store, as each store module
385 # sets itself as the default store upon being loaded. This is the only supported
386 # 'compatibility' mode.
390 my ( $c, $uid, @rest ) = @_;
392 return $c->find_user( {'id' => $uid, 'rest'=>\@rest }, 'default' );
396 ## this should only be called when using old-style authentication plugins. IF this gets
397 ## called in a new-style config - it will OVERWRITE the store of your default realm. Don't do it.
398 ## also - this is a partial setup - because no credential is instantiated... in other words it ONLY
399 ## works with old-style auth plugins and C::P::Authentication in compatibility mode. Trying to combine
400 ## this with a realm-type config will probably crash your app.
401 sub default_auth_store {
404 my $realm = $self->get_auth_realm('default');
406 $realm = $self->setup_auth_realm('default', { class => 'Compatibility' });
408 if ( my $new = shift ) {
413 $storeclass = ref($new);
418 # BACKWARDS COMPATIBILITY - if the store class does not define find_user, we define it in terms
419 # of get_user and add it to the class. this is because the auth routines use find_user,
420 # and rely on it being present. (this avoids per-call checks)
421 if (!$storeclass->can('find_user')) {
423 *{"${storeclass}::find_user"} = sub {
424 my ($self, $info) = @_;
425 my @rest = @{$info->{rest}} if exists($info->{rest});
426 $self->get_user($info->{id}, @rest);
431 return $self->get_auth_realm('default')->store;
434 ## BACKWARDS COMPATIBILITY
435 ## this only ever returns a hash containing 'default' - as that is the only
436 ## supported mode of calling this.
437 sub auth_store_names {
440 my %hash = ( $self->get_auth_realm('default')->store => 'default' );
444 my ( $self, $name ) = @_;
446 if ($name ne 'default') {
447 Carp::croak "get_auth_store called on non-default realm '$name'. Only default supported in compatibility mode";
449 $self->default_auth_store();
453 sub get_auth_store_name {
454 my ( $self, $store ) = @_;
458 # sub auth_stores is only used internally - here for completeness
462 my %hash = ( 'default' => $self->get_auth_realm('default')->store);
473 Catalyst::Plugin::Authentication - Infrastructure plugin for the Catalyst
474 authentication framework.
483 $c->authenticate({ username => 'myusername',
484 password => 'mypassword' });
485 my $age = $c->user->get('age');
490 The authentication plugin provides generic user support for Catalyst apps. It
491 is the basis for both authentication (checking the user is who they claim to
492 be), and authorization (allowing the user to do what the system authorises
495 Using authentication is split into two parts. A Store is used to actually
496 store the user information, and can store any amount of data related to the
497 user. Credentials are used to verify users, using information from the store,
498 given data from the frontend. A Credential and a Store are paired to form a
499 'Realm'. A Catalyst application using the authentication framework must have
500 at least one realm, and may have several.
502 To implement authentication in a Catalyst application you need to add this
503 module, and specify at least one realm in the configuration.
505 Authentication data can also be stored in a session, if the application
506 is using the L<Catalyst::Plugin::Session> module.
508 B<NOTE> in version 0.10 of this module, the interface to this module changed.
509 Please see L</COMPATIBILITY ROUTINES> for more information.
513 =head2 The Authentication/Authorization Process
515 Web applications typically need to identify a user - to tell the user apart
516 from other users. This is usually done in order to display private information
517 that is only that user's business, or to limit access to the application so
518 that only certain entities can access certain parts.
520 This process is split up into several steps. First you ask the user to identify
521 themselves. At this point you can't be sure that the user is really who they
524 Then the user tells you who they are, and backs this claim with some piece of
525 information that only the real user could give you. For example, a password is
526 a secret that is known to both the user and you. When the user tells you this
527 password you can assume they're in on the secret and can be trusted (ignore
528 identity theft for now). Checking the password, or any other proof is called
529 B<credential verification>.
531 By this time you know exactly who the user is - the user's identity is
532 B<authenticated>. This is where this module's job stops, and your application
533 or other plugins step in.
535 The next logical step is B<authorization>, the process of deciding what a user
536 is (or isn't) allowed to do. For example, say your users are split into two
537 main groups - regular users and administrators. You want to verify that the
538 currently logged in user is indeed an administrator before performing the
539 actions in an administrative part of your application. These decisions may be
540 made within your application code using just the information available after
541 authentication, or it may be facilitated by a number of plugins.
543 =head2 The Components In This Framework
547 Configuration of the Catalyst::Plugin::Authentication framework is done in
548 terms of realms. In simplest terms, a realm is a pairing of a Credential
549 verifier and a User storage (Store) backend. As of version 0.10003, realms are
550 now objects that you can create and customize.
552 An application can have any number of Realms, each of which operates
553 independant of the others. Each realm has a name, which is used to identify it
554 as the target of an authentication request. This name can be anything, such as
555 'users' or 'members'. One realm must be defined as the default_realm, which is
556 used when no realm name is specified. More information about configuring
557 realms is available in the configuration section.
559 =head3 Credential Verifiers
561 When user input is transferred to the L<Catalyst> application
562 (typically via form inputs) the application may pass this information
563 into the authentication system through the C<<$c->authenticate()>>
564 method. From there, it is passed to the appropriate Credential
567 These plugins check the data, and ensure that it really proves the user is who
570 Credential verifiers compatible with versions of this module 0.10x and
571 upwards should be in the namespace
572 C<Catalyst::Authentication::Credential>.
574 =head3 Storage Backends
576 The authentication data also identifies a user, and the Storage backend modules
577 use this data to locate and return a standardized object-oriented
578 representation of a user.
580 When a user is retrieved from a store it is not necessarily authenticated.
581 Credential verifiers accept a set of authentication data and use this
582 information to retrieve the user from the store they are paired with.
584 storage backends compatible with versions of this module 0.10x and
585 upwards should be in the namespace
586 C<Catalyst::Authentication::Store>.
588 =head3 The Core Plugin
590 This plugin on its own is the glue, providing realm configuration, session
591 integration, and other goodness for the other plugins.
595 More layers of plugins can be stacked on top of the authentication code. For
596 example, L<Catalyst::Plugin::Session::PerUser> provides an abstraction of
597 browser sessions that is more persistent per user.
598 L<Catalyst::Plugin::Authorization::Roles> provides an accepted way to separate
599 and group users into categories, and then check which categories the current
604 Let's say we were storing users in a simple perl hash. Users are
605 verified by supplying a password which is matched within the hash.
607 This means that our application will begin like this:
615 __PACKAGE__->config->{'Plugin::Authentication'} =
617 default_realm => 'members',
622 password_field => 'password',
623 password_type => 'clear'
629 password => "s00p3r",
631 roles => [qw/edit delete/],
634 password => "s3cr3t",
635 roles => [qw/comment/],
644 This tells the authentication plugin what realms are available, which
645 credential and store modules are used, and the configuration of each. With
646 this code loaded, we can now attempt to authenticate users.
648 To show an example of this, let's create an authentication controller:
650 package MyApp::Controller::Auth;
653 my ( $self, $c ) = @_;
655 if ( my $user = $c->req->param("user")
656 and my $password = $c->req->param("password") )
658 if ( $c->authenticate( { username => $user,
659 password => $password } ) ) {
660 $c->res->body( "hello " . $c->user->get("name") );
670 This code should be self-explanatory. If all the necessary fields are supplied,
671 call the C<authenticate> method on the context object. If it succeeds the
674 The credential verifier will attempt to retrieve the user whose
675 details match the authentication information provided to
676 C<<$c->authenticate()>>. Once it fetches the user the password is
677 checked and if it matches the user will be B<authenticated> and
678 C<<$c->user>> will contain the user object retrieved from the store.
680 In the above case, the default realm is checked, but we could just as easily
681 check an alternate realm. If this were an admin login, for example, we could
682 authenticate on the admin realm by simply changing the C<<$c->authenticate()>>
685 if ( $c->authenticate( { username => $user,
686 password => $password }, 'admin' ) ) {
687 $c->res->body( "hello " . $c->user->get("name") );
691 Now suppose we want to restrict the ability to edit to a user with an
692 'editor' value of yes.
694 The restricted action might look like this:
697 my ( $self, $c ) = @_;
699 $c->detach("unauthorized")
700 unless $c->user_exists
701 and $c->user->get('editor') eq 'yes';
703 # do something restricted here
706 (Note that if you have multiple realms, you can use
707 C<<$c->user_in_realm('realmname')>>) in place of
708 C<<$c->user_exists();>> This will essentially perform the same
709 verification as user_exists, with the added requirement that if there
710 is a user, it must have come from the realm specified.)
712 The above example is somewhat similar to role based access control.
713 L<Catalyst::Authentication::Store::Minimal> treats the roles field as
714 an array of role names. Let's leverage this. Add the role authorization
723 my ( $self, $c ) = @_;
725 $c->detach("unauthorized") unless $c->check_user_roles("edit");
727 # do something restricted here
730 This is somewhat simpler and will work if you change your store, too, since the
731 role interface is consistent.
733 Let's say your app grew, and you now have 10000 users. It's no longer
734 efficient to maintain a hash of users, so you move this data to a database.
735 You can accomplish this simply by installing the L<DBIx::Class|Catalyst::Authentication::Store::DBIx::Class> Store and
736 changing your config:
738 __PACKAGE__->config->{'Plugin::Authentication'} =
740 default_realm => 'members',
745 password_field => 'password',
746 password_type => 'clear'
749 class => 'DBIx::Class',
750 user_class => 'MyApp::Users',
751 role_column => 'roles'
757 The authentication system works behind the scenes to load your data from the
758 new source. The rest of your application is completely unchanged.
764 __PACKAGE__->config->{'Plugin::Authentication'} =
766 default_realm => 'members',
771 password_field => 'password',
772 password_type => 'clear'
775 class => 'DBIx::Class',
776 user_class => 'MyApp::Users',
777 role_column => 'roles'
783 password_field => 'password',
784 password_type => 'clear'
787 class => '+MyApp::Authentication::Store::NetAuth',
788 authserver => '192.168.10.17'
799 Whether or not to store the user's logged in state in the session, if the
800 application is also using L<Catalyst::Plugin::Session>. This
801 value is set to true per default.
805 This defines which realm should be used as when no realm is provided to methods
806 that require a realm such as authenticate or find_user.
810 This contains the series of realm configurations you want to use for your app.
811 The only rule here is that there must be at least one. A realm consists of a
812 name, which is used to reference the realm, a credential and a store.
814 You can also specify a realm class to instantiate instead of the default
815 L<Catalyst::Authentication::Realm> class using the 'class' element within the
818 Each realm config contains two hashes, one called 'credential' and one called
819 'store', each of which provide configuration details to the respective modules.
820 The contents of these hashes is specific to the module being used, with the
821 exception of the 'class' element, which tells the core Authentication module the
822 classname to instantiate.
824 The 'class' element follows the standard Catalyst mechanism of class
825 specification. If a class is prefixed with a +, it is assumed to be a complete
826 class name. Otherwise it is considered to be a portion of the class name. For
827 credentials, the classname 'B<Password>', for example, is expanded to
828 Catalyst::Authentication::Credential::B<Password>. For stores, the
829 classname 'B<storename>' is expanded to:
830 Catalyst::Authentication::Store::B<storename>.
836 =head2 $c->authenticate( $userinfo, [ $realm ])
838 Attempts to authenticate the user using the information in the $userinfo hash
839 reference using the realm $realm. $realm may be omitted, in which case the
840 default realm is checked.
844 Returns the currently logged in user or undef if there is none.
846 =head2 $c->user_exists( )
848 Returns true if a user is logged in right now. The difference between
849 user_exists and user is that user_exists will return true if a user is logged
850 in, even if it has not been yet retrieved from the storage backend. If you only
851 need to know if the user is logged in, depending on the storage mechanism this
852 can be much more efficient.
854 =head2 $c->user_in_realm( $realm )
856 Works like user_exists, except that it only returns true if a user is both
857 logged in right now and was retrieved from the realm provided.
861 Logs the user out, Deletes the currently logged in user from C<<$c->user>> and the session.
863 =head2 $c->find_user( $userinfo, $realm )
865 Fetch a particular users details, matching the provided user info, from the realm
868 =head2 persist_user()
870 Under normal circumstances the user data is only saved to the session during
871 initial authentication. This call causes the auth system to save the
872 currently authenticated users data across requests. Useful if you have
873 changed the user data and want to ensure that future requests reflect the
874 most current data. Assumes that at the time of this call, $c->user
875 contains the most current data.
877 =head1 INTERNAL METHODS
879 These methods are for Catalyst::Plugin::Authentication B<INTERNAL USE> only.
880 Please do not use them in your own code, whether application or credential /
881 store modules. If you do, you will very likely get the nasty shock of having
882 to fix / rewrite your code when things change. They are documented here only
885 =head2 $c->set_authenticated( $user, $realmname )
887 Marks a user as authenticated. This is called from within the authenticate
888 routine when a credential returns a user. $realmname defaults to 'default'
890 =head2 $c->auth_restore_user( $user, $realmname )
892 Used to restore a user from the session. In most cases this is called without
893 arguments to restore the user via the session. Can be called with arguments
894 when restoring a user from some other method. Currently not used in this way.
896 =head2 $c->auth_realms( )
898 Returns a hashref containing realmname -> realm instance pairs. Realm
899 instances contain an instantiated store and credential object as the 'store'
900 and 'credential' elements, respectively
902 =head2 $c->get_auth_realm( $realmname )
904 Retrieves the realm instance for the realmname provided.
908 This list might not be up to date. Below are modules known to work with the updated
909 API of 0.10 and are therefore compatible with realms.
913 L<Catalyst::Authentication::Realm>
915 =head2 User Storage Backends
917 L<Catalyst::Authentication::Store::Minimal>,
918 L<Catalyst::Authentication::Store::DBIx::Class>,
920 =head2 Credential verification
922 L<Catalyst::Authentication::Credential::Password>,
926 L<Catalyst::Plugin::Authorization::ACL>,
927 L<Catalyst::Plugin::Authorization::Roles>
929 =head2 Internals Documentation
931 L<Catalyst::Plugin::Authentication::Internals>
935 L<Catalyst::Plugin::Session>,
936 L<Catalyst::Plugin::Session::PerUser>
938 =head1 DON'T SEE ALSO
940 This module along with its sub plugins deprecate a great number of other
941 modules. These include L<Catalyst::Plugin::Authentication::Simple>,
942 L<Catalyst::Plugin::Authentication::CDBI>.
944 At the time of writing these plugins have not yet been replaced or updated, but
945 should be eventually: L<Catalyst::Plugin::Authentication::OpenID>,
946 L<Catalyst::Plugin::Authentication::LDAP>,
947 L<Catalyst::Plugin::Authentication::CDBI::Basic>,
948 L<Catalyst::Plugin::Authentication::Basic::Remote>.
950 =head1 INCOMPATABILITIES
952 The realms based configuration and functionality of the 0.10 update
953 of L<Catalyst::Plugin::Authentication> required a change in the API used by
954 credentials and stores. It has a compatibility mode which allows use of
955 modules that have not yet been updated. This, however, completely mimics the
956 older api and disables the new realm-based features. In other words you can
957 not mix the older credential and store modules with realms, or realm-based
958 configs. The changes required to update modules are relatively minor and are
959 covered in L<Catalyst::Plugin::Authentication::Internals>. We hope that most
960 modules will move to the compatible list above very quickly.
962 =head1 COMPATIBILITY ROUTINES
964 In version 0.10 of L<Catalyst::Plugin::Authentication>, the API
965 changed. For app developers, this change is fairly minor, but for
966 Credential and Store authors, the changes are significant.
968 Please see the documentation in version 0.09 of
969 Catalyst::Plugin::Authentication for a better understanding of how the old API
972 The items below are still present in the plugin, though using them is
973 deprecated. They remain only as a transition tool, for those sites which can
974 not yet be upgraded to use the new system due to local customizations or use
975 of Credential / Store modules that have not yet been updated to work with the
978 These routines should not be used in any application using realms
979 functionality or any of the methods described above. These are for reference
984 This method is used to initiate authentication and user retrieval. Technically
985 this is part of the old Password credential module and it still resides in the
986 L<Password|Catalyst::Plugin::Authentication::Credential::Password> class. It is
987 included here for reference only.
989 =head2 $c->default_auth_store( )
991 Return the store whose name is 'default'.
993 This is set to C<< $c->config->{'Plugin::Authentication'}{store} >> if that value exists,
994 or by using a Store plugin:
996 # load the Minimal authentication store.
997 use Catalyst qw/Authentication Authentication::Store::Minimal/;
999 Sets the default store to
1000 L<Catalyst::Plugin::Authentication::Store::Minimal>.
1002 =head2 $c->get_auth_store( $name )
1004 Return the store whose name is $name.
1006 =head2 $c->get_auth_store_name( $store )
1008 Return the name of the store $store.
1010 =head2 $c->auth_stores( )
1012 A hash keyed by name, with the stores registered in the app.
1014 =head2 $c->register_auth_stores( %stores_by_name )
1016 Register stores into the application.
1018 =head2 $c->auth_store_names( )
1020 =head2 $c->get_user( )
1024 =head2 $c->setup_auth_realm( )
1028 Yuval Kogman, C<nothingmuch@woobling.org>
1030 Jay Kuri, C<jayk@cpan.org>
1036 =head1 COPYRIGHT & LICENSE
1038 Copyright (c) 2005 the aforementioned authors. All rights
1039 reserved. This program is free software; you can redistribute
1040 it and/or modify it under the same terms as Perl itself.