1 package Catalyst::Plugin::Authentication;
4 use namespace::clean -except => 'meta';
8 use Catalyst::Authentication::Realm;
10 with 'MooseX::Emulate::Class::Accessor::Fast';
12 __PACKAGE__->mk_accessors(qw/_user/);
14 our $VERSION = "0.10019";
16 sub set_authenticated {
17 my ( $c, $user, $realmname ) = @_;
20 $c->request->{user} = $user; # compatibility kludge
23 $realmname = 'default';
25 my $realm = $c->get_auth_realm($realmname);
28 Catalyst::Exception->throw(
29 "set_authenticated called with nonexistant realm: '$realmname'.");
31 $user->auth_realm($realm->name);
35 $c->maybe::next::method($user, $realmname);
45 if ( defined($c->_user) ) {
48 return $c->auth_restore_user;
52 # change this to allow specification of a realm - to verify the user is part of that realm
53 # in addition to verifying that they exist.
56 return defined($c->_user) || defined($c->find_realm_for_persisted_user);
59 # works like user_exists - except only returns true if user
60 # exists AND is in the realm requested.
62 my ($c, $realmname) = @_;
64 if (defined($c->_user)) {
65 return ($c->_user->auth_realm eq $realmname);
67 my $realm = $c->find_realm_for_persisted_user;
69 return ($realm->name eq $realmname);
76 sub __old_save_user_in_session {
77 my ( $c, $user, $realmname ) = @_;
79 $c->session->{__user_realm} = $realmname;
81 # we want to ask the store for a user prepared for the session.
82 # but older modules split this functionality between the user and the
83 # store. We try the store first. If not, we use the old method.
84 my $realm = $c->get_auth_realm($realmname);
85 if ($realm->{'store'}->can('for_session')) {
86 $c->session->{__user} = $realm->{'store'}->for_session($c, $user);
88 $c->session->{__user} = $user->for_session;
95 if ($c->user_exists) {
97 ## if we have a valid session handler - we store the
98 ## realm in the session. If not - we have to hope that
99 ## the realm can recognize its frozen user somehow.
100 if ($c->can('session') &&
101 $c->config->{'Plugin::Authentication'}{'use_session'} &&
102 $c->session_is_valid) {
104 $c->session->{'__user_realm'} = $c->_user->auth_realm;
107 my $realm = $c->get_auth_realm($c->_user->auth_realm);
109 # used to call $realm->save_user_in_session
110 $realm->persist_user($c, $c->user);
115 ## this was a short lived method to update user information -
116 ## you should use persist_user instead.
117 sub update_user_in_session {
120 return $c->persist_user;
128 my $realm = $c->find_realm_for_persisted_user;
130 $realm->remove_persisted_user($c);
133 $c->maybe::next::method(@_);
137 my ( $c, $userinfo, $realmname ) = @_;
139 $realmname ||= 'default';
140 my $realm = $c->get_auth_realm($realmname);
143 Catalyst::Exception->throw(
144 "find_user called with nonexistant realm: '$realmname'.");
146 return $realm->find_user($userinfo, $c);
149 ## Consider making this a public method. - would make certain things easier when
150 ## dealing with things pre-auth restore.
151 sub find_realm_for_persisted_user {
155 if ($c->can('session')
156 and $c->config->{'Plugin::Authentication'}{'use_session'}
157 and $c->session_is_valid
158 and exists($c->session->{'__user_realm'})) {
160 $realm = $c->auth_realms->{$c->session->{'__user_realm'}};
161 if ($realm->user_is_restorable($c)) {
165 ## we have no choice but to ask each realm whether it has a persisted user.
166 foreach my $realmname (@{$c->_auth_realm_restore_order}) {
167 my $realm = $c->auth_realms->{$realmname}
168 || Catalyst::Exception->throw("Could not find authentication realm '$realmname'");
170 if $realm->user_is_restorable($c);
176 sub auth_restore_user {
177 my ( $c, $frozen_user, $realmname ) = @_;
180 if (defined($realmname)) {
181 $realm = $c->get_auth_realm($realmname);
183 $realm = $c->find_realm_for_persisted_user;
185 return undef unless $realm; # FIXME die unless? This is an internal inconsistency
187 $c->_user( my $user = $realm->restore_user( $c, $frozen_user ) );
189 # this sets the realm the user originated in.
190 $user->auth_realm($realm->name) if $user;
196 # we can't actually do our setup in setup because the model has not yet been loaded.
197 # So we have to trigger off of setup_finished. :-(
201 $app->_authentication_initialize();
202 $app->next::method(@_);
205 ## the actual initialization routine. whee.
206 sub _authentication_initialize {
209 ## let's avoid recreating / configuring everything if we have already done it, eh?
210 if ($app->can('_auth_realms')) { return };
212 ## make classdata where it is used.
213 $app->mk_classdata( '_auth_realms' => {});
215 ## the order to attempt restore in - If we don't have session - we have
216 ## no way to be sure where a frozen user came from - so we have to
217 ## ask each realm if it can restore the user. Unfortunately it is possible
218 ## that multiple realms could restore the user from the data we have -
219 ## So we have to determine at setup time what order to ask the realms in.
220 ## The default is to use the user_restore_priority values defined in the realm
221 ## config. if they are not defined - we go by alphabetical order. Note that
222 ## the 'default' realm always gets first chance at it unless it is explicitly
223 ## placed elsewhere by user_restore_priority. Remember this only comes
224 ## into play if session is disabled.
226 $app->mk_classdata( '_auth_realm_restore_order' => []);
228 my $cfg = $app->config->{'Plugin::Authentication'};
230 if (!defined($cfg)) {
231 if (exists($app->config->{'authentication'})) {
232 $cfg = $app->config->{'authentication'};
233 $app->config->{'Plugin::Authentication'} = $app->config->{'authentication'};
238 # the realmshash contains the various configured realms. By default this is
239 # the main $app->config->{'Plugin::Authentication'} hash - but if that is
240 # not defined, or there is a subkey {'realms'} then we use that.
244 ## If we have a sub-key of {'realms'} then we use that for realm configuration
245 if (exists($cfg->{'realms'})) {
246 $realmshash = $cfg->{'realms'};
249 # old default was to force use_session on. This must remain for that
250 # reason - but if use_session is already in the config, we respect its setting.
251 if (!exists($cfg->{'use_session'})) {
252 $cfg->{'use_session'} = 1;
255 ## if we have a realms hash
256 if (ref($realmshash) eq 'HASH') {
258 my %auth_restore_order;
260 my $defaultrealm = 'default';
262 foreach my $realm (sort keys %{$realmshash}) {
263 if (ref($realmshash->{$realm}) eq 'HASH' &&
264 (exists($realmshash->{$realm}{credential}) || exists($realmshash->{$realm}{class}))) {
266 $app->setup_auth_realm($realm, $realmshash->{$realm});
268 if (exists($realmshash->{$realm}{'user_restore_priority'})) {
269 $auth_restore_order{$realm} = $realmshash->{$realm}{'user_restore_priority'};
271 $auth_restore_order{$realm} = $authcount++;
276 # if we have a 'default_realm' in the config hash and we don't already
277 # have a realm called 'default', we point default at the realm specified
278 if (exists($cfg->{'default_realm'}) && !$app->get_auth_realm('default')) {
279 if ($app->_set_default_auth_realm($cfg->{'default_realm'})) {
280 $defaultrealm = $cfg->{'default_realm'};
281 $auth_restore_order{'default'} = $auth_restore_order{$cfg->{'default_realm'}};
282 delete($auth_restore_order{$cfg->{'default_realm'}});
286 ## if the default realm did not have a defined priority in its config - we put it at the front.
287 if (!exists($realmshash->{$defaultrealm}{'user_restore_priority'})) {
288 $auth_restore_order{'default'} = 1;
291 @{$app->_auth_realm_restore_order} = sort { $auth_restore_order{$a} <=> $auth_restore_order{$b} } keys %auth_restore_order;
295 ## BACKWARDS COMPATIBILITY - if realms is not defined - then we are probably dealing
296 ## with an old-school config. The only caveat here is that we must add a classname
298 ## also - we have to treat {store} as {stores}{default} - because
299 ## while it is not a clear as a valid config in the docs, it
300 ## is functional with the old api. Whee!
301 if (exists($cfg->{'store'}) && !exists($cfg->{'stores'}{'default'})) {
302 $cfg->{'stores'}{'default'} = $cfg->{'store'};
305 push @{$app->_auth_realm_restore_order}, 'default';
306 foreach my $storename (keys %{$cfg->{'stores'}}) {
308 store => { class => $cfg->{'stores'}{$storename} },
310 $app->setup_auth_realm($storename, $realmcfg);
317 sub setup_auth_realm {
318 my ($app, $realmname, $config) = @_;
320 my $realmclass = $config->{class};
323 $realmclass = 'Catalyst::Authentication::Realm';
324 } elsif ($realmclass !~ /^\+(.*)$/ ) {
325 $realmclass = "Catalyst::Authentication::Realm::${realmclass}";
330 Catalyst::Utils::ensure_class_loaded( $realmclass );
332 my $realm = $realmclass->new($realmname, $config, $app);
334 $app->auth_realms->{$realmname} = $realm;
336 $app->log->debug("realm initialization for '$realmname' failed.");
343 $self->_authentication_initialize(); # Ensure _auth_realms created!
344 return($self->_auth_realms);
348 my ($app, $realmname) = @_;
349 return $app->auth_realms->{$realmname};
353 # Very internal method. Vital Valuable Urgent, Do not touch on pain of death.
354 # Using this method just assigns the default realm to be the value associated
355 # with the realmname provided. It WILL overwrite any real realm called 'default'
356 # so can be very confusing if used improperly. It's used properly already.
357 # Translation: don't use it.
358 sub _set_default_auth_realm {
359 my ($app, $realmname) = @_;
361 if (exists($app->auth_realms->{$realmname})) {
362 $app->auth_realms->{'default'} = $app->auth_realms->{$realmname};
364 return $app->get_auth_realm('default');
368 my ($app, $userinfo, $realmname) = @_;
371 $realmname = 'default';
374 my $realm = $app->get_auth_realm($realmname);
376 ## note to self - make authenticate throw an exception if realm is invalid.
379 return $realm->authenticate($app, $userinfo);
381 Catalyst::Exception->throw(
382 "authenticate called with nonexistant realm: '$realmname'.");
388 ## BACKWARDS COMPATIBILITY -- Warning: Here be monsters!
390 # What follows are backwards compatibility routines - for use with Stores and Credentials
391 # that have not been updated to work with C::P::Authentication v0.10.
392 # These are here so as to not break people's existing installations, but will go away
393 # in a future version.
395 # The old style of configuration only supports a single store, as each store module
396 # sets itself as the default store upon being loaded. This is the only supported
397 # 'compatibility' mode.
401 my ( $c, $uid, @rest ) = @_;
403 return $c->find_user( {'id' => $uid, 'rest'=>\@rest }, 'default' );
407 ## this should only be called when using old-style authentication plugins. IF this gets
408 ## called in a new-style config - it will OVERWRITE the store of your default realm. Don't do it.
409 ## also - this is a partial setup - because no credential is instantiated... in other words it ONLY
410 ## works with old-style auth plugins and C::P::Authentication in compatibility mode. Trying to combine
411 ## this with a realm-type config will probably crash your app.
412 sub default_auth_store {
415 my $realm = $self->get_auth_realm('default');
417 $realm = $self->setup_auth_realm('default', { class => 'Compatibility' });
419 if ( my $new = shift ) {
424 $storeclass = ref($new);
429 # BACKWARDS COMPATIBILITY - if the store class does not define find_user, we define it in terms
430 # of get_user and add it to the class. this is because the auth routines use find_user,
431 # and rely on it being present. (this avoids per-call checks)
432 if (!$storeclass->can('find_user')) {
434 *{"${storeclass}::find_user"} = sub {
435 my ($self, $info) = @_;
436 my @rest = @{$info->{rest}} if exists($info->{rest});
437 $self->get_user($info->{id}, @rest);
442 return $self->get_auth_realm('default')->store;
445 ## BACKWARDS COMPATIBILITY
446 ## this only ever returns a hash containing 'default' - as that is the only
447 ## supported mode of calling this.
448 sub auth_store_names {
451 my %hash = ( $self->get_auth_realm('default')->store => 'default' );
455 my ( $self, $name ) = @_;
457 if ($name ne 'default') {
458 Carp::croak "get_auth_store called on non-default realm '$name'. Only default supported in compatibility mode";
460 $self->default_auth_store();
464 sub get_auth_store_name {
465 my ( $self, $store ) = @_;
469 # sub auth_stores is only used internally - here for completeness
473 my %hash = ( 'default' => $self->get_auth_realm('default')->store);
476 __PACKAGE__->meta->make_immutable;
485 Catalyst::Plugin::Authentication - Infrastructure plugin for the Catalyst
486 authentication framework.
495 $c->authenticate({ username => 'myusername',
496 password => 'mypassword' });
497 my $age = $c->user->get('age');
502 The authentication plugin provides generic user support for Catalyst apps. It
503 is the basis for both authentication (checking the user is who they claim to
504 be), and authorization (allowing the user to do what the system authorises
507 Using authentication is split into two parts. A Store is used to actually
508 store the user information, and can store any amount of data related to the
509 user. Credentials are used to verify users, using information from the store,
510 given data from the frontend. A Credential and a Store are paired to form a
511 'Realm'. A Catalyst application using the authentication framework must have
512 at least one realm, and may have several.
514 To implement authentication in a Catalyst application you need to add this
515 module, and specify at least one realm in the configuration.
517 Authentication data can also be stored in a session, if the application
518 is using the L<Catalyst::Plugin::Session> module.
520 B<NOTE> in version 0.10 of this module, the interface to this module changed.
521 Please see L</COMPATIBILITY ROUTINES> for more information.
525 =head2 The Authentication/Authorization Process
527 Web applications typically need to identify a user - to tell the user apart
528 from other users. This is usually done in order to display private information
529 that is only that user's business, or to limit access to the application so
530 that only certain entities can access certain parts.
532 This process is split up into several steps. First you ask the user to identify
533 themselves. At this point you can't be sure that the user is really who they
536 Then the user tells you who they are, and backs this claim with some piece of
537 information that only the real user could give you. For example, a password is
538 a secret that is known to both the user and you. When the user tells you this
539 password you can assume they're in on the secret and can be trusted (ignore
540 identity theft for now). Checking the password, or any other proof is called
541 B<credential verification>.
543 By this time you know exactly who the user is - the user's identity is
544 B<authenticated>. This is where this module's job stops, and your application
545 or other plugins step in.
547 The next logical step is B<authorization>, the process of deciding what a user
548 is (or isn't) allowed to do. For example, say your users are split into two
549 main groups - regular users and administrators. You want to verify that the
550 currently logged in user is indeed an administrator before performing the
551 actions in an administrative part of your application. These decisions may be
552 made within your application code using just the information available after
553 authentication, or it may be facilitated by a number of plugins.
555 =head2 The Components In This Framework
559 Configuration of the Catalyst::Plugin::Authentication framework is done in
560 terms of realms. In simplest terms, a realm is a pairing of a Credential
561 verifier and a User storage (Store) backend. As of version 0.10003, realms are
562 now objects that you can create and customize.
564 An application can have any number of Realms, each of which operates
565 independent of the others. Each realm has a name, which is used to identify it
566 as the target of an authentication request. This name can be anything, such as
567 'users' or 'members'. One realm must be defined as the default_realm, which is
568 used when no realm name is specified. More information about configuring
569 realms is available in the configuration section.
571 =head3 Credential Verifiers
573 When user input is transferred to the L<Catalyst> application
574 (typically via form inputs) the application may pass this information
575 into the authentication system through the C<< $c->authenticate() >>
576 method. From there, it is passed to the appropriate Credential
579 These plugins check the data, and ensure that it really proves the user is who
582 Credential verifiers compatible with versions of this module 0.10x and
583 upwards should be in the namespace
584 C<Catalyst::Authentication::Credential>.
586 =head3 Storage Backends
588 The authentication data also identifies a user, and the Storage backend modules
589 use this data to locate and return a standardized object-oriented
590 representation of a user.
592 When a user is retrieved from a store it is not necessarily authenticated.
593 Credential verifiers accept a set of authentication data and use this
594 information to retrieve the user from the store they are paired with.
596 Storage backends compatible with versions of this module 0.10x and
597 upwards should be in the namespace
598 C<Catalyst::Authentication::Store>.
600 =head3 The Core Plugin
602 This plugin on its own is the glue, providing realm configuration, session
603 integration, and other goodness for the other plugins.
607 More layers of plugins can be stacked on top of the authentication code. For
608 example, L<Catalyst::Plugin::Session::PerUser> provides an abstraction of
609 browser sessions that is more persistent per user.
610 L<Catalyst::Plugin::Authorization::Roles> provides an accepted way to separate
611 and group users into categories, and then check which categories the current
616 Let's say we were storing users in a simple Perl hash. Users are
617 verified by supplying a password which is matched within the hash.
619 This means that our application will begin like this:
627 __PACKAGE__->config( 'Plugin::Authentication' =>
632 password_field => 'password',
633 password_type => 'clear'
639 password => "s00p3r",
641 roles => [qw/edit delete/],
644 password => "s3cr3t",
645 roles => [qw/comment/],
653 This tells the authentication plugin what realms are available, which
654 credential and store modules are used, and the configuration of each. With
655 this code loaded, we can now attempt to authenticate users.
657 To show an example of this, let's create an authentication controller:
659 package MyApp::Controller::Auth;
662 my ( $self, $c ) = @_;
664 if ( my $user = $c->req->params->{user}
665 and my $password = $c->req->params->{password} )
667 if ( $c->authenticate( { username => $user,
668 password => $password } ) ) {
669 $c->res->body( "hello " . $c->user->get("name") );
679 This code should be self-explanatory. If all the necessary fields are supplied,
680 call the C<authenticate> method on the context object. If it succeeds the
683 The credential verifier will attempt to retrieve the user whose
684 details match the authentication information provided to
685 C<< $c->authenticate() >>. Once it fetches the user the password is
686 checked and if it matches the user will be B<authenticated> and
687 C<< $c->user >> will contain the user object retrieved from the store.
689 In the above case, the default realm is checked, but we could just as easily
690 check an alternate realm. If this were an admin login, for example, we could
691 authenticate on the admin realm by simply changing the C<< $c->authenticate() >>
694 if ( $c->authenticate( { username => $user,
695 password => $password }, 'admin' ) ) {
696 $c->res->body( "hello " . $c->user->get("name") );
700 Now suppose we want to restrict the ability to edit to a user with an
701 'editor' value of yes.
703 The restricted action might look like this:
706 my ( $self, $c ) = @_;
708 $c->detach("unauthorized")
709 unless $c->user_exists
710 and $c->user->get('editor') eq 'yes';
712 # do something restricted here
715 (Note that if you have multiple realms, you can use
716 C<< $c->user_in_realm('realmname') >> in place of
717 C<< $c->user_exists(); >> This will essentially perform the same
718 verification as user_exists, with the added requirement that if there
719 is a user, it must have come from the realm specified.)
721 The above example is somewhat similar to role based access control.
722 L<Catalyst::Authentication::Store::Minimal> treats the roles field as
723 an array of role names. Let's leverage this. Add the role authorization
732 my ( $self, $c ) = @_;
734 $c->detach("unauthorized") unless $c->check_user_roles("edit");
736 # do something restricted here
739 This is somewhat simpler and will work if you change your store, too, since the
740 role interface is consistent.
742 Let's say your app grows, and you now have 10,000 users. It's no longer
743 efficient to maintain a hash of users, so you move this data to a database.
744 You can accomplish this simply by installing the L<DBIx::Class|Catalyst::Authentication::Store::DBIx::Class> Store and
745 changing your config:
747 __PACKAGE__->config( 'Plugin::Authentication' =>
749 default_realm => 'members',
753 password_field => 'password',
754 password_type => 'clear'
757 class => 'DBIx::Class',
758 user_model => 'MyApp::Users',
759 role_column => 'roles',
765 The authentication system works behind the scenes to load your data from the
766 new source. The rest of your application is completely unchanged.
772 __PACKAGE__->config( 'Plugin::Authentication' =>
774 default_realm => 'members',
779 password_field => 'password',
780 password_type => 'clear'
783 class => 'DBIx::Class',
784 user_model => 'MyApp::Users',
785 role_column => 'roles',
791 password_field => 'password',
792 password_type => 'clear'
795 class => '+MyApp::Authentication::Store::NetAuth',
796 authserver => '192.168.10.17'
802 NOTE: Until version 0.10008 of this module, you would need to put all the
803 realms inside a "realms" key in the configuration. Please see
804 L</COMPATIBILITY CONFIGURATION> for more information
810 Whether or not to store the user's logged in state in the session, if the
811 application is also using L<Catalyst::Plugin::Session>. This
812 value is set to true per default.
814 However, even if use_session is disabled, if any code touches $c->session, a session
815 object will be auto-vivified and session Cookies will be sent in the headers. To
816 prevent accidental session creation, check if a session already exists with
817 if ($c->sessionid) { ... }. If the session doesn't exist, then don't place
818 anything in the session to prevent an unecessary session from being created.
822 This defines which realm should be used as when no realm is provided to methods
823 that require a realm such as authenticate or find_user.
827 The Plugin::Authentication config hash contains the series of realm
828 configurations you want to use for your app. The only rule here is
829 that there must be at least one. A realm consists of a name, which is used
830 to reference the realm, a credential and a store. You may also put your
831 realm configurations within a subelement called 'realms' if you desire to
832 separate them from the remainder of your configuration. Note that if you use
833 a 'realms' subelement, you must put ALL of your realms within it.
835 You can also specify a realm class to instantiate instead of the default
836 L<Catalyst::Authentication::Realm> class using the 'class' element within the
839 Each realm config contains two hashes, one called 'credential' and one called
840 'store', each of which provide configuration details to the respective modules.
841 The contents of these hashes is specific to the module being used, with the
842 exception of the 'class' element, which tells the core Authentication module the
843 classname to instantiate.
845 The 'class' element follows the standard Catalyst mechanism of class
846 specification. If a class is prefixed with a +, it is assumed to be a complete
847 class name. Otherwise it is considered to be a portion of the class name. For
848 credentials, the classname 'B<Password>', for example, is expanded to
849 Catalyst::Authentication::Credential::B<Password>. For stores, the
850 classname 'B<storename>' is expanded to:
851 Catalyst::Authentication::Store::B<storename>.
857 =head2 $c->authenticate( $userinfo [, $realm ])
859 Attempts to authenticate the user using the information in the $userinfo hash
860 reference using the realm $realm. $realm may be omitted, in which case the
861 default realm is checked.
865 Returns the currently logged in user, or undef if there is none.
866 Normally the user is re-retrieved from the store.
867 For L<Catalyst::Authentication::Store::DBIx::Class> the user is re-restored
868 using the primary key of the user table.
869 Thus B<user> can throw an error even though B<user_exists>
872 =head2 $c->user_exists( )
874 Returns true if a user is logged in right now. The difference between
875 B<user_exists> and B<user> is that user_exists will return true if a user is logged
876 in, even if it has not been yet retrieved from the storage backend. If you only
877 need to know if the user is logged in, depending on the storage mechanism this
878 can be much more efficient.
879 B<user_exists> only looks into the session while B<user> is trying to restore the user.
881 =head2 $c->user_in_realm( $realm )
883 Works like user_exists, except that it only returns true if a user is both
884 logged in right now and was retrieved from the realm provided.
888 Logs the user out. Deletes the currently logged in user from C<< $c->user >>
889 and the session. It does not delete the session.
891 =head2 $c->find_user( $userinfo, $realm )
893 Fetch a particular users details, matching the provided user info, from the realm
896 $user = $c->find_user({ id => $id });
897 $c->set_authenticated($user); # logs the user in and calls persist_user
899 =head2 persist_user()
901 Under normal circumstances the user data is only saved to the session during
902 initial authentication. This call causes the auth system to save the
903 currently authenticated user's data across requests. Useful if you have
904 changed the user data and want to ensure that future requests reflect the
905 most current data. Assumes that at the time of this call, $c->user
906 contains the most current data.
908 =head2 find_realm_for_persisted_user()
910 Private method, do not call from user code!
912 =head1 INTERNAL METHODS
914 These methods are for Catalyst::Plugin::Authentication B<INTERNAL USE> only.
915 Please do not use them in your own code, whether application or credential /
916 store modules. If you do, you will very likely get the nasty shock of having
917 to fix / rewrite your code when things change. They are documented here only
920 =head2 $c->set_authenticated( $user, $realmname )
922 Marks a user as authenticated. This is called from within the authenticate
923 routine when a credential returns a user. $realmname defaults to 'default'.
924 You can use find_user to get $user
926 =head2 $c->auth_restore_user( $user, $realmname )
928 Used to restore a user from the session. In most cases this is called without
929 arguments to restore the user via the session. Can be called with arguments
930 when restoring a user from some other method. Currently not used in this way.
932 =head2 $c->auth_realms( )
934 Returns a hashref containing realmname -> realm instance pairs. Realm
935 instances contain an instantiated store and credential object as the 'store'
936 and 'credential' elements, respectively
938 =head2 $c->get_auth_realm( $realmname )
940 Retrieves the realm instance for the realmname provided.
942 =head2 $c->update_user_in_session
944 This was a short-lived method to update user information - you should use persist_user instead.
946 =head2 $c->setup_auth_realm( )
948 =head1 OVERRIDDEN METHODS
954 This list might not be up to date. Below are modules known to work with the updated
955 API of 0.10 and are therefore compatible with realms.
959 L<Catalyst::Authentication::Realm>
961 =head2 User Storage Backends
965 =item L<Catalyst::Authentication::Store::Minimal>
967 =item L<Catalyst::Authentication::Store::DBIx::Class>
969 =item L<Catalyst::Authentication::Store::LDAP>
971 =item L<Catalyst::Authentication::Store::RDBO>
973 =item L<Catalyst::Authentication::Store::Model::KiokuDB>
975 =item L<Catalyst::Authentication::Store::Jifty::DBI>
977 =item L<Catalyst::Authentication::Store::Htpasswd>
981 =head2 Credential verification
985 =item L<Catalyst::Authentication::Credential::Password>
987 =item L<Catalyst::Authentication::Credential::HTTP>
989 =item L<Catalyst::Authentication::Credential::OpenID>
991 =item L<Catalyst::Authentication::Credential::Authen::Simple>
993 =item L<Catalyst::Authentication::Credential::Flickr>
995 =item L<Catalyst::Authentication::Credential::Testing>
997 =item L<Catalyst::Authentication::Credential::AuthTkt>
999 =item L<Catalyst::Authentication::Credential::Kerberos>
1003 =head2 Authorization
1005 L<Catalyst::Plugin::Authorization::ACL>,
1006 L<Catalyst::Plugin::Authorization::Roles>
1008 =head2 Internals Documentation
1010 L<Catalyst::Plugin::Authentication::Internals>
1014 L<Catalyst::Plugin::Session>,
1015 L<Catalyst::Plugin::Session::PerUser>
1017 =head1 DON'T SEE ALSO
1019 This module along with its sub plugins deprecate a great number of other
1020 modules. These include L<Catalyst::Plugin::Authentication::Simple>,
1021 L<Catalyst::Plugin::Authentication::CDBI>.
1023 =head1 INCOMPATABILITIES
1025 The realms-based configuration and functionality of the 0.10 update
1026 of L<Catalyst::Plugin::Authentication> required a change in the API used by
1027 credentials and stores. It has a compatibility mode which allows use of
1028 modules that have not yet been updated. This, however, completely mimics the
1029 older api and disables the new realm-based features. In other words you cannot
1030 mix the older credential and store modules with realms, or realm-based
1031 configs. The changes required to update modules are relatively minor and are
1032 covered in L<Catalyst::Plugin::Authentication::Internals>. We hope that most
1033 modules will move to the compatible list above very quickly.
1035 =head1 COMPATIBILITY CONFIGURATION
1037 Until version 0.10008 of this module, you needed to put all the
1038 realms inside a "realms" key in the configuration.
1041 __PACKAGE__->config( 'Plugin::Authentication' =>
1043 default_realm => 'members',
1052 If you use the old, deprecated C<< __PACKAGE__->config( 'authentication' ) >>
1053 configuration key, then the realms key is still required.
1055 =head1 COMPATIBILITY ROUTINES
1057 In version 0.10 of L<Catalyst::Plugin::Authentication>, the API
1058 changed. For app developers, this change is fairly minor, but for
1059 Credential and Store authors, the changes are significant.
1061 Please see the documentation in version 0.09 of
1062 Catalyst::Plugin::Authentication for a better understanding of how the old API
1065 The items below are still present in the plugin, though using them is
1066 deprecated. They remain only as a transition tool, for those sites which can
1067 not yet be upgraded to use the new system due to local customizations or use
1068 of Credential / Store modules that have not yet been updated to work with the
1071 These routines should not be used in any application using realms
1072 functionality or any of the methods described above. These are for reference
1077 This method is used to initiate authentication and user retrieval. Technically
1078 this is part of the old Password credential module and it still resides in the
1079 L<Password|Catalyst::Plugin::Authentication::Credential::Password> class. It is
1080 included here for reference only.
1082 =head2 $c->default_auth_store( )
1084 Return the store whose name is 'default'.
1086 This is set to C<< $c->config( 'Plugin::Authentication' => { store => # Store} ) >> if that value exists,
1087 or by using a Store plugin:
1089 # load the Minimal authentication store.
1090 use Catalyst qw/Authentication Authentication::Store::Minimal/;
1092 Sets the default store to
1093 L<Catalyst::Plugin::Authentication::Store::Minimal>.
1095 =head2 $c->get_auth_store( $name )
1097 Return the store whose name is $name.
1099 =head2 $c->get_auth_store_name( $store )
1101 Return the name of the store $store.
1103 =head2 $c->auth_stores( )
1105 A hash keyed by name, with the stores registered in the app.
1107 =head2 $c->register_auth_stores( %stores_by_name )
1109 Register stores into the application.
1111 =head2 $c->auth_store_names( )
1113 =head2 $c->get_user( )
1117 Yuval Kogman, C<nothingmuch@woobling.org>
1119 Jay Kuri, C<jayk@cpan.org>
1125 Tomas Doran (t0m), C<bobtfish@bobtfish.net>
1131 Florian Ragwitz C<rafl@debian.org>
1133 Stephan Jauernick C<stephanj@cpan.org>
1135 Oskari Ojala (Okko), C<perl@okko.net>
1137 John Napiorkowski (jnap) C<jjnapiork@cpan.org>
1139 =head1 COPYRIGHT & LICENSE
1141 Copyright (c) 2005 - 2012
1142 the Catalyst::Plugin::Authentication L</AUTHORS>
1145 This program is free software; you can redistribute
1146 it and/or modify it under the same terms as Perl itself.