Debian Codegraph @

README

raw
1 NAME
2 Catalyst::Authentication::Credential::Authen::Simple - Verify
3 credentials with the Authen::Simple framework
4
5 SYNOPSIS
6 use Catalyst qw(Authentication);
7 # later on ...
8 if ($c->authenticate({ username => 'myusername',
9 password => 'mypassword' })){
10 my $long_name = $c->user->get('LongName');
11 # Hello Mr $long_name
12 }
13
14 DESCRIPTION
15 This module helps your Cataylst Application authenticate against a lot
16 of credential databases thanks to the Authen::Simple framework.
17
18 USAGE
19 Just configure your Catalyst App Authentication to use class
20 'Authen::Simple' as the credential verifier, and give it a set of
21 Authen::Simple classes. You can pass arguments to the Authen::Simple:XXX
22 class constructors with the 'args' key. Note that the authen key is an
23 array. If more than one class is specified, when your app authenticates,
24 the username and password is submitted to each class until one of the
25 classes returns that the user/pass pair is valid. If no class validates
26 the credentials, the user is not able to log in.
27
28 'Plugin::Authentication' => {
29 'realms' => {
30 'default' => {
31 'store' => { ... }
32 'credential' => {
33 'class' => 'Authen::Simple',
34 'authen' => [
35 {
36 'class' => 'Passwd',
37 'args' => {
38 'path' => '/etc/shadow'
39 }
40 },
41 {
42 'class' => 'SSH',
43 'args' => {
44 'host' => 'host.company.com'
45 }
46 }
47 ]
48 }
49 }
50 }
51 }
52
53 If the Catalyst log object is compatible with the Authen::Simple log
54 object, Authen::Simple classes will log through Catalyst.
55
56 new
57 Called by Catalyst::Authentication. Instances the Authen::Simple classes
58 read from the configuration.
59
60 authenticate
61 Usage : Call $c->authenticate({ username => ..., password => ...});
62 Returns : User object if the credentials are verified successfully. undef if user not authenticated.
63
64 AUTHOR
65 Jose Luis Martinez
66 CPAN ID: JLMARTIN
67 CAPSiDE
68 [email protected]
69 http://www.pplusdomain.net
70
71 THANKS
72 Tobjorn Lindahl, Dylan Martin, Tomas Doran and Inigo Tejedor Arrondo for
73 patches and recommedations
74
75 COPYRIGHT
76 Copyright (c) 2008 by Jose Luis Martinez Torres
77
78 This program is free software; you can redistribute it and/or modify it
79 under the same terms as Perl itself.
80
81 The full text of the license can be found in the LICENSE file included
82 with this module.
83
84 SEE ALSO
85 Authen::Simple and all of the Authen::Simple::XXX classes
86