MDL-58220 oauth2: missing param confirmtokenexpires
[moodle.git] / auth / oauth2 / classes / api.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Class for loading/storing oauth2 linked logins from the DB.
19  *
20  * @package    auth_oauth2
21  * @copyright  2017 Damyon Wiese
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
24 namespace auth_oauth2;
26 use context_user;
27 use stdClass;
28 use moodle_exception;
29 use moodle_url;
31 defined('MOODLE_INTERNAL') || die();
33 /**
34  * Static list of api methods for auth oauth2 configuration.
35  *
36  * @package    auth_oauth2
37  * @copyright  2017 Damyon Wiese
38  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39  */
40 class api {
42     /**
43      * List linked logins
44      *
45      * Requires auth/oauth2:managelinkedlogins capability at the user context.
46      *
47      * @param int $userid (defaults to $USER->id)
48      * @return boolean
49      */
50     public static function get_linked_logins($userid = false) {
51         global $USER;
53         if ($userid === false) {
54             $userid = $USER->id;
55         }
57         if (\core\session\manager::is_loggedinas()) {
58             throw new moodle_exception('notwhileloggedinas', 'auth_oauth2');
59         }
61         $context = context_user::instance($userid);
62         require_capability('auth/oauth2:managelinkedlogins', $context);
64         return linked_login::get_records(['userid' => $userid, 'confirmtoken' => '']);
65     }
67     /**
68      * See if there is a match for this username and issuer in the linked_login table.
69      *
70      * @param string $username as returned from an oauth client.
71      * @param \core\oauth2\issuer $issuer
72      * @return stdClass User record if found.
73      */
74     public static function match_username_to_user($username, $issuer) {
75         $params = [
76             'issuerid' => $issuer->get('id'),
77             'username' => $username
78         ];
79         $result = linked_login::get_record($params);
81         if ($result) {
82             $user = \core_user::get_user($result->get('userid'));
83             if (!empty($user) && !$user->deleted) {
84                 return $result;
85             }
86         }
87         return false;
88     }
90     /**
91      * Link a login to this account.
92      *
93      * Requires auth/oauth2:managelinkedlogins capability at the user context.
94      *
95      * @param array $userinfo as returned from an oauth client.
96      * @param \core\oauth2\issuer $issuer
97      * @param int $userid (defaults to $USER->id)
98      * @param bool $skippermissions During signup we need to set this before the user is setup for capability checks.
99      * @return bool
100      */
101     public static function link_login($userinfo, $issuer, $userid = false, $skippermissions = false) {
102         global $USER;
104         if ($userid === false) {
105             $userid = $USER->id;
106         }
108         if (\core\session\manager::is_loggedinas()) {
109             throw new moodle_exception('notwhileloggedinas', 'auth_oauth2');
110         }
112         $context = context_user::instance($userid);
113         if (!$skippermissions) {
114             require_capability('auth/oauth2:managelinkedlogins', $context);
115         }
117         $record = new stdClass();
118         $record->issuerid = $issuer->get('id');
119         $record->username = $userinfo['username'];
120         $record->userid = $userid;
121         $existing = linked_login::get_record((array)$record);
122         if ($existing) {
123             $existing->set('confirmtoken', '');
124             $existing->update();
125             return $existing;
126         }
127         $record->email = $userinfo['email'];
128         $record->confirmtoken = '';
129         $record->confirmtokenexpires = 0;
130         $linkedlogin = new linked_login(0, $record);
131         return $linkedlogin->create();
132     }
134     /**
135      * Send an email with a link to confirm linking this account.
136      *
137      * @param array $userinfo as returned from an oauth client.
138      * @param \core\oauth2\issuer $issuer
139      * @param int $userid (defaults to $USER->id)
140      * @return bool
141      */
142     public static function send_confirm_link_login_email($userinfo, $issuer, $userid) {
143         $record = new stdClass();
144         $record->issuerid = $issuer->get('id');
145         $record->username = $userinfo['username'];
146         $record->userid = $userid;
147         $existing = linked_login::get_record((array)$record);
148         if ($existing) {
149             return false;
150         }
151         $record->email = $userinfo['email'];
152         $record->confirmtoken = random_string(32);
153         $expires = new \DateTime('NOW');
154         $expires->add(new \DateInterval('PT30M'));
155         $record->confirmtokenexpires = $expires->getTimestamp();
157         $linkedlogin = new linked_login(0, $record);
158         $linkedlogin->create();
160         // Construct the email.
161         $site = get_site();
162         $supportuser = \core_user::get_support_user();
163         $user = get_complete_user_data('id', $userid);
165         $data = new stdClass();
166         $data->fullname = fullname($user);
167         $data->sitename  = format_string($site->fullname);
168         $data->admin     = generate_email_signoff();
169         $data->issuername = format_string($issuer->get('name'));
170         $data->linkedemail = format_string($linkedlogin->get('email'));
172         $subject = get_string('confirmlinkedloginemailsubject', 'auth_oauth2', format_string($site->fullname));
174         $params = [
175             'token' => $linkedlogin->get('confirmtoken'),
176             'userid' => $userid,
177             'username' => $userinfo['username'],
178             'issuerid' => $issuer->get('id'),
179         ];
180         $confirmationurl = new moodle_url('/auth/oauth2/confirm-linkedlogin.php', $params);
182         // Remove data parameter just in case it was included in the confirmation so we can add it manually later.
183         $data->link = $confirmationurl->out();
185         $message     = get_string('confirmlinkedloginemail', 'auth_oauth2', $data);
186         $messagehtml = text_to_html(get_string('confirmlinkedloginemail', 'auth_oauth2', $data), false, false, true);
188         $user->mailformat = 1;  // Always send HTML version as well.
190         // Directly email rather than using the messaging system to ensure its not routed to a popup or jabber.
191         return email_to_user($user, $supportuser, $subject, $message, $messagehtml);
192     }
194     /**
195      * Look for a waiting confirmation token, and if we find a match - confirm it.
196      *
197      * @param int $userid
198      * @param string $username
199      * @param int $issuerid
200      * @param string $token
201      * @return boolean True if we linked.
202      */
203     public static function confirm_link_login($userid, $username, $issuerid, $token) {
204         if (empty($token) || empty($userid) || empty($issuerid) || empty($username)) {
205             return false;
206         }
207         $params = [
208             'userid' => $userid,
209             'username' => $username,
210             'issuerid' => $issuerid,
211             'confirmtoken' => $token,
212         ];
214         $login = linked_login::get_record($params);
215         if (empty($login)) {
216             return false;
217         }
218         $expires = $login->get('confirmtokenexpires');
219         if (time() > $expires) {
220             $login->delete();
221             return;
222         }
223         $login->set('confirmtokenexpires', 0);
224         $login->set('confirmtoken', '');
225         $login->update();
226         return true;
227     }
229     /**
230      * Send an email with a link to confirm creating this account.
231      *
232      * @param array $userinfo as returned from an oauth client.
233      * @param \core\oauth2\issuer $issuer
234      * @param int $userid (defaults to $USER->id)
235      * @return bool
236      */
237     public static function send_confirm_account_email($userinfo, $issuer) {
238         global $CFG, $DB;
239         require_once($CFG->dirroot.'/user/profile/lib.php');
240         require_once($CFG->dirroot.'/user/lib.php');
242         $user = new stdClass();
243         $user->username = $userinfo['username'];
244         $user->email = $userinfo['email'];
245         $user->auth = 'oauth2';
246         $user->mnethostid = $CFG->mnet_localhost_id;
247         $user->lastname = isset($userinfo['lastname']) ? $userinfo['lastname'] : '';
248         $user->firstname = isset($userinfo['firstname']) ? $userinfo['firstname'] : '';
249         $user->url = isset($userinfo['url']) ? $userinfo['url'] : '';
250         $user->alternatename = isset($userinfo['alternatename']) ? $userinfo['alternatename'] : '';
251         $user->secret = random_string(15);
253         $user->password = '';
254         // This user is not confirmed.
255         $user->confirmed = 0;
257         $user->id = user_create_user($user, false, true);
259         // The linked account is pre-confirmed.
260         $record = new stdClass();
261         $record->issuerid = $issuer->get('id');
262         $record->username = $userinfo['username'];
263         $record->userid = $user->id;
264         $record->email = $userinfo['email'];
265         $record->confirmtoken = '';
266         $record->confirmtokenexpires = 0;
268         $linkedlogin = new linked_login(0, $record);
269         $linkedlogin->create();
271         // Construct the email.
272         $site = get_site();
273         $supportuser = \core_user::get_support_user();
274         $user = get_complete_user_data('id', $user->id);
276         $data = new stdClass();
277         $data->fullname = fullname($user);
278         $data->sitename  = format_string($site->fullname);
279         $data->admin     = generate_email_signoff();
281         $subject = get_string('confirmaccountemailsubject', 'auth_oauth2', format_string($site->fullname));
283         $params = [
284             'token' => $user->secret,
285             'username' => $userinfo['username']
286         ];
287         $confirmationurl = new moodle_url('/auth/oauth2/confirm-account.php', $params);
289         $data->link = $confirmationurl->out();
291         $message     = get_string('confirmaccountemail', 'auth_oauth2', $data);
292         $messagehtml = text_to_html(get_string('confirmaccountemail', 'auth_oauth2', $data), false, false, true);
294         $user->mailformat = 1;  // Always send HTML version as well.
296         // Directly email rather than using the messaging system to ensure its not routed to a popup or jabber.
297         email_to_user($user, $supportuser, $subject, $message, $messagehtml);
298         return $user;
299     }
301     /**
302      * Delete linked login
303      *
304      * Requires auth/oauth2:managelinkedlogins capability at the user context.
305      *
306      * @param int $linkedloginid
307      * @return boolean
308      */
309     public static function delete_linked_login($linkedloginid) {
310         $login = new linked_login($linkedloginid);
311         $userid = $login->get('userid');
313         if (\core\session\manager::is_loggedinas()) {
314             throw new moodle_exception('notwhileloggedinas', 'auth_oauth2');
315         }
317         $context = context_user::instance($userid);
318         require_capability('auth/oauth2:managelinkedlogins', $context);
320         $login->delete();
321     }