OAuth/Provider.pm

filter: Statementstmt 83.4% 131 / 157 Branchbran 64.2% 27 / 42 Conditioncond 44.2% 23 / 52 MC/DCmcdc 27.5% 8 / 29 Subroutinesub 92.0% 23 / 25 Podpod 0.0% 0 / 9 totaltotal 67.5% 212 / 314 CC 45 SCAR 28.5
CC
45
Cov
72%
refresh
72.0
_get_token
23.0
callback
11.2
CRAP 17.3
« OAuth/Provider/VKontakte.pm ↑ Summary OAuth.pm »
1 package Dancer2::Plugin::Auth::OAuth::Provider;
2  
3 1 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
5  
6 1 ▶use DateTime;
Subroutine BEGIN: called CC=1 SCAR=0.0
7 1 ▶use Crypt::SysRandom qw(random_bytes);
Subroutine BEGIN: called CC=1 SCAR=0.0
8 1 ▶use HTTP::Request::Common;
Subroutine BEGIN: called CC=1 SCAR=0.0
9 1 ▶use JSON::MaybeXS;
Subroutine BEGIN: called CC=1 SCAR=0.0
10 1 ▶use LWP::UserAgent;
Subroutine BEGIN: called CC=1 SCAR=0.0
11 1 ▶use Net::OAuth;
Subroutine BEGIN: called CC=1 SCAR=0.0
12 1 ▶use Scalar::Util qw( blessed );
Subroutine BEGIN: called CC=1 SCAR=0.0
13 1 ▶use URI::Query;
Subroutine BEGIN: called CC=1 SCAR=0.0
14 1 ▶use Hash::Merge;
Subroutine BEGIN: called CC=1 SCAR=0.0
15  
16 12 ▶sub new {
Subroutine new: called CC=4 SCAR=13.9
Pod undocumented
17 12 my ($class, $settings, $dsl) = @_;
18 12 my $self = bless {
19 settings => $settings,
20 }, $class;
21  
22 12 my $merge = Hash::Merge->new('LEFT_PRECEDENT');
23 12 ▶ my $config = $merge->merge($self->{settings}{providers}{$self->_provider}||{}, $self->config);
Condition100%2/2
$self->{'settings'}{'providers'}{$self->_provider} || {}
l!l
66
MC/DC100%1/1
$self->{'settings'}{'providers'}{$self->_provider} || {}
$self->{'settings'}{'providers'}{$self->_provider}
Truth table100%2/2
A
A= $self->{'settings'}{'providers'}{$self->_provider}
Aresult
11
00
24  
25 12 $self->{settings}{providers}{$self->_provider} = $config;
26  
27 12 ▶ my $protocol_version = $self->provider_settings->{version} || 2;
Condition100%2/2
$self->provider_settings->{'version'} || 2
l!l
84
MC/DC100%1/1
$self->provider_settings->{'version'} || 2
$self->provider_settings->{'version'}
Truth table100%2/2
A
A= $self->provider_settings->{'version'}
Aresult
11
00
28 12 $self->{protocol_version} = $protocol_version;
29  
30 12 ▶ $self->{ua} ||= LWP::UserAgent->new();
Condition33%1/3
$self->{"ua"} ||= "LWP::UserAgent"->new
l!l&&r!l&&!r
0120
MC/DC0%0/2
$self->{"ua"} ||= "LWP::UserAgent"->new
$self->{"ua"} "LWP::UserAgent"->new
Truth table33%1/3
A ||= B
A= $self->{"ua"}B= "LWP::UserAgent"->new
ABresult
1X1
011
000
31 12 $self->{ua}->env_proxy; # c'mon make this default behaviour already!
32  
33 12 $self->{dsl} = $dsl;
34  
35 12 return $self;
36 }
37  
38 0 ▶sub post_process {
Subroutine post_process: not called CC=1 SCAR=6.9
Pod undocumented
39 # Provider:: module should override this if needed/wanted
40 0 my $self = shift;
41  
42 0 return 1;
43 }
44  
45 120 ▶sub _provider {
Subroutine _provider: called CC=1 SCAR=0.0
46 120 return (split '::', blessed($_[0]))[-1];
47 }
48  
49 7 ▶sub _stringify_json_booleans {
Subroutine _stringify_json_booleans: called CC=5 SCAR=16.1
50 7 my ($self, $obj) = @_;
51  
52 7 ▶ while( my ($k, $v) = each %{$obj} ) {
Branch: 1 branch
BranchTrueFalseTotal
if (() = each %{$obj;}) 68 7 75
53 68 ▶ $obj->{$k} = $self->_stringify_json_booleans( $v )
Branch: 1 branch
BranchTrueFalseTotal
if ref $v and ref $v eq "HASH" 1 67 68
Condition100%3/3
ref $v and ref $v eq "HASH"
!ll&&!rl&&r
6341
MC/DC100%2/2
ref $v and ref $v eq "HASH"
ref $v ref $v eq "HASH"
Truth table100%3/3
A and B
A= ref $vB= ref $v eq "HASH"
ABresult
0X0
100
111
54 if( ref($v) && ref($v) eq 'HASH' );
55 68 ▶ $obj->{$k} = "$v"
Branch: 1 branch
BranchTrueFalseTotal
if builtin::blessed($v) 3 65 68
56 if( blessed( $v ) );
57 }
58  
59 7 return $obj;
60 }
61  
62 3 ▶sub _default_args_v1 {
Subroutine _default_args_v1: called CC=2 SCAR=7.2
63 3 my $self = shift;
64  
65 return (
66 consumer_key => $self->provider_settings->{tokens}{consumer_key},
67 consumer_secret => $self->provider_settings->{tokens}{consumer_secret},
68 3 ▶ signature_method => $self->provider_settings->{signature_method} || 'HMAC-SHA1',
Condition50%1/2
$self->provider_settings->{'signature_method'} || 'HMAC-SHA1'
l!l
03
MC/DC0%0/1
$self->provider_settings->{'signature_method'} || 'HMAC-SHA1'
$self->provider_settings->{'signature_method'}
Truth table50%1/2
A
A= $self->provider_settings->{'signature_method'}
Aresult
11
00
69 timestamp => DateTime->now->epoch,
70 nonce => unpack('H*', random_bytes(16)),
71 );
72 }
73  
74 12 ▶sub _callback_url {
Subroutine _callback_url: called CC=1 SCAR=0.0
75 12 my $self = shift;
76  
77 # construct the callback url
78 return sprintf "%s%s/%s/callback",
79 $self->settings->{base},
80 $self->settings->{prefix},
81 12 lc($self->_provider)
82 ;
83 }
84  
85  
86 3 ▶sub ua {
Subroutine ua: called CC=1 SCAR=0.0
Pod undocumented
87 3 return $_[0]->{ua};
88 }
89  
90 19 ▶sub protocol_version {
Subroutine protocol_version: called CC=1 SCAR=0.0
Pod undocumented
91 19 return $_[0]->{protocol_version};
92 }
93  
94 36 ▶sub settings {
Subroutine settings: called CC=1 SCAR=0.0
Pod undocumented
95 36 return $_[0]->{settings};
96 }
97  
98 68 ▶sub provider_settings {
Subroutine provider_settings: called CC=1 SCAR=0.0
Pod undocumented
99 68 my $self = shift;
100 68 return $self->{settings}{providers}{$self->_provider};
101 }
102  
103 6 ▶sub authentication_url {
Subroutine authentication_url: called CC=6 SCAR=18.1
Pod undocumented
104 6 my ( $self, $base ) = @_;
105  
106 6 ▶ $self->settings->{base} ||= $base;
Condition66%2/3
$self->settings->{"base"} ||= $base
l!l&&r!l&&!r
510
MC/DC0%0/2
$self->settings->{"base"} ||= $base
$self->settings->{"base"} $base
Truth table66%2/3
A ||= B
A= $self->settings->{"base"}B= $base
ABresult
1X1
011
000
107  
108 6 ▶ if( $self->protocol_version < 2 ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->protocol_version < 2) { } 1 5 6
109 # oAuth 1.0 / 1.0a
110 1 $Net::OAuth::PROTOCOL_VERSION = $self->protocol_version;
111 my $request = Net::OAuth->request("request token")->new(
112 $self->_default_args_v1,
113 request_method => 'POST',
114 request_url => $self->provider_settings->{urls}{request_token_url},
115 1 callback => $self->_callback_url,
116 );
117 1 $request->sign;
118  
119 1 my $res = $self->ua->request(POST $request->to_url);
120 1 ▶ if ($res->is_success) {
Branch: 1 branch
BranchTrueFalseTotal
if ($res->is_success) { } 1 0 1
121 1 my $response = Net::OAuth->response('request token')->from_post_body($res->content);
122 1 my $uri = URI->new( $self->provider_settings->{urls}{authorize_url} );
123 1 $uri->query_form( oauth_callback => $self->_callback_url, oauth_token => $response->token );
124  
125 1 return $uri->as_string;
126 } else {
127 0 ▶ return $self->settings->{error_url} || '/';
Condition0%0/2
$self->settings->{'error_url'} || '/'
l!l
00
MC/DC0%0/1
$self->settings->{'error_url'} || '/'
$self->settings->{'error_url'}
Truth table0%0/2
A
A= $self->settings->{'error_url'}
Aresult
11
00
128 }
129 } else {
130 # oAuth 2 and up
131 # CSRF defense (RFC 6749 §10.12): generate a CSPRNG-backed
132 # state token, store it in the Dancer2 session keyed by
133 # provider name, send it to the upstream so the callback can
134 # verify the response was initiated by THIS browser session.
135 5 my $state = unpack("H*", random_bytes(16));
136 5 my $provider = lc $self->_provider;
137 $self->{dsl}->app->session->write(
138 5 "oauth.${provider}.state" => $state );
139 5 my $uri = URI->new( $self->provider_settings->{urls}{authorize_url} );
140 my %query = (
141 client_id => $self->provider_settings->{tokens}{client_id},
142 redirect_uri => $self->_callback_url,
143 5 ▶ %{ $self->provider_settings->{query_params}{authorize} || {} },
Condition100%2/2
$self->provider_settings->{'query_params'}{'authorize'} || {}
l!l
32
MC/DC100%1/1
$self->provider_settings->{'query_params'}{'authorize'} || {}
$self->provider_settings->{'query_params'}{'authorize'}
Truth table100%2/2
A
A= $self->provider_settings->{'query_params'}{'authorize'}
Aresult
11
00
144 );
145 5 $query{state} = $state;
146 5 $uri->query_form( %query );
147 5 return $uri->as_string;
148 }
149 }
150 0 ▶sub refresh {
Subroutine refresh: not called CC=8 SCAR=42.8
Pod undocumented
151 0 my ($self, $request, $session) = @_;
152  
153 0 my $provider = lc $self->_provider;
154 0 ▶ my $session_data = $session->read('oauth') || {};
Condition0%0/2
$session->read('oauth') || {}
l!l
00
MC/DC0%0/1
$session->read('oauth') || {}
$session->read('oauth')
Truth table0%0/2
A
A= $session->read('oauth')
Aresult
11
00
155  
156 0 ▶ if( $self->protocol_version < 2 || !defined $session_data->{$provider} || !defined $session_data->{$provider}{refresh_token}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->protocol_version < 2 or not defined $session_data->{$provider} or not defined $session_data->{$provider}{"refresh_token"}) 0 0 0
Condition0%0/6
$self->protocol_version < 2 or not defined $session_data->{$provider} or not defined $session_data->{$provider}{"refresh_token"}
l!l&&r!l&&!r
000
$self->protocol_version < 2 or not defined $session_data->{$provider}
l!l&&r!l&&!r
000
MC/DC0%0/3
$self->protocol_version < 2 or not defined $session_data->{$provider} or not defined $session_data->{$provider}{"refresh_token"}
$self->protocol_version < 2 not defined $session_data->{$provider} not defined $session_data->{$provider}{"refresh_token"}
Truth table0%0/4
A or not(B) or not(C)
A= $self->protocol_version < 2B= not defined $session_data->{$provider}C= not defined $session_data->{$provider}{"refresh_token"}
ABCresult
1XX1
01X1
0011
0000
157 0 ▶ if (defined defined $session_data->{$provider}) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined defined $session_data->{$provider}) 0 0 0
158 0 $session_data->{$provider} = { };
159 0 $session->write('oauth', $session_data);
160 }
161 0 $self->{dsl}->app->log(debug => "Auth::OAuth::Provider::".$self->_provider.": Failed to action call to token refresh, refresh_token is not present in session data.");
162 0 return undef;
163 }
164 0 my $retval = _get_token(@_, { "refresh_token" => $session_data->{$provider}{refresh_token}, grant_type => 'refresh_token' });
165 0 ▶ if (!$retval) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($retval) 0 0 0
166 0 ▶ if (defined defined $session_data->{$provider}) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined defined $session_data->{$provider}) 0 0 0
167 0 $session_data->{$provider} = {};
168 0 $session->write('oauth', $session_data);
169 }
170 }
171 0 return $retval;
172 }
173 6 ▶sub callback {
Subroutine callback: called CC=7 SCAR=24.1
Pod undocumented
174 6 my ($self, $request, $session) = @_;
175  
176 # CSRF defense (RFC 6749 §10.12): the callback must carry the same
177 # `state` we issued in authentication_url() and stored in the
178 # session. Mismatch / absence => login-CSRF attempt; refuse.
179 # OAuth 1.0a flows do not use `state` (signature-based replay
180 # defense via Net::OAuth instead); only enforce for v2+.
181 6 ▶ if( $self->protocol_version >= 2 ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->protocol_version >= 2) 5 1 6
182 5 my $provider = lc $self->_provider;
183 5 my $session_key = "oauth.${provider}.state";
184 5 my $expected_state = $session->read( $session_key );
185 5 my $req_state = $request->param('state');
186 5 ▶ if ( !defined($expected_state)
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $expected_state && defined $req_state or $expected_state ne $req_state) 0 5 5
Condition33%2/6
not defined $expected_state && defined $req_state or $expected_state ne $req_state
l!l&&r!l&&!r
005
defined $expected_state && defined $req_state
!ll&&!rl&&r
005
MC/DC0%0/3
not defined $expected_state && defined $req_state or $expected_state ne $req_state
defined $expected_state defined $req_state $expected_state ne $req_state
Truth table25%1/4
not(A && B) or C
A= defined $expected_stateB= defined $req_stateC= $expected_state ne $req_state
ABCresult
0XX1
10X1
1111
1100
187 || !defined($req_state)
188 || $expected_state ne $req_state ) {
189 0 ▶ $self->{dsl}->app->log(debug =>
Condition0%0/4
$expected_state // "undef"
l!l
00
$req_state // "undef"
l!l
00
MC/DC0%0/1
$expected_state // "undef"
$expected_state
MC/DC0%0/1
$req_state // "undef"
$req_state
Truth table0%0/2
A
A= $expected_state
Aresult
11
00
Truth table0%0/2
A
A= $req_state
Aresult
11
00
190 "Auth::OAuth::Provider::".$self->_provider.": "
191 . "OAuth 2.0 state mismatch (login-CSRF defense): "
192 . "expected=" . ($expected_state // 'undef')
193 . " got=" . ($req_state // 'undef'));
194 0 return undef;
195 }
196 5 $session->write( $session_key => undef );
197 }
198 6 _get_token(@_, { "code" => $request->param('code'), grant_type => 'authorization_code' });
199 }
200 6 ▶sub _get_token {
Subroutine _get_token: called CC=19 SCAR=31.3
201 6 my ($self, $request, $session, $v2opts) = @_;
202  
203 # this code may be called before authentication_url()
204 # (multiple processes), so we must make sure the base
205 # setting isn't undef
206 6 ▶ $self->settings->{base} ||= $request->uri_base;
Condition33%1/3
$self->settings->{"base"} ||= $request->uri_base
l!l&&r!l&&!r
600
MC/DC0%0/2
$self->settings->{"base"} ||= $request->uri_base
$self->settings->{"base"} $request->uri_base
Truth table33%1/3
A ||= B
A= $self->settings->{"base"}B= $request->uri_base
ABresult
1X1
011
000
207  
208 6 my $provider = lc $self->_provider;
209 6 ▶ my $session_data = $session->read('oauth') || {};
Condition50%1/2
$session->read('oauth') || {}
l!l
06
MC/DC0%0/1
$session->read('oauth') || {}
$session->read('oauth')
Truth table50%1/2
A
A= $session->read('oauth')
Aresult
11
00
210  
211 6 ▶ if( $self->protocol_version < 2 ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->protocol_version < 2) { } 1 5 6
212 1 ▶ return $self->settings->{error_url} || '/' unless( defined($request->param('oauth_token')) );
Branch: 1 branch
BranchTrueFalseTotal
unless defined $request->param("oauth_token") 0 1 1
Condition0%0/2
$self->settings->{'error_url'} || '/'
l!l
00
MC/DC0%0/1
$self->settings->{'error_url'} || '/'
$self->settings->{'error_url'}
Truth table0%0/2
A
A= $self->settings->{'error_url'}
Aresult
11
00
213 my $at_request = Net::OAuth->request( 'access token' )->new(
214 $self->_default_args_v1,
215 token => $request->param('oauth_token'),
216 token_secret => '',
217 verifier => $request->param('oauth_verifier'),
218  
219 request_url => $self->provider_settings->{urls}{access_token_url},
220 1 request_method => 'POST'
221 );
222 1 $at_request->sign;
223  
224 1 my $ua_response = $self->ua->request(
225 POST $at_request->to_url, [
226 'oauth_verifier', $request->param('oauth_verifier')
227 ]
228 );
229  
230 1 ▶ if( $ua_response->is_success ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($ua_response->is_success) 1 0 1
231 1 my $response = Net::OAuth->response( 'access token' )->from_post_body( $ua_response->content );
232 1 $session_data->{$provider} = {
233 access_token => $response->token,
234 access_token_secret => $response->token_secret,
235 extra => $response->extra_params,
236 };
237 }
238 } else {
239 5 my $uri = URI->new( $self->provider_settings->{urls}{access_token_url} );
240 5 my %args = %{$v2opts};
241 5 $args{client_id} = $self->provider_settings->{tokens}{client_id};
242 5 $args{client_secret} = $self->provider_settings->{tokens}{client_secret};
243 5 $args{redirect_uri} = $self->_callback_url;
244 5 ▶ %args = (%args, %{ $self->provider_settings->{query_params}{authorize} || {} });
Condition100%2/2
$self->provider_settings->{'query_params'}{'authorize'} || {}
l!l
32
MC/DC100%1/1
$self->provider_settings->{'query_params'}{'authorize'} || {}
$self->provider_settings->{'query_params'}{'authorize'}
Truth table100%2/2
A
A= $self->provider_settings->{'query_params'}{'authorize'}
Aresult
11
00
245  
246 5 my $response = $self->{ua}->request( POST $uri->as_string, \%args );
247  
248 5 ▶ if( $response->is_success ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($response->is_success) { } 5 0 5
249 5 my $content_type = $response->header('Content-Type');
250 5 my $params = {};
251 5 ▶ if( $content_type =~ m/json/ || $content_type =~ m/javascript/ ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($content_type =~ /json/ or $content_type =~ /javascript/) { } 2 3 5
Condition66%2/3
$content_type =~ /json/ or $content_type =~ /javascript/
l!l&&r!l&&!r
203
MC/DC50%1/2
$content_type =~ /json/ or $content_type =~ /javascript/
$content_type =~ /json/ $content_type =~ /javascript/
Truth table66%2/3
A or B
A= $content_type =~ /json/B= $content_type =~ /javascript/
ABresult
1X1
011
000
252 2 $params = decode_json( $response->content );
253 } else {
254 3 $params = URI::Query->new( $response->content )->hash;
255 }
256  
257 # Error checking on the response from the server. If this is a refresh that failed we need to catch and return that fact
258 5 my $keys_found = 0;
259 5 for my $key (qw/access_token email user_id expires expires_in id_token token_type id issued_at scope instance_url refresh_token signature x_mailru_vid error/) {
260 75 ▶ if ($params->{$key}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($params->{$key}) 18 57 75
261 18 $keys_found++;
262 }
263 }
264 5 ▶ if (!$keys_found) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($keys_found) 0 5 5
265 0 $self->{dsl}->app->log(debug => "Auth::OAuth::Provider::".$self->_provider.": Token request for grant_type ".$args{grant_type}." didn't return any known ID data. Assuming failed, and returning failed response.");
266 0 return undef;
267 }
268  
269 # Some servers don't return an issued_at or expires; Dancer app authors might need this to check if a refresh is required
270 5 ▶ if (!defined $params->{"issued_at"}) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $params->{"issued_at"}) 0 5 5
271 0 $params->{"issued_at"} = DateTime->now->epoch;
272 }
273 5 ▶ if ($params->{"expires_in"} && !defined $params->{"expires"}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($params->{"expires_in"} and not defined $params->{"expires"}) 2 3 5
Condition66%2/3
$params->{"expires_in"} and not defined $params->{"expires"}
!ll&&!rl&&r
302
MC/DC50%1/2
$params->{"expires_in"} and not defined $params->{"expires"}
$params->{"expires_in"} not defined $params->{"expires"}
Truth table66%2/3
A and not(B)
A= $params->{"expires_in"}B= not defined $params->{"expires"}
ABresult
0X0
100
111
274 2 $params->{"expires"} = $params->{"issued_at"} + $params->{"expires_in"};
275 }
276  
277 5 for my $key (qw/access_token email user_id expires expires_in id_token token_type id issued_at scope instance_url refresh_token signature x_mailru_vid error/) {
278 75 ▶ if ($params->{$key}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($params->{$key}) 20 55 75
279 20 $session_data->{$provider}{$key} = $params->{$key};
280 }
281 }
282  
283 } else {
284 0 $self->{dsl}->app->log(debug => "Auth::OAuth::Provider::".$self->_provider.": Token request for grant_type ".$args{grant_type}." failed with ".$response->status_line);
285 0 $self->{dsl}->app->log(debug => "Auth::OAuth::Provider::".$self->_provider.": payload returned is ". $response->content);
286 0 return undef;
287 }
288 }
289 6 $session->write('oauth', $session_data);
290  
291 # fetch user info or whatever we want to do at this point
292 6 $self->post_process( $session );
293 }
294  
295 1 1;
« OAuth/Provider/VKontakte.pm ↑ Summary OAuth.pm »