-
Notifications
You must be signed in to change notification settings - Fork 114
/
EOAuth2Service.php
218 lines (191 loc) · 5.56 KB
/
EOAuth2Service.php
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
<?php
/**
* EOAuth2Service class file.
*
* @author Maxim Zemskov <[email protected]>
* @link http://github.com/Nodge/yii-eauth/
* @license http://www.opensource.org/licenses/bsd-license.php
*/
require_once 'EAuthServiceBase.php';
/**
* EOAuth2Service is a base class for all OAuth 2.0 providers.
*
* @package application.extensions.eauth
*/
abstract class EOAuth2Service extends EAuthServiceBase implements IAuthService {
/**
* @var string OAuth2 client id.
*/
protected $client_id;
/**
* @var string OAuth2 client secret key.
*/
protected $client_secret;
/**
* @var string OAuth scopes.
*/
protected $scope = '';
/**
* @var array Provider options. Must contain the keys: authorize, access_token.
*/
protected $providerOptions = array(
'authorize' => '',
'access_token' => '',
);
/**
* @var string current OAuth2 access token.
*/
protected $access_token = '';
/**
* @var string Error key name in _GET options.
*/
protected $errorParam = 'error';
/**
* @var string Error description key name in _GET options.
*/
protected $errorDescriptionParam = 'error_description';
/**
* @var string Error code for access_denied response.
*/
protected $errorAccessDeniedCode = 'access_denied';
public function init($component, $options = array()) {
parent::init($component, $options);
// Try to restore access token from session.
$this->restoreAccessToken();
}
/**
* Authenticate the user.
*
* @return boolean whether user was successfuly authenticated.
* @throws EAuthException
*/
public function authenticate() {
if (isset($_GET[$this->errorParam])) {
$error_code = $_GET[$this->errorParam];
if ($error_code === $this->errorAccessDeniedCode) {
// access_denied error (user canceled)
$this->cancel();
}
else {
$error = $error_code;
if (isset($_GET[$this->errorDescriptionParam])) {
$error = $_GET[$this->errorDescriptionParam].' ('.$error.')';
}
throw new EAuthException($error);
}
return false;
}
// Get the access_token and save them to the session.
if (isset($_GET['code'])) {
$code = $_GET['code'];
$token = $this->getAccessToken($code);
if (isset($token)) {
$this->authenticated = true;
$this->saveAccessToken($token);
}
}
// Redirect to the authorization page
else {
// Use the URL of the current page as the callback URL.
if (isset($_GET['redirect_uri'])) {
$redirect_uri = $_GET['redirect_uri'];
}
else {
$server = Yii::app()->request->getHostInfo();
$path = Yii::app()->request->getUrl();
$redirect_uri = $server . $path;
}
$url = $this->getCodeUrl($redirect_uri);
Yii::app()->request->redirect($url);
}
return $this->getIsAuthenticated();
}
/**
* Returns the url to request to get OAuth2 code.
*
* @param string $redirect_uri url to redirect after user confirmation.
* @return string url to request.
*/
protected function getCodeUrl($redirect_uri) {
$this->setState('redirect_uri', $redirect_uri);
return $this->providerOptions['authorize'] . '?client_id=' . $this->client_id . '&redirect_uri=' . urlencode($redirect_uri) . '&scope=' . $this->scope . '&response_type=code';
}
/**
* Returns the url to request to get OAuth2 access token.
*
* @param string $code
* @return string url to request.
*/
protected function getTokenUrl($code) {
return $this->providerOptions['access_token'] . '?client_id=' . $this->client_id . '&client_secret=' . $this->client_secret . '&code=' . $code . '&redirect_uri=' . urlencode($this->getState('redirect_uri'));
}
/**
* Returns the OAuth2 access token.
*
* @param string $code the OAuth2 code. See {@link getCodeUrl}.
* @return string the token.
*/
protected function getAccessToken($code) {
return $this->makeRequest($this->getTokenUrl($code));
}
/**
* Save access token to the session.
*
* @param string $token access token.
*/
protected function saveAccessToken($token) {
$this->setState('auth_token', $token);
$this->access_token = $token;
}
/**
* Restore access token from the session.
*
* @return boolean whether the access token was successfuly restored.
*/
protected function restoreAccessToken() {
if (!$this->authenticated) {
if ($this->hasState('auth_token') && $this->getState('expires', 0) > time()) {
$this->access_token = $this->getState('auth_token');
$this->authenticated = true;
}
else {
$this->access_token = null;
$this->authenticated = false;
}
}
return $this->authenticated;
}
/**
* Returns fields required for signed request.
* By default returns array('access_token' => $this->access_token).
* Used in {@link makeSignedRequest}.
*
* @return array
*/
protected function getSignedRequestFields()
{
return array('access_token' => $this->access_token);
}
/**
* Returns the protected resource.
*
* @param string $url url to request.
* @param array $options HTTP request options. Keys: query, data, referer.
* @param boolean $parseJson Whether to parse response in json format.
* @return stdClass the response.
* @see makeRequest
*/
public function makeSignedRequest($url, $options = array(), $parseJson = true) {
if (!$this->getIsAuthenticated()) {
throw new CHttpException(401, Yii::t('eauth', 'Unable to complete the request because the user was not authenticated.'));
}
// Merge query fields with fields required for signed request.
$options['query'] =
array_merge(
isset($options['query']) ? $options['query'] : array(),
$this->getSignedRequestFields()
);
$result = $this->makeRequest($url, $options, $parseJson);
return $result;
}
}