From: Sascha Kiefer Date: Mon, 24 Apr 2006 00:27:52 +0000 (+0000) Subject: (no commit message) X-Git-Tag: v0.11~19 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Authentication-Credential-HTTP.git;a=commitdiff_plain;h=007935b8dde3d41f0f0517508159321f5baae8cb --- diff --git a/lib/Catalyst/Plugin/Authentication/Credential/HTTP.pm b/lib/Catalyst/Plugin/Authentication/Credential/HTTP.pm index e89402c..fbb1491 100644 --- a/lib/Catalyst/Plugin/Authentication/Credential/HTTP.pm +++ b/lib/Catalyst/Plugin/Authentication/Credential/HTTP.pm @@ -1,147 +1,338 @@ -#!/usr/bin/perl - -package Catalyst::Plugin::Authentication::Credential::HTTP; -use base qw/Catalyst::Plugin::Authentication::Credential::Password/; - -use strict; -use warnings; - -use String::Escape (); -use URI::Escape (); -use Catalyst (); - -our $VERSION = "0.01"; - -sub authenticate_http { - my $c = shift; - - my $headers = $c->req->headers; - - if ( my ( $user, $password ) = $headers->authorization_basic ) { - - if ( my $store = $c->config->{authentication}{http}{store} ) { - $user = $store->get_user($user); - } - - return $c->login( $user, $password ); - } -} - -sub authorization_required { - my ( $c, %opts ) = @_; - - return 1 if $c->authenticate_http; - - $c->authorization_required_response( %opts ); - - die $Catalyst::DETACH; -} - -sub authorization_required_response { - my ( $c, %opts ) = @_; - - $c->res->status(401); - - my @opts; - - if ( my $realm = $opts{realm} ) { - push @opts, sprintf 'realm=%s', String::Escape::qprintable($realm); - } - - if ( my $domain = $opts{domain} ) { - Catalyst::Excpetion->throw("domain must be an array reference") - unless ref($domain) && ref($domain) eq "ARRAY"; - - my @uris = - $c->config->{authentication}{http}{use_uri_for} - ? ( map { $c->uri_for($_) } @$domain ) - : ( map { URI::Escape::uri_escape($_) } @$domain ); - - push @opts, qq{domain="@uris"}; - } - - $c->res->headers->www_authenticate(join " ", "Basic", @opts); -} - -__PACKAGE__; - -__END__ - -=pod - -=head1 NAME - -Catalyst::Plugin::Authentication::Credential::HTTP - HTTP Basic authentication -for Catlayst. - -=head1 SYNOPSIS - - use Catalyst qw/ - Authentication - Authentication::Store::Moose - Authentication::Credential::HTTP - /; - - sub foo : Local { - my ( $self, $c ) = @_; - - $c->authorization_required( realm => "foo" ); # named after the status code ;-) - - # either user gets authenticated or 401 is sent - - do_stuff(); - } - - # with ACL plugin - __PACKAGE__->deny_access_unless("/path", sub { $_[0]->authenticate_http }); - - sub end : Private { - my ( $self, $c ) = @_; - - $c->authorization_required_response( realm => "foo" ); - $c->error(0); - } - -=head1 DESCRIPTION - -This moduule lets you use HTTP authentication with -L. - -Currently this module only supports the Basic scheme, but upon request Digest -will also be added. Patches welcome! - -=head1 METHODS - -=over 4 - -=item authorization_required - -Tries to C, and if that fails calls -C and detaches the current action call stack. - -=item authenticate_http - -Looks inside C<< $c->request->headers >> and processes the basic (badly named) -authorization header. - -=item authorization_required_response - -Sets C<< $c->response >> to the correct status code, and adds the correct -header to demand authentication data from the user agent. - -=back - -=head1 AUTHORS - -Yuval Kogman, C - -Jess Robinson - -=head1 COPYRIGHT & LICENSE - - Copyright (c) 2005 the aforementioned authors. All rights - reserved. This program is free software; you can redistribute - it and/or modify it under the same terms as Perl itself. - -=cut - +#!/usr/bin/perl + +package Catalyst::Plugin::Authentication::Credential::HTTP; +use base qw/Catalyst::Plugin::Authentication::Credential::Password/; + +use strict; +use warnings; + +use String::Escape (); +use URI::Escape (); +use Catalyst (); +use Digest::MD5 (); + +our $VERSION = "0.02"; + +sub authenticate_http { + my $c = shift; + + return $c->authenticate_digest || $c->authenticate_basic; +} + +sub authenticate_basic { + my $c = shift; + + $c->log->debug('Checking http basic authentication.') if $c->debug; + + my $headers = $c->req->headers; + + if ( my ( $user, $password ) = $headers->authorization_basic ) { + + if ( my $store = $c->config->{authentication}{http}{store} ) { + $user = $store->get_user($user); + } + + return $c->login( $user, $password ); + } + + return 0; +} + +sub authenticate_digest { + my $c = shift; + + $c->log->debug('Checking http digest authentication.') if $c->debug; + + my $headers = $c->req->headers; + my @authorization = $headers->header('Authorization'); + foreach my $authorization (@authorization) { + next unless $authorization =~ m{^Digest}; + + $c->_check_cache; + + my %res = map { + my @key_val = split /=/, $_, 2; + $key_val[0] = lc $key_val[0]; + $key_val[1] =~ s{"}{}g; # remove the quotes + @key_val; + } split /,\s?/, substr( $authorization, 7 ); #7 == length "Digest " + + my $opaque = $res{opaque}; + my $nonce = $c->cache->get( __PACKAGE__ . '::opaque:' . $opaque ); + next unless $nonce; + + $c->log->debug('Checking authentication parameters.') + if $c->debug; + + my $uri = '/' . $c->request->path; + my $algorithm = $res{algorithm} || 'MD5'; + my $nonce_count = '0x' . $res{nc}; + + my $check = $uri eq $res{uri} + && ( exists $res{username} ) + && ( exists $res{qop} ) + && ( exists $res{cnonce} ) + && ( exists $res{nc} ) + && $algorithm eq $nonce->algorithm + && hex($nonce_count) > hex( $nonce->nonce_count ) + && $res{nonce} eq $nonce->nonce; # TODO: set Stale instead + + unless ($check) { + $c->log->debug('Digest authentication failed. Bad request.') + if $c->debug; + $c->res->status(400); # bad request + die $Catalyst::DETACH; + } + + $c->log->debug('Checking authentication response.') + if $c->debug; + + my $username = $res{username}; + my $realm = $res{realm}; + + my $user; + my $store = $c->config->{authentication}{http}{store} + || $c->default_auth_store; + $user = $store->get_user($username) if $store; + unless ($user) { # no user, no authentication + $c->log->debug('Unknown user: $user.') if $c->debug; + return 0; + } + + # everything looks good, let's check the response + + # calculate H(A2) as per spec + my $ctx = Digest::MD5->new; + $ctx->add( join( ':', $c->request->method, $res{uri} ) ); + if ( $res{qop} eq 'auth-int' ) { + my $digest = + Digest::MD5::md5_hex( $c->request->body ); # not sure here + $ctx->add( ':', $digest ); + } + my $A2_digest = $ctx->hexdigest; + + # the idea of the for loop: + # if we do not want to store the plain password in our user store, + # we can store md5_hex("$username:$realm:$password") instead + for my $r ( 0 .. 1 ) { + + # calculate H(A1) as per spec + my $A1_digest = $r ? $user->password : do { + $ctx = Digest::MD5->new; + $ctx->add( join( ':', $username, $realm, $user->password ) ); + $ctx->hexdigest; + }; + if ( $nonce->algorithm eq 'MD5-sess' ) { + $ctx = Digest::MD5->new; + $ctx->add( join( ':', $A1_digest, $res{nonce}, $res{cnonce} ) ); + $A1_digest = $ctx->hexdigest; + } + + my $rq_digest = Digest::MD5::md5_hex( + join( ':', + $A1_digest, $res{nonce}, + $res{qop} ? ( $res{nc}, $res{cnonce}, $res{qop} ) : (), + $A2_digest ) + ); + + $nonce->nonce_count($nonce_count); + $c->cache->set( __PACKAGE__ . '::opaque:' . $nonce->opaque, + $nonce ); + + return $c->login( $user, $user->password ) + if $rq_digest eq $res{response}; + } + } + + return 0; +} + +sub _check_cache { + my $c = shift; + + die "A cache is needed for http digest authentication." + unless $c->can('cache'); +} + +sub _is_auth_type { + my ( $c, $type ) = @_; + + my $cfgtype = lc( $c->config->{authentication}{http}{type} || 'any' ); + return 1 if $cfgtype eq 'any' || $cfgtype eq lc $type; + return 0; +} + +sub authorization_required { + my ( $c, %opts ) = @_; + + return 1 if $c->_is_auth_type('digest') && $c->authenticate_digest; + return 1 if $c->_is_auth_type('basic') && $c->authenticate_basic; + + $c->authorization_required_response(%opts); + + die $Catalyst::DETACH; +} + +sub authorization_required_response { + my ( $c, %opts ) = @_; + + $c->res->status(401); + + my ( $digest, $basic ); + $digest = $c->build_authorization_required_response( \%opts, 'Digest' ) + if $c->_is_auth_type('digest'); + $basic = $c->build_authorization_required_response( \%opts, 'Basic' ) + if $c->_is_auth_type('basic'); + + die 'Could not build authorization required response. ' + . 'Did you configure a valid authentication http type: ' + . 'basic, digest, any' + unless $digest || $basic; + + $c->res->headers->push_header( 'WWW-Authenticate' => $digest ) + if $digest; + $c->res->headers->push_header( 'WWW-Authenticate' => $basic ) if $basic; +} + +sub build_authorization_required_response { + my ( $c, $opts, $type ) = @_; + my @opts; + + if ( my $realm = $opts->{realm} ) { + push @opts, 'realm=' . String::Escape::qprintable($realm); + } + + if ( my $domain = $opts->{domain} ) { + Catalyst::Excpetion->throw("domain must be an array reference") + unless ref($domain) && ref($domain) eq "ARRAY"; + + my @uris = + $c->config->{authentication}{http}{use_uri_for} + ? ( map { $c->uri_for($_) } @$domain ) + : ( map { URI::Escape::uri_escape($_) } @$domain ); + + push @opts, qq{domain="@uris"}; + } + + if ( $type eq 'Digest' ) { + my $package = __PACKAGE__ . '::Nonce'; + my $nonce = $package->new; + $nonce->algorithm( $c->config->{authentication}{http}{algorithm} + || $nonce->algorithm ); + + push @opts, 'qop="' . $nonce->qop . '"'; + push @opts, 'nonce="' . $nonce->nonce . '"'; + push @opts, 'opaque="' . $nonce->opaque . '"'; + push @opts, 'algorithm="' . $nonce->algorithm . '"'; + + $c->_check_cache; + $c->cache->set( __PACKAGE__ . '::opaque:' . $nonce->opaque, $nonce ); + } + + return "$type " . join( ', ', @opts ); +} + +package Catalyst::Plugin::Authentication::Credential::HTTP::Nonce; + +use strict; +use base qw[ Class::Accessor::Fast ]; +use Data::UUID (); + +our $VERSION = "0.01"; + +__PACKAGE__->mk_accessors(qw[ nonce nonce_count qop opaque algorithm ]); + +sub new { + my $class = shift; + my $self = $class->SUPER::new(@_); + + $self->nonce( Data::UUID->new->create_b64 ); + $self->opaque( Data::UUID->new->create_b64 ); + $self->qop('auth,auth-int'); + $self->nonce_count('0x0'); + $self->algorithm('MD5'); + + return $self; +} + +1; + +__END__ + +=pod + +=head1 NAME + +Catalyst::Plugin::Authentication::Credential::HTTP - HTTP Basic authentication +for Catlayst. + +=head1 SYNOPSIS + + use Catalyst qw/ + Authentication + Authentication::Store::Moose + Authentication::Credential::HTTP + /; + + sub foo : Local { + my ( $self, $c ) = @_; + + $c->authorization_required( realm => "foo" ); # named after the status code ;-) + + # either user gets authenticated or 401 is sent + + do_stuff(); + } + + # with ACL plugin + __PACKAGE__->deny_access_unless("/path", sub { $_[0]->authenticate_http }); + + sub end : Private { + my ( $self, $c ) = @_; + + $c->authorization_required_response( realm => "foo" ); + $c->error(0); + } + +=head1 DESCRIPTION + +This moduule lets you use HTTP authentication with +L. + +Currently this module only supports the Basic scheme, but upon request Digest +will also be added. Patches welcome! + +=head1 METHODS + +=over 4 + +=item authorization_required + +Tries to C, and if that fails calls +C and detaches the current action call stack. + +=item authenticate_http + +Looks inside C<< $c->request->headers >> and processes the basic (badly named) +authorization header. + +=item authorization_required_response + +Sets C<< $c->response >> to the correct status code, and adds the correct +header to demand authentication data from the user agent. + +=back + +=head1 AUTHORS + +Yuval Kogman, C + +Jess Robinson + +=head1 COPYRIGHT & LICENSE + + Copyright (c) 2005 the aforementioned authors. All rights + reserved. This program is free software; you can redistribute + it and/or modify it under the same terms as Perl itself. + +=cut diff --git a/t/basic.t b/t/basic.t index 9060dc1..2ba6ff8 100644 --- a/t/basic.t +++ b/t/basic.t @@ -3,7 +3,7 @@ use strict; use warnings; -use Test::More tests => 11; +use Test::More tests => 12; use Test::MockObject::Extends; use Test::MockObject; use Test::Exception; @@ -31,6 +31,11 @@ $res->set_always( headers => $res_headers ); my $c = Test::MockObject::Extends->new( $m ); +my $cache = Test::MockObject->new; +$cache->mock(set => sub { shift->{$_[0]} = $_[1] }); +$cache->mock(get => sub { return shift->{$_[0]} }); +$c->mock(cache => sub { $cache }); + my @login_info; $c->mock( login => sub { shift; @login_info = @_; 1 } ); $c->set_always( config => {} ); @@ -57,4 +62,5 @@ throws_ok { } qr/^ $Catalyst::DETACH $/x, "detached on no authorization required with bad auth"; is( $status, 401, "401 status code" ); -like( $res_headers->www_authenticate, qr/^Basic/, "WWW-Authenticate header set"); +like( ($res_headers->header('WWW-Authenticate'))[0], qr/^Digest/, "WWW-Authenticate header set: digest"); +like( ($res_headers->header('WWW-Authenticate'))[1], qr/^Basic/, "WWW-Authenticate header set: basic"); diff --git a/t/live_app.t b/t/live_app.t index 770115d..519bf0c 100644 --- a/t/live_app.t +++ b/t/live_app.t @@ -34,7 +34,7 @@ use HTTP::Request; $c->res->body( $c->user->id ); } - + __PACKAGE__->config->{authentication}{http}{type} = 'basic'; __PACKAGE__->config->{authentication}{users} = $users = { foo => { password => "s3cr3t", }, }; diff --git a/t/live_app_digest.t b/t/live_app_digest.t new file mode 100644 index 0000000..e0e2ad4 --- /dev/null +++ b/t/live_app_digest.t @@ -0,0 +1,103 @@ +#!/usr/bin/perl + +use strict; +use warnings; + +use Test::More; + +BEGIN { + eval { require Test::WWW::Mechanize::Catalyst } + or plan skip_all => + "Test::WWW::Mechanize::Catalyst is needed for this test"; + eval { require Catalyst::Plugin::Cache::FileCache } + or plan skip_all => + "Catalyst::Plugin::Cache::FileCache is needed for this test"; + plan tests => 4; +} + +use HTTP::Request; + +{ + + package AuthTestApp; + use Catalyst qw/ + Authentication + Authentication::Store::Minimal + Authentication::Credential::HTTP + Cache::FileCache + /; + + use Test::More; + + our $users; + + sub moose : Local { + my ( $self, $c ) = @_; + + $c->authorization_required( realm => 'testrealm@host.com' ); + + $c->res->body( $c->user->id ); + } + __PACKAGE__->config->{authentication}{http}{type} = 'digest'; + __PACKAGE__->config->{authentication}{users} = $users = { + Mufasa => { password => "Circle Of Life", }, + }; + + __PACKAGE__->setup; +} + +use Test::WWW::Mechanize::Catalyst qw/AuthTestApp/; + +my $mech = Test::WWW::Mechanize::Catalyst->new; + +$mech->get("http://localhost/moose"); +is( $mech->status, 401, "status is 401" ); + +my $www_auth = $mech->res->headers->header('WWW-Authenticate'); +my %www_auth_params = map { + my @key_val = split /=/, $_, 2; + $key_val[0] = lc $key_val[0]; + $key_val[1] =~ s{"}{}g; # remove the quotes + @key_val; +} split /, /, substr( $www_auth, 7 ); #7 == length "Digest " + +$mech->content_lacks( "foo", "no output" ); + +my $response = ''; +{ + my $username = 'Mufasa'; + my $password = 'Circle Of Life'; + my $realm = $www_auth_params{realm}; + my $nonce = $www_auth_params{nonce}; + my $cnonce = '0a4f113b'; + my $opaque = $www_auth_params{opaque}; + my $nc = '00000001'; + my $method = 'GET'; + my $qop = 'auth'; + my $uri = '/moose'; + + my $ctx = Digest::MD5->new; + $ctx->add( join( ':', $username, $realm, $password ) ); + my $A1_digest = $ctx->hexdigest; + + $ctx = Digest::MD5->new; + $ctx->add( join( ':', $method, $uri ) ); + my $A2_digest = $ctx->hexdigest; + + my $digest = Digest::MD5::md5_hex( + join( ':', + $A1_digest, $nonce, $qop ? ( $nc, $cnonce, $qop ) : (), $A2_digest ) + ); + + $response = qq{Digest username="$username", realm="$realm", nonce="$nonce", uri="$uri", qop=$qop, nc=$nc, cnonce="$cnonce", response="$digest", opaque="$opaque"}; +} + +my $r = HTTP::Request->new( GET => "http://localhost/moose" ); +$mech->request($r); + +$r->headers->push_header( Authorization => $response ); +$mech->request($r); + +is( $mech->status, 200, "status is 200" ); +$mech->content_contains( "Mufasa", "Mufasa output" ); +