mirrored from git://git.moodle.org/moodle.git
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-61882 auth_oauth2: Implement Privacy API
- Loading branch information
Showing
3 changed files
with
347 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| <?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/>. | ||
| /** | ||
| * Privacy class for requesting user data for auth_oauth2. | ||
| * | ||
| * @package auth_oauth2 | ||
| * @copyright 2018 Carlos Escobedo <carlos@moodle.com> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| namespace auth_oauth2\privacy; | ||
|
|
||
| defined('MOODLE_INTERNAL') || die(); | ||
|
|
||
| use \core_privacy\local\metadata\collection; | ||
| use \core_privacy\local\request\contextlist; | ||
| use \core_privacy\local\request\approved_contextlist; | ||
| use \core_privacy\local\request\transform; | ||
| use \core_privacy\local\request\writer; | ||
|
|
||
| /** | ||
| * Privacy provider for auth_oauth2 | ||
| * | ||
| * @package auth_oauth2 | ||
| * @copyright 2018 Carlos Escobedo <carlos@moodle.com> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class provider implements | ||
| \core_privacy\local\metadata\provider, | ||
| \core_privacy\local\request\plugin\provider { | ||
|
|
||
| /** | ||
| * Get information about the user data stored by this plugin. | ||
| * | ||
| * @param collection $collection An object for storing metadata. | ||
| * @return collection The metadata. | ||
| */ | ||
| public static function get_metadata(collection $collection) { | ||
| $authfields = [ | ||
| 'timecreated' => 'privacy:metadata:auth_oauth2:timecreated', | ||
| 'timemodified' => 'privacy:metadata:auth_oauth2:timemodified', | ||
| 'usermodified' => 'privacy:metadata:auth_oauth2:usermodified', | ||
| 'userid' => 'privacy:metadata:auth_oauth2:userid', | ||
| 'issuerid' => 'privacy:metadata:auth_oauth2:issuerid', | ||
| 'username' => 'privacy:metadata:auth_oauth2:username', | ||
| 'email' => 'privacy:metadata:auth_oauth2:email', | ||
| 'confirmtoken' => 'privacy:metadata:auth_oauth2:confirmtoken', | ||
| 'confirmtokenexpires' => 'privacy:metadata:auth_oauth2:confirmtokenexpires' | ||
| ]; | ||
|
|
||
| $collection->add_database_table('auth_oauth2_linked_login', $authfields, 'privacy:metadata:auth_oauth2:tableexplanation'); | ||
| $collection->link_subsystem('core_auth', 'privacy:metadata:auth_oauth2:authsubsystem'); | ||
|
|
||
| return $collection; | ||
| } | ||
|
|
||
| /** | ||
| * Return all contexts for this userid. In this situation the user context. | ||
| * | ||
| * @param int $userid The user ID. | ||
| * @return contextlist The list of context IDs. | ||
| */ | ||
| public static function get_contexts_for_userid($userid) { | ||
| $sql = "SELECT ctx.id | ||
| FROM {auth_oauth2_linked_login} ao | ||
| JOIN {user} u ON ao.userid = u.id | ||
| JOIN {context} ctx ON ctx.instanceid = u.id AND ctx.contextlevel = :contextlevel | ||
| WHERE ao.userid = :userid"; | ||
| $params = ['userid' => $userid, 'contextlevel' => CONTEXT_USER]; | ||
| $contextlist = new contextlist(); | ||
| $contextlist->add_from_sql($sql, $params); | ||
|
|
||
| return $contextlist; | ||
| } | ||
|
|
||
| /** | ||
| * Export all oauth2 information for the list of contexts and this user. | ||
| * | ||
| * @param approved_contextlist $contextlist The list of approved contexts for a user. | ||
| */ | ||
| public static function export_user_data(approved_contextlist $contextlist) { | ||
| global $DB; | ||
|
|
||
| // Export oauth2 linked accounts. | ||
| $context = \context_user::instance($contextlist->get_user()->id); | ||
| $sql = "SELECT ll.id, ll.username, ll.email, ll.timecreated, ll.timemodified, oi.name as issuername | ||
| FROM {auth_oauth2_linked_login} ll JOIN {oauth2_issuer} oi ON oi.id = ll.issuerid | ||
| WHERE ll.userid = :userid"; | ||
| if ($oauth2accounts = $DB->get_records_sql($sql, ['userid' => $contextlist->get_user()->id])) { | ||
| foreach ($oauth2accounts as $oauth2account) { | ||
| $data = (object)[ | ||
| 'timecreated' => transform::datetime($oauth2account->timecreated), | ||
| 'timemodified' => transform::datetime($oauth2account->timemodified), | ||
| 'issuerid' => $oauth2account->issuername, | ||
| 'username' => $oauth2account->username, | ||
| 'email' => $oauth2account->email | ||
| ]; | ||
| writer::with_context($context)->export_data([ | ||
| get_string('privacy:metadata:auth_oauth2', 'auth_oauth2'), | ||
| $oauth2account->issuername | ||
| ], $data); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Delete all user data for this context. | ||
| * | ||
| * @param \context $context The context to delete data for. | ||
| */ | ||
| public static function delete_data_for_all_users_in_context(\context $context) { | ||
| if (empty($context)) { | ||
| return; | ||
| } | ||
|
|
||
| if ($context->contextlevel != CONTEXT_USER) { | ||
| return; | ||
| } | ||
| static::delete_user_data($context->instanceid); | ||
| } | ||
|
|
||
| /** | ||
| * Delete all user data for this user only. | ||
| * | ||
| * @param approved_contextlist $contextlist The list of approved contexts for a user. | ||
| */ | ||
| public static function delete_data_for_user(approved_contextlist $contextlist) { | ||
| if (empty($contextlist->count())) { | ||
| return; | ||
| } | ||
| foreach ($contextlist->get_contexts() as $context) { | ||
| if ($context->contextlevel != CONTEXT_USER) { | ||
| return; | ||
| } | ||
| // Because we only use user contexts the instance ID is the user ID. | ||
| static::delete_user_data($context->instanceid); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * This does the deletion of user data for the auth_oauth2. | ||
| * | ||
| * @param int $userid The user ID | ||
| */ | ||
| protected static function delete_user_data($userid) { | ||
| global $DB; | ||
|
|
||
| // Because we only use user contexts the instance ID is the user ID. | ||
| $DB->delete_records('auth_oauth2_linked_login', ['userid' => $userid]); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,172 @@ | ||
| <?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/>. | ||
| /** | ||
| * Privacy test for the authentication oauth2 | ||
| * | ||
| * @package auth_oauth2 | ||
| * @category test | ||
| * @copyright 2018 Carlos Escobedo <carlos@moodle.com> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
|
|
||
| defined('MOODLE_INTERNAL') || die(); | ||
|
|
||
| use \auth_oauth2\privacy\provider; | ||
| use \core_privacy\local\request\approved_contextlist; | ||
| use \core_privacy\local\request\writer; | ||
| use \core_privacy\tests\provider_testcase; | ||
|
|
||
| /** | ||
| * Privacy test for the authentication oauth2 | ||
| * | ||
| * @package auth_oauth2 | ||
| * @category test | ||
| * @copyright 2018 Carlos Escobedo <carlos@moodle.com> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class auth_oauth2_privacy_testcase extends provider_testcase { | ||
| /** | ||
| * Set up method. | ||
| */ | ||
| public function setUp() { | ||
| $this->resetAfterTest(); | ||
| $this->setAdminUser(); | ||
| } | ||
|
|
||
| /** | ||
| * Check that a user context is returned if there is any user data for this user. | ||
| */ | ||
| public function test_get_contexts_for_userid() { | ||
| $user = $this->getDataGenerator()->create_user(); | ||
| $this->assertEmpty(provider::get_contexts_for_userid($user->id)); | ||
|
|
||
| $issuer = \core\oauth2\api::create_standard_issuer('google'); | ||
| $info = []; | ||
| $info['username'] = 'gina'; | ||
| $info['email'] = 'gina@example.com'; | ||
| \auth_oauth2\api::link_login($info, $issuer, $user->id, false); | ||
|
|
||
| $contextlist = provider::get_contexts_for_userid($user->id); | ||
| // Check that we only get back one context. | ||
| $this->assertCount(1, $contextlist); | ||
|
|
||
| // Check that a context is returned is the expected. | ||
| $usercontext = \context_user::instance($user->id); | ||
| $this->assertEquals($usercontext->id, $contextlist->get_contextids()[0]); | ||
| } | ||
|
|
||
| /** | ||
| * Test that user data is exported correctly. | ||
| */ | ||
| public function test_export_user_data() { | ||
| $user = $this->getDataGenerator()->create_user(); | ||
| $issuer = \core\oauth2\api::create_standard_issuer('google'); | ||
| $info = []; | ||
| $info['username'] = 'gina'; | ||
| $info['email'] = 'gina@example.com'; | ||
| \auth_oauth2\api::link_login($info, $issuer, $user->id, false); | ||
| $usercontext = \context_user::instance($user->id); | ||
|
|
||
| $writer = writer::with_context($usercontext); | ||
| $this->assertFalse($writer->has_any_data()); | ||
| $approvedlist = new approved_contextlist($user, 'auth_oauth2', [$usercontext->id]); | ||
| provider::export_user_data($approvedlist); | ||
| $data = $writer->get_data([get_string('privacy:metadata:auth_oauth2', 'auth_oauth2'), $issuer->get('name')]); | ||
| $this->assertEquals($info['username'], $data->username); | ||
| $this->assertEquals($info['email'], $data->email); | ||
| } | ||
|
|
||
| /** | ||
| * Test deleting all user data for a specific context. | ||
| */ | ||
| public function test_delete_data_for_all_users_in_context() { | ||
| global $DB; | ||
|
|
||
| $user1 = $this->getDataGenerator()->create_user(); | ||
| $issuer1 = \core\oauth2\api::create_standard_issuer('google'); | ||
| $info = []; | ||
| $info['username'] = 'gina'; | ||
| $info['email'] = 'gina@example.com'; | ||
| \auth_oauth2\api::link_login($info, $issuer1, $user1->id, false); | ||
| $user1context = \context_user::instance($user1->id); | ||
|
|
||
| $user2 = $this->getDataGenerator()->create_user(); | ||
| $issuer2 = \core\oauth2\api::create_standard_issuer('microsoft'); | ||
| $info = []; | ||
| $info['username'] = 'jerry'; | ||
| $info['email'] = 'jerry@example.com'; | ||
| \auth_oauth2\api::link_login($info, $issuer2, $user2->id, false); | ||
| $user2context = \context_user::instance($user2->id); | ||
|
|
||
| // Get all oauth2 accounts. | ||
| $oauth2accounts = $DB->get_records('auth_oauth2_linked_login', array()); | ||
| // There should be two. | ||
| $this->assertCount(2, $oauth2accounts); | ||
|
|
||
| // Delete everything for the first user context. | ||
| provider::delete_data_for_all_users_in_context($user1context); | ||
|
|
||
| // Get all oauth2 accounts match with user1. | ||
| $oauth2accounts = $DB->get_records('auth_oauth2_linked_login', ['userid' => $user1->id]); | ||
| $this->assertCount(0, $oauth2accounts); | ||
|
|
||
| // Get all oauth2 accounts. | ||
| $oauth2accounts = $DB->get_records('auth_oauth2_linked_login', array()); | ||
| // There should be one. | ||
| $this->assertCount(1, $oauth2accounts); | ||
| } | ||
|
|
||
| /** | ||
| * This should work identical to the above test. | ||
| */ | ||
| public function test_delete_data_for_user() { | ||
| global $DB; | ||
|
|
||
| $user1 = $this->getDataGenerator()->create_user(); | ||
| $issuer1 = \core\oauth2\api::create_standard_issuer('google'); | ||
| $info = []; | ||
| $info['username'] = 'gina'; | ||
| $info['email'] = 'gina@example.com'; | ||
| \auth_oauth2\api::link_login($info, $issuer1, $user1->id, false); | ||
| $user1context = \context_user::instance($user1->id); | ||
|
|
||
| $user2 = $this->getDataGenerator()->create_user(); | ||
| $issuer2 = \core\oauth2\api::create_standard_issuer('microsoft'); | ||
| $info = []; | ||
| $info['username'] = 'jerry'; | ||
| $info['email'] = 'jerry@example.com'; | ||
| \auth_oauth2\api::link_login($info, $issuer2, $user2->id, false); | ||
| $user2context = \context_user::instance($user2->id); | ||
|
|
||
| // Get all oauth2 accounts. | ||
| $oauth2accounts = $DB->get_records('auth_oauth2_linked_login', array()); | ||
| // There should be two. | ||
| $this->assertCount(2, $oauth2accounts); | ||
|
|
||
| // Delete everything for the first user. | ||
| $approvedlist = new approved_contextlist($user1, 'auth_oauth2', [$user1context->id]); | ||
| provider::delete_data_for_user($approvedlist); | ||
|
|
||
| // Get all oauth2 accounts match with user1. | ||
| $oauth2accounts = $DB->get_records('auth_oauth2_linked_login', ['userid' => $user1->id]); | ||
| $this->assertCount(0, $oauth2accounts); | ||
|
|
||
| // Get all oauth2 accounts. | ||
| $oauth2accounts = $DB->get_records('auth_oauth2_linked_login', array()); | ||
| // There should be one user. | ||
| $this->assertCount(1, $oauth2accounts); | ||
| } | ||
| } |