1 package Catalyst::Authentication::Realm;
6 use base qw/Class::Accessor::Fast/;
9 __PACKAGE__->mk_accessors(qw/store credential name config/);
12 ## Add use_session config item to realm.
15 my ($class, $realmname, $config, $app) = @_;
17 my $self = { config => $config };
20 $self->name($realmname);
22 if (!exists($self->config->{'use_session'})) {
23 if (exists($app->config->{'Plugin::Authentication'}{'use_session'})) {
24 $self->config->{'use_session'} = $app->config->{'Plugin::Authentication'}{'use_session'};
26 $self->config->{'use_session'} = 1;
30 $app->log->debug("Setting up auth realm $realmname") if $app->debug;
32 # use the Null store as a default
33 if( ! exists $config->{store}{class} ) {
34 $config->{store}{class} = '+Catalyst::Authentication::Store::Null';
35 $app->log->debug( qq(No Store specified for realm "$realmname", using the Null store.) );
37 my $storeclass = $config->{'store'}{'class'};
39 ## follow catalyst class naming - a + prefix means a fully qualified class, otherwise it's
40 ## taken to mean C::P::A::Store::(specifiedclass)
41 if ($storeclass !~ /^\+(.*)$/ ) {
42 $storeclass = "Catalyst::Authentication::Store::${storeclass}";
47 # a little niceness - since most systems seem to use the password credential class,
48 # if no credential class is specified we use password.
49 $config->{credential}{class} ||= '+Catalyst::Authentication::Credential::Password';
51 my $credentialclass = $config->{'credential'}{'class'};
53 ## follow catalyst class naming - a + prefix means a fully qualified class, otherwise it's
54 ## taken to mean C::A::Credential::(specifiedclass)
55 if ($credentialclass !~ /^\+(.*)$/ ) {
56 $credentialclass = "Catalyst::Authentication::Credential::${credentialclass}";
58 $credentialclass = $1;
61 # if we made it here - we have what we need to load the classes
63 ### BACKWARDS COMPATIBILITY - DEPRECATION WARNING:
64 ### we must eval the ensure_class_loaded - because we might need to try the old-style
65 ### ::Plugin:: module naming if the standard method fails.
67 ## Note to self - catch second exception and bitch in detail?
70 Catalyst::Utils::ensure_class_loaded( $credentialclass );
74 # If the file is missing, then try the old-style fallback,
75 # but re-throw anything else for the user to deal with.
76 die unless $@ =~ /^Can't locate/;
77 $app->log->warn( qq(Credential class "$credentialclass" not found, trying deprecated ::Plugin:: style naming. ) );
78 my $origcredentialclass = $credentialclass;
79 $credentialclass =~ s/Catalyst::Authentication/Catalyst::Plugin::Authentication/;
81 eval { Catalyst::Utils::ensure_class_loaded( $credentialclass ); };
83 # Likewise this croak is useful if the second exception is also "not found",
84 # but would be confusing if it's anything else.
85 die unless $@ =~ /^Can't locate/;
86 Carp::croak "Unable to load credential class, " . $origcredentialclass . " OR " . $credentialclass .
87 " in realm " . $self->name;
92 Catalyst::Utils::ensure_class_loaded( $storeclass );
96 # If the file is missing, then try the old-style fallback,
97 # but re-throw anything else for the user to deal with.
98 die unless $@ =~ /^Can't locate/;
99 $app->log->warn( qq(Store class "$storeclass" not found, trying deprecated ::Plugin:: style naming. ) );
100 my $origstoreclass = $storeclass;
101 $storeclass =~ s/Catalyst::Authentication/Catalyst::Plugin::Authentication/;
102 eval { Catalyst::Utils::ensure_class_loaded( $storeclass ); };
104 # Likewise this croak is useful if the second exception is also "not found",
105 # but would be confusing if it's anything else.
106 die unless $@ =~ /^Can't locate/;
107 Carp::croak "Unable to load store class, " . $origstoreclass . " OR " . $storeclass .
108 " in realm " . $self->name;
112 # BACKWARDS COMPATIBILITY - if the store class does not define find_user, we define it in terms
113 # of get_user and add it to the class. this is because the auth routines use find_user,
114 # and rely on it being present. (this avoids per-call checks)
115 if (!$storeclass->can('find_user')) {
117 *{"${storeclass}::find_user"} = sub {
118 my ($self, $info) = @_;
119 my @rest = @{$info->{rest}} if exists($info->{rest});
120 $self->get_user($info->{id}, @rest);
124 ## a little cruft to stay compatible with some poorly written stores / credentials
125 ## we'll remove this soon.
126 if ($storeclass->can('new')) {
127 $self->store($storeclass->new($config->{'store'}, $app, $self));
129 $app->log->error("THIS IS DEPRECATED: $storeclass has no new() method - Attempting to use uninstantiated");
130 $self->store($storeclass);
132 if ($credentialclass->can('new')) {
133 $self->credential($credentialclass->new($config->{'credential'}, $app, $self));
135 $app->log->error("THIS IS DEPRECATED: $credentialclass has no new() method - Attempting to use uninstantiated");
136 $self->credential($credentialclass);
143 my ( $self, $authinfo, $c ) = @_;
145 my $res = $self->store->find_user($authinfo, $c);
148 if ($self->config->{'auto_create_user'} && $self->store->can('auto_create_user') ) {
149 $res = $self->store->auto_create_user($authinfo, $c);
151 } elsif ($self->config->{'auto_update_user'} && $self->store->can('auto_update_user')) {
152 $res = $self->store->auto_update_user($authinfo, $c, $res);
159 my ($self, $c, $authinfo) = @_;
161 my $user = $self->credential->authenticate($c, $self, $authinfo);
163 $c->set_authenticated($user, $self->name);
170 sub user_is_restorable {
174 $c->isa("Catalyst::Plugin::Session")
175 and $self->config->{'use_session'}
176 and $c->session_is_valid;
178 return $c->session->{__user};
182 my ($self, $c, $frozen_user) = @_;
184 $frozen_user ||= $self->user_is_restorable($c);
185 return unless defined($frozen_user);
187 my $user = $self->from_session( $c, $frozen_user );
192 # this sets the realm the user originated in.
193 $user->auth_realm($self->name);
195 $c->log->error("Store claimed to have a restorable user, but restoration failed. Did you change the user's id_field?");
196 $self->failed_user_restore($c);
202 ## this occurs if there is a session but the thing the session refers to
203 ## can not be found. Do what you must do here.
204 sub failed_user_restore {
207 $self->remove_persisted_user($c);
211 my ($self, $c, $user) = @_;
214 $c->isa("Catalyst::Plugin::Session")
215 and $self->config->{'use_session'}
216 and $user->supports("session")
218 $c->session->{__user_realm} = $self->name;
220 # we want to ask the store for a user prepared for the session.
221 # but older modules split this functionality between the user and the
222 # store. We try the store first. If not, we use the old method.
223 if ($self->store->can('for_session')) {
224 $c->session->{__user} = $self->store->for_session($c, $user);
226 $c->session->{__user} = $user->for_session;
232 sub remove_persisted_user {
236 $c->isa("Catalyst::Plugin::Session")
237 and $self->config->{'use_session'}
238 and $c->session_is_valid
240 delete @{ $c->session }{qw/__user __user_realm/};
244 ## backwards compatibility - I don't think many people wrote realms since they
245 ## have only existed for a short time - but just in case.
246 sub save_user_in_session {
247 my ( $self, $c, $user ) = @_;
249 return $self->persist_user($c, $user);
253 my ($self, $c, $frozen_user) = @_;
255 return $self->store->from_session($c, $frozen_user);
267 Catalyst::Authentication::Realm - Base class for realm objects.
277 By default this class is used by
278 L<Catalyst::Plugin::Authentication|Catalyst::Plugin::Authentication> for all
279 realms. The class parameter allows you to choose a different class to use for
280 this realm. Creating a new Realm class can allow for authentication methods
281 that fall outside the normal credential/store methodology.
283 =item auto_create_user
285 Set this to true if you wish this realm to auto-create user accounts when the
286 user doesn't exist (most useful for remote authentication schemes).
288 =item auto_update_user
290 Set this to true if you wish this realm to auto-update user accounts after
291 authentication (most useful for remote authentication schemes).
295 Sets session usage for this particular realm - overriding the global use_sesion setting.
302 =head2 new( $realmname, $config, $app )
304 Instantiantes this realm, plus the specified store and credential classes.
308 Returns an instance of the store object for this realm.
312 Returns an instance of the credential object for this realm.
314 =head2 find_user( $authinfo, $c )
316 Retrieves the user given the authentication information provided. This
317 is most often called from the credential. The default realm class simply
318 delegates this call the store object. If enabled, auto-creation and
319 auto-updating of users is also handled here.
321 =head2 authenticate( $c, $authinfo)
323 Performs the authentication process for the current realm. The default
324 realm class simply delegates this to the credential and sets
325 the authenticated user on success. Returns the authenticated user object;
327 =head1 USER PERSISTENCE
329 The Realm class allows complete control over the persistance of users
330 between requests. By default the realm attempts to use the Catalyst
331 session system to accomplish this. By overriding the methods below
332 in a custom Realm class, however, you can handle user persistance in
335 =head2 persist_user($c, $user)
337 persist_user is the entry point for saving user information between requests
338 in most cases this will utilize the session. By default this uses the
339 catalyst session system to store the user by calling for_session on the
340 active store. The user object must be a subclass of
341 Catalyst::Authentication::User. If you have updated the user object, you
342 must call persist_user again to ensure that the persisted user object reflects
345 =head2 remove_persisted_user($c)
347 Removes any persisted user data. By default, removes the user from the session.
349 =head2 user_is_restorable( $c )
351 Returns whether there is a persisted user that may be restored. Returns
352 a token used to restore the user. With the default session persistance
353 it returns the raw frozen user information.
355 =head2 restore_user($c, [$frozen_user])
357 Restores the user from the given frozen_user parameter, or if not provided,
358 using the response from $self->user_is_restorable(); Uses $self->from_session()
359 to decode the frozen user.
361 =head2 failed_user_restore($c)
363 If there is a session to restore, but the restore fails for any reason then this method
364 is called. This method supplied just removes the persisted user, but can be overridden
365 if required to have more complex logic (e.g. finding a the user by their 'old' username).
367 =head2 from_session($c, $frozenuser )
369 Decodes the frozenuser information provided and returns an instantiated
370 user object. By default, this call is delegated to $store->from_session().
372 =head2 save_user_in_session($c, $user)
374 DEPRECATED. Use persist_user instead. (this simply calls persist_user)