Catalyst::Plugin::Authentication::Credential::Password - Authenticate a user with a password.
use Catalyst qw/ Authentication Authentication::Store::Foo 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('username'), $c->req->param('password') ); }
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:
If the user has clear a clear text password it will be compared directly.
If UNIX crypt hashed passwords are supported, they will be compared using perl's builtin crypt function.
crypt
If the user object supports hashed passwords, they will be used in conjunction with Digest.
Try to log a user in.
$username can be a string (e.g. retrieved from a form) or an object. If the object is a Catalyst::Plugin::Authentication::User it will be used as is. Otherwise $c->get_user is used to retrieve it.
$username
$c->get_user
$password is a string.
$password
If $username or $password are not provided, the query parameters login, user, username and password, passwd, pass will be tried instead.
login
user
username
password
passwd
pass
After the user is logged in, the user object for the current logged in user can be retrieved from the context using the $c->user method.
$c->user
The current user can be logged out again by calling the $c->logout method.
$c->logout
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 supported_features method in one or many of the following ways:
supported_features
Predicate:
$user->supported_features(qw/password clear/);
Expected methods:
Returns the user's clear text password as a string to be compared with eq.
eq
$user->supported_features(qw/password crypted/);
Return's the user's crypted password as a string, with the salt as the first two chars.
$user->supported_features(qw/password hashed/);
Return's the hash of the user's password as binary.
Returns a string suitable for feeding into "new" in Digest.
Returns a string to be hashed before/after the user's password. Typically only a pre-salt is used.
$user->supported_features(qw/password salted_hash/);
Returns the hash of the user's password as returned from Crypt-SaltedHash->generate.
Optional methods:
Returns the length of salt used to generate the salted hash.
To install Catalyst::Plugin::Authentication, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Catalyst::Plugin::Authentication
CPAN shell
perl -MCPAN -e shell install Catalyst::Plugin::Authentication
For more information on module installation, please visit the detailed CPAN module installation guide.