use Catalyst::Exception ();
use Digest ();
+sub new {
+ my ($class, $config, $app) = @_;
+
+ my $self = { %{$config} };
+ $self->{'password_field'} ||= 'password';
+ $self->{'password_type'} ||= 'clear';
+ $self->{'password_hash_type'} ||= 'SHA-1';
+
+ if (!grep /$$self{'password_type'}/, ('clear', 'hashed', 'salted_hash', 'crypted', 'self_check')) {
+ Catalyst::Exception->throw(__PACKAGE__ . " used with unsupported password type: " . $self->{'password_type'});
+ }
+
+ bless $self, $class;
+}
+
+sub authenticate {
+ my ( $self, $c, $authstore, $authinfo ) = @_;
+
+ my $user_obj = $authstore->find_user($authinfo, $c);
+ if ($user_obj) {
+ if ($self->check_password($user_obj, $authinfo)) {
+ return $user_obj;
+ }
+ } else {
+ $c->log->debug("Unable to locate user matching user info provided");
+ return;
+ }
+}
+
+sub check_password {
+ my ( $self, $user, $authinfo ) = @_;
+
+ if ($self->{'password_type'} eq 'self_check') {
+ return $user->check_password($authinfo->{$self->{'password_field'}});
+ } else {
+ my $password = $authinfo->{$self->{'password_field'}};
+ my $storedpassword = $user->get($self->{'password_field'});
+
+ if ($self->{password_type} eq 'clear') {
+ return $password eq $storedpassword;
+ } elsif ($self->{'password_type'} eq 'crypted') {
+ return $storedpassword eq crypt( $password, $storedpassword );
+ } elsif ($self->{'password_type'} eq 'salted_hash') {
+ require Crypt::SaltedHash;
+ my $salt_len = $self->{'password_salt_len'} ? $self->{'password_salt_len'} : 0;
+ return Crypt::SaltedHash->validate( $storedpassword, $password,
+ $salt_len );
+ } elsif ($self->{'password_type'} eq 'hashed') {
+
+ my $d = Digest->new( $self->{'password_hash_type'} );
+ $d->add( $self->{'password_pre_salt'} || '' );
+ $d->add($password);
+ $d->add( $self->{'password_post_salt'} || '' );
+
+ my $computed = $d->clone()->digest;
+ my $b64computed = $d->clone()->b64digest;
+ return ( ( $computed eq $storedpassword )
+ || ( unpack( "H*", $computed ) eq $storedpassword )
+ || ( $b64computed eq $storedpassword)
+ || ( $b64computed.'=' eq $storedpassword) );
+ }
+ }
+}
+
+## BACKWARDS COMPATIBILITY - all subs below here are deprecated
+## They are here for compatibility with older modules that use / inherit from C::P::A::Password
+## login()'s existance relies rather heavily on the fact that Credential::Password
+## is being used as a credential. This may not be the case. This is only here
+## for backward compatibility. It will go away in a future version
+## login should not be used in new applications.
+
sub login {
- my ( $self, $c, $user, $password ) = @_;
- $user = $c->get_user($user)
- unless Scalar::Util::blessed($user)
- and $user->isa("Catalyst:::Plugin::Authentication::User");
+ my ( $c, $user, $password, @rest ) = @_;
+
+ unless (
+ defined($user)
+ or
+ $user = $c->request->param("login")
+ || $c->request->param("user")
+ || $c->request->param("username")
+ ) {
+ $c->log->debug(
+ "Can't login a user without a user object or user ID param")
+ if $c->debug;
+ return;
+ }
+
+ unless (
+ defined($password)
+ or
+ $password = $c->request->param("password")
+ || $c->request->param("passwd")
+ || $c->request->param("pass")
+ ) {
+ $c->log->debug("Can't login a user without a password")
+ if $c->debug;
+ return;
+ }
+
+ unless ( Scalar::Util::blessed($user)
+ and $user->isa("Catalyst::Plugin::Authentication::User") )
+ {
+ if ( my $user_obj = $c->get_user( $user, $password, @rest ) ) {
+ $user = $user_obj;
+ }
+ else {
+ $c->log->debug("User '$user' doesn't exist in the default store")
+ if $c->debug;
+ return;
+ }
+ }
if ( $c->_check_password( $user, $password ) ) {
$c->set_authenticated($user);
+ $c->log->debug("Successfully authenticated user '$user'.")
+ if $c->debug;
return 1;
}
else {
- return undef;
+ $c->log->debug(
+ "Failed to authenticate user '$user'. Reason: 'Incorrect password'")
+ if $c->debug;
+ return;
}
+
}
+## also deprecated. Here for compatibility with older credentials which do not inherit from C::P::A::Password
sub _check_password {
my ( $c, $user, $password ) = @_;
-
+
if ( $user->supports(qw/password clear/) ) {
return $user->password eq $password;
}
return $crypted eq crypt( $password, $crypted );
}
elsif ( $user->supports(qw/password hashed/) ) {
+
my $d = Digest->new( $user->hash_algorithm );
$d->add( $user->password_pre_salt || '' );
$d->add($password);
$d->add( $user->password_post_salt || '' );
- return $c->digest eq $user->hashed_password;
+
+ my $stored = $user->hashed_password;
+ my $computed = $d->clone()->digest;
+ my $b64computed = $d->clone()->b64digest;
+
+ return ( ( $computed eq $stored )
+ || ( unpack( "H*", $computed ) eq $stored )
+ || ( $b64computed eq $stored)
+ || ( $b64computed.'=' eq $stored) );
+ }
+ elsif ( $user->supports(qw/password salted_hash/) ) {
+ require Crypt::SaltedHash;
+
+ my $salt_len =
+ $user->can("password_salt_len") ? $user->password_salt_len : 0;
+
+ return Crypt::SaltedHash->validate( $user->hashed_password, $password,
+ $salt_len );
+ }
+ elsif ( $user->supports(qw/password self_check/) ) {
+
+ # while somewhat silly, this is to prevent code duplication
+ return $user->check_password($password);
+
}
else {
Catalyst::Exception->throw(
=head1 NAME
-Catalyst:::Plugin::Authentication::Credential::Password - Authenticate a user
+Catalyst::Plugin::Authentication::Credential::Password - Authenticate a user
with a password.
=head1 SYNOPSIS
Authentication::Credential::Password
/;
+ package MyApp::Controller::Auth;
+
+ # *** NOTE ***
+ # if you place an action named 'login' in your application's root (as
+ # opposed to inside a controller) the following snippet will recurse,
+ # giving you lots of grief.
+ # never name actions in the root controller after plugin methods - use
+ # controllers and : Global instead.
+
sub login : Local {
my ( $self, $c ) = @_;
- $c->login( $c->req->param('login'), $c->req->param('password') );
+ $c->login( $c->req->param('username'), $c->req->param('password') );
}
=head1 DESCRIPTION
-This authentication credential checker takes a user and a password, and tries
-various methods of comparing a password based on what the user supports:
+This authentication credential checker takes a username (or userid) and a
+password, and tries various methods of comparing a password based on what
+the chosen store's user objects support:
=over 4
=over 4
-=item login $user, $password
+=item login $username, $password
Try to log a user in.
-$user can be an ID or object. If it isa
-L<Catalyst:::Plugin::Authentication::User> it will be used as is. Otherwise
-C<< $c->get_user >> is used to retrieve it.
+C<$username> can be a string (e.g. retrieved from a form) or an object.
+If the object is a L<Catalyst::Plugin::Authentication::User> it will be used
+as is. Otherwise C<< $c->get_user >> is used to retrieve it.
+
+C<$password> is a string.
+
+If C<$username> or C<$password> are not provided, the query parameters
+C<login>, C<user>, C<username> and C<password>, C<passwd>, C<pass> will
+be tried instead.
+
+=back
+
+=head1 RELATED USAGE
+
+After the user is logged in, the user object for the current logged in user
+can be retrieved from the context using the C<< $c->user >> method.
+
+The current user can be logged out again by calling the C<< $c->logout >>
+method.
+
+=head1 SUPPORTING THIS PLUGIN
+
+For a User class to support credential verification using this plugin, it
+needs to indicate what sort of password a given user supports
+by implementing the C<supported_features> method in one or many of the
+following ways:
+
+=head2 Clear Text Passwords
+
+Predicate:
+
+ $user->supported_features(qw/password clear/);
+
+Expected methods:
+
+=over 4
+
+=item password
+
+Returns the user's clear text password as a string to be compared with C<eq>.
+
+=back
+
+=head2 Crypted Passwords
+
+Predicate:
+
+ $user->supported_features(qw/password crypted/);
+
+Expected methods:
+
+=over 4
+
+=item crypted_password
+
+Return's the user's crypted password as a string, with the salt as the first two chars.
+
+=back
+
+=head2 Hashed Passwords
+
+Predicate:
+
+ $user->supported_features(qw/password hashed/);
+
+Expected methods:
+
+=over 4
+
+=item hashed_password
+
+Return's the hash of the user's password as B<binary>.
+
+=item hash_algorithm
+
+Returns a string suitable for feeding into L<Digest/new>.
+
+=item password_pre_salt
+
+=item password_post_salt
+
+Returns a string to be hashed before/after the user's password. Typically only
+a pre-salt is used.
+
+=back
+
+=head2 Crypt::SaltedHash Passwords
+
+Predicate:
+
+ $user->supported_features(qw/password salted_hash/);
+
+Expected methods:
+
+=over 4
+
+=item hashed_password
+
+Returns the hash of the user's password as returned from L<Crypt-SaltedHash>->generate.
+
+=back
+
+Optional methods:
+
+=over 4
+
+=item password_salt_len
-$password is a string.
+Returns the length of salt used to generate the salted hash.
=back
projects / catagits/Catalyst-Plugin-Authentication.git / blobdiff