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 our $VERSION = "0.10009_01";
18 sub set_authenticated {
19 my ( $c, $user, $realmname ) = @_;
22 $c->request->{user} = $user; # compatibility kludge
25 $realmname = 'default';
27 my $realm = $c->get_auth_realm($realmname);
30 Catalyst::Exception->throw(
31 "set_authenticated called with nonexistant realm: '$realmname'.");
33 $user->auth_realm($realm->name);
37 $c->NEXT::set_authenticated($user, $realmname);
47 if ( defined($c->_user) ) {
50 return $c->auth_restore_user;
54 # change this to allow specification of a realm - to verify the user is part of that realm
55 # in addition to verifying that they exist.
58 return defined($c->_user) || defined($c->find_realm_for_persisted_user);
61 # works like user_exists - except only returns true if user
62 # exists AND is in the realm requested.
64 my ($c, $realmname) = @_;
66 if (defined($c->_user)) {
67 return ($c->_user->auth_realm eq $realmname);
69 my $realm = $c->find_realm_for_persisted_user;
71 return ($realm->name eq $realmname);
78 sub __old_save_user_in_session {
79 my ( $c, $user, $realmname ) = @_;
81 $c->session->{__user_realm} = $realmname;
83 # we want to ask the store for a user prepared for the session.
84 # but older modules split this functionality between the user and the
85 # store. We try the store first. If not, we use the old method.
86 my $realm = $c->get_auth_realm($realmname);
87 if ($realm->{'store'}->can('for_session')) {
88 $c->session->{__user} = $realm->{'store'}->for_session($c, $user);
90 $c->session->{__user} = $user->for_session;
97 if ($c->user_exists) {
99 ## if we have a valid session handler - we store the
100 ## realm in the session. If not - we have to hope that
101 ## the realm can recognize its frozen user somehow.
102 if ($c->isa("Catalyst::Plugin::Session") &&
103 $c->config->{'Plugin::Authentication'}{'use_session'} &&
104 $c->session_is_valid) {
106 $c->session->{'__user_realm'} = $c->_user->auth_realm;
109 my $realm = $c->get_auth_realm($c->_user->auth_realm);
111 # used to call $realm->save_user_in_session
112 $realm->persist_user($c, $c->user);
117 ## this was a short lived method to update user information -
118 ## you should use persist_user instead.
119 sub update_user_in_session {
122 return $c->persist_user;
130 my $realm = $c->find_realm_for_persisted_user;
132 $realm->remove_persisted_user($c);
135 $c->NEXT::logout(@_);
139 my ( $c, $userinfo, $realmname ) = @_;
141 $realmname ||= 'default';
142 my $realm = $c->get_auth_realm($realmname);
145 Catalyst::Exception->throw(
146 "find_user called with nonexistant realm: '$realmname'.");
148 return $realm->find_user($userinfo, $c);
151 ## Consider making this a public method. - would make certain things easier when
152 ## dealing with things pre-auth restore.
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 undef 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'};
232 if (!defined($cfg)) {
233 if (exists($app->config->{'authentication'})) {
234 $cfg = $app->config->{'authentication'};
235 $app->config->{'Plugin::Authentication'} = $app->config->{'authentication'};
240 # the realmshash contains the various configured realms. By default this is
241 # the main $app->config->{'Plugin::Authentication'} hash - but if that is
242 # not defined, or there is a subkey {'realms'} then we use that.
246 ## If we have a sub-key of {'realms'} then we use that for realm configuration
247 if (exists($cfg->{'realms'})) {
248 $realmshash = $cfg->{'realms'};
251 # old default was to force use_session on. This must remain for that
252 # reason - but if use_session is already in the config, we respect its setting.
253 if (!exists($cfg->{'use_session'})) {
254 $cfg->{'use_session'} = 1;
257 ## if we have a realms hash
258 if (ref($realmshash) eq 'HASH') {
260 my %auth_restore_order;
262 my $defaultrealm = 'default';
264 foreach my $realm (sort keys %{$realmshash}) {
265 if (ref($realmshash->{$realm}) eq 'HASH' &&
266 (exists($realmshash->{$realm}{credential}) || exists($realmshash->{$realm}{class}))) {
268 $app->setup_auth_realm($realm, $realmshash->{$realm});
270 if (exists($realmshash->{$realm}{'user_restore_priority'})) {
271 $auth_restore_order{$realm} = $realmshash->{$realm}{'user_restore_priority'};
273 $auth_restore_order{$realm} = $authcount++;
278 # if we have a 'default_realm' in the config hash and we don't already
279 # have a realm called 'default', we point default at the realm specified
280 if (exists($cfg->{'default_realm'}) && !$app->get_auth_realm('default')) {
281 if ($app->_set_default_auth_realm($cfg->{'default_realm'})) {
282 $defaultrealm = $cfg->{'default_realm'};
283 $auth_restore_order{'default'} = $auth_restore_order{$cfg->{'default_realm'}};
284 delete($auth_restore_order{$cfg->{'default_realm'}});
288 ## if the default realm did not have a defined priority in its config - we put it at the front.
289 if (!exists($realmshash->{$defaultrealm}{'user_restore_priority'})) {
290 $auth_restore_order{'default'} = 1;
293 @{$app->_auth_realm_restore_order} = sort { $auth_restore_order{$a} <=> $auth_restore_order{$b} } keys %auth_restore_order;
297 ## BACKWARDS COMPATIBILITY - if realms is not defined - then we are probably dealing
298 ## with an old-school config. The only caveat here is that we must add a classname
300 ## also - we have to treat {store} as {stores}{default} - because
301 ## while it is not a clear as a valid config in the docs, it
302 ## is functional with the old api. Whee!
303 if (exists($cfg->{'store'}) && !exists($cfg->{'stores'}{'default'})) {
304 $cfg->{'stores'}{'default'} = $cfg->{'store'};
307 push @{$app->_auth_realm_restore_order}, 'default';
308 foreach my $storename (keys %{$cfg->{'stores'}}) {
310 store => { class => $cfg->{'stores'}{$storename} },
312 print STDERR "Foo, ok?\n";
313 $app->setup_auth_realm($storename, $realmcfg);
320 sub setup_auth_realm {
321 my ($app, $realmname, $config) = @_;
323 my $realmclass = $config->{class};
326 $realmclass = 'Catalyst::Authentication::Realm';
327 } elsif ($realmclass !~ /^\+(.*)$/ ) {
328 $realmclass = "Catalyst::Authentication::Realm::${realmclass}";
333 Catalyst::Utils::ensure_class_loaded( $realmclass );
335 my $realm = $realmclass->new($realmname, $config, $app);
337 $app->auth_realms->{$realmname} = $realm;
339 $app->log->debug("realm initialization for '$realmname' failed.");
346 return($self->_auth_realms);
350 my ($app, $realmname) = @_;
352 return $app->auth_realms->{$realmname};
357 # Very internal method. Vital Valuable Urgent, Do not touch on pain of death.
358 # Using this method just assigns the default realm to be the value associated
359 # with the realmname provided. It WILL overwrite any real realm called 'default'
360 # so can be very confusing if used improperly. It's used properly already.
361 # Translation: don't use it.
362 sub _set_default_auth_realm {
363 my ($app, $realmname) = @_;
365 if (exists($app->auth_realms->{$realmname})) {
366 $app->auth_realms->{'default'} = $app->auth_realms->{$realmname};
368 return $app->get_auth_realm('default');
372 my ($app, $userinfo, $realmname) = @_;
375 $realmname = 'default';
378 my $realm = $app->get_auth_realm($realmname);
380 ## note to self - make authenticate throw an exception if realm is invalid.
383 return $realm->authenticate($app, $userinfo);
385 Catalyst::Exception->throw(
386 "authenticate called with nonexistant realm: '$realmname'.");
392 ## BACKWARDS COMPATIBILITY -- Warning: Here be monsters!
394 # What follows are backwards compatibility routines - for use with Stores and Credentials
395 # that have not been updated to work with C::P::Authentication v0.10.
396 # These are here so as to not break people's existing installations, but will go away
397 # in a future version.
399 # The old style of configuration only supports a single store, as each store module
400 # sets itself as the default store upon being loaded. This is the only supported
401 # 'compatibility' mode.
405 my ( $c, $uid, @rest ) = @_;
407 return $c->find_user( {'id' => $uid, 'rest'=>\@rest }, 'default' );
411 ## this should only be called when using old-style authentication plugins. IF this gets
412 ## called in a new-style config - it will OVERWRITE the store of your default realm. Don't do it.
413 ## also - this is a partial setup - because no credential is instantiated... in other words it ONLY
414 ## works with old-style auth plugins and C::P::Authentication in compatibility mode. Trying to combine
415 ## this with a realm-type config will probably crash your app.
416 sub default_auth_store {
419 my $realm = $self->get_auth_realm('default');
421 $realm = $self->setup_auth_realm('default', { class => 'Compatibility' });
423 if ( my $new = shift ) {
428 $storeclass = ref($new);
433 # BACKWARDS COMPATIBILITY - if the store class does not define find_user, we define it in terms
434 # of get_user and add it to the class. this is because the auth routines use find_user,
435 # and rely on it being present. (this avoids per-call checks)
436 if (!$storeclass->can('find_user')) {
438 *{"${storeclass}::find_user"} = sub {
439 my ($self, $info) = @_;
440 my @rest = @{$info->{rest}} if exists($info->{rest});
441 $self->get_user($info->{id}, @rest);
446 return $self->get_auth_realm('default')->store;
449 ## BACKWARDS COMPATIBILITY
450 ## this only ever returns a hash containing 'default' - as that is the only
451 ## supported mode of calling this.
452 sub auth_store_names {
455 my %hash = ( $self->get_auth_realm('default')->store => 'default' );
459 my ( $self, $name ) = @_;
461 if ($name ne 'default') {
462 Carp::croak "get_auth_store called on non-default realm '$name'. Only default supported in compatibility mode";
464 $self->default_auth_store();
468 sub get_auth_store_name {
469 my ( $self, $store ) = @_;
473 # sub auth_stores is only used internally - here for completeness
477 my %hash = ( 'default' => $self->get_auth_realm('default')->store);
488 Catalyst::Plugin::Authentication - Infrastructure plugin for the Catalyst
489 authentication framework.
498 $c->authenticate({ username => 'myusername',
499 password => 'mypassword' });
500 my $age = $c->user->get('age');
505 The authentication plugin provides generic user support for Catalyst apps. It
506 is the basis for both authentication (checking the user is who they claim to
507 be), and authorization (allowing the user to do what the system authorises
510 Using authentication is split into two parts. A Store is used to actually
511 store the user information, and can store any amount of data related to the
512 user. Credentials are used to verify users, using information from the store,
513 given data from the frontend. A Credential and a Store are paired to form a
514 'Realm'. A Catalyst application using the authentication framework must have
515 at least one realm, and may have several.
517 To implement authentication in a Catalyst application you need to add this
518 module, and specify at least one realm in the configuration.
520 Authentication data can also be stored in a session, if the application
521 is using the L<Catalyst::Plugin::Session> module.
523 B<NOTE> in version 0.10 of this module, the interface to this module changed.
524 Please see L</COMPATIBILITY ROUTINES> for more information.
528 =head2 The Authentication/Authorization Process
530 Web applications typically need to identify a user - to tell the user apart
531 from other users. This is usually done in order to display private information
532 that is only that user's business, or to limit access to the application so
533 that only certain entities can access certain parts.
535 This process is split up into several steps. First you ask the user to identify
536 themselves. At this point you can't be sure that the user is really who they
539 Then the user tells you who they are, and backs this claim with some piece of
540 information that only the real user could give you. For example, a password is
541 a secret that is known to both the user and you. When the user tells you this
542 password you can assume they're in on the secret and can be trusted (ignore
543 identity theft for now). Checking the password, or any other proof is called
544 B<credential verification>.
546 By this time you know exactly who the user is - the user's identity is
547 B<authenticated>. This is where this module's job stops, and your application
548 or other plugins step in.
550 The next logical step is B<authorization>, the process of deciding what a user
551 is (or isn't) allowed to do. For example, say your users are split into two
552 main groups - regular users and administrators. You want to verify that the
553 currently logged in user is indeed an administrator before performing the
554 actions in an administrative part of your application. These decisions may be
555 made within your application code using just the information available after
556 authentication, or it may be facilitated by a number of plugins.
558 =head2 The Components In This Framework
562 Configuration of the Catalyst::Plugin::Authentication framework is done in
563 terms of realms. In simplest terms, a realm is a pairing of a Credential
564 verifier and a User storage (Store) backend. As of version 0.10003, realms are
565 now objects that you can create and customize.
567 An application can have any number of Realms, each of which operates
568 independent of the others. Each realm has a name, which is used to identify it
569 as the target of an authentication request. This name can be anything, such as
570 'users' or 'members'. One realm must be defined as the default_realm, which is
571 used when no realm name is specified. More information about configuring
572 realms is available in the configuration section.
574 =head3 Credential Verifiers
576 When user input is transferred to the L<Catalyst> application
577 (typically via form inputs) the application may pass this information
578 into the authentication system through the C<< $c->authenticate() >>
579 method. From there, it is passed to the appropriate Credential
582 These plugins check the data, and ensure that it really proves the user is who
585 Credential verifiers compatible with versions of this module 0.10x and
586 upwards should be in the namespace
587 C<Catalyst::Authentication::Credential>.
589 =head3 Storage Backends
591 The authentication data also identifies a user, and the Storage backend modules
592 use this data to locate and return a standardized object-oriented
593 representation of a user.
595 When a user is retrieved from a store it is not necessarily authenticated.
596 Credential verifiers accept a set of authentication data and use this
597 information to retrieve the user from the store they are paired with.
599 Storage backends compatible with versions of this module 0.10x and
600 upwards should be in the namespace
601 C<Catalyst::Authentication::Store>.
603 =head3 The Core Plugin
605 This plugin on its own is the glue, providing realm configuration, session
606 integration, and other goodness for the other plugins.
610 More layers of plugins can be stacked on top of the authentication code. For
611 example, L<Catalyst::Plugin::Session::PerUser> provides an abstraction of
612 browser sessions that is more persistent per user.
613 L<Catalyst::Plugin::Authorization::Roles> provides an accepted way to separate
614 and group users into categories, and then check which categories the current
619 Let's say we were storing users in a simple Perl hash. Users are
620 verified by supplying a password which is matched within the hash.
622 This means that our application will begin like this:
630 __PACKAGE__->config->{'Plugin::Authentication'} =
635 password_field => 'password',
636 password_type => 'clear'
642 password => "s00p3r",
644 roles => [qw/edit delete/],
647 password => "s3cr3t",
648 roles => [qw/comment/],
655 This tells the authentication plugin what realms are available, which
656 credential and store modules are used, and the configuration of each. With
657 this code loaded, we can now attempt to authenticate users.
659 To show an example of this, let's create an authentication controller:
661 package MyApp::Controller::Auth;
664 my ( $self, $c ) = @_;
666 if ( my $user = $c->req->params->{user}
667 and my $password = $c->req->params->{password} )
669 if ( $c->authenticate( { username => $user,
670 password => $password } ) ) {
671 $c->res->body( "hello " . $c->user->get("name") );
681 This code should be self-explanatory. If all the necessary fields are supplied,
682 call the C<authenticate> method on the context object. If it succeeds the
685 The credential verifier will attempt to retrieve the user whose
686 details match the authentication information provided to
687 C<< $c->authenticate() >>. Once it fetches the user the password is
688 checked and if it matches the user will be B<authenticated> and
689 C<< $c->user >> will contain the user object retrieved from the store.
691 In the above case, the default realm is checked, but we could just as easily
692 check an alternate realm. If this were an admin login, for example, we could
693 authenticate on the admin realm by simply changing the C<< $c->authenticate() >>
696 if ( $c->authenticate( { username => $user,
697 password => $password }, 'admin' ) ) {
698 $c->res->body( "hello " . $c->user->get("name") );
702 Now suppose we want to restrict the ability to edit to a user with an
703 'editor' value of yes.
705 The restricted action might look like this:
708 my ( $self, $c ) = @_;
710 $c->detach("unauthorized")
711 unless $c->user_exists
712 and $c->user->get('editor') eq 'yes';
714 # do something restricted here
717 (Note that if you have multiple realms, you can use
718 C<< $c->user_in_realm('realmname') >> in place of
719 C<< $c->user_exists(); >> This will essentially perform the same
720 verification as user_exists, with the added requirement that if there
721 is a user, it must have come from the realm specified.)
723 The above example is somewhat similar to role based access control.
724 L<Catalyst::Authentication::Store::Minimal> treats the roles field as
725 an array of role names. Let's leverage this. Add the role authorization
734 my ( $self, $c ) = @_;
736 $c->detach("unauthorized") unless $c->check_user_roles("edit");
738 # do something restricted here
741 This is somewhat simpler and will work if you change your store, too, since the
742 role interface is consistent.
744 Let's say your app grows, and you now have 10,000 users. It's no longer
745 efficient to maintain a hash of users, so you move this data to a database.
746 You can accomplish this simply by installing the L<DBIx::Class|Catalyst::Authentication::Store::DBIx::Class> Store and
747 changing your config:
749 __PACKAGE__->config->{'Plugin::Authentication'} =
751 default_realm => 'members',
755 password_field => 'password',
756 password_type => 'clear'
759 class => 'DBIx::Class',
760 user_class => 'MyApp::Users',
761 role_column => 'roles'
766 The authentication system works behind the scenes to load your data from the
767 new source. The rest of your application is completely unchanged.
773 __PACKAGE__->config->{'Plugin::Authentication'} =
775 default_realm => 'members',
780 password_field => 'password',
781 password_type => 'clear'
784 class => 'DBIx::Class',
785 user_class => 'MyApp::Users',
786 role_column => 'roles'
792 password_field => 'password',
793 password_type => 'clear'
796 class => '+MyApp::Authentication::Store::NetAuth',
797 authserver => '192.168.10.17'
806 Whether or not to store the user's logged in state in the session, if the
807 application is also using L<Catalyst::Plugin::Session>. This
808 value is set to true per default.
812 This defines which realm should be used as when no realm is provided to methods
813 that require a realm such as authenticate or find_user.
817 The Plugin::Authentication config hash contains the series of realm
818 configurations you want to use for your app. The only rule here is
819 that there must be at least one. A realm consists of a name, which is used
820 to reference the realm, a credential and a store. You may also put your
821 realm configurations within a subelement called 'realms' if you desire to
822 separate them from the remainder of your configuration. Note that if you use
823 a 'realms' subelement, you must put ALL of your realms within it.
825 You can also specify a realm class to instantiate instead of the default
826 L<Catalyst::Authentication::Realm> class using the 'class' element within the
829 Each realm config contains two hashes, one called 'credential' and one called
830 'store', each of which provide configuration details to the respective modules.
831 The contents of these hashes is specific to the module being used, with the
832 exception of the 'class' element, which tells the core Authentication module the
833 classname to instantiate.
835 The 'class' element follows the standard Catalyst mechanism of class
836 specification. If a class is prefixed with a +, it is assumed to be a complete
837 class name. Otherwise it is considered to be a portion of the class name. For
838 credentials, the classname 'B<Password>', for example, is expanded to
839 Catalyst::Authentication::Credential::B<Password>. For stores, the
840 classname 'B<storename>' is expanded to:
841 Catalyst::Authentication::Store::B<storename>.
847 =head2 $c->authenticate( $userinfo [, $realm ])
849 Attempts to authenticate the user using the information in the $userinfo hash
850 reference using the realm $realm. $realm may be omitted, in which case the
851 default realm is checked.
855 Returns the currently logged in user, or undef if there is none.
857 =head2 $c->user_exists( )
859 Returns true if a user is logged in right now. The difference between
860 user_exists and user is that user_exists will return true if a user is logged
861 in, even if it has not been yet retrieved from the storage backend. If you only
862 need to know if the user is logged in, depending on the storage mechanism this
863 can be much more efficient.
865 =head2 $c->user_in_realm( $realm )
867 Works like user_exists, except that it only returns true if a user is both
868 logged in right now and was retrieved from the realm provided.
872 Logs the user out. Deletes the currently logged in user from C<< $c->user >> and the session.
874 =head2 $c->find_user( $userinfo, $realm )
876 Fetch a particular users details, matching the provided user info, from the realm
879 =head2 persist_user()
881 Under normal circumstances the user data is only saved to the session during
882 initial authentication. This call causes the auth system to save the
883 currently authenticated user's data across requests. Useful if you have
884 changed the user data and want to ensure that future requests reflect the
885 most current data. Assumes that at the time of this call, $c->user
886 contains the most current data.
888 =head2 find_realm_for_persisted_user()
890 Private method, do not call from user code!
892 =head1 INTERNAL METHODS
894 These methods are for Catalyst::Plugin::Authentication B<INTERNAL USE> only.
895 Please do not use them in your own code, whether application or credential /
896 store modules. If you do, you will very likely get the nasty shock of having
897 to fix / rewrite your code when things change. They are documented here only
900 =head2 $c->set_authenticated( $user, $realmname )
902 Marks a user as authenticated. This is called from within the authenticate
903 routine when a credential returns a user. $realmname defaults to 'default'
905 =head2 $c->auth_restore_user( $user, $realmname )
907 Used to restore a user from the session. In most cases this is called without
908 arguments to restore the user via the session. Can be called with arguments
909 when restoring a user from some other method. Currently not used in this way.
911 =head2 $c->auth_realms( )
913 Returns a hashref containing realmname -> realm instance pairs. Realm
914 instances contain an instantiated store and credential object as the 'store'
915 and 'credential' elements, respectively
917 =head2 $c->get_auth_realm( $realmname )
919 Retrieves the realm instance for the realmname provided.
921 =head2 $c->update_user_in_session
923 This was a short-lived method to update user information - you should use persist_user instead.
927 This list might not be up to date. Below are modules known to work with the updated
928 API of 0.10 and are therefore compatible with realms.
932 L<Catalyst::Authentication::Realm>
934 =head2 User Storage Backends
936 L<Catalyst::Authentication::Store::Minimal>,
937 L<Catalyst::Authentication::Store::DBIx::Class>,
939 =head2 Credential verification
941 L<Catalyst::Authentication::Credential::Password>,
945 L<Catalyst::Plugin::Authorization::ACL>,
946 L<Catalyst::Plugin::Authorization::Roles>
948 =head2 Internals Documentation
950 L<Catalyst::Plugin::Authentication::Internals>
954 L<Catalyst::Plugin::Session>,
955 L<Catalyst::Plugin::Session::PerUser>
957 =head1 DON'T SEE ALSO
959 This module along with its sub plugins deprecate a great number of other
960 modules. These include L<Catalyst::Plugin::Authentication::Simple>,
961 L<Catalyst::Plugin::Authentication::CDBI>.
963 At the time of writing these plugins have not yet been replaced or updated, but
964 should be eventually: L<Catalyst::Plugin::Authentication::OpenID>,
965 L<Catalyst::Plugin::Authentication::CDBI::Basic>,
966 L<Catalyst::Plugin::Authentication::Basic::Remote>.
968 =head1 INCOMPATABILITIES
970 The realms-based configuration and functionality of the 0.10 update
971 of L<Catalyst::Plugin::Authentication> required a change in the API used by
972 credentials and stores. It has a compatibility mode which allows use of
973 modules that have not yet been updated. This, however, completely mimics the
974 older api and disables the new realm-based features. In other words you cannot
975 mix the older credential and store modules with realms, or realm-based
976 configs. The changes required to update modules are relatively minor and are
977 covered in L<Catalyst::Plugin::Authentication::Internals>. We hope that most
978 modules will move to the compatible list above very quickly.
980 =head1 COMPATIBILITY ROUTINES
982 In version 0.10 of L<Catalyst::Plugin::Authentication>, the API
983 changed. For app developers, this change is fairly minor, but for
984 Credential and Store authors, the changes are significant.
986 Please see the documentation in version 0.09 of
987 Catalyst::Plugin::Authentication for a better understanding of how the old API
990 The items below are still present in the plugin, though using them is
991 deprecated. They remain only as a transition tool, for those sites which can
992 not yet be upgraded to use the new system due to local customizations or use
993 of Credential / Store modules that have not yet been updated to work with the
996 These routines should not be used in any application using realms
997 functionality or any of the methods described above. These are for reference
1002 This method is used to initiate authentication and user retrieval. Technically
1003 this is part of the old Password credential module and it still resides in the
1004 L<Password|Catalyst::Plugin::Authentication::Credential::Password> class. It is
1005 included here for reference only.
1007 =head2 $c->default_auth_store( )
1009 Return the store whose name is 'default'.
1011 This is set to C<< $c->config->{'Plugin::Authentication'}{store} >> if that value exists,
1012 or by using a Store plugin:
1014 # load the Minimal authentication store.
1015 use Catalyst qw/Authentication Authentication::Store::Minimal/;
1017 Sets the default store to
1018 L<Catalyst::Plugin::Authentication::Store::Minimal>.
1020 =head2 $c->get_auth_store( $name )
1022 Return the store whose name is $name.
1024 =head2 $c->get_auth_store_name( $store )
1026 Return the name of the store $store.
1028 =head2 $c->auth_stores( )
1030 A hash keyed by name, with the stores registered in the app.
1032 =head2 $c->register_auth_stores( %stores_by_name )
1034 Register stores into the application.
1036 =head2 $c->auth_store_names( )
1038 =head2 $c->get_user( )
1042 =head2 $c->setup_auth_realm( )
1046 Yuval Kogman, C<nothingmuch@woobling.org>
1048 Jay Kuri, C<jayk@cpan.org>
1054 Tomas Doran (t0m), C<bobtfish@bobtfish.net>
1056 =head1 COPYRIGHT & LICENSE
1058 Copyright (c) 2005 the aforementioned authors. All rights
1059 reserved. This program is free software; you can redistribute
1060 it and/or modify it under the same terms as Perl itself.