mirrored from git://git.moodle.org/moodle.git
/
client.php
283 lines (249 loc) · 8.46 KB
/
client.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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Configurable oauth2 client class.
*
* @package core\oauth2
* @copyright 2017 Damyon Wiese
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace core\oauth2;
defined('MOODLE_INTERNAL') || die();
require_once($CFG->libdir . '/oauthlib.php');
require_once($CFG->libdir . '/filelib.php');
use moodle_url;
use curl;
use stdClass;
/**
* Configurable oauth2 client class where the urls come from DB.
*
* @copyright 2017 Damyon Wiese
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class client extends \oauth2_client {
/** @var \core\oauth2\issuer $issuer */
private $issuer;
/** @var bool $system */
protected $system = false;
/**
* Constructor.
*
* @param issuer $issuer
* @param moodle_url|null $returnurl
* @param string $scopesrequired
* @param boolean $system
*/
public function __construct(issuer $issuer, $returnurl, $scopesrequired, $system = false) {
$this->issuer = $issuer;
$this->system = $system;
$scopes = $this->get_login_scopes();
$additionalscopes = explode(' ', $scopesrequired);
foreach ($additionalscopes as $scope) {
if (!empty($scope)) {
if (strpos(' ' . $scopes . ' ', ' ' . $scope . ' ') === false) {
$scopes .= ' ' . $scope;
}
}
}
if (empty($returnurl)) {
$returnurl = new moodle_url('/');
}
parent::__construct($issuer->get('clientid'), $issuer->get('clientsecret'), $returnurl, $scopes);
}
/**
* Returns the auth url for OAuth 2.0 request
* @return string the auth url
*/
protected function auth_url() {
return $this->issuer->get_endpoint_url('authorization');
}
/**
* Get the oauth2 issuer for this client.
*
* @return \core\oauth2\issuer Issuer
*/
public function get_issuer() {
return $this->issuer;
}
/**
* Override to append additional params to a authentication request.
*
* @return array (name value pairs).
*/
public function get_additional_login_parameters() {
$params = '';
if ($this->system) {
if (!empty($this->issuer->get('loginparamsoffline'))) {
$params = $this->issuer->get('loginparamsoffline');
}
} else {
if (!empty($this->issuer->get('loginparams'))) {
$params = $this->issuer->get('loginparams');
}
}
if (empty($params)) {
return [];
}
$result = [];
parse_str($params, $result);
return $result;
}
/**
* Override to change the scopes requested with an authentiction request.
*
* @return string
*/
protected function get_login_scopes() {
if ($this->system) {
return $this->issuer->get('loginscopesoffline');
} else {
return $this->issuer->get('loginscopes');
}
}
/**
* Returns the token url for OAuth 2.0 request
*
* We are overriding the parent function so we get this from the configured endpoint.
*
* @return string the auth url
*/
protected function token_url() {
return $this->issuer->get_endpoint_url('token');
}
/**
* We want a unique key for each issuer / and a different key for system vs user oauth.
*
* @return string The unique key for the session value.
*/
protected function get_tokenname() {
$name = 'oauth2-state-' . $this->issuer->get('id');
if ($this->system) {
$name .= '-system';
}
return $name;
}
/**
* Get a list of the mapping user fields in an associative array.
*
* @return array
*/
protected function get_userinfo_mapping() {
$fields = user_field_mapping::get_records(['issuerid' => $this->issuer->get('id')]);
$map = [];
foreach ($fields as $field) {
$map[$field->get('externalfield')] = $field->get('internalfield');
}
return $map;
}
/**
* Upgrade a refresh token from oauth 2.0 to an access token
*
* @param \core\oauth2\system_account $systemaccount
* @return boolean true if token is upgraded succesfully
*/
public function upgrade_refresh_token(system_account $systemaccount) {
$refreshtoken = $systemaccount->get('refreshtoken');
$params = array('refresh_token' => $refreshtoken,
'client_id' => $this->issuer->get('clientid'),
'client_secret' => $this->issuer->get('clientsecret'),
'grant_type' => 'refresh_token'
);
// Requests can either use http GET or POST.
if ($this->use_http_get()) {
$response = $this->get($this->token_url(), $params);
} else {
$response = $this->post($this->token_url(), $this->build_post_data($params));
}
if (!$this->info['http_code'] === 200) {
throw new moodle_exception('Could not upgrade oauth token');
}
$r = json_decode($response);
if (!empty($r->error)) {
throw new moodle_exception($r->error . ' ' . $r->error_description);
}
if (!isset($r->access_token)) {
return false;
}
if (isset($r->refresh_token)) {
$systemaccount->set('refreshtoken', $r->refresh_token);
$systemaccount->update();
$this->refreshtoken = $r->refresh_token;
}
// Store the token an expiry time.
$accesstoken = new stdClass;
$accesstoken->token = $r->access_token;
if (isset($r->expires_in)) {
// Expires 10 seconds before actual expiry.
$accesstoken->expires = (time() + ($r->expires_in - 10));
}
if (isset($r->scope)) {
$accesstoken->scope = $r->scope;
} else {
$accesstoken->scope = $this->scope;
}
// Also add the scopes.
$this->store_token($accesstoken);
return true;
}
/**
* Fetch the user info from the user info endpoint and map all
* the fields back into moodle fields.
*
* @return array (Moodle user fields for the logged in user).
*/
public function get_userinfo() {
$url = $this->get_issuer()->get_endpoint_url('userinfo');
$response = $this->get($url);
if (!$response) {
return false;
}
$userinfo = new stdClass();
try {
$userinfo = json_decode($response);
} catch (Exception $e) {
return false;
}
$map = $this->get_userinfo_mapping();
$user = new stdClass();
foreach ($map as $openidproperty => $moodleproperty) {
// We support nested objects via a-b-c syntax.
$getfunc = function($obj, $prop) use (&$getfunc) {
$proplist = explode('-', $prop, 2);
if (empty($proplist[0]) || empty($obj->{$proplist[0]})) {
return false;
}
$obj = $obj->{$proplist[0]};
if (count($proplist) > 1) {
return $getfunc($obj, $proplist[1]);
}
return $obj;
};
$resolved = $getfunc($userinfo, $openidproperty);
if (!empty($resolved)) {
$user->$moodleproperty = $resolved;
}
}
if (!empty($user->picture)) {
$user->picture = download_file_content($user->picture, null, null, false, 10, 10, true, null, false);
} else {
$pictureurl = $this->issuer->get_endpoint_url('userpicture');
if (!empty($pictureurl)) {
$user->picture = $this->get($pictureurl);
}
}
return (array)$user;
}
}