3 package Catalyst::Plugin::Authentication::Store::Minimal;
8 use Catalyst::Plugin::Authentication::User::Hash;
10 use base qw/Class::Accessor::Fast/;
13 __PACKAGE__->mk_accessors(qw/userhash/);
17 my ( $class, $config, $app) = @_;
19 bless { userhash => $config->{'users'} }, $class;
23 my ( $self, $c, $id ) = @_;
25 return $id if ref $id;
27 $self->find_user( { id => $id } );
30 ## this is not necessarily a good example of what find_user can do, since all we do is
31 ## look up with the id anyway. find_user can be used to locate a user based on other
32 ## combinations of data. See C::P::Authentication::Store::DBIx::Class for a better example
34 my ( $self, $userinfo, $c ) = @_;
36 my $id = $userinfo->{'id'};
38 $id ||= $userinfo->{'username'};
40 return unless exists $self->userhash->{$id};
42 my $user = $self->userhash->{$id};
45 if ( ref $user eq "HASH" ) {
47 return bless $user, "Catalyst::Plugin::Authentication::User::Hash";
50 Catalyst::Exception->throw( "The user '$id' is a reference of type "
52 . " but should be a HASH" );
56 Catalyst::Exception->throw(
57 "The user '$id' is has to be a hash reference or an object");
66 # choose a random user
67 scalar keys %{ $self->userhash };
68 ( undef, my $user ) = each %{ $self->userhash };
73 ## Backwards compatibility
75 # This is a backwards compatible routine. get_user is specifically for loading a user by it's unique id
76 # find_user is capable of doing the same by simply passing { id => $id }
77 # no new code should be written using get_user as it is deprecated.
79 my ( $self, $id ) = @_;
80 $self->find_user({id => $id});
83 ## backwards compatibility
87 $c->default_auth_store(
89 $c->config->{authentication}, $c
104 Catalyst::Plugin::Authentication::Store::Minimal - Minimal
105 authentication store.
109 # you probably just want Store::Minimal under most cases,
110 # but if you insist you can instantiate your own store:
112 use Catalyst::Plugin::Authentication::Store::Minimal;
118 __PACKAGE__->config->{authentication} =
120 default_realm => 'members',
125 password_field => 'password',
126 password_type => 'clear'
132 password => "s00p3r",
134 roles => [qw/edit delete/],
137 password => "s3cr3t",
138 roles => [qw/comment/],
149 This authentication store lets you create a very quick and dirty user
150 database in your application's config hash.
152 You will need to include the Authentication plugin, and at least one Credential
153 plugin to use this Store. Credential::Password is reccommended.
155 It's purpose is mainly for testing, and it should probably be replaced by a
156 more "serious" store for production.
158 The hash in the config, as well as the user objects/hashes are freely mutable
167 The classname used for the store. This is part of
168 L<Catalyst::Plugin::Authentication> and is the method by which
169 Catalyst::Plugin::Authentication::Store::Minimal is loaded as the
170 user store. For this module to be used, this must be set to
175 This is a simple hash of users, the keys are the usenames, and the values are
176 hashrefs containing a password key/value pair, and optionally, a roles/list
177 of role-names pair. If using roles, you will also need to add the
178 Authorization::Roles plugin.
180 See the SYNOPSIS for an example.
186 There are no publicly exported routines in the Minimal store (or indeed in
187 most authentication stores) However, below is a description of the routines
188 required by L<Catalyst::Plugin::Authentication> for all authentication stores.
192 =item new ( $config, $app )
194 Constructs a new store object, which uses the user element of the supplied config
195 hash ref as it's backing structure.
197 =item find_user ( $authinfo, $c )
199 Keys the hash by the 'id' or 'username' element in the authinfo hash and returns the user.
201 ... documentation fairy stopped here. ...
203 If the return value is unblessed it will be blessed as
204 L<Catalyst::Plugin::Authentication::User::Hash>.
206 =item from_session $id
208 Delegates to C<get_user>.
212 Chooses a random user from the hash and delegates to it.