X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FPlugin%2FAuthentication%2FCredential%2FPassword.pm;h=624143b7bd911a788dabd31cac6349bef53d5e3c;hb=646ea5b1aa19c86dda9cc98a62b656e7005c553f;hp=f9d9b620b5ee1be0fa98e54e5c05ed1ec0f3cbc6;hpb=c0f72d03a107a3e8246e05cded0c421f3e296192;p=catagits%2FCatalyst-Plugin-Authentication.git diff --git a/lib/Catalyst/Plugin/Authentication/Credential/Password.pm b/lib/Catalyst/Plugin/Authentication/Credential/Password.pm index f9d9b62..624143b 100644 --- a/lib/Catalyst/Plugin/Authentication/Credential/Password.pm +++ b/lib/Catalyst/Plugin/Authentication/Credential/Password.pm @@ -1,6 +1,5 @@ -#!/usr/bin/perl - package Catalyst::Plugin::Authentication::Credential::Password; +use base qw/Class::Accessor::Fast/; use strict; use warnings; @@ -9,36 +8,121 @@ use Scalar::Util (); use Catalyst::Exception (); use Digest (); -sub login { - my ( $c, $user, $password, @rest ) = @_; +BEGIN { + __PACKAGE__->mk_accessors(qw/_config realm/); +} - for ( $c->request ) { - unless ( - defined($user) - or - $user = $_->param("login") - || $_->param("user") - || $_->param("username") - ) { - $c->log->debug( - "Can't login a user without a user object or user ID param") - if $c->debug; - return; +sub new { + my ($class, $config, $app, $realm) = @_; + + my $self = { _config => $config }; + bless $self, $class; + + $self->realm($realm); + + $self->_config->{'password_field'} ||= 'password'; + $self->_config->{'password_type'} ||= 'clear'; + $self->_config->{'password_hash_type'} ||= 'SHA-1'; + + my $passwordtype = $self->_config->{'password_type'}; + if (!grep /$passwordtype/, ('none', 'clear', 'hashed', 'salted_hash', 'crypted', 'self_check')) { + Catalyst::Exception->throw(__PACKAGE__ . " used with unsupported password type: " . $self->_config->{'password_type'}); + } + return $self; +} + +sub authenticate { + my ( $self, $c, $realm, $authinfo ) = @_; + + ## because passwords may be in a hashed format, we have to make sure that we remove the + ## password_field before we pass it to the user routine, as some auth modules use + ## all data passed to them to find a matching user... + my $userfindauthinfo = {%{$authinfo}}; + delete($userfindauthinfo->{$self->_config->{'password_field'}}); + + my $user_obj = $realm->find_user($userfindauthinfo, $c); + if (ref($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; + } +} - unless ( - defined($password) - or - $password = $_->param("password") - || $_->param("passwd") - || $_->param("pass") - ) { - $c->log->debug("Can't login a user without a password") - if $c->debug; - return; +sub check_password { + my ( $self, $user, $authinfo ) = @_; + + if ($self->_config->{'password_type'} eq 'self_check') { + return $user->check_password($authinfo->{$self->_config->{'password_field'}}); + } else { + my $password = $authinfo->{$self->_config->{'password_field'}}; + my $storedpassword = $user->get($self->_config->{'password_field'}); + + if ($self->_config->{'password_type'} eq 'none') { + return 1; + } elsif ($self->_config->{'password_type'} eq 'clear') { + return $password eq $storedpassword; + } elsif ($self->_config->{'password_type'} eq 'crypted') { + return $storedpassword eq crypt( $password, $storedpassword ); + } elsif ($self->_config->{'password_type'} eq 'salted_hash') { + require Crypt::SaltedHash; + my $salt_len = $self->_config->{'password_salt_len'} ? $self->_config->{'password_salt_len'} : 0; + return Crypt::SaltedHash->validate( $storedpassword, $password, + $salt_len ); + } elsif ($self->_config->{'password_type'} eq 'hashed') { + + my $d = Digest->new( $self->_config->{'password_hash_type'} ); + $d->add( $self->_config->{'password_pre_salt'} || '' ); + $d->add($password); + $d->add( $self->_config->{'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 only 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 ( $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") ) { @@ -64,11 +148,13 @@ sub login { 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; } @@ -129,169 +215,163 @@ 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') ); + $c->authenticate( { username => $c->req->param('username'), + password => $c->req->param('password') }); } =head1 DESCRIPTION -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 +This authentication credential checker takes authentication information +(most often a username) and a password, and attempts to validate the password +provided against the user retrieved from the store. -=item clear text password +=head1 CONFIGURATION -If the user has clear a clear text password it will be compared directly. + # example + __PACKAGE__->config->{authentication} = + { + default_realm => 'members', + realms => { + members => { + + credential => { + class => 'Password', + password_field => 'password', + password_type => 'hashed', + password_hash_type => 'SHA-1' + }, + ... -=item crypted password -If UNIX crypt hashed passwords are supported, they will be compared using -perl's builtin C function. +The password module is capable of working with several different password +encryption/hashing algorithms. The one the module uses is determined by the +credential configuration. -=item hashed password +Those who have used L prior to the 0.10 release +should note that the password field and type information is no longer part +of the store configuration and is now part of the Password credential configuration. -If the user object supports hashed passwords, they will be used in conjunction -with L. +=over 4 -=back +=item class -=head1 METHODS +The classname used for Credential. This is part of +L and is the method by which +Catalyst::Plugin::Authentication::Credential::Password is loaded as the +credential validator. For this module to be used, this must be set to +'Password'. -=over 4 +=item password_field -=item login $username, $password +The field in the user object that contains the password. This will vary +depending on the storage class used, but is most likely something like +'password'. In fact, this is so common that if this is left out of the config, +it defaults to 'password'. This field is obtained from the user object using +the get() method. Essentially: $user->get('passwordfieldname'); -Try to log a user in. +=item password_type -C<$username> can be a string (e.g. retrieved from a form) or an object. -If the object is a L it will be used -as is. Otherwise C<< $c->get_user >> is used to retrieve it. +This sets the password type. Often passwords are stored in crypted or hashed +formats. In order for the password module to verify the plaintext password +passed in, it must be told what format the password will be in when it is retreived +from the user object. The supported options are: -C<$password> is a string. +=over 8 -If C<$username> or C<$password> are not provided, the query parameters -C, C, C and C, C, C will -be tried instead. +=item none -=back +No password check is done. An attempt is made to retrieve the user based on +the information provided in the $c->authenticate() call. If a user is found, +authentication is considered to be successful. -=head1 RELATED USAGE +=item clear -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 password in user is in clear text and will be compared directly. -The current user can be logged out again by calling the C<< $c->logout >> -method. +=item self_check -=head1 SUPPORTING THIS PLUGIN +This option indicates that the password should be passed to the check_password() +routine on the user object returned from the store. -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 method in one or many of the -following ways: +=item crypted -=head2 Clear Text Passwords +The password in user is in UNIX crypt hashed format. -Predicate: +=item salted_hash - $user->supported_features(qw/password clear/); +The password in user is in salted hash format, and will be validated +using L. If this password type is selected, you should +also provide the B config element to define the salt length. -Expected methods: +=item hashed -=over 4 - -=item password - -Returns the user's clear text password as a string to be compared with C. - -=back +If the user object supports hashed passwords, they will be used in conjunction +with L. The following config elements affect the hashed configuration: -=head2 Crypted Passwords +=over 8 -Predicate: +=item password_hash_type - $user->supported_features(qw/password crypted/); +The hash type used, passed directly to L. -Expected methods: +=item password_pre_salt -=over 4 +Any pre-salt data to be passed to L before processing the password. -=item crypted_password +=item password_post_salt -Return's the user's crypted password as a string, with the salt as the first two chars. +Any post-salt data to be passed to L after processing the password. =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. - -=item hash_algorithm - -Returns a string suitable for feeding into L. - -=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 +=back -Predicate: +=head1 USAGE + +The Password credential module is very simple to use. Once configured as +indicated above, authenticating using this module is simply a matter of +calling $c->authenticate() with an authinfo hashref that includes the +B element. The password element should contain the password supplied +by the user to be authenticated, in clear text. The other information supplied +in the auth hash is ignored by the Password module, and simply passed to the +auth store to be used to retrieve the user. An example call follows: + + if ($c->authenticate({ username => $username, + password => $password} )) { + # authentication successful + } else { + # authentication failed + } - $user->supported_features(qw/password salted_hash/); +=head1 METHODS -Expected methods: +There are no publicly exported routines in the Password module (or indeed in +most credential modules.) However, below is a description of the routines +required by L for all credential modules. =over 4 -=item hashed_password +=item new ( $config, $app ) -Returns the hash of the user's password as returned from L->generate. +Instantiate a new Password object using the configuration hash provided in +$config. A reference to the application is provided as the second argument. +Note to credential module authors: new() is called during the application's +plugin setup phase, which is before the application specific controllers are +loaded. The practical upshot of this is that things like $c->model(...) will +not function as expected. -=back - -Optional methods: - -=over 4 +=item authenticate ( $authinfo, $c ) -=item password_salt_len - -Returns the length of salt used to generate the salted hash. +Try to log a user in, receives a hashref containing authentication information +as the first argument, and the current context as the second. =back - -=cut - -