Commit | Line | Data |
06675d2e |
1 | #!/usr/bin/perl |
2 | |
3 | package Catalyst::Plugin::Authentication; |
4 | |
b003080b |
5 | use base qw/Class::Accessor::Fast Class::Data::Inheritable/; |
06675d2e |
6 | |
b003080b |
7 | BEGIN { |
7bb06c91 |
8 | __PACKAGE__->mk_accessors(qw/_user/); |
b003080b |
9 | } |
06675d2e |
10 | |
11 | use strict; |
12 | use warnings; |
13 | |
96777f3a |
14 | use Tie::RefHash; |
12dae309 |
15 | use Class::Inspector; |
96777f3a |
16 | |
bbf1cb39 |
17 | # this optimization breaks under Template::Toolkit |
18 | # use user_exists instead |
e145babc |
19 | #BEGIN { |
20 | # require constant; |
21 | # constant->import(have_want => eval { require Want }); |
22 | #} |
a1e5bd36 |
23 | |
7a8da4b8 |
24 | our $VERSION = "0.10001"; |
c7c003d3 |
25 | |
06675d2e |
26 | sub set_authenticated { |
54c8dc06 |
27 | my ( $c, $user, $realmname ) = @_; |
06675d2e |
28 | |
29 | $c->user($user); |
e300c5b6 |
30 | $c->request->{user} = $user; # compatibility kludge |
06675d2e |
31 | |
54c8dc06 |
32 | if (!$realmname) { |
33 | $realmname = 'default'; |
06675d2e |
34 | } |
54c8dc06 |
35 | |
36 | if ( $c->isa("Catalyst::Plugin::Session") |
37 | and $c->config->{authentication}{use_session} |
38 | and $user->supports("session") ) |
39 | { |
e8919861 |
40 | $c->save_user_in_session($user, $realmname); |
54c8dc06 |
41 | } |
45c7644b |
42 | $user->auth_realm($realmname); |
815ee585 |
43 | $user->store(ref($c->auth_realms->{$realmname}{'store'})); |
54c8dc06 |
44 | |
45 | $c->NEXT::set_authenticated($user, $realmname); |
06675d2e |
46 | } |
47 | |
7bb06c91 |
48 | sub user { |
e300c5b6 |
49 | my $c = shift; |
7bb06c91 |
50 | |
e300c5b6 |
51 | if (@_) { |
52 | return $c->_user(@_); |
53 | } |
7bb06c91 |
54 | |
45c7644b |
55 | if ( defined($c->_user) ) { |
56 | return $c->_user; |
56e23e7a |
57 | } else { |
47c6643f |
58 | return $c->auth_restore_user; |
e300c5b6 |
59 | } |
7bb06c91 |
60 | } |
61 | |
54c8dc06 |
62 | # change this to allow specification of a realm - to verify the user is part of that realm |
63 | # in addition to verifying that they exist. |
ce0b058d |
64 | sub user_exists { |
65 | my $c = shift; |
9deccb83 |
66 | return defined($c->_user) || defined($c->_user_in_session); |
56e23e7a |
67 | } |
68 | |
45c7644b |
69 | # works like user_exists - except only returns true if user |
70 | # exists AND is in the realm requested. |
71 | sub user_in_realm { |
72 | my ($c, $realmname) = @_; |
73 | |
74 | if (defined($c->_user)) { |
75 | return ($c->_user->auth_realm eq $realmname); |
76 | } elsif (defined($c->_user_in_session)) { |
77 | return ($c->session->{__user_realm} eq $realmname); |
78 | } else { |
79 | return undef; |
80 | } |
81 | } |
54c8dc06 |
82 | |
12dae309 |
83 | sub save_user_in_session { |
e8919861 |
84 | my ( $c, $user, $realmname ) = @_; |
12dae309 |
85 | |
54c8dc06 |
86 | $c->session->{__user_realm} = $realmname; |
87 | |
45c7644b |
88 | # we want to ask the store for a user prepared for the session. |
54c8dc06 |
89 | # but older modules split this functionality between the user and the |
45c7644b |
90 | # store. We try the store first. If not, we use the old method. |
54c8dc06 |
91 | my $realm = $c->get_auth_realm($realmname); |
92 | if ($realm->{'store'}->can('for_session')) { |
93 | $c->session->{__user} = $realm->{'store'}->for_session($c, $user); |
94 | } else { |
95 | $c->session->{__user} = $user->for_session; |
96 | } |
12dae309 |
97 | } |
98 | |
06675d2e |
99 | sub logout { |
100 | my $c = shift; |
101 | |
102 | $c->user(undef); |
b003080b |
103 | |
54c8dc06 |
104 | if ( |
105 | $c->isa("Catalyst::Plugin::Session") |
106 | and $c->config->{authentication}{use_session} |
107 | and $c->session_is_valid |
108 | ) { |
109 | delete @{ $c->session }{qw/__user __user_realm/}; |
b003080b |
110 | } |
351e2a82 |
111 | |
112 | $c->NEXT::logout(@_); |
06675d2e |
113 | } |
114 | |
54c8dc06 |
115 | sub find_user { |
116 | my ( $c, $userinfo, $realmname ) = @_; |
117 | |
118 | $realmname ||= 'default'; |
119 | my $realm = $c->get_auth_realm($realmname); |
120 | if ( $realm->{'store'} ) { |
121 | return $realm->{'store'}->find_user($userinfo, $c); |
122 | } else { |
123 | $c->log->debug('find_user: unable to locate a store matching the requested realm'); |
7d0922d8 |
124 | } |
125 | } |
126 | |
54c8dc06 |
127 | |
47c6643f |
128 | sub _user_in_session { |
129 | my $c = shift; |
130 | |
57751a69 |
131 | return unless |
132 | $c->isa("Catalyst::Plugin::Session") |
133 | and $c->config->{authentication}{use_session} |
134 | and $c->session_is_valid; |
47c6643f |
135 | |
136 | return $c->session->{__user}; |
488433fd |
137 | } |
47c6643f |
138 | |
7bb06c91 |
139 | sub auth_restore_user { |
54c8dc06 |
140 | my ( $c, $frozen_user, $realmname ) = @_; |
7bb06c91 |
141 | |
47c6643f |
142 | $frozen_user ||= $c->_user_in_session; |
143 | return unless defined($frozen_user); |
4402d92d |
144 | |
54c8dc06 |
145 | $realmname ||= $c->session->{__user_realm}; |
146 | return unless $realmname; # FIXME die unless? This is an internal inconsistency |
7bb06c91 |
147 | |
54c8dc06 |
148 | my $realm = $c->get_auth_realm($realmname); |
149 | $c->_user( my $user = $realm->{'store'}->from_session( $c, $frozen_user ) ); |
150 | |
151 | # this sets the realm the user originated in. |
45c7644b |
152 | $user->auth_realm($realmname); |
815ee585 |
153 | ## compatibility - some pre 0.10 store / credentials may need the store name, |
154 | ## this is not used by the current api in any form. |
155 | $user->store(ref($c->auth_realms->{$realmname}{'store'})); |
156 | |
e300c5b6 |
157 | return $user; |
7bb06c91 |
158 | |
159 | } |
160 | |
54c8dc06 |
161 | # we can't actually do our setup in setup because the model has not yet been loaded. |
162 | # So we have to trigger off of setup_finished. :-( |
06675d2e |
163 | sub setup { |
c5fbff80 |
164 | my $app = shift; |
06675d2e |
165 | |
c5fbff80 |
166 | $app->_authentication_initialize(); |
167 | $app->NEXT::setup(@_); |
54c8dc06 |
168 | } |
169 | |
170 | ## the actual initialization routine. whee. |
171 | sub _authentication_initialize { |
c5fbff80 |
172 | my $app = shift; |
54c8dc06 |
173 | |
d6209239 |
174 | ## let's avoid recreating / configuring everything if we have already done it, eh? |
175 | if ($app->can('_auth_realms')) { return }; |
c5fbff80 |
176 | |
d6209239 |
177 | ## make classdata where it is used. |
178 | $app->mk_classdata( '_auth_realms' => {}); |
937d5ab9 |
179 | |
c5fbff80 |
180 | my $cfg = $app->config->{'authentication'} ||= {}; |
06675d2e |
181 | |
c5fbff80 |
182 | $cfg->{use_session} = 1; |
c5fbff80 |
183 | |
54c8dc06 |
184 | if (exists($cfg->{'realms'})) { |
54c8dc06 |
185 | foreach my $realm (keys %{$cfg->{'realms'}}) { |
c5fbff80 |
186 | $app->setup_auth_realm($realm, $cfg->{'realms'}{$realm}); |
54c8dc06 |
187 | } |
54c8dc06 |
188 | # if we have a 'default-realm' in the config hash and we don't already |
189 | # have a realm called 'default', we point default at the realm specified |
c5fbff80 |
190 | if (exists($cfg->{'default_realm'}) && !$app->get_auth_realm('default')) { |
191 | $app->_set_default_auth_realm($cfg->{'default_realm'}); |
54c8dc06 |
192 | } |
193 | } else { |
c5fbff80 |
194 | |
58db3441 |
195 | ## BACKWARDS COMPATIBILITY - if realms is not defined - then we are probably dealing |
c5fbff80 |
196 | ## with an old-school config. The only caveat here is that we must add a classname |
197 | |
58db3441 |
198 | ## also - we have to treat {store} as {stores}{default} - because |
199 | ## while it is not a clear as a valid config in the docs, it |
200 | ## is functional with the old api. Whee! |
201 | if (exists($cfg->{'store'}) && !exists($cfg->{'stores'}{'default'})) { |
202 | $cfg->{'stores'}{'default'} = $cfg->{'store'}; |
203 | } |
204 | |
54c8dc06 |
205 | foreach my $storename (keys %{$cfg->{'stores'}}) { |
206 | my $realmcfg = { |
58db3441 |
207 | store => { class => $cfg->{'stores'}{$storename} }, |
54c8dc06 |
208 | }; |
c5fbff80 |
209 | $app->setup_auth_realm($storename, $realmcfg); |
54c8dc06 |
210 | } |
211 | } |
212 | |
06675d2e |
213 | } |
214 | |
54c8dc06 |
215 | # set up realmname. |
216 | sub setup_auth_realm { |
217 | my ($app, $realmname, $config) = @_; |
218 | |
cccb9b5e |
219 | $app->log->debug("Setting up auth realm $realmname") if $app->debug; |
54c8dc06 |
220 | if (!exists($config->{'store'}{'class'})) { |
221 | Carp::croak "Couldn't setup the authentication realm named '$realmname', no class defined"; |
222 | } |
223 | |
224 | # use the |
225 | my $storeclass = $config->{'store'}{'class'}; |
226 | |
227 | ## follow catalyst class naming - a + prefix means a fully qualified class, otherwise it's |
45c7644b |
228 | ## taken to mean C::P::A::Store::(specifiedclass) |
54c8dc06 |
229 | if ($storeclass !~ /^\+(.*)$/ ) { |
45c7644b |
230 | $storeclass = "Catalyst::Plugin::Authentication::Store::${storeclass}"; |
54c8dc06 |
231 | } else { |
232 | $storeclass = $1; |
233 | } |
234 | |
235 | |
236 | # a little niceness - since most systems seem to use the password credential class, |
237 | # if no credential class is specified we use password. |
58db3441 |
238 | $config->{credential}{class} ||= '+Catalyst::Plugin::Authentication::Credential::Password'; |
54c8dc06 |
239 | |
240 | my $credentialclass = $config->{'credential'}{'class'}; |
241 | |
242 | ## follow catalyst class naming - a + prefix means a fully qualified class, otherwise it's |
243 | ## taken to mean C::P::A::Credential::(specifiedclass) |
244 | if ($credentialclass !~ /^\+(.*)$/ ) { |
245 | $credentialclass = "Catalyst::Plugin::Authentication::Credential::${credentialclass}"; |
246 | } else { |
247 | $credentialclass = $1; |
248 | } |
249 | |
250 | # if we made it here - we have what we need to load the classes; |
251 | Catalyst::Utils::ensure_class_loaded( $credentialclass ); |
252 | Catalyst::Utils::ensure_class_loaded( $storeclass ); |
253 | |
254 | # BACKWARDS COMPATIBILITY - if the store class does not define find_user, we define it in terms |
255 | # of get_user and add it to the class. this is because the auth routines use find_user, |
256 | # and rely on it being present. (this avoids per-call checks) |
257 | if (!$storeclass->can('find_user')) { |
258 | no strict 'refs'; |
259 | *{"${storeclass}::find_user"} = sub { |
260 | my ($self, $info) = @_; |
261 | my @rest = @{$info->{rest}} if exists($info->{rest}); |
262 | $self->get_user($info->{id}, @rest); |
263 | }; |
264 | } |
265 | |
58db3441 |
266 | ## a little cruft to stay compatible with some poorly written stores / credentials |
267 | ## we'll remove this soon. |
268 | if ($storeclass->can('new')) { |
269 | $app->auth_realms->{$realmname}{'store'} = $storeclass->new($config->{'store'}, $app); |
270 | } else { |
271 | $app->log->error("THIS IS DEPRECATED: $storeclass has no new() method - Attempting to use uninstantiated"); |
272 | $app->auth_realms->{$realmname}{'store'} = $storeclass; |
273 | } |
274 | if ($credentialclass->can('new')) { |
275 | $app->auth_realms->{$realmname}{'credential'} = $credentialclass->new($config->{'credential'}, $app); |
276 | } else { |
277 | $app->log->error("THIS IS DEPRECATED: $credentialclass has no new() method - Attempting to use uninstantiated"); |
278 | $app->auth_realms->{$realmname}{'credential'} = $credentialclass; |
279 | } |
96777f3a |
280 | } |
281 | |
54c8dc06 |
282 | sub auth_realms { |
283 | my $self = shift; |
284 | return($self->_auth_realms); |
96777f3a |
285 | } |
286 | |
54c8dc06 |
287 | sub get_auth_realm { |
288 | my ($app, $realmname) = @_; |
289 | return $app->auth_realms->{$realmname}; |
290 | } |
96777f3a |
291 | |
e8919861 |
292 | |
293 | # Very internal method. Vital Valuable Urgent, Do not touch on pain of death. |
294 | # Using this method just assigns the default realm to be the value associated |
295 | # with the realmname provided. It WILL overwrite any real realm called 'default' |
296 | # so can be very confusing if used improperly. It's used properly already. |
297 | # Translation: don't use it. |
298 | sub _set_default_auth_realm { |
54c8dc06 |
299 | my ($app, $realmname) = @_; |
300 | |
301 | if (exists($app->auth_realms->{$realmname})) { |
302 | $app->auth_realms->{'default'} = $app->auth_realms->{$realmname}; |
12dae309 |
303 | } |
54c8dc06 |
304 | return $app->get_auth_realm('default'); |
96777f3a |
305 | } |
306 | |
54c8dc06 |
307 | sub authenticate { |
308 | my ($app, $userinfo, $realmname) = @_; |
309 | |
310 | if (!$realmname) { |
311 | $realmname = 'default'; |
312 | } |
313 | |
314 | my $realm = $app->get_auth_realm($realmname); |
315 | |
45c7644b |
316 | ## note to self - make authenticate throw an exception if realm is invalid. |
317 | |
54c8dc06 |
318 | if ($realm && exists($realm->{'credential'})) { |
319 | my $user = $realm->{'credential'}->authenticate($app, $realm->{store}, $userinfo); |
649de93b |
320 | if (ref($user)) { |
54c8dc06 |
321 | $app->set_authenticated($user, $realmname); |
322 | return $user; |
323 | } |
324 | } else { |
325 | $app->log->debug("The realm requested, '$realmname' does not exist," . |
326 | " or there is no credential associated with it.") |
327 | } |
0cc778ab |
328 | return undef; |
96777f3a |
329 | } |
330 | |
54c8dc06 |
331 | ## BACKWARDS COMPATIBILITY -- Warning: Here be monsters! |
332 | # |
333 | # What follows are backwards compatibility routines - for use with Stores and Credentials |
334 | # that have not been updated to work with C::P::Authentication v0.10. |
335 | # These are here so as to not break people's existing installations, but will go away |
336 | # in a future version. |
337 | # |
338 | # The old style of configuration only supports a single store, as each store module |
339 | # sets itself as the default store upon being loaded. This is the only supported |
340 | # 'compatibility' mode. |
341 | # |
342 | |
343 | sub get_user { |
344 | my ( $c, $uid, @rest ) = @_; |
96777f3a |
345 | |
54c8dc06 |
346 | return $c->find_user( {'id' => $uid, 'rest'=>\@rest }, 'default' ); |
96777f3a |
347 | } |
348 | |
e8919861 |
349 | |
54c8dc06 |
350 | ## this should only be called when using old-style authentication plugins. IF this gets |
351 | ## called in a new-style config - it will OVERWRITE the store of your default realm. Don't do it. |
352 | ## also - this is a partial setup - because no credential is instantiated... in other words it ONLY |
353 | ## works with old-style auth plugins and C::P::Authentication in compatibility mode. Trying to combine |
354 | ## this with a realm-type config will probably crash your app. |
96777f3a |
355 | sub default_auth_store { |
12dae309 |
356 | my $self = shift; |
96777f3a |
357 | |
12dae309 |
358 | if ( my $new = shift ) { |
54c8dc06 |
359 | $self->auth_realms->{'default'}{'store'} = $new; |
58db3441 |
360 | |
361 | my $storeclass; |
362 | if (ref($new)) { |
363 | $storeclass = ref($new); |
364 | } else { |
365 | $storeclass = $new; |
366 | } |
54c8dc06 |
367 | |
368 | # BACKWARDS COMPATIBILITY - if the store class does not define find_user, we define it in terms |
369 | # of get_user and add it to the class. this is because the auth routines use find_user, |
370 | # and rely on it being present. (this avoids per-call checks) |
371 | if (!$storeclass->can('find_user')) { |
372 | no strict 'refs'; |
373 | *{"${storeclass}::find_user"} = sub { |
374 | my ($self, $info) = @_; |
375 | my @rest = @{$info->{rest}} if exists($info->{rest}); |
376 | $self->get_user($info->{id}, @rest); |
377 | }; |
378 | } |
12dae309 |
379 | } |
96777f3a |
380 | |
54c8dc06 |
381 | return $self->get_auth_realm('default')->{'store'}; |
96777f3a |
382 | } |
383 | |
54c8dc06 |
384 | ## BACKWARDS COMPATIBILITY |
385 | ## this only ever returns a hash containing 'default' - as that is the only |
386 | ## supported mode of calling this. |
387 | sub auth_store_names { |
388 | my $self = shift; |
389 | |
390 | my %hash = ( $self->get_auth_realm('default')->{'store'} => 'default' ); |
391 | } |
392 | |
393 | sub get_auth_store { |
394 | my ( $self, $name ) = @_; |
395 | |
396 | if ($name ne 'default') { |
397 | Carp::croak "get_auth_store called on non-default realm '$name'. Only default supported in compatibility mode"; |
398 | } else { |
399 | $self->default_auth_store(); |
400 | } |
401 | } |
402 | |
403 | sub get_auth_store_name { |
404 | my ( $self, $store ) = @_; |
405 | return 'default'; |
406 | } |
407 | |
408 | # sub auth_stores is only used internally - here for completeness |
409 | sub auth_stores { |
410 | my $self = shift; |
411 | |
412 | my %hash = ( 'default' => $self->get_auth_realm('default')->{'store'}); |
413 | } |
414 | |
06675d2e |
415 | __PACKAGE__; |
416 | |
417 | __END__ |
418 | |
419 | =pod |
420 | |
421 | =head1 NAME |
422 | |
55395841 |
423 | Catalyst::Plugin::Authentication - Infrastructure plugin for the Catalyst |
424 | authentication framework. |
06675d2e |
425 | |
426 | =head1 SYNOPSIS |
427 | |
189b5b0c |
428 | use Catalyst qw/ |
429 | Authentication |
189b5b0c |
430 | /; |
431 | |
432 | # later on ... |
c5fbff80 |
433 | $c->authenticate({ username => 'myusername', |
434 | password => 'mypassword' }); |
54c8dc06 |
435 | my $age = $c->user->get('age'); |
189b5b0c |
436 | $c->logout; |
06675d2e |
437 | |
438 | =head1 DESCRIPTION |
439 | |
16ef3eb8 |
440 | The authentication plugin provides generic user support for Catalyst apps. It |
441 | is the basis for both authentication (checking the user is who they claim to |
442 | be), and authorization (allowing the user to do what the system authorises |
443 | them to do). |
444 | |
445 | Using authentication is split into two parts. A Store is used to actually |
446 | store the user information, and can store any amount of data related to the |
447 | user. Credentials are used to verify users, using information from the store, |
448 | given data from the frontend. A Credential and a Store are paired to form a |
e8919861 |
449 | 'Realm'. A Catalyst application using the authentication framework must have |
450 | at least one realm, and may have several. |
189b5b0c |
451 | |
6a36933d |
452 | To implement authentication in a Catalyst application you need to add this |
16ef3eb8 |
453 | module, and specify at least one realm in the configuration. |
189b5b0c |
454 | |
e7522758 |
455 | Authentication data can also be stored in a session, if the application |
456 | is using the L<Catalyst::Plugin::Session> module. |
06675d2e |
457 | |
30e90c6f |
458 | B<NOTE> in version 0.10 of this module, the interface to this module changed. |
459 | Please see L</COMPATIBILITY ROUTINES> for more information. |
e8919861 |
460 | |
4bb9b01c |
461 | =head1 INTRODUCTION |
462 | |
463 | =head2 The Authentication/Authorization Process |
464 | |
465 | Web applications typically need to identify a user - to tell the user apart |
466 | from other users. This is usually done in order to display private information |
467 | that is only that user's business, or to limit access to the application so |
468 | that only certain entities can access certain parts. |
469 | |
470 | This process is split up into several steps. First you ask the user to identify |
471 | themselves. At this point you can't be sure that the user is really who they |
472 | claim to be. |
473 | |
6a36933d |
474 | Then the user tells you who they are, and backs this claim with some piece of |
4bb9b01c |
475 | information that only the real user could give you. For example, a password is |
476 | a secret that is known to both the user and you. When the user tells you this |
477 | password you can assume they're in on the secret and can be trusted (ignore |
478 | identity theft for now). Checking the password, or any other proof is called |
479 | B<credential verification>. |
480 | |
481 | By this time you know exactly who the user is - the user's identity is |
16ef3eb8 |
482 | B<authenticated>. This is where this module's job stops, and your application |
483 | or other plugins step in. |
484 | |
485 | The next logical step is B<authorization>, the process of deciding what a user |
486 | is (or isn't) allowed to do. For example, say your users are split into two |
487 | main groups - regular users and administrators. You want to verify that the |
4bb9b01c |
488 | currently logged in user is indeed an administrator before performing the |
c5fbff80 |
489 | actions in an administrative part of your application. These decisions may be |
16ef3eb8 |
490 | made within your application code using just the information available after |
491 | authentication, or it may be facilitated by a number of plugins. |
4bb9b01c |
492 | |
493 | =head2 The Components In This Framework |
494 | |
62f27384 |
495 | =head3 Realms |
496 | |
497 | Configuration of the Catalyst::Plugin::Authentication framework is done in |
498 | terms of realms. In simplest terms, a realm is a pairing of a Credential |
499 | verifier and a User storage (Store) backend. |
500 | |
501 | An application can have any number of Realms, each of which operates |
502 | independant of the others. Each realm has a name, which is used to identify it |
503 | as the target of an authentication request. This name can be anything, such as |
504 | 'users' or 'members'. One realm must be defined as the default_realm, which is |
16ef3eb8 |
505 | used when no realm name is specified. More information about configuring |
506 | realms is available in the configuration section. |
62f27384 |
507 | |
4bb9b01c |
508 | =head3 Credential Verifiers |
509 | |
510 | When user input is transferred to the L<Catalyst> application (typically via |
16ef3eb8 |
511 | form inputs) the application may pass this information into the authentication |
512 | system through the $c->authenticate() method. From there, it is passed to the |
62f27384 |
513 | appropriate Credential verifier. |
4bb9b01c |
514 | |
515 | These plugins check the data, and ensure that it really proves the user is who |
516 | they claim to be. |
517 | |
518 | =head3 Storage Backends |
519 | |
45c7644b |
520 | The authentication data also identifies a user, and the Storage backend modules |
62f27384 |
521 | use this data to locate and return a standardized object-oriented |
522 | representation of a user. |
4bb9b01c |
523 | |
524 | When a user is retrieved from a store it is not necessarily authenticated. |
62f27384 |
525 | Credential verifiers accept a set of authentication data and use this |
526 | information to retrieve the user from the store they are paired with. |
4bb9b01c |
527 | |
528 | =head3 The Core Plugin |
529 | |
62f27384 |
530 | This plugin on its own is the glue, providing realm configuration, session |
4bb9b01c |
531 | integration, and other goodness for the other plugins. |
532 | |
533 | =head3 Other Plugins |
534 | |
535 | More layers of plugins can be stacked on top of the authentication code. For |
536 | example, L<Catalyst::Plugin::Session::PerUser> provides an abstraction of |
537 | browser sessions that is more persistent per users. |
538 | L<Catalyst::Plugin::Authorization::Roles> provides an accepted way to separate |
539 | and group users into categories, and then check which categories the current |
540 | user belongs to. |
541 | |
5e91c057 |
542 | =head1 EXAMPLE |
543 | |
16ef3eb8 |
544 | Let's say we were storing users in a simple perl hash. Users are |
545 | verified by supplying a password which is matched within the hash. |
5e91c057 |
546 | |
547 | This means that our application will begin like this: |
548 | |
549 | package MyApp; |
550 | |
551 | use Catalyst qw/ |
552 | Authentication |
5e91c057 |
553 | /; |
554 | |
62f27384 |
555 | __PACKAGE__->config->{authentication} = |
c5fbff80 |
556 | { |
557 | default_realm => 'members', |
558 | realms => { |
559 | members => { |
560 | credential => { |
561 | class => 'Password', |
562 | password_field => 'password', |
563 | password_type => 'clear' |
564 | }, |
565 | store => { |
566 | class => 'Minimal', |
567 | users = { |
568 | bob => { |
569 | password => "s00p3r", |
570 | editor => 'yes', |
571 | roles => [qw/edit delete/], |
572 | }, |
573 | william => { |
574 | password => "s3cr3t", |
575 | roles => [qw/comment/], |
576 | } |
577 | } |
578 | } |
579 | } |
580 | } |
581 | }; |
62f27384 |
582 | |
5e91c057 |
583 | |
16ef3eb8 |
584 | This tells the authentication plugin what realms are available, which |
585 | credential and store modules are used, and the configuration of each. With |
586 | this code loaded, we can now attempt to authenticate users. |
5e91c057 |
587 | |
62f27384 |
588 | To show an example of this, let's create an authentication controller: |
5e91c057 |
589 | |
590 | package MyApp::Controller::Auth; |
591 | |
592 | sub login : Local { |
593 | my ( $self, $c ) = @_; |
594 | |
595 | if ( my $user = $c->req->param("user") |
596 | and my $password = $c->req->param("password") ) |
597 | { |
62f27384 |
598 | if ( $c->authenticate( { username => $user, |
599 | password => $password } ) ) { |
600 | $c->res->body( "hello " . $c->user->get("name") ); |
5e91c057 |
601 | } else { |
602 | # login incorrect |
603 | } |
604 | } |
605 | else { |
606 | # invalid form input |
607 | } |
608 | } |
609 | |
610 | This code should be very readable. If all the necessary fields are supplied, |
c5fbff80 |
611 | call the "authenticate" method from the controller. If it succeeds the |
612 | user is logged in. |
5e91c057 |
613 | |
62f27384 |
614 | The credential verifier will attempt to retrieve the user whose details match |
615 | the authentication information provided to $c->authenticate(). Once it fetches |
616 | the user the password is checked and if it matches the user will be |
16ef3eb8 |
617 | B<authenticated> and C<< $c->user >> will contain the user object retrieved |
62f27384 |
618 | from the store. |
5e91c057 |
619 | |
62f27384 |
620 | In the above case, the default realm is checked, but we could just as easily |
621 | check an alternate realm. If this were an admin login, for example, we could |
622 | authenticate on the admin realm by simply changing the $c->authenticate() |
623 | call: |
5e91c057 |
624 | |
62f27384 |
625 | if ( $c->authenticate( { username => $user, |
626 | password => $password }, 'admin' )l ) { |
627 | $c->res->body( "hello " . $c->user->get("name") ); |
628 | } ... |
5e91c057 |
629 | |
5e91c057 |
630 | |
c5fbff80 |
631 | Now suppose we want to restrict the ability to edit to a user with an |
632 | 'editor' value of yes. |
5e91c057 |
633 | |
62f27384 |
634 | The restricted action might look like this: |
5e91c057 |
635 | |
62f27384 |
636 | sub edit : Local { |
5e91c057 |
637 | my ( $self, $c ) = @_; |
638 | |
639 | $c->detach("unauthorized") |
640 | unless $c->user_exists |
c5fbff80 |
641 | and $c->user->get('editor') eq 'yes'; |
5e91c057 |
642 | |
643 | # do something restricted here |
644 | } |
645 | |
c5fbff80 |
646 | (Note that if you have multiple realms, you can use $c->user_in_realm('realmname') |
647 | in place of $c->user_exists(); This will essentially perform the same |
648 | verification as user_exists, with the added requirement that if there is a |
649 | user, it must have come from the realm specified.) |
650 | |
651 | The above example is somewhat similar to role based access control. |
62f27384 |
652 | L<Catalyst::Plugin::Authentication::Store::Minimal> treats the roles field as |
653 | an array of role names. Let's leverage this. Add the role authorization |
654 | plugin: |
5e91c057 |
655 | |
656 | use Catalyst qw/ |
657 | ... |
658 | Authorization::Roles |
659 | /; |
660 | |
62f27384 |
661 | sub edit : Local { |
5e91c057 |
662 | my ( $self, $c ) = @_; |
663 | |
62f27384 |
664 | $c->detach("unauthorized") unless $c->check_roles("edit"); |
5e91c057 |
665 | |
666 | # do something restricted here |
667 | } |
668 | |
669 | This is somewhat simpler and will work if you change your store, too, since the |
670 | role interface is consistent. |
671 | |
0cc778ab |
672 | Let's say your app grew, and you now have 10000 users. It's no longer |
673 | efficient to maintain a hash of users, so you move this data to a database. |
674 | You can accomplish this simply by installing the DBIx::Class Store and |
675 | changing your config: |
5e91c057 |
676 | |
0cc778ab |
677 | __PACKAGE__->config->{authentication} = |
678 | { |
679 | default_realm => 'members', |
680 | realms => { |
681 | members => { |
682 | credential => { |
c5fbff80 |
683 | class => 'Password', |
684 | password_field => 'password', |
685 | password_type => 'clear' |
0cc778ab |
686 | }, |
687 | store => { |
688 | class => 'DBIx::Class', |
689 | user_class => 'MyApp::Users', |
690 | role_column => 'roles' |
691 | } |
692 | } |
693 | } |
694 | }; |
5e91c057 |
695 | |
0cc778ab |
696 | The authentication system works behind the scenes to load your data from the |
697 | new source. The rest of your application is completely unchanged. |
5e91c057 |
698 | |
189b5b0c |
699 | |
700 | =head1 CONFIGURATION |
701 | |
702 | =over 4 |
703 | |
0cc778ab |
704 | # example |
705 | __PACKAGE__->config->{authentication} = |
706 | { |
707 | default_realm => 'members', |
708 | realms => { |
709 | members => { |
710 | credential => { |
c5fbff80 |
711 | class => 'Password', |
712 | password_field => 'password', |
713 | password_type => 'clear' |
0cc778ab |
714 | }, |
715 | store => { |
716 | class => 'DBIx::Class', |
717 | user_class => 'MyApp::Users', |
718 | role_column => 'roles' |
719 | } |
720 | }, |
721 | admins => { |
722 | credential => { |
c5fbff80 |
723 | class => 'Password', |
724 | password_field => 'password', |
725 | password_type => 'clear' |
0cc778ab |
726 | }, |
727 | store => { |
728 | class => '+MyApp::Authentication::Store::NetAuth', |
729 | authserver => '192.168.10.17' |
730 | } |
731 | } |
732 | |
733 | } |
734 | }; |
735 | |
189b5b0c |
736 | =item use_session |
737 | |
738 | Whether or not to store the user's logged in state in the session, if the |
e8919861 |
739 | application is also using L<Catalyst::Plugin::Session>. This |
e7522758 |
740 | value is set to true per default. |
741 | |
0cc778ab |
742 | =item default_realm |
fe4cf44a |
743 | |
0cc778ab |
744 | This defines which realm should be used as when no realm is provided to methods |
745 | that require a realm such as authenticate or find_user. |
7d0922d8 |
746 | |
0cc778ab |
747 | =item realms |
7d0922d8 |
748 | |
0cc778ab |
749 | This contains the series of realm configurations you want to use for your app. |
750 | The only rule here is that there must be at least one. A realm consists of a |
751 | name, which is used to reference the realm, a credential and a store. |
4fbe2e14 |
752 | |
0cc778ab |
753 | Each realm config contains two hashes, one called 'credential' and one called |
754 | 'store', each of which provide configuration details to the respective modules. |
755 | The contents of these hashes is specific to the module being used, with the |
756 | exception of the 'class' element, which tells the core Authentication module the |
e8919861 |
757 | classname to instantiate. |
4fbe2e14 |
758 | |
0cc778ab |
759 | The 'class' element follows the standard Catalyst mechanism of class |
760 | specification. If a class is prefixed with a +, it is assumed to be a complete |
761 | class name. Otherwise it is considered to be a portion of the class name. For |
e8919861 |
762 | credentials, the classname 'B<Password>', for example, is expanded to |
763 | Catalyst::Plugin::Authentication::Credential::B<Password>. For stores, the |
764 | classname 'B<storename>' is expanded to: |
45c7644b |
765 | Catalyst::Plugin::Authentication::Store::B<storename>. |
4fbe2e14 |
766 | |
a1e5bd36 |
767 | |
fe4cf44a |
768 | =back |
769 | |
e8919861 |
770 | |
771 | =head1 METHODS |
772 | |
773 | =over 4 |
774 | |
775 | =item authenticate( $userinfo, $realm ) |
776 | |
777 | Attempts to authenticate the user using the information in the $userinfo hash |
778 | reference using the realm $realm. $realm may be omitted, in which case the |
779 | default realm is checked. |
780 | |
781 | =item user |
782 | |
783 | Returns the currently logged in user or undef if there is none. |
784 | |
785 | =item user_exists |
786 | |
787 | Returns true if a user is logged in right now. The difference between |
788 | user_exists and user is that user_exists will return true if a user is logged |
45c7644b |
789 | in, even if it has not been yet retrieved from the storage backend. If you only |
e8919861 |
790 | need to know if the user is logged in, depending on the storage mechanism this |
791 | can be much more efficient. |
792 | |
45c7644b |
793 | =item user_in_realm ( $realm ) |
794 | |
795 | Works like user_exists, except that it only returns true if a user is both |
c5fbff80 |
796 | logged in right now and was retrieved from the realm provided. |
45c7644b |
797 | |
e8919861 |
798 | =item logout |
799 | |
800 | Logs the user out, Deletes the currently logged in user from $c->user and the session. |
801 | |
802 | =item find_user( $userinfo, $realm ) |
803 | |
804 | Fetch a particular users details, matching the provided user info, from the realm |
805 | specified in $realm. |
806 | |
807 | =back |
0cc778ab |
808 | |
06675d2e |
809 | =head1 INTERNAL METHODS |
810 | |
e8919861 |
811 | These methods are for Catalyst::Plugin::Authentication B<INTERNAL USE> only. |
812 | Please do not use them in your own code, whether application or credential / |
813 | store modules. If you do, you will very likely get the nasty shock of having |
814 | to fix / rewrite your code when things change. They are documented here only |
815 | for reference. |
06675d2e |
816 | |
e8919861 |
817 | =over 4 |
06675d2e |
818 | |
e8919861 |
819 | =item set_authenticated ( $user, $realmname ) |
06675d2e |
820 | |
e8919861 |
821 | Marks a user as authenticated. This is called from within the authenticate |
822 | routine when a credential returns a user. $realmname defaults to 'default' |
06675d2e |
823 | |
e8919861 |
824 | =item auth_restore_user ( $user, $realmname ) |
e300c5b6 |
825 | |
e8919861 |
826 | Used to restore a user from the session. In most cases this is called without |
827 | arguments to restore the user via the session. Can be called with arguments |
828 | when restoring a user from some other method. Currently not used in this way. |
e300c5b6 |
829 | |
e8919861 |
830 | =item save_user_in_session ( $user, $realmname ) |
e300c5b6 |
831 | |
e8919861 |
832 | Used to save the user in a session. Saves $user in session, marked as |
833 | originating in $realmname. Both arguments are required. |
e300c5b6 |
834 | |
e8919861 |
835 | =item auth_realms |
06675d2e |
836 | |
e8919861 |
837 | Returns a hashref containing realmname -> realm instance pairs. Realm |
838 | instances contain an instantiated store and credential object as the 'store' |
839 | and 'credential' elements, respectively |
06675d2e |
840 | |
e8919861 |
841 | =item get_auth_realm ( $realmname ) |
06675d2e |
842 | |
e8919861 |
843 | Retrieves the realm instance for the realmname provided. |
06675d2e |
844 | |
845 | =item |
846 | |
847 | =back |
848 | |
fbe577ac |
849 | =head1 SEE ALSO |
850 | |
649de93b |
851 | This list might not be up to date. Below are modules known to work with the updated |
852 | API of 0.10 and are therefore compatible with realms. |
4bb9b01c |
853 | |
854 | =head2 User Storage Backends |
855 | |
fbe577ac |
856 | L<Catalyst::Plugin::Authentication::Store::Minimal>, |
30e90c6f |
857 | L<Catalyst::Plugin::Authentication::Store::DBIx::Class>, |
4bb9b01c |
858 | |
859 | =head2 Credential verification |
860 | |
861 | L<Catalyst::Plugin::Authentication::Credential::Password>, |
4bb9b01c |
862 | |
863 | =head2 Authorization |
864 | |
fbe577ac |
865 | L<Catalyst::Plugin::Authorization::ACL>, |
4bb9b01c |
866 | L<Catalyst::Plugin::Authorization::Roles> |
867 | |
5e91c057 |
868 | =head2 Internals Documentation |
869 | |
649de93b |
870 | L<Catalyst::Plugin::Authentication::Internals> |
5e91c057 |
871 | |
4bb9b01c |
872 | =head2 Misc |
873 | |
874 | L<Catalyst::Plugin::Session>, |
875 | L<Catalyst::Plugin::Session::PerUser> |
fbe577ac |
876 | |
93f08fb0 |
877 | =head1 DON'T SEE ALSO |
878 | |
1a05e6ed |
879 | This module along with its sub plugins deprecate a great number of other |
880 | modules. These include L<Catalyst::Plugin::Authentication::Simple>, |
881 | L<Catalyst::Plugin::Authentication::CDBI>. |
93f08fb0 |
882 | |
883 | At the time of writing these plugins have not yet been replaced or updated, but |
1a05e6ed |
884 | should be eventually: L<Catalyst::Plugin::Authentication::OpenID>, |
885 | L<Catalyst::Plugin::Authentication::LDAP>, |
886 | L<Catalyst::Plugin::Authentication::CDBI::Basic>, |
887 | L<Catalyst::Plugin::Authentication::Basic::Remote>. |
93f08fb0 |
888 | |
649de93b |
889 | =head1 INCOMPATABILITIES |
890 | |
891 | The realms based configuration and functionality of the 0.10 update |
892 | of L<Catalyst::Plugin::Authentication> required a change in the API used by |
893 | credentials and stores. It has a compatibility mode which allows use of |
894 | modules that have not yet been updated. This, however, completely mimics the |
895 | older api and disables the new realm-based features. In other words you can |
896 | not mix the older credential and store modules with realms, or realm-based |
897 | configs. The changes required to update modules are relatively minor and are |
898 | covered in L<Catalyst::Plugin::Authentication::Internals>. We hope that most |
899 | modules will move to the compatible list above very quickly. |
0cc778ab |
900 | |
901 | =head1 COMPATIBILITY ROUTINES |
902 | |
e8919861 |
903 | In version 0.10 of L<Catalyst::Plugin::Authentication>, the API |
904 | changed. For app developers, this change is fairly minor, but for |
905 | Credential and Store authors, the changes are significant. |
906 | |
907 | Please see the documentation in version 0.09 of |
30e90c6f |
908 | Catalyst::Plugin::Authentication for a better understanding of how the old API |
e8919861 |
909 | functioned. |
910 | |
911 | The items below are still present in the plugin, though using them is |
912 | deprecated. They remain only as a transition tool, for those sites which can |
30e90c6f |
913 | not yet be upgraded to use the new system due to local customizations or use |
914 | of Credential / Store modules that have not yet been updated to work with the |
45c7644b |
915 | new API. |
e8919861 |
916 | |
917 | These routines should not be used in any application using realms |
918 | functionality or any of the methods described above. These are for reference |
919 | purposes only. |
0cc778ab |
920 | |
921 | =over 4 |
922 | |
e8919861 |
923 | =item login |
924 | |
925 | This method is used to initiate authentication and user retrieval. Technically |
649de93b |
926 | this is part of the old Password credential module and it still resides in the |
927 | L<Password|Catalyst::Plugin::Authentication::Credential::Password> class. It is |
928 | included here for reference only. |
e8919861 |
929 | |
0cc778ab |
930 | =item default_auth_store |
931 | |
932 | Return the store whose name is 'default'. |
933 | |
934 | This is set to C<< $c->config->{authentication}{store} >> if that value exists, |
935 | or by using a Store plugin: |
936 | |
30e90c6f |
937 | # load the Minimal authentication store. |
0cc778ab |
938 | use Catalyst qw/Authentication Authentication::Store::Minimal/; |
939 | |
940 | Sets the default store to |
45c7644b |
941 | L<Catalyst::Plugin::Authentication::Store::Minimal>. |
0cc778ab |
942 | |
0cc778ab |
943 | =item get_auth_store $name |
944 | |
945 | Return the store whose name is $name. |
946 | |
947 | =item get_auth_store_name $store |
948 | |
949 | Return the name of the store $store. |
950 | |
951 | =item auth_stores |
952 | |
953 | A hash keyed by name, with the stores registered in the app. |
954 | |
0cc778ab |
955 | =item register_auth_stores %stores_by_name |
956 | |
957 | Register stores into the application. |
958 | |
959 | =back |
960 | |
961 | |
962 | |
2bcde605 |
963 | =head1 AUTHORS |
fbe577ac |
964 | |
965 | Yuval Kogman, C<nothingmuch@woobling.org> |
2bcde605 |
966 | |
649de93b |
967 | Jay Kuri, C<jayk@cpan.org> |
968 | |
7d2f34eb |
969 | Jess Robinson |
2bcde605 |
970 | |
7d2f34eb |
971 | David Kamholz |
06675d2e |
972 | |
e8919861 |
973 | |
ff46c00b |
974 | =head1 COPYRIGHT & LICENSE |
fbe577ac |
975 | |
976 | Copyright (c) 2005 the aforementioned authors. All rights |
977 | reserved. This program is free software; you can redistribute |
978 | it and/or modify it under the same terms as Perl itself. |
979 | |
980 | =cut |
06675d2e |
981 | |