-#!/usr/bin/perl
-
package Catalyst::Plugin::Authentication::Credential::Password;
use strict;
use warnings;
-use Scalar::Util ();
-use Catalyst::Exception ();
-use Digest ();
-
-sub login {
- my ( $c, $user, $password ) = @_;
-
- for ( $c->request ) {
- $user ||= $_->param("login")
- || $c->param("user")
- || $c->param("username")
- || Catalyst::Exception->throw("Can't determine username for login");
-
- $password ||= $_->param("password")
- || $c->param("passwd")
- || $c->param("pass")
- || Catalyst::Exception->throw("Can't determine password for login");
- }
-
- $user = $c->get_user($user)
- unless Scalar::Util::blessed($user)
- and $user->isa("Catalyst:::Plugin::Authentication::User");
-
- if ( $c->_check_password( $user, $password ) ) {
- $c->set_authenticated($user);
- return 1;
- }
- else {
- return undef;
- }
-}
-
-sub _check_password {
- my ( $c, $user, $password ) = @_;
-
- if ( $user->supports(qw/password clear/) ) {
- return $user->password eq $password;
- }
- elsif ( $user->supports(qw/password crypted/) ) {
- my $crypted = $user->crypted_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 $d->digest eq $user->hashed_password;
- }
- 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(
- "The user object $user does not support any "
- . "known password authentication mechanism." );
- }
-}
+use base qw/Catalyst::Authentication::Credential::Password/;
__PACKAGE__;
=head1 NAME
-Catalyst::Plugin::Authentication::Credential::Password - Authenticate a user
-with a password.
-
-=head1 SYNOPSIS
-
- use Catalyst qw/
- Authentication
- Authentication::Store::Foo
- Authentication::Credential::Password
- /;
-
- sub login : Local {
- my ( $self, $c ) = @_;
-
- $c->login( $c->req->param('login'), $c->req->param('password') );
- }
+Catalyst::Plugin::Authentication::Credential::Password - Compatibility shim
=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:
-
-=over 4
-
-=item clear text password
-
-If the user has clear a clear text password it will be compared directly.
-
-=item crypted password
-
-If UNIX crypt hashed passwords are supported, they will be compared using
-perl's builtin C<crypt> function.
-
-=item hashed password
-
-If the user object supports hashed passwords, they will be used in conjunction
-with L<Digest>.
-
-=back
-
-=head1 METHODS
-
-=over 4
-
-=item login $user, $password
-
-=item login
-
-Try to log a user in.
-
-C<$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<$password> is a string.
-
-If C<$user> or C<$password> are not provided the parameters C<login>, C<user>,
-C<username> and C<password>, C<passwd>, C<pass> will be tried instead.
-
-=back
-
-=head1 SUPPORTING THIS PLUGIN
-
-=head2 Clear Text Passwords
-
-Predicate:
-
- $user->supports(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->supports(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->supports(qw/password hashed/);
-
-Expected methods:
-
-=over 4
-
-=item hashed_passwords
-
-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.
+THIS IS A COMPATIBILITY SHIM. It allows old configurations of Catalyst
+Authentication to work without code changes.
-=back
+B<DO NOT USE IT IN ANY NEW CODE!>
-=cut
+Please see L<Catalyst::Authentication::Credential::Password> for more information.
projects / catagits/Catalyst-Plugin-Authentication.git / blobdiff