|
1
|
|
|
<?php |
|
2
|
|
|
/** |
|
3
|
|
|
* Copyright 2016 François Kooman <[email protected]>. |
|
4
|
|
|
* |
|
5
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License"); |
|
6
|
|
|
* you may not use this file except in compliance with the License. |
|
7
|
|
|
* You may obtain a copy of the License at |
|
8
|
|
|
* |
|
9
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0 |
|
10
|
|
|
* |
|
11
|
|
|
* Unless required by applicable law or agreed to in writing, software |
|
12
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS, |
|
13
|
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
14
|
|
|
* See the License for the specific language governing permissions and |
|
15
|
|
|
* limitations under the License. |
|
16
|
|
|
*/ |
|
17
|
|
|
|
|
18
|
|
|
namespace fkooman\OAuth\Client; |
|
19
|
|
|
|
|
20
|
|
|
use fkooman\OAuth\Client\Exception\OAuthException; |
|
21
|
|
|
|
|
22
|
|
|
class OAuth2Client |
|
23
|
|
|
{ |
|
24
|
|
|
/** @var Provider */ |
|
25
|
|
|
private $provider; |
|
26
|
|
|
|
|
27
|
|
|
/** @var HttpClientInterface */ |
|
28
|
|
|
private $httpClient; |
|
29
|
|
|
|
|
30
|
|
|
/** @var RandomInterface */ |
|
31
|
|
|
private $random; |
|
32
|
|
|
|
|
33
|
|
|
public function __construct(Provider $provider, HttpClientInterface $httpClient, RandomInterface $random = null) |
|
34
|
|
|
{ |
|
35
|
|
|
$this->provider = $provider; |
|
36
|
|
|
$this->httpClient = $httpClient; |
|
37
|
|
|
if (is_null($random)) { |
|
38
|
|
|
$random = new Random(); |
|
39
|
|
|
} |
|
40
|
|
|
$this->random = $random; |
|
41
|
|
|
} |
|
42
|
|
|
|
|
43
|
|
|
/** |
|
44
|
|
|
* Obtain an authorization request URL to start the authorization process |
|
45
|
|
|
* at the OAuth provider. |
|
46
|
|
|
* |
|
47
|
|
|
* @param string $scope the space separated scope tokens |
|
48
|
|
|
* @param string $redirectUri the URL to redirect back to after coming back |
|
49
|
|
|
* from the OAuth provider (callback URL) |
|
50
|
|
|
* |
|
51
|
|
|
* @return string the authorization request URL |
|
52
|
|
|
*/ |
|
53
|
|
|
public function getAuthorizationRequestUri($scope, $redirectUri) |
|
54
|
|
|
{ |
|
55
|
|
|
$state = $this->random->get(); |
|
56
|
|
|
|
|
57
|
|
|
$queryParams = http_build_query( |
|
58
|
|
|
[ |
|
59
|
|
|
'client_id' => $this->provider->getId(), |
|
60
|
|
|
'redirect_uri' => $redirectUri, |
|
61
|
|
|
'scope' => $scope, |
|
62
|
|
|
'state' => $state, |
|
63
|
|
|
'response_type' => 'code', |
|
64
|
|
|
], |
|
65
|
|
|
'&' |
|
66
|
|
|
); |
|
67
|
|
|
|
|
68
|
|
|
return sprintf( |
|
69
|
|
|
'%s%s%s', |
|
70
|
|
|
$this->provider->getAuthorizationEndpoint(), |
|
71
|
|
|
false === strpos($this->provider->getAuthorizationEndpoint(), '?') ? '?' : '&', |
|
72
|
|
|
$queryParams |
|
73
|
|
|
); |
|
74
|
|
|
} |
|
75
|
|
|
|
|
76
|
|
|
/** |
|
77
|
|
|
* Obtain the access token from the OAuth provider after returning from the |
|
78
|
|
|
* OAuth provider on the redirectUri (callback URL). |
|
79
|
|
|
* |
|
80
|
|
|
* @param string $authorizationRequestUri the original authorization |
|
81
|
|
|
* request URL as obtained by getAuthorzationRequestUri |
|
82
|
|
|
* @param string $authorizationResponseCode the code passed to the 'code' |
|
83
|
|
|
* query parameter on the callback URL |
|
84
|
|
|
* @param string $authorizationResponsestate the state passed to the 'state' |
|
|
|
|
|
|
85
|
|
|
* query parameter on the callback URL |
|
86
|
|
|
* |
|
87
|
|
|
* @return AccessToken |
|
88
|
|
|
*/ |
|
89
|
|
|
public function getAccessToken($authorizationRequestUri, $authorizationResponseCode, $authorizationResponseState) |
|
90
|
|
|
{ |
|
91
|
|
|
self::requireNonEmptyStrings(func_get_args()); |
|
92
|
|
|
|
|
93
|
|
|
// parse our authorizationRequestUri to extract the state |
|
94
|
|
|
if (false === strpos($authorizationRequestUri, '?')) { |
|
95
|
|
|
throw new OAuthException('invalid authorizationRequestUri'); |
|
96
|
|
|
} |
|
97
|
|
|
|
|
98
|
|
|
parse_str(explode('?', $authorizationRequestUri)[1], $queryParams); |
|
99
|
|
|
|
|
100
|
|
|
if (!isset($queryParams['state'])) { |
|
101
|
|
|
throw new OAuthException('state missing from authorizationRequestUri'); |
|
102
|
|
|
} |
|
103
|
|
|
|
|
104
|
|
|
if (!isset($queryParams['redirect_uri'])) { |
|
105
|
|
|
throw new OAuthException('redirect_uri missing from authorizationRequestUri'); |
|
106
|
|
|
} |
|
107
|
|
|
|
|
108
|
|
|
if ($authorizationResponseState !== $queryParams['state']) { |
|
109
|
|
|
throw new OAuthException('state from authorizationRequestUri does not equal authorizationResponseState'); |
|
110
|
|
|
} |
|
111
|
|
|
|
|
112
|
|
|
// prepare access_token request |
|
113
|
|
|
$tokenRequestData = [ |
|
114
|
|
|
'client_id' => $this->provider->getId(), |
|
115
|
|
|
'grant_type' => 'authorization_code', |
|
116
|
|
|
'code' => $authorizationResponseCode, |
|
117
|
|
|
'redirect_uri' => $queryParams['redirect_uri'], |
|
118
|
|
|
]; |
|
119
|
|
|
|
|
120
|
|
|
$responseData = self::validateTokenResponse( |
|
121
|
|
|
$this->httpClient->post( |
|
122
|
|
|
$this->provider, |
|
123
|
|
|
$tokenRequestData |
|
124
|
|
|
) |
|
125
|
|
|
); |
|
126
|
|
|
|
|
127
|
|
|
return new AccessToken( |
|
128
|
|
|
$responseData['access_token'], |
|
129
|
|
|
$responseData['token_type'], |
|
130
|
|
|
$responseData['scope'], |
|
131
|
|
|
$responseData['expire_in'] |
|
132
|
|
|
); |
|
133
|
|
|
} |
|
134
|
|
|
|
|
135
|
|
|
private static function validateTokenResponse(array $responseData) |
|
136
|
|
|
{ |
|
137
|
|
|
if (!isset($responseData['access_token'])) { |
|
138
|
|
|
throw new OAuthException('no access_token received from token endpoint'); |
|
139
|
|
|
} |
|
140
|
|
|
|
|
141
|
|
|
if (!isset($responseData['token_type'])) { |
|
142
|
|
|
throw new OAuthException('no token_type received from token endpoint'); |
|
143
|
|
|
} |
|
144
|
|
|
|
|
145
|
|
|
if (!isset($responseData['scope'])) { |
|
146
|
|
|
$responseData['scope'] = null; |
|
147
|
|
|
} |
|
148
|
|
|
|
|
149
|
|
|
if (!isset($responseData['expires_in'])) { |
|
150
|
|
|
$responseData['expire_in'] = null; |
|
151
|
|
|
} |
|
152
|
|
|
|
|
153
|
|
|
return $responseData; |
|
154
|
|
|
} |
|
155
|
|
|
|
|
156
|
|
|
private static function requireNonEmptyStrings(array $strs) |
|
157
|
|
|
{ |
|
158
|
|
|
foreach ($strs as $no => $str) { |
|
159
|
|
|
if (!is_string($str)) { |
|
160
|
|
|
throw new InvalidArgumentException(sprintf('parameter %d must be string', $no)); |
|
161
|
|
|
} |
|
162
|
|
|
if (0 >= strlen($str)) { |
|
163
|
|
|
throw new DomainException(sprintf('parameter %d must be non-empty', $no)); |
|
164
|
|
|
} |
|
165
|
|
|
} |
|
166
|
|
|
} |
|
167
|
|
|
} |
|
168
|
|
|
|
fkooman /
php-oauth2-client
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit.
Consider the following example. The parameter
$irelandis not defined by the methodfinale(...).The most likely cause is that the parameter was changed, but the annotation was not.