1 package Catalyst::Authentication::Credential::Password;
3 use namespace::autoclean;
5 with 'MooseX::Emulate::Class::Accessor::Fast';
8 use Catalyst::Exception ();
11 __PACKAGE__->mk_accessors(qw/_config realm/);
14 my ($class, $config, $app, $realm) = @_;
16 # Note _config is horrible back compat hackery!
17 my $self = { _config => $config };
22 $self->_config->{'password_field'} ||= 'password';
23 $self->_config->{'password_type'} ||= 'clear';
24 $self->_config->{'password_hash_type'} ||= 'SHA-1';
26 my $passwordtype = $self->_config->{'password_type'};
27 if (!grep /$passwordtype/, ('none', 'clear', 'hashed', 'salted_hash', 'crypted', 'self_check')) {
28 Catalyst::Exception->throw(__PACKAGE__ . " used with unsupported password type: " . $self->_config->{'password_type'});
34 my ( $self, $c, $realm, $authinfo ) = @_;
36 ## because passwords may be in a hashed format, we have to make sure that we remove the
37 ## password_field before we pass it to the user routine, as some auth modules use
38 ## all data passed to them to find a matching user...
39 my $userfindauthinfo = {%{$authinfo}};
40 delete($userfindauthinfo->{$self->_config->{'password_field'}});
42 my $user_obj = $realm->find_user($userfindauthinfo, $c);
44 if ($self->check_password($user_obj, $authinfo)) {
49 'Unable to locate user matching user info provided in realm: '
57 my ( $self, $user, $authinfo ) = @_;
59 if ($self->_config->{'password_type'} eq 'self_check') {
60 return $user->check_password($authinfo->{$self->_config->{'password_field'}});
63 if $self->_config->{'password_type'} eq 'none';
65 my $password = $authinfo->{$self->_config->{'password_field'}};
66 my $storedpassword = $user->get($self->_config->{'password_field'});
68 if ($self->_config->{'password_type'} eq 'clear') {
69 # FIXME - Should we warn in the $storedpassword undef case,
70 # as the user probably fluffed the config?
71 return unless defined $storedpassword;
72 return $password eq $storedpassword;
73 } elsif ($self->_config->{'password_type'} eq 'crypted') {
74 return $storedpassword eq crypt( $password, $storedpassword );
75 } elsif ($self->_config->{'password_type'} eq 'salted_hash') {
76 require Crypt::SaltedHash;
77 my $salt_len = $self->_config->{'password_salt_len'} ? $self->_config->{'password_salt_len'} : 0;
78 return Crypt::SaltedHash->validate( $storedpassword, $password,
80 } elsif ($self->_config->{'password_type'} eq 'hashed') {
82 my $d = Digest->new( $self->_config->{'password_hash_type'} );
83 $d->add( $self->_config->{'password_pre_salt'} || '' );
85 $d->add( $self->_config->{'password_post_salt'} || '' );
87 my $computed = $d->clone()->digest;
88 my $b64computed = $d->clone()->b64digest;
89 return ( ( $computed eq $storedpassword )
90 || ( unpack( "H*", $computed ) eq $storedpassword )
91 || ( $b64computed eq $storedpassword)
92 || ( $b64computed.'=' eq $storedpassword) );
105 Catalyst::Authentication::Credential::Password - Authenticate a user
114 package MyApp::Controller::Auth;
117 my ( $self, $c ) = @_;
119 $c->authenticate( { username => $c->req->param('username'),
120 password => $c->req->param('password') });
125 This authentication credential checker takes authentication information
126 (most often a username) and a password, and attempts to validate the password
127 provided against the user retrieved from the store.
132 __PACKAGE__->config('Plugin::Authentication' =>
134 default_realm => 'members',
140 password_field => 'password',
141 password_type => 'hashed',
142 password_hash_type => 'SHA-1'
147 The password module is capable of working with several different password
148 encryption/hashing algorithms. The one the module uses is determined by the
149 credential configuration.
151 Those who have used L<Catalyst::Plugin::Authentication> prior to the 0.10 release
152 should note that the password field and type information is no longer part
153 of the store configuration and is now part of the Password credential configuration.
159 The classname used for Credential. This is part of
160 L<Catalyst::Plugin::Authentication> and is the method by which
161 Catalyst::Authentication::Credential::Password is loaded as the
162 credential validator. For this module to be used, this must be set to
167 The field in the user object that contains the password. This will vary
168 depending on the storage class used, but is most likely something like
169 'password'. In fact, this is so common that if this is left out of the config,
170 it defaults to 'password'. This field is obtained from the user object using
171 the get() method. Essentially: $user->get('passwordfieldname');
172 B<NOTE> If the password_field is something other than 'password', you must
173 be sure to use that same field name when calling $c->authenticate().
177 This sets the password type. Often passwords are stored in crypted or hashed
178 formats. In order for the password module to verify the plaintext password
179 passed in, it must be told what format the password will be in when it is retreived
180 from the user object. The supported options are:
186 No password check is done. An attempt is made to retrieve the user based on
187 the information provided in the $c->authenticate() call. If a user is found,
188 authentication is considered to be successful.
192 The password in user is in clear text and will be compared directly.
196 This option indicates that the password should be passed to the check_password()
197 routine on the user object returned from the store.
201 The password in user is in UNIX crypt hashed format.
205 The password in user is in salted hash format, and will be validated
206 using L<Crypt::SaltedHash>. If this password type is selected, you should
207 also provide the B<password_salt_len> config element to define the salt length.
211 If the user object supports hashed passwords, they will be used in conjunction
212 with L<Digest>. The following config elements affect the hashed configuration:
216 =item password_hash_type
218 The hash type used, passed directly to L<Digest/new>.
220 =item password_pre_salt
222 Any pre-salt data to be passed to L<Digest/add> before processing the password.
224 =item password_post_salt
226 Any post-salt data to be passed to L<Digest/add> after processing the password.
236 The Password credential module is very simple to use. Once configured as
237 indicated above, authenticating using this module is simply a matter of
238 calling $c->authenticate() with an authinfo hashref that includes the
239 B<password> element. The password element should contain the password supplied
240 by the user to be authenticated, in clear text. The other information supplied
241 in the auth hash is ignored by the Password module, and simply passed to the
242 auth store to be used to retrieve the user. An example call follows:
244 if ($c->authenticate({ username => $username,
245 password => $password} )) {
246 # authentication successful
248 # authentication failed
253 There are no publicly exported routines in the Password module (or indeed in
254 most credential modules.) However, below is a description of the routines
255 required by L<Catalyst::Plugin::Authentication> for all credential modules.
257 =head2 new( $config, $app, $realm )
259 Instantiate a new Password object using the configuration hash provided in
260 $config. A reference to the application is provided as the second argument.
261 Note to credential module authors: new() is called during the application's
262 plugin setup phase, which is before the application specific controllers are
263 loaded. The practical upshot of this is that things like $c->model(...) will
264 not function as expected.
266 =head2 authenticate( $authinfo, $c )
268 Try to log a user in, receives a hashref containing authentication information
269 as the first argument, and the current context as the second.
271 =head2 check_password( )