1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
|
package Plack::Middleware::Auth::OAuth2::ProtectedResource;
use strict;
use warnings;
use parent 'Plack::Middleware';
use Plack::Request;
use Plack::Util::Accessor qw(realm data_handler error_uri);
use Try::Tiny;
use Carp ();
use OAuth::Lite2::Server::Error;
use OAuth::Lite2::ParamMethods;
sub call {
my ($self, $env) = @_;
my $is_legacy = 0;
my $error_res = try {
my $req = Plack::Request->new($env);
# after draft-v6, signature is not required, so always each connection
# should be under TLS.
# warn "insecure bearere token request" unless $req->secure;
my $parser = OAuth::Lite2::ParamMethods->get_param_parser($req)
or OAuth::Lite2::Server::Error::InvalidRequest->throw;
$is_legacy = $parser->is_legacy($req);
# after draft-v6, $params aren't required.
my ($token, $params) = $parser->parse($req);
OAuth::Lite2::Server::Error::InvalidRequest->throw unless $token;
my $dh = $self->{data_handler}->new(request => $req);
my $access_token = $dh->get_access_token($token);
OAuth::Lite2::Server::Error::InvalidToken->throw
unless $access_token;
Carp::croak "OAuth::Lite2::Server::DataHandler::get_access_token doesn't return OAuth::Lite2::Model::AccessToken"
unless $access_token->isa("OAuth::Lite2::Model::AccessToken");
unless ($access_token->created_on + $access_token->expires_in > time())
{
if($is_legacy){
OAuth::Lite2::Server::Error::ExpiredTokenLegacy->throw;
}else{
OAuth::Lite2::Server::Error::ExpiredToken->throw;
}
}
my $auth_info = $dh->get_auth_info_by_id($access_token->auth_id);
OAuth::Lite2::Server::Error::InvalidToken->throw
unless $auth_info;
Carp::croak "OAuth::Lite2::Server::DataHandler::get_auth_info_by_id doesn't return OAuth::Lite2::Model::AuthInfo"
unless $auth_info->isa("OAuth::Lite2::Model::AuthInfo");
$dh->validate_client_by_id($auth_info->client_id)
or OAuth::Lite2::Server::Error::InvalidToken->throw;
$dh->validate_user_by_id($auth_info->user_id)
or OAuth::Lite2::Server::Error::InvalidToken->throw;
$env->{REMOTE_USER} = $auth_info->user_id;
$env->{X_OAUTH_CLIENT} = $auth_info->client_id;
$env->{X_OAUTH_SCOPE} = $auth_info->scope if $auth_info->scope;
# pass legacy flag
$env->{X_OAUTH_IS_LEGACY} = ($is_legacy);
return;
} catch {
if ($_->isa("OAuth::Lite2::Server::Error")) {
my @params;
push(@params, sprintf(q{realm="%s"}, $self->{realm}))
if $self->{realm};
push(@params, sprintf(q{error="%s"}, $_->type));
push(@params, sprintf(q{error_description="%s"}, $_->description))
if $_->description;
push(@params, sprintf(q{error_uri="%s"}, $self->{error_uri}))
if $self->{error_uri};
# push(@params, sprintf(q{scope='%s'}, $_->scope))
# if $_->scope;
if($is_legacy){
return [ $_->code, [ "WWW-Authenticate" =>
"OAuth " . join(', ', @params) ], [ ] ];
}else{
return [ $_->code, [ "WWW-Authenticate" =>
"Bearer " . join(', ', @params) ], [ ] ];
}
} else {
# rethrow
die $_;
}
};
return $error_res || $self->app->($env);
}
=head1 NAME
Plack::Middleware::Auth::OAuth2::ProtectedResource - middleware for OAuth 2.0 Protected Resource endpoint
=head1 SYNOPSIS
my $app = sub {...};
builder {
enable "Plack::Middleware::Auth::OAuth2::ProtectedResource",
data_handler => "YourApp::DataHandler",
error_uri => q{http://example.org/error/description};
enable "Plack::Middleware::JSONP";
enable "Plack::Middleware::ContentLength";
$app;
};
# and on your controller
$plack_request->env->{REMOTE_USER};
$plack_request->env->{X_OAUTH_CLIENT_ID};
$plack_request->env->{X_OAUTH_SCOPE};
=head1 DESCRIPTION
middleware for OAuth 2.0 Protected Resource endpoint
=head1 METHODS
=head2 call( $env )
This method parses access token.
If access token is valid, authorization information are set to environment variables.
=head1 ENV VALUES
After successful verifying authorization within middleware layer,
Following 3 type of values are set in env.
=over 4
=item REMOTE_USER
Identifier of user who grant the client to access the user's protected
resource that is stored on service provider.
=item X_OAUTH_CLIENT
Identifier of the client that accesses to user's protected resource
on beharf of the user.
=item X_OAUTH_SCOPE
Scope parameter that represents what kind of resources that
the user grant client to access.
=back
=head1 AUTHOR
Lyo Kato, E<lt>lyo.kato@gmail.comE<gt>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2010 by Lyo Kato
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.8 or,
at your option, any later version of Perl 5 you may have available.
=cut
1;
|