__PACKAGE__->mk_accessors(qw/_config realm/);
}
-our $VERSION = "1.002";
+our $VERSION = "1.007";
sub new {
my ($class, $config, $app, $realm) = @_;
+ $config->{username_field} ||= 'username';
my $self = { _config => $config, _debug => $app->debug };
bless $self, $class;
$self->realm($realm);
+ $self->init;
+ return $self;
+}
+
+sub init {
+ my ($self) = @_;
my $type = $self->_config->{'type'} ||= 'any';
if (!grep /$type/, ('basic', 'digest', 'any')) {
Catalyst::Exception->throw(__PACKAGE__ . " used with unsupported authentication type: " . $type);
}
- return $self;
}
sub authenticate {
my $headers = $c->req->headers;
if ( my ( $username, $password ) = $headers->authorization_basic ) {
- my $user_obj = $realm->find_user( { username => $username }, $c);
- if (ref($user_obj)) {
- if ($self->check_password($user_obj, {$self->_config->{password_field} => $password})) {
+ my $user_obj = $realm->find_user( { $self->_config->{username_field} => $username }, $c);
+ if (ref($user_obj)) {
+ my $opts = {};
+ $opts->{$self->_config->{password_field}} = $password
+ if $self->_config->{password_field};
+ if ($self->check_password($user_obj, $opts)) {
$c->set_authenticated($user_obj);
return $user_obj;
}
$c->log->debug('Checking authentication parameters.')
if $c->debug;
- my $uri = '/' . $c->request->path;
+ my $uri = $c->request->uri->path_query;
my $algorithm = $res{algorithm} || 'MD5';
my $nonce_count = '0x' . $res{nc};
my $user;
unless ( $user = $auth_info->{user} ) {
- $user = $realm->find_user( { username => $username }, $c);
+ $user = $realm->find_user( { $self->_config->{username_field} => $username }, $c);
}
unless ($user) { # no user, no authentication
$c->log->debug("Unable to locate user matching user info provided") if $c->debug;
# we can store md5_hex("$username:$realm:$password") instead
my $password_field = $self->_config->{password_field};
for my $r ( 0 .. 1 ) {
- # FIXME - Do not assume accessor is called password.
# calculate H(A1) as per spec
my $A1_digest = $r ? $user->$password_field() : do {
$ctx = Digest::MD5->new;
sub _build_auth_header_domain {
my ( $self, $c, $opts ) = @_;
-
if ( my $domain = $opts->{domain} ) {
Catalyst::Exception->throw("domain must be an array reference")
unless ref($domain) && ref($domain) eq "ARRAY";
sub _build_auth_header_common {
my ( $self, $c, $opts ) = @_;
-
return (
$self->_build_auth_header_realm($c, $opts),
$self->_build_auth_header_domain($c, $opts),
/;
__PACKAGE__->config( authentication => {
+ default_realm => 'example',
realms => {
example => {
credential => {
$c->authenticate({ realm => "example" });
# either user gets authenticated or 401 is sent
- # Note that the authentication realm sent to the client is overridden
- # here, but this does not affect the Catalyst::Authentication::Realm
- # used for authentication.
+ # Note that the authentication realm sent to the client (in the
+ # RFC 2617 sense) is overridden here, but this *does not*
+ # effect the Catalyst::Authentication::Realm used for
+ # authentication - to do that, you need
+ # $c->authenticate({}, 'otherrealm')
do_stuff();
}
+
+ sub always_auth : Local {
+ my ( $self, $c ) = @_;
+
+ # Force authorization headers onto the response so that the user
+ # is asked again for authentication, even if they successfully
+ # authenticated.
+ my $realm = $c->get_auth_realm('example');
+ $realm->credential->authorization_required_response($c, $realm);
+ }
# with ACL plugin
__PACKAGE__->deny_access_unless("/path", sub { $_[0]->authenticate });
Simple constructor.
+=item init
+
+Validates that $config is ok.
+
=item authenticate $c, $realm, \%auth_info
Tries to authenticate the user, and if that fails calls
Sets the HTTP authentication realm presented to the client. Note this does not alter the
Catalyst::Authentication::Realm object used for the authentication.
-=item password_type
+=item domain
-The type of password returned by the user object. Same useage as in
-L<Catalyst::Authentication::Credential::Password|Catalyst::Authentication::Credential::Password/passwprd_type>
+Array reference to domains used to build the authorization headers.
-=item password_field
+This list of domains defines the protection space. If a domain URI is an
+absolute path (starts with /), it is relative to the root URL of the server being accessed.
+An absolute URI in this list may refer to a different server than the one being accessed.
-The name of accessor used to retrieve the value of the password field from the user object. Same useage as in
-L<Catalyst::Authentication::Credential::Password|Catalyst::Authentication::Credential::Password/password_field>
+The client will use this list to determine the set of URIs for which the same authentication
+information may be sent.
+
+If this is omitted or its value is empty, the client will assume that the
+protection space consists of all URIs on the responding server.
+
+Therefore, if your application is not hosted at the root of this domain, and you want to
+prevent the authentication credentials for this application being sent to any other applications.
+then you should use the I<use_uri_for> configuration option, and pass a domain of I</>.
=back
=item authenticate_digest $c, $realm, \%auth_info
Performs HTTP digest authentication. Note that the password_type B<must> by I<clear> for
-digest authentication to succeed.
+digest authentication to succeed, and you must have L<Catalyst::Plugin::Session> in
+your application as digest authentication needs to store persistent data.
+
+Note - if you do not want to store your user passwords as clear text, then it is possible
+to store instead the MD5 digest in hex of the string '$username:$realm:$password'
+
+Takes an additional parameter of I<algorithm>, the possible values of which are 'MD5' (the default)
+and 'MD5-sess'. For more information about 'MD5-sess', see section 3.2.2.2 in RFC 2617.
=item authorization_required_response $c, $realm, \%auth_info
This should be a hash, and it can contain the following entries:
-=over 4
+=over
=item type
Set this to a string to override the default body content "Authorization required.", or set to undef to suppress body content being generated.
+=item password_type
+
+The type of password returned by the user object. Same usage as in
+L<Catalyst::Authentication::Credential::Password|Catalyst::Authentication::Credential::Password/password_type>
+
+=item password_field
+
+The name of accessor used to retrieve the value of the password field from the user object. Same usage as in
+L<Catalyst::Authentication::Credential::Password|Catalyst::Authentication::Credential::Password/password_field>
+
+=item username_field
+
+The field name that the user's username is mapped into when finding the user from the realm. Defaults to 'username'.
+
+=item use_uri_for
+
+If this configuration key has a true value, then the domain(s) for the authorization header will be
+run through $c->uri_for(). Use this configuration option if your application is not running at the root
+of your domain, and you want to ensure that authentication credentials from your application are not shared with
+other applications on the same server.
+
=back
=head1 RESTRICTIONS
Updated to current name space and currently maintained
by: Tomas Doran C<bobtfish@bobtfish.net>.
-Original module by:
+Original module by:
=over
=back
+=head1 CONTRIBUTORS
+
+Patches contributed by:
+
+=over
+
+=item Peter Corlett
+
+=back
+
=head1 SEE ALSO
RFC 2617 (or its successors), L<Catalyst::Plugin::Cache>, L<Catalyst::Plugin::Authentication>
projects / catagits/Catalyst-Authentication-Credential-HTTP.git / blobdiff