2c36d7d7c7d635cf7ef7222d636bce24e6a67abe
[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      * Remove all linked logins that are using issuers that have been deleted.
44      *
45      * @param int $issuerid The issuer id of the issuer to check, or false to check all (defaults to all)
46      * @return boolean
47      */
48     public static function clean_orphaned_linked_logins($issuerid = false) {
49         return linked_login::delete_orphaned($issuerid);
50     }
52     /**
53      * List linked logins
54      *
55      * Requires auth/oauth2:managelinkedlogins capability at the user context.
56      *
57      * @param int $userid (defaults to $USER->id)
58      * @return boolean
59      */
60     public static function get_linked_logins($userid = false) {
61         global $USER;
63         if ($userid === false) {
64             $userid = $USER->id;
65         }
67         if (\core\session\manager::is_loggedinas()) {
68             throw new moodle_exception('notwhileloggedinas', 'auth_oauth2');
69         }
71         $context = context_user::instance($userid);
72         require_capability('auth/oauth2:managelinkedlogins', $context);
74         return linked_login::get_records(['userid' => $userid, 'confirmtoken' => '']);
75     }
77     /**
78      * See if there is a match for this username and issuer in the linked_login table.
79      *
80      * @param string $username as returned from an oauth client.
81      * @param \core\oauth2\issuer $issuer
82      * @return stdClass User record if found.
83      */
84     public static function match_username_to_user($username, $issuer) {
85         $params = [
86             'issuerid' => $issuer->get('id'),
87             'username' => $username
88         ];
89         $result = linked_login::get_record($params);
91         if ($result) {
92             $user = \core_user::get_user($result->get('userid'));
93             if (!empty($user) && !$user->deleted) {
94                 return $result;
95             }
96         }
97         return false;
98     }
100     /**
101      * Link a login to this account.
102      *
103      * Requires auth/oauth2:managelinkedlogins capability at the user context.
104      *
105      * @param array $userinfo as returned from an oauth client.
106      * @param \core\oauth2\issuer $issuer
107      * @param int $userid (defaults to $USER->id)
108      * @param bool $skippermissions During signup we need to set this before the user is setup for capability checks.
109      * @return bool
110      */
111     public static function link_login($userinfo, $issuer, $userid = false, $skippermissions = false) {
112         global $USER;
114         if ($userid === false) {
115             $userid = $USER->id;
116         }
118         if (\core\session\manager::is_loggedinas()) {
119             throw new moodle_exception('notwhileloggedinas', 'auth_oauth2');
120         }
122         $context = context_user::instance($userid);
123         if (!$skippermissions) {
124             require_capability('auth/oauth2:managelinkedlogins', $context);
125         }
127         $record = new stdClass();
128         $record->issuerid = $issuer->get('id');
129         $record->username = $userinfo['username'];
130         $record->userid = $userid;
131         $existing = linked_login::get_record((array)$record);
132         if ($existing) {
133             $existing->set('confirmtoken', '');
134             $existing->update();
135             return $existing;
136         }
137         $record->email = $userinfo['email'];
138         $record->confirmtoken = '';
139         $record->confirmtokenexpires = 0;
140         $linkedlogin = new linked_login(0, $record);
141         return $linkedlogin->create();
142     }
144     /**
145      * Send an email with a link to confirm linking this account.
146      *
147      * @param array $userinfo as returned from an oauth client.
148      * @param \core\oauth2\issuer $issuer
149      * @param int $userid (defaults to $USER->id)
150      * @return bool
151      */
152     public static function send_confirm_link_login_email($userinfo, $issuer, $userid) {
153         $record = new stdClass();
154         $record->issuerid = $issuer->get('id');
155         $record->username = $userinfo['username'];
156         $record->userid = $userid;
157         $existing = linked_login::get_record((array)$record);
158         if ($existing) {
159             return false;
160         }
161         $record->email = $userinfo['email'];
162         $record->confirmtoken = random_string(32);
163         $expires = new \DateTime('NOW');
164         $expires->add(new \DateInterval('PT30M'));
165         $record->confirmtokenexpires = $expires->getTimestamp();
167         $linkedlogin = new linked_login(0, $record);
168         $linkedlogin->create();
170         // Construct the email.
171         $site = get_site();
172         $supportuser = \core_user::get_support_user();
173         $user = get_complete_user_data('id', $userid);
175         $data = new stdClass();
176         $data->fullname = fullname($user);
177         $data->sitename  = format_string($site->fullname);
178         $data->admin     = generate_email_signoff();
179         $data->issuername = format_string($issuer->get('name'));
180         $data->linkedemail = format_string($linkedlogin->get('email'));
182         $subject = get_string('confirmlinkedloginemailsubject', 'auth_oauth2', format_string($site->fullname));
184         $params = [
185             'token' => $linkedlogin->get('confirmtoken'),
186             'userid' => $userid,
187             'username' => $userinfo['username'],
188             'issuerid' => $issuer->get('id'),
189         ];
190         $confirmationurl = new moodle_url('/auth/oauth2/confirm-linkedlogin.php', $params);
192         // Remove data parameter just in case it was included in the confirmation so we can add it manually later.
193         $data->link = $confirmationurl->out();
195         $message     = get_string('confirmlinkedloginemail', 'auth_oauth2', $data);
196         $messagehtml = text_to_html(get_string('confirmlinkedloginemail', 'auth_oauth2', $data), false, false, true);
198         $user->mailformat = 1;  // Always send HTML version as well.
200         // Directly email rather than using the messaging system to ensure its not routed to a popup or jabber.
201         return email_to_user($user, $supportuser, $subject, $message, $messagehtml);
202     }
204     /**
205      * Look for a waiting confirmation token, and if we find a match - confirm it.
206      *
207      * @param int $userid
208      * @param string $username
209      * @param int $issuerid
210      * @param string $token
211      * @return boolean True if we linked.
212      */
213     public static function confirm_link_login($userid, $username, $issuerid, $token) {
214         if (empty($token) || empty($userid) || empty($issuerid) || empty($username)) {
215             return false;
216         }
217         $params = [
218             'userid' => $userid,
219             'username' => $username,
220             'issuerid' => $issuerid,
221             'confirmtoken' => $token,
222         ];
224         $login = linked_login::get_record($params);
225         if (empty($login)) {
226             return false;
227         }
228         $expires = $login->get('confirmtokenexpires');
229         if (time() > $expires) {
230             $login->delete();
231             return;
232         }
233         $login->set('confirmtokenexpires', 0);
234         $login->set('confirmtoken', '');
235         $login->update();
236         return true;
237     }
239     /**
240      * Send an email with a link to confirm creating this account.
241      *
242      * @param array $userinfo as returned from an oauth client.
243      * @param \core\oauth2\issuer $issuer
244      * @param int $userid (defaults to $USER->id)
245      * @return bool
246      */
247     public static function send_confirm_account_email($userinfo, $issuer) {
248         global $CFG, $DB;
249         require_once($CFG->dirroot.'/user/profile/lib.php');
250         require_once($CFG->dirroot.'/user/lib.php');
252         $user = new stdClass();
253         $user->username = $userinfo['username'];
254         $user->email = $userinfo['email'];
255         $user->auth = 'oauth2';
256         $user->mnethostid = $CFG->mnet_localhost_id;
257         $user->lastname = isset($userinfo['lastname']) ? $userinfo['lastname'] : '';
258         $user->firstname = isset($userinfo['firstname']) ? $userinfo['firstname'] : '';
259         $user->url = isset($userinfo['url']) ? $userinfo['url'] : '';
260         $user->alternatename = isset($userinfo['alternatename']) ? $userinfo['alternatename'] : '';
261         $user->secret = random_string(15);
263         $user->password = '';
264         // This user is not confirmed.
265         $user->confirmed = 0;
267         $user->id = user_create_user($user, false, true);
269         // The linked account is pre-confirmed.
270         $record = new stdClass();
271         $record->issuerid = $issuer->get('id');
272         $record->username = $userinfo['username'];
273         $record->userid = $user->id;
274         $record->email = $userinfo['email'];
275         $record->confirmtoken = '';
276         $record->confirmtokenexpires = 0;
278         $linkedlogin = new linked_login(0, $record);
279         $linkedlogin->create();
281         // Construct the email.
282         $site = get_site();
283         $supportuser = \core_user::get_support_user();
284         $user = get_complete_user_data('id', $user->id);
286         $data = new stdClass();
287         $data->fullname = fullname($user);
288         $data->sitename  = format_string($site->fullname);
289         $data->admin     = generate_email_signoff();
291         $subject = get_string('confirmaccountemailsubject', 'auth_oauth2', format_string($site->fullname));
293         $params = [
294             'token' => $user->secret,
295             'username' => $userinfo['username']
296         ];
297         $confirmationurl = new moodle_url('/auth/oauth2/confirm-account.php', $params);
299         $data->link = $confirmationurl->out();
301         $message     = get_string('confirmaccountemail', 'auth_oauth2', $data);
302         $messagehtml = text_to_html(get_string('confirmaccountemail', 'auth_oauth2', $data), false, false, true);
304         $user->mailformat = 1;  // Always send HTML version as well.
306         // Directly email rather than using the messaging system to ensure its not routed to a popup or jabber.
307         email_to_user($user, $supportuser, $subject, $message, $messagehtml);
308         return $user;
309     }
311     /**
312      * Delete linked login
313      *
314      * Requires auth/oauth2:managelinkedlogins capability at the user context.
315      *
316      * @param int $linkedloginid
317      * @return boolean
318      */
319     public static function delete_linked_login($linkedloginid) {
320         $login = new linked_login($linkedloginid);
321         $userid = $login->get('userid');
323         if (\core\session\manager::is_loggedinas()) {
324             throw new moodle_exception('notwhileloggedinas', 'auth_oauth2');
325         }
327         $context = context_user::instance($userid);
328         require_capability('auth/oauth2:managelinkedlogins', $context);
330         $login->delete();
331     }