1 package Catalyst::Plugin::Authentication;
6 use Catalyst::Authentication::Realm;
7 use namespace::autoclean;
9 has _user => ( is => 'rw' );
11 our $VERSION = "0.10016";
13 sub set_authenticated {
14 my ( $c, $user, $realmname ) = @_;
17 $c->request->{user} = $user; # compatibility kludge
20 $realmname = 'default';
22 my $realm = $c->get_auth_realm($realmname);
25 Catalyst::Exception->throw(
26 "set_authenticated called with nonexistant realm: '$realmname'.");
28 $user->auth_realm($realm->name);
32 $c->maybe::next::method($user, $realmname);
42 if ( defined($c->_user) ) {
45 return $c->auth_restore_user;
49 # change this to allow specification of a realm - to verify the user is part of that realm
50 # in addition to verifying that they exist.
53 return defined($c->_user) || defined($c->find_realm_for_persisted_user);
56 # works like user_exists - except only returns true if user
57 # exists AND is in the realm requested.
59 my ($c, $realmname) = @_;
61 if (defined($c->_user)) {
62 return ($c->_user->auth_realm eq $realmname);
64 my $realm = $c->find_realm_for_persisted_user;
66 return ($realm->name eq $realmname);
73 sub __old_save_user_in_session {
74 my ( $c, $user, $realmname ) = @_;
76 $c->session->{__user_realm} = $realmname;
78 # we want to ask the store for a user prepared for the session.
79 # but older modules split this functionality between the user and the
80 # store. We try the store first. If not, we use the old method.
81 my $realm = $c->get_auth_realm($realmname);
82 if ($realm->{'store'}->can('for_session')) {
83 $c->session->{__user} = $realm->{'store'}->for_session($c, $user);
85 $c->session->{__user} = $user->for_session;
92 if ($c->user_exists) {
94 ## if we have a valid session handler - we store the
95 ## realm in the session. If not - we have to hope that
96 ## the realm can recognize its frozen user somehow.
97 if ($c->can('session') &&
98 $c->config->{'Plugin::Authentication'}{'use_session'} &&
99 $c->session_is_valid) {
101 $c->session->{'__user_realm'} = $c->_user->auth_realm;
104 my $realm = $c->get_auth_realm($c->_user->auth_realm);
106 # used to call $realm->save_user_in_session
107 $realm->persist_user($c, $c->user);
112 ## this was a short lived method to update user information -
113 ## you should use persist_user instead.
114 sub update_user_in_session {
117 return $c->persist_user;
125 my $realm = $c->find_realm_for_persisted_user;
127 $realm->remove_persisted_user($c);
130 $c->maybe::next::method(@_);
134 my ( $c, $userinfo, $realmname ) = @_;
136 $realmname ||= 'default';
137 my $realm = $c->get_auth_realm($realmname);
140 Catalyst::Exception->throw(
141 "find_user called with nonexistant realm: '$realmname'.");
143 return $realm->find_user($userinfo, $c);
146 ## Consider making this a public method. - would make certain things easier when
147 ## dealing with things pre-auth restore.
148 sub find_realm_for_persisted_user {
152 if ($c->can('session')
153 and $c->config->{'Plugin::Authentication'}{'use_session'}
154 and $c->session_is_valid
155 and exists($c->session->{'__user_realm'})) {
157 $realm = $c->auth_realms->{$c->session->{'__user_realm'}};
158 if ($realm->user_is_restorable($c)) {
162 ## we have no choice but to ask each realm whether it has a persisted user.
163 foreach my $realmname (@{$c->_auth_realm_restore_order}) {
164 my $realm = $c->auth_realms->{$realmname}
165 || Catalyst::Exception->throw("Could not find authentication realm '$realmname'");
167 if $realm->user_is_restorable($c);
173 sub auth_restore_user {
174 my ( $c, $frozen_user, $realmname ) = @_;
177 if (defined($realmname)) {
178 $realm = $c->get_auth_realm($realmname);
180 $realm = $c->find_realm_for_persisted_user;
182 return undef unless $realm; # FIXME die unless? This is an internal inconsistency
184 $c->_user( my $user = $realm->restore_user( $c, $frozen_user ) );
186 # this sets the realm the user originated in.
187 $user->auth_realm($realm->name) if $user;
193 # We can't actually do our setup in setup because the model has not yet been loaded.
194 # So we have to trigger before 'setup_finalize'.
195 before 'setup_finalize' => sub {
198 $app->mk_classdata('_auth_initialized');
199 $app->_authentication_initialize();
202 ## the actual initialization routine. whee.
203 sub _authentication_initialize {
206 ## let's avoid recreating / configuring everything if we have already done it, eh?
207 if ($app->can('_auth_realms')) { return };
209 ## make classdata where it is used.
210 $app->mk_classdata( '_auth_realms' => {});
212 ## the order to attempt restore in - If we don't have session - we have
213 ## no way to be sure where a frozen user came from - so we have to
214 ## ask each realm if it can restore the user. Unfortunately it is possible
215 ## that multiple realms could restore the user from the data we have -
216 ## So we have to determine at setup time what order to ask the realms in.
217 ## The default is to use the user_restore_priority values defined in the realm
218 ## config. if they are not defined - we go by alphabetical order. Note that
219 ## the 'default' realm always gets first chance at it unless it is explicitly
220 ## placed elsewhere by user_restore_priority. Remember this only comes
221 ## into play if session is disabled.
223 $app->mk_classdata( '_auth_realm_restore_order' => []);
225 my $cfg = $app->config->{'Plugin::Authentication'};
227 if (!defined($cfg)) {
228 if (exists($app->config->{'authentication'})) {
229 $cfg = $app->config->{'authentication'};
230 $app->config->{'Plugin::Authentication'} = $app->config->{'authentication'};
235 # the realmshash contains the various configured realms. By default this is
236 # the main $app->config->{'Plugin::Authentication'} hash - but if that is
237 # not defined, or there is a subkey {'realms'} then we use that.
241 ## If we have a sub-key of {'realms'} then we use that for realm configuration
242 if (exists($cfg->{'realms'})) {
243 $realmshash = $cfg->{'realms'};
246 # old default was to force use_session on. This must remain for that
247 # reason - but if use_session is already in the config, we respect its setting.
248 if (!exists($cfg->{'use_session'})) {
249 $cfg->{'use_session'} = 1;
252 ## if we have a realms hash
253 if (ref($realmshash) eq 'HASH') {
255 my %auth_restore_order;
257 my $defaultrealm = 'default';
259 foreach my $realm (sort keys %{$realmshash}) {
260 if (ref($realmshash->{$realm}) eq 'HASH' &&
261 (exists($realmshash->{$realm}{credential}) || exists($realmshash->{$realm}{class}))) {
263 $app->setup_auth_realm($realm, $realmshash->{$realm});
265 if (exists($realmshash->{$realm}{'user_restore_priority'})) {
266 $auth_restore_order{$realm} = $realmshash->{$realm}{'user_restore_priority'};
268 $auth_restore_order{$realm} = $authcount++;
273 # if we have a 'default_realm' in the config hash and we don't already
274 # have a realm called 'default', we point default at the realm specified
275 if (exists($cfg->{'default_realm'}) && !$app->get_auth_realm('default')) {
276 if ($app->_set_default_auth_realm($cfg->{'default_realm'})) {
277 $defaultrealm = $cfg->{'default_realm'};
278 $auth_restore_order{'default'} = $auth_restore_order{$cfg->{'default_realm'}};
279 delete($auth_restore_order{$cfg->{'default_realm'}});
283 ## if the default realm did not have a defined priority in its config - we put it at the front.
284 if (!exists($realmshash->{$defaultrealm}{'user_restore_priority'})) {
285 $auth_restore_order{'default'} = 1;
288 @{$app->_auth_realm_restore_order} = sort { $auth_restore_order{$a} <=> $auth_restore_order{$b} } keys %auth_restore_order;
292 ## BACKWARDS COMPATIBILITY - if realms is not defined - then we are probably dealing
293 ## with an old-school config. The only caveat here is that we must add a classname
295 ## also - we have to treat {store} as {stores}{default} - because
296 ## while it is not a clear as a valid config in the docs, it
297 ## is functional with the old api. Whee!
298 if (exists($cfg->{'store'}) && !exists($cfg->{'stores'}{'default'})) {
299 $cfg->{'stores'}{'default'} = $cfg->{'store'};
302 push @{$app->_auth_realm_restore_order}, 'default';
303 foreach my $storename (keys %{$cfg->{'stores'}}) {
305 store => { class => $cfg->{'stores'}{$storename} },
307 $app->setup_auth_realm($storename, $realmcfg);
314 sub setup_auth_realm {
315 my ($app, $realmname, $config) = @_;
317 my $realmclass = $config->{class};
320 $realmclass = 'Catalyst::Authentication::Realm';
321 } elsif ($realmclass !~ /^\+(.*)$/ ) {
322 $realmclass = "Catalyst::Authentication::Realm::${realmclass}";
327 Catalyst::Utils::ensure_class_loaded( $realmclass );
329 my $realm = $realmclass->new($realmname, $config, $app);
331 $app->auth_realms->{$realmname} = $realm;
333 $app->log->debug("realm initialization for '$realmname' failed.");
340 $self->_authentication_initialize(); # Ensure _auth_realms created!
341 return($self->_auth_realms);
345 my ($app, $realmname) = @_;
346 return $app->auth_realms->{$realmname};
350 # Very internal method. Vital Valuable Urgent, Do not touch on pain of death.
351 # Using this method just assigns the default realm to be the value associated
352 # with the realmname provided. It WILL overwrite any real realm called 'default'
353 # so can be very confusing if used improperly. It's used properly already.
354 # Translation: don't use it.
355 sub _set_default_auth_realm {
356 my ($app, $realmname) = @_;
358 if (exists($app->auth_realms->{$realmname})) {
359 $app->auth_realms->{'default'} = $app->auth_realms->{$realmname};
361 return $app->get_auth_realm('default');
365 my ($app, $userinfo, $realmname) = @_;
368 $realmname = 'default';
371 my $realm = $app->get_auth_realm($realmname);
373 ## note to self - make authenticate throw an exception if realm is invalid.
376 return $realm->authenticate($app, $userinfo);
378 Catalyst::Exception->throw(
379 "authenticate called with nonexistant realm: '$realmname'.");
385 ## BACKWARDS COMPATIBILITY -- Warning: Here be monsters!
387 # What follows are backwards compatibility routines - for use with Stores and Credentials
388 # that have not been updated to work with C::P::Authentication v0.10.
389 # These are here so as to not break people's existing installations, but will go away
390 # in a future version.
392 # The old style of configuration only supports a single store, as each store module
393 # sets itself as the default store upon being loaded. This is the only supported
394 # 'compatibility' mode.
398 my ( $c, $uid, @rest ) = @_;
400 return $c->find_user( {'id' => $uid, 'rest'=>\@rest }, 'default' );
404 ## this should only be called when using old-style authentication plugins. IF this gets
405 ## called in a new-style config - it will OVERWRITE the store of your default realm. Don't do it.
406 ## also - this is a partial setup - because no credential is instantiated... in other words it ONLY
407 ## works with old-style auth plugins and C::P::Authentication in compatibility mode. Trying to combine
408 ## this with a realm-type config will probably crash your app.
409 sub default_auth_store {
412 my $realm = $self->get_auth_realm('default');
414 $realm = $self->setup_auth_realm('default', { class => 'Compatibility' });
416 if ( my $new = shift ) {
421 $storeclass = ref($new);
426 # BACKWARDS COMPATIBILITY - if the store class does not define find_user, we define it in terms
427 # of get_user and add it to the class. this is because the auth routines use find_user,
428 # and rely on it being present. (this avoids per-call checks)
429 if (!$storeclass->can('find_user')) {
431 *{"${storeclass}::find_user"} = sub {
432 my ($self, $info) = @_;
433 my @rest = @{$info->{rest}} if exists($info->{rest});
434 $self->get_user($info->{id}, @rest);
439 return $self->get_auth_realm('default')->store;
442 ## BACKWARDS COMPATIBILITY
443 ## this only ever returns a hash containing 'default' - as that is the only
444 ## supported mode of calling this.
445 sub auth_store_names {
448 my %hash = ( $self->get_auth_realm('default')->store => 'default' );
452 my ( $self, $name ) = @_;
454 if ($name ne 'default') {
455 Carp::croak "get_auth_store called on non-default realm '$name'. Only default supported in compatibility mode";
457 $self->default_auth_store();
461 sub get_auth_store_name {
462 my ( $self, $store ) = @_;
466 # sub auth_stores is only used internally - here for completeness
470 my %hash = ( 'default' => $self->get_auth_realm('default')->store);
481 Catalyst::Plugin::Authentication - Infrastructure plugin for the Catalyst
482 authentication framework.
491 $c->authenticate({ username => 'myusername',
492 password => 'mypassword' });
493 my $age = $c->user->get('age');
498 The authentication plugin provides generic user support for Catalyst apps. It
499 is the basis for both authentication (checking the user is who they claim to
500 be), and authorization (allowing the user to do what the system authorises
503 Using authentication is split into two parts. A Store is used to actually
504 store the user information, and can store any amount of data related to the
505 user. Credentials are used to verify users, using information from the store,
506 given data from the frontend. A Credential and a Store are paired to form a
507 'Realm'. A Catalyst application using the authentication framework must have
508 at least one realm, and may have several.
510 To implement authentication in a Catalyst application you need to add this
511 module, and specify at least one realm in the configuration.
513 Authentication data can also be stored in a session, if the application
514 is using the L<Catalyst::Plugin::Session> module.
516 B<NOTE> in version 0.10 of this module, the interface to this module changed.
517 Please see L</COMPATIBILITY ROUTINES> for more information.
521 =head2 The Authentication/Authorization Process
523 Web applications typically need to identify a user - to tell the user apart
524 from other users. This is usually done in order to display private information
525 that is only that user's business, or to limit access to the application so
526 that only certain entities can access certain parts.
528 This process is split up into several steps. First you ask the user to identify
529 themselves. At this point you can't be sure that the user is really who they
532 Then the user tells you who they are, and backs this claim with some piece of
533 information that only the real user could give you. For example, a password is
534 a secret that is known to both the user and you. When the user tells you this
535 password you can assume they're in on the secret and can be trusted (ignore
536 identity theft for now). Checking the password, or any other proof is called
537 B<credential verification>.
539 By this time you know exactly who the user is - the user's identity is
540 B<authenticated>. This is where this module's job stops, and your application
541 or other plugins step in.
543 The next logical step is B<authorization>, the process of deciding what a user
544 is (or isn't) allowed to do. For example, say your users are split into two
545 main groups - regular users and administrators. You want to verify that the
546 currently logged in user is indeed an administrator before performing the
547 actions in an administrative part of your application. These decisions may be
548 made within your application code using just the information available after
549 authentication, or it may be facilitated by a number of plugins.
551 =head2 The Components In This Framework
555 Configuration of the Catalyst::Plugin::Authentication framework is done in
556 terms of realms. In simplest terms, a realm is a pairing of a Credential
557 verifier and a User storage (Store) backend. As of version 0.10003, realms are
558 now objects that you can create and customize.
560 An application can have any number of Realms, each of which operates
561 independent of the others. Each realm has a name, which is used to identify it
562 as the target of an authentication request. This name can be anything, such as
563 'users' or 'members'. One realm must be defined as the default_realm, which is
564 used when no realm name is specified. More information about configuring
565 realms is available in the configuration section.
567 =head3 Credential Verifiers
569 When user input is transferred to the L<Catalyst> application
570 (typically via form inputs) the application may pass this information
571 into the authentication system through the C<< $c->authenticate() >>
572 method. From there, it is passed to the appropriate Credential
575 These plugins check the data, and ensure that it really proves the user is who
578 Credential verifiers compatible with versions of this module 0.10x and
579 upwards should be in the namespace
580 C<Catalyst::Authentication::Credential>.
582 =head3 Storage Backends
584 The authentication data also identifies a user, and the Storage backend modules
585 use this data to locate and return a standardized object-oriented
586 representation of a user.
588 When a user is retrieved from a store it is not necessarily authenticated.
589 Credential verifiers accept a set of authentication data and use this
590 information to retrieve the user from the store they are paired with.
592 Storage backends compatible with versions of this module 0.10x and
593 upwards should be in the namespace
594 C<Catalyst::Authentication::Store>.
596 =head3 The Core Plugin
598 This plugin on its own is the glue, providing realm configuration, session
599 integration, and other goodness for the other plugins.
603 More layers of plugins can be stacked on top of the authentication code. For
604 example, L<Catalyst::Plugin::Session::PerUser> provides an abstraction of
605 browser sessions that is more persistent per user.
606 L<Catalyst::Plugin::Authorization::Roles> provides an accepted way to separate
607 and group users into categories, and then check which categories the current
612 Let's say we were storing users in a simple Perl hash. Users are
613 verified by supplying a password which is matched within the hash.
615 This means that our application will begin like this:
623 __PACKAGE__->config( 'Plugin::Authentication' =>
628 password_field => 'password',
629 password_type => 'clear'
635 password => "s00p3r",
637 roles => [qw/edit delete/],
640 password => "s3cr3t",
641 roles => [qw/comment/],
649 This tells the authentication plugin what realms are available, which
650 credential and store modules are used, and the configuration of each. With
651 this code loaded, we can now attempt to authenticate users.
653 To show an example of this, let's create an authentication controller:
655 package MyApp::Controller::Auth;
658 my ( $self, $c ) = @_;
660 if ( my $user = $c->req->params->{user}
661 and my $password = $c->req->params->{password} )
663 if ( $c->authenticate( { username => $user,
664 password => $password } ) ) {
665 $c->res->body( "hello " . $c->user->get("name") );
675 This code should be self-explanatory. If all the necessary fields are supplied,
676 call the C<authenticate> method on the context object. If it succeeds the
679 The credential verifier will attempt to retrieve the user whose
680 details match the authentication information provided to
681 C<< $c->authenticate() >>. Once it fetches the user the password is
682 checked and if it matches the user will be B<authenticated> and
683 C<< $c->user >> will contain the user object retrieved from the store.
685 In the above case, the default realm is checked, but we could just as easily
686 check an alternate realm. If this were an admin login, for example, we could
687 authenticate on the admin realm by simply changing the C<< $c->authenticate() >>
690 if ( $c->authenticate( { username => $user,
691 password => $password }, 'admin' ) ) {
692 $c->res->body( "hello " . $c->user->get("name") );
696 Now suppose we want to restrict the ability to edit to a user with an
697 'editor' value of yes.
699 The restricted action might look like this:
702 my ( $self, $c ) = @_;
704 $c->detach("unauthorized")
705 unless $c->user_exists
706 and $c->user->get('editor') eq 'yes';
708 # do something restricted here
711 (Note that if you have multiple realms, you can use
712 C<< $c->user_in_realm('realmname') >> in place of
713 C<< $c->user_exists(); >> This will essentially perform the same
714 verification as user_exists, with the added requirement that if there
715 is a user, it must have come from the realm specified.)
717 The above example is somewhat similar to role based access control.
718 L<Catalyst::Authentication::Store::Minimal> treats the roles field as
719 an array of role names. Let's leverage this. Add the role authorization
728 my ( $self, $c ) = @_;
730 $c->detach("unauthorized") unless $c->check_user_roles("edit");
732 # do something restricted here
735 This is somewhat simpler and will work if you change your store, too, since the
736 role interface is consistent.
738 Let's say your app grows, and you now have 10,000 users. It's no longer
739 efficient to maintain a hash of users, so you move this data to a database.
740 You can accomplish this simply by installing the L<DBIx::Class|Catalyst::Authentication::Store::DBIx::Class> Store and
741 changing your config:
743 __PACKAGE__->config( 'Plugin::Authentication' =>
745 default_realm => 'members',
749 password_field => 'password',
750 password_type => 'clear'
753 class => 'DBIx::Class',
754 user_model => 'MyApp::Users',
755 role_column => 'roles',
761 The authentication system works behind the scenes to load your data from the
762 new source. The rest of your application is completely unchanged.
768 __PACKAGE__->config( 'Plugin::Authentication' =>
770 default_realm => 'members',
775 password_field => 'password',
776 password_type => 'clear'
779 class => 'DBIx::Class',
780 user_model => 'MyApp::Users',
781 role_column => 'roles',
787 password_field => 'password',
788 password_type => 'clear'
791 class => '+MyApp::Authentication::Store::NetAuth',
792 authserver => '192.168.10.17'
798 NOTE: Until version 0.10008 of this module, you would need to put all the
799 realms inside a "realms" key in the configuration. Please see
800 L</COMPATIBILITY CONFIGURATION> for more information
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.
810 However, even if use_session is disabled, if any code touches $c->session, a session
811 object will be auto-vivified and session Cookies will be sent in the headers. To
812 prevent accidental session creation, check if a session already exists with
813 if ($c->sessionid) { ... }. If the session doesn't exist, then don't place
814 anything in the session to prevent an unecessary session from being created.
818 This defines which realm should be used as when no realm is provided to methods
819 that require a realm such as authenticate or find_user.
823 The Plugin::Authentication config hash contains the series of realm
824 configurations you want to use for your app. The only rule here is
825 that there must be at least one. A realm consists of a name, which is used
826 to reference the realm, a credential and a store. You may also put your
827 realm configurations within a subelement called 'realms' if you desire to
828 separate them from the remainder of your configuration. Note that if you use
829 a 'realms' subelement, you must put ALL of your realms within it.
831 You can also specify a realm class to instantiate instead of the default
832 L<Catalyst::Authentication::Realm> class using the 'class' element within the
835 Each realm config contains two hashes, one called 'credential' and one called
836 'store', each of which provide configuration details to the respective modules.
837 The contents of these hashes is specific to the module being used, with the
838 exception of the 'class' element, which tells the core Authentication module the
839 classname to instantiate.
841 The 'class' element follows the standard Catalyst mechanism of class
842 specification. If a class is prefixed with a +, it is assumed to be a complete
843 class name. Otherwise it is considered to be a portion of the class name. For
844 credentials, the classname 'B<Password>', for example, is expanded to
845 Catalyst::Authentication::Credential::B<Password>. For stores, the
846 classname 'B<storename>' is expanded to:
847 Catalyst::Authentication::Store::B<storename>.
853 =head2 $c->authenticate( $userinfo [, $realm ])
855 Attempts to authenticate the user using the information in the $userinfo hash
856 reference using the realm $realm. $realm may be omitted, in which case the
857 default realm is checked.
861 Returns the currently logged in user, or undef if there is none.
863 =head2 $c->user_exists( )
865 Returns true if a user is logged in right now. The difference between
866 user_exists and user is that user_exists will return true if a user is logged
867 in, even if it has not been yet retrieved from the storage backend. If you only
868 need to know if the user is logged in, depending on the storage mechanism this
869 can be much more efficient.
871 =head2 $c->user_in_realm( $realm )
873 Works like user_exists, except that it only returns true if a user is both
874 logged in right now and was retrieved from the realm provided.
878 Logs the user out. Deletes the currently logged in user from C<< $c->user >>
879 and the session. It does not delete the session.
881 =head2 $c->find_user( $userinfo, $realm )
883 Fetch a particular users details, matching the provided user info, from the realm
886 =head2 persist_user()
888 Under normal circumstances the user data is only saved to the session during
889 initial authentication. This call causes the auth system to save the
890 currently authenticated user's data across requests. Useful if you have
891 changed the user data and want to ensure that future requests reflect the
892 most current data. Assumes that at the time of this call, $c->user
893 contains the most current data.
895 =head2 find_realm_for_persisted_user()
897 Private method, do not call from user code!
899 =head1 INTERNAL METHODS
901 These methods are for Catalyst::Plugin::Authentication B<INTERNAL USE> only.
902 Please do not use them in your own code, whether application or credential /
903 store modules. If you do, you will very likely get the nasty shock of having
904 to fix / rewrite your code when things change. They are documented here only
907 =head2 $c->set_authenticated( $user, $realmname )
909 Marks a user as authenticated. This is called from within the authenticate
910 routine when a credential returns a user. $realmname defaults to 'default'
912 =head2 $c->auth_restore_user( $user, $realmname )
914 Used to restore a user from the session. In most cases this is called without
915 arguments to restore the user via the session. Can be called with arguments
916 when restoring a user from some other method. Currently not used in this way.
918 =head2 $c->auth_realms( )
920 Returns a hashref containing realmname -> realm instance pairs. Realm
921 instances contain an instantiated store and credential object as the 'store'
922 and 'credential' elements, respectively
924 =head2 $c->get_auth_realm( $realmname )
926 Retrieves the realm instance for the realmname provided.
928 =head2 $c->update_user_in_session
930 This was a short-lived method to update user information - you should use persist_user instead.
932 =head2 $c->setup_auth_realm( )
934 =head1 OVERRIDDEN METHODS
940 This list might not be up to date. Below are modules known to work with the updated
941 API of 0.10 and are therefore compatible with realms.
945 L<Catalyst::Authentication::Realm>
947 =head2 User Storage Backends
951 =item L<Catalyst::Authentication::Store::Minimal>
953 =item L<Catalyst::Authentication::Store::DBIx::Class>
955 =item L<Catalyst::Authentication::Store::LDAP>
957 =item L<Catalyst::Authentication::Store::RDBO>
959 =item L<Catalyst::Authentication::Store::Model::KiokuDB>
961 =item L<Catalyst::Authentication::Store::Jifty::DBI>
963 =item L<Catalyst::Authentication::Store::Htpasswd>
967 =head2 Credential verification
971 =item L<Catalyst::Authentication::Credential::Password>
973 =item L<Catalyst::Authentication::Credential::HTTP>
975 =item L<Catalyst::Authentication::Credential::OpenID>
977 =item L<Catalyst::Authentication::Credential::Authen::Simple>
979 =item L<Catalyst::Authentication::Credential::Flickr>
981 =item L<Catalyst::Authentication::Credential::Testing>
983 =item L<Catalyst::Authentication::Credential::AuthTkt>
985 =item L<Catalyst::Authentication::Credential::Kerberos>
991 L<Catalyst::Plugin::Authorization::ACL>,
992 L<Catalyst::Plugin::Authorization::Roles>
994 =head2 Internals Documentation
996 L<Catalyst::Plugin::Authentication::Internals>
1000 L<Catalyst::Plugin::Session>,
1001 L<Catalyst::Plugin::Session::PerUser>
1003 =head1 DON'T SEE ALSO
1005 This module along with its sub plugins deprecate a great number of other
1006 modules. These include L<Catalyst::Plugin::Authentication::Simple>,
1007 L<Catalyst::Plugin::Authentication::CDBI>.
1009 =head1 INCOMPATABILITIES
1011 The realms-based configuration and functionality of the 0.10 update
1012 of L<Catalyst::Plugin::Authentication> required a change in the API used by
1013 credentials and stores. It has a compatibility mode which allows use of
1014 modules that have not yet been updated. This, however, completely mimics the
1015 older api and disables the new realm-based features. In other words you cannot
1016 mix the older credential and store modules with realms, or realm-based
1017 configs. The changes required to update modules are relatively minor and are
1018 covered in L<Catalyst::Plugin::Authentication::Internals>. We hope that most
1019 modules will move to the compatible list above very quickly.
1021 =head1 COMPATIBILITY CONFIGURATION
1023 Until version 0.10008 of this module, you needed to put all the
1024 realms inside a "realms" key in the configuration.
1027 __PACKAGE__->config( 'Plugin::Authentication' =>
1029 default_realm => 'members',
1038 If you use the old, deprecated C<< __PACKAGE__->config( 'authentication' ) >>
1039 configuration key, then the realms key is still required.
1041 =head1 COMPATIBILITY ROUTINES
1043 In version 0.10 of L<Catalyst::Plugin::Authentication>, the API
1044 changed. For app developers, this change is fairly minor, but for
1045 Credential and Store authors, the changes are significant.
1047 Please see the documentation in version 0.09 of
1048 Catalyst::Plugin::Authentication for a better understanding of how the old API
1051 The items below are still present in the plugin, though using them is
1052 deprecated. They remain only as a transition tool, for those sites which can
1053 not yet be upgraded to use the new system due to local customizations or use
1054 of Credential / Store modules that have not yet been updated to work with the
1057 These routines should not be used in any application using realms
1058 functionality or any of the methods described above. These are for reference
1063 This method is used to initiate authentication and user retrieval. Technically
1064 this is part of the old Password credential module and it still resides in the
1065 L<Password|Catalyst::Plugin::Authentication::Credential::Password> class. It is
1066 included here for reference only.
1068 =head2 $c->default_auth_store( )
1070 Return the store whose name is 'default'.
1072 This is set to C<< $c->config( 'Plugin::Authentication' => { store => # Store} ) >> if that value exists,
1073 or by using a Store plugin:
1075 # load the Minimal authentication store.
1076 use Catalyst qw/Authentication Authentication::Store::Minimal/;
1078 Sets the default store to
1079 L<Catalyst::Plugin::Authentication::Store::Minimal>.
1081 =head2 $c->get_auth_store( $name )
1083 Return the store whose name is $name.
1085 =head2 $c->get_auth_store_name( $store )
1087 Return the name of the store $store.
1089 =head2 $c->auth_stores( )
1091 A hash keyed by name, with the stores registered in the app.
1093 =head2 $c->register_auth_stores( %stores_by_name )
1095 Register stores into the application.
1097 =head2 $c->auth_store_names( )
1099 =head2 $c->get_user( )
1103 Yuval Kogman, C<nothingmuch@woobling.org>
1105 Jay Kuri, C<jayk@cpan.org>
1111 Tomas Doran (t0m), C<bobtfish@bobtfish.net>
1117 Florian Ragwitz C<rafl@debian.org>
1119 Stephan Jauernick C<stephanj@cpan.org>
1121 =head1 COPYRIGHT & LICENSE
1123 Copyright (c) 2005 - 2009
1124 the Catalyst::Plugin::Authentication L</AUTHORS>
1127 This program is free software; you can redistribute
1128 it and/or modify it under the same terms as Perl itself.