952d3d3632538eeeab486cefc72b4c54a7ab10a5
[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         $linkedlogin = new linked_login(0, $record);
130         return $linkedlogin->create();
131     }
133     /**
134      * Send an email with a link to confirm linking this account.
135      *
136      * @param array $userinfo as returned from an oauth client.
137      * @param \core\oauth2\issuer $issuer
138      * @param int $userid (defaults to $USER->id)
139      * @return bool
140      */
141     public static function send_confirm_link_login_email($userinfo, $issuer, $userid) {
142         $record = new stdClass();
143         $record->issuerid = $issuer->get('id');
144         $record->username = $userinfo['username'];
145         $record->userid = $userid;
146         $existing = linked_login::get_record((array)$record);
147         if ($existing) {
148             return false;
149         }
150         $record->email = $userinfo['email'];
151         $record->confirmtoken = random_string(32);
152         $expires = new \DateTime('NOW');
153         $expires->add(new \DateInterval('PT30M'));
154         $record->confirmtokenexpires = $expires->getTimestamp();
156         $linkedlogin = new linked_login(0, $record);
157         $linkedlogin->create();
159         // Construct the email.
160         $site = get_site();
161         $supportuser = \core_user::get_support_user();
162         $user = get_complete_user_data('id', $userid);
164         $data = new stdClass();
165         $data->fullname = fullname($user);
166         $data->sitename  = format_string($site->fullname);
167         $data->admin     = generate_email_signoff();
168         $data->issuername = format_string($issuer->get('name'));
169         $data->linkedemail = format_string($linkedlogin->get('email'));
171         $subject = get_string('confirmlinkedloginemailsubject', 'auth_oauth2', format_string($site->fullname));
173         $params = [
174             'token' => $linkedlogin->get('confirmtoken'),
175             'userid' => $userid,
176             'username' => $userinfo['username'],
177             'issuerid' => $issuer->get('id'),
178         ];
179         $confirmationurl = new moodle_url('/auth/oauth2/confirm-linkedlogin.php', $params);
181         // Remove data parameter just in case it was included in the confirmation so we can add it manually later.
182         $data->link = $confirmationurl->out();
184         $message     = get_string('confirmlinkedloginemail', 'auth_oauth2', $data);
185         $messagehtml = text_to_html(get_string('confirmlinkedloginemail', 'auth_oauth2', $data), false, false, true);
187         $user->mailformat = 1;  // Always send HTML version as well.
189         // Directly email rather than using the messaging system to ensure its not routed to a popup or jabber.
190         return email_to_user($user, $supportuser, $subject, $message, $messagehtml);
191     }
193     /**
194      * Look for a waiting confirmation token, and if we find a match - confirm it.
195      *
196      * @param int $userid
197      * @param string $username
198      * @param int $issuerid
199      * @param string $token
200      * @return boolean True if we linked.
201      */
202     public static function confirm_link_login($userid, $username, $issuerid, $token) {
203         if (empty($token) || empty($userid) || empty($issuerid) || empty($username)) {
204             return false;
205         }
206         $params = [
207             'userid' => $userid,
208             'username' => $username,
209             'issuerid' => $issuerid,
210             'confirmtoken' => $token,
211         ];
213         $login = linked_login::get_record($params);
214         if (empty($login)) {
215             return false;
216         }
217         $expires = $login->get('confirmtokenexpires');
218         if (time() > $expires) {
219             $login->delete();
220             return;
221         }
222         $login->set('confirmtokenexpires', 0);
223         $login->set('confirmtoken', '');
224         $login->update();
225         return true;
226     }
228     /**
229      * Send an email with a link to confirm creating this account.
230      *
231      * @param array $userinfo as returned from an oauth client.
232      * @param \core\oauth2\issuer $issuer
233      * @param int $userid (defaults to $USER->id)
234      * @return bool
235      */
236     public static function send_confirm_account_email($userinfo, $issuer) {
237         global $CFG, $DB;
238         require_once($CFG->dirroot.'/user/profile/lib.php');
239         require_once($CFG->dirroot.'/user/lib.php');
241         $user = new stdClass();
242         $user->username = $userinfo['username'];
243         $user->email = $userinfo['email'];
244         $user->auth = 'oauth2';
245         $user->mnethostid = $CFG->mnet_localhost_id;
246         $user->lastname = isset($userinfo['lastname']) ? $userinfo['lastname'] : '';
247         $user->firstname = isset($userinfo['firstname']) ? $userinfo['firstname'] : '';
248         $user->url = isset($userinfo['url']) ? $userinfo['url'] : '';
249         $user->alternatename = isset($userinfo['alternatename']) ? $userinfo['alternatename'] : '';
250         $user->secret = random_string(15);
252         $user->password = '';
253         // This user is not confirmed.
254         $user->confirmed = 0;
256         $user->id = user_create_user($user, false, true);
258         // The linked account is pre-confirmed.
259         $record = new stdClass();
260         $record->issuerid = $issuer->get('id');
261         $record->username = $userinfo['username'];
262         $record->userid = $user->id;
263         $record->email = $userinfo['email'];
264         $record->confirmtoken = '';
265         $record->confirmtokenexpires = 0;
267         $linkedlogin = new linked_login(0, $record);
268         $linkedlogin->create();
270         // Construct the email.
271         $site = get_site();
272         $supportuser = \core_user::get_support_user();
273         $user = get_complete_user_data('id', $user->id);
275         $data = new stdClass();
276         $data->fullname = fullname($user);
277         $data->sitename  = format_string($site->fullname);
278         $data->admin     = generate_email_signoff();
280         $subject = get_string('confirmaccountemailsubject', 'auth_oauth2', format_string($site->fullname));
282         $params = [
283             'token' => $user->secret,
284             'username' => $userinfo['username']
285         ];
286         $confirmationurl = new moodle_url('/auth/oauth2/confirm-account.php', $params);
288         $data->link = $confirmationurl->out();
290         $message     = get_string('confirmaccountemail', 'auth_oauth2', $data);
291         $messagehtml = text_to_html(get_string('confirmaccountemail', 'auth_oauth2', $data), false, false, true);
293         $user->mailformat = 1;  // Always send HTML version as well.
295         // Directly email rather than using the messaging system to ensure its not routed to a popup or jabber.
296         email_to_user($user, $supportuser, $subject, $message, $messagehtml);
297         return $user;
298     }
300     /**
301      * Delete linked login
302      *
303      * Requires auth/oauth2:managelinkedlogins capability at the user context.
304      *
305      * @param int $linkedloginid
306      * @return boolean
307      */
308     public static function delete_linked_login($linkedloginid) {
309         $login = new linked_login($linkedloginid);
310         $userid = $login->get('userid');
312         if (\core\session\manager::is_loggedinas()) {
313             throw new moodle_exception('notwhileloggedinas', 'auth_oauth2');
314         }
316         $context = context_user::instance($userid);
317         require_capability('auth/oauth2:managelinkedlogins', $context);
319         $login->delete();
320     }