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 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
|
package OAuth::Lite2::ParamMethod::AuthHeader;
use strict;
use warnings;
use bytes ();
use parent 'OAuth::Lite2::ParamMethod';
use URI;
use MIME::Base64 qw(decode_base64);
use Hash::MultiValue;
use HTTP::Request;
use HTTP::Headers;
use Params::Validate;
use OAuth::Lite2::Util qw(encode_param decode_param build_content);
=head1 NAME
OAuth::Lite2::ParamMethod::AuthHeader - builder/parser for OAuth 2.0 AuthHeader type of parameter
=head1 SYNOPSIS
my $meth = OAuth::Lite2::ParamMethod::AuthHeader->new;
# server side
if ($meth->match( $plack_request )) {
my ($token, $params) = $meth->parse( $plack_request );
}
# client side
my $http_req = $meth->request_builder(...);
=head1 DESCRIPTION
builder/parser for OAuth 2.0 AuthHeader type of parameter
=head1 METHODS
=head2 new
Constructor
=head2 match( $plack_request )
Returns true if passed L<Plack::Request> object is matched for the type of this method.
if ( $meth->match( $plack_request ) ) {
...
}
=cut
sub match {
my ($self, $req) = @_;
my $header = $req->header("Authorization");
return ($header && $header =~ /^\s*(OAuth|Bearer)(.*)$/);
}
=head2 parse( $plack_request )
Parse the L<Plack::Request>, and returns access token and oauth parameters.
my ($token, $params) = $meth->parse( $plack_request );
=cut
sub parse {
my ($self, $req) = @_;
my $header = $req->header("Authorization");
my $token;
if ($header =~ s/^\s*(OAuth|Bearer)\s+([^\s\,]*)//){
$token = $2;
}
my $params = Hash::MultiValue->new;
$header =~ s/^\s*(OAuth|Bearer)\s*([^\s\,]*)//;
if ($header) {
$header =~ s/^\s*\,\s*//;
for my $attr (split /,\s*/, $header) {
my ($key, $val) = split /=/, $attr, 2;
$val =~ s/^"//;
$val =~ s/"$//;
$params->add($key, decode_param($val));
}
}
return ($token, $params);
}
=head2 build_request( %params )
Build L<HTTP::Request> object.
my $req = $meth->build_request(
url => $url,
method => $http_method,
token => $access_token,
oauth_params => $oauth_params,
params => $params,
content => $content,
headers => $headers,
);
=cut
sub build_request {
my $self = shift;
my %args = Params::Validate::validate(@_, {
url => 1,
method => 1,
token => 1,
oauth_params => 1,
params => { optional => 1 },
content => { optional => 1 },
headers => { optional => 1 },
});
my $oauth_params = $args{oauth_params} || {};
my @pairs = sort map { sprintf q{%s="%s"},
encode_param($_),
encode_param($oauth_params->{$_})
} keys %$oauth_params;
my $params = $args{params} || {};
my $method = uc $args{method};
my $headers = $args{headers};
if (defined $headers) {
if (ref($headers) eq 'ARRAY') {
$headers = HTTP::Headers->new(@$headers);
} else {
$headers = $headers->clone;
}
} else {
$headers = HTTP::Headers->new;
}
my $auth_header = sprintf(q{Bearer %s}, $args{token});
$auth_header .= ", " . join(", ", @pairs) if @pairs > 0;
$headers->header(Authorization => $auth_header);
if ($method eq 'GET' || $method eq 'DELETE') {
my $url = URI->new($args{url});
$url->query_form(%$params);
my $req = HTTP::Request->new($method, $url->as_string, $headers);
return $req;
} else {
unless ($headers->header("Content-Type")) {
$headers->header("Content-Type",
"application/x-www-form-urlencoded");
}
my $content_type = $headers->header("Content-Type");
my $content = ($content_type eq "application/x-www-form-urlencoded")
? build_content($params)
: $args{content} || build_content($params);
$headers->header("Content-Length", bytes::length($content));
my $req = HTTP::Request->new($method, $args{url}, $headers, $content);
return $req;
}
}
=head2 is_legacy( $plack_request )
Returns true if passed L<Plack::Request> object is based draft version 10.
if ( $meth->is_legacy( $plack_request ) ) {
...
}
=cut
sub is_legacy {
my ($self, $req) = @_;
my $header = $req->header("Authorization");
return ($header && $header =~ /^\s*OAuth(.*)$/);
}
=head2 basic_clientcredentials( $plack_request )
Returns Hash reference if passed L<Plack::Request> object has client credentials in Authorization header.
my $basic_clientcredentials = $meth->basic_credentials( $plack_request );
if( defined($basic_clientcredentials) ){
my $client_id = $basic_clientcredentials->{client_id};
my $client_secret = $basic_clientcredentials->{client_secret};
}
=cut
sub basic_credentials{
my ($self, $req) = @_;
my %credentials = (
client_id => '',
client_secret => ''
);
my $header = $req->header("Authorization");
return \%credentials unless (defined($header));
my $decoded;
if ( $header =~ /\A\s*(Basic)\s([^\s\,]*)/ ){
$decoded = decode_base64($2);
return \%credentials unless (index($decoded,':') > 0);
my @split_credentials = split(/:/, $decoded);
return \%credentials unless (scalar(@split_credentials) == 2);
%credentials = (
client_id => $split_credentials[0],
client_secret => $split_credentials[1]
);
}
return \%credentials;
};
=head1 SEE ALSO
L<OAuth::Lite2::ParamMethods>
L<OAuth::Lite2::ParamMethod>
L<OAuth::Lite2::ParamMethod::FormEncodedBody>
L<OAuth::Lite2::ParamMethod::URIQueryParameter>
=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;
|