1 package Catalyst::Authentication::Store::Minimal;
6 use Catalyst::Authentication::User::Hash;
7 use Scalar::Util qw( blessed );
8 use base qw/Class::Accessor::Fast/;
11 __PACKAGE__->mk_accessors(qw/userhash/);
15 my ( $class, $config, $app, $realm) = @_;
17 bless { userhash => $config->{'users'} }, $class;
21 my ( $self, $c, $id ) = @_;
23 return $id if ref $id;
25 $self->find_user( { id => $id } );
28 ## this is not necessarily a good example of what find_user can do, since all we do is
29 ## look up with the id anyway. find_user can be used to locate a user based on other
30 ## combinations of data. See C::P::Authentication::Store::DBIx::Class for a better example
32 my ( $self, $userinfo, $c ) = @_;
34 my $id = $userinfo->{'id'};
36 $id ||= $userinfo->{'username'};
38 return unless exists $self->userhash->{$id};
40 my $user = $self->userhash->{$id};
42 #print STDERR "FOO1! " . ref($user) . " - ". Scalar::Util::blessed($user) . "\n";
44 if ( ref($user) eq "HASH") {
46 return bless $user, "Catalyst::Authentication::User::Hash";
47 } elsif ( ref($user) && blessed($user) && $user->isa('Catalyst::Authentication::User::Hash')) {
50 Catalyst::Exception->throw( "The user '$id' must be a hash reference or an " .
51 "object of class Catalyst::Authentication::User::Hash");
59 # choose a random user
60 scalar keys %{ $self->userhash };
61 ( undef, my $user ) = each %{ $self->userhash };
66 ## Backwards compatibility
68 # This is a backwards compatible routine. get_user is specifically for loading a user by it's unique id
69 # find_user is capable of doing the same by simply passing { id => $id }
70 # no new code should be written using get_user as it is deprecated.
72 my ( $self, $id ) = @_;
73 $self->find_user({id => $id});
76 ## backwards compatibility
80 $c->default_auth_store(
82 $c->config->{authentication}, $c
97 Catalyst::Authentication::Store::Minimal - Minimal authentication store
101 # you probably just want Store::Minimal under most cases,
102 # but if you insist you can instantiate your own store:
104 use Catalyst::Authentication::Store::Minimal;
110 __PACKAGE__->config->{authentication} =
112 default_realm => 'members',
117 password_field => 'password',
118 password_type => 'clear'
124 password => "s00p3r",
126 roles => [qw/edit delete/],
129 password => "s3cr3t",
130 roles => [qw/comment/],
141 This authentication store lets you create a very quick and dirty user
142 database in your application's config hash.
144 You will need to include the Authentication plugin, and at least one Credential
145 plugin to use this Store. Credential::Password is reccommended.
147 It's purpose is mainly for testing, and it should probably be replaced by a
148 more "serious" store for production.
150 The hash in the config, as well as the user objects/hashes are freely mutable
159 The classname used for the store. This is part of
160 L<Catalyst::Plugin::Authentication> and is the method by which
161 Catalyst::Authentication::Store::Minimal is loaded as the
162 user store. For this module to be used, this must be set to
167 This is a simple hash of users, the keys are the usenames, and the values are
168 hashrefs containing a password key/value pair, and optionally, a roles/list
169 of role-names pair. If using roles, you will also need to add the
170 Authorization::Roles plugin.
172 See the SYNOPSIS for an example.
178 There are no publicly exported routines in the Minimal store (or indeed in
179 most authentication stores) However, below is a description of the routines
180 required by L<Catalyst::Plugin::Authentication> for all authentication stores.
182 =head2 new( $config, $app, $realm )
184 Constructs a new store object, which uses the user element of the supplied config
185 hash ref as it's backing structure.
187 =head2 find_user( $authinfo, $c )
189 Keys the hash by the 'id' or 'username' element in the authinfo hash and returns the user.
191 ... documentation fairy stopped here. ...
193 If the return value is unblessed it will be blessed as
194 L<Catalyst::Authentication::User::Hash>.
196 =head2 from_session( $id )
198 Delegates to C<get_user>.
200 =head2 user_supports( )
202 Chooses a random user from the hash and delegates to it.