From 9bc236d48d2a3d8ab6fd17c16b136b70e538f4ca Mon Sep 17 00:00:00 2001 From: Alex Morris Date: Wed, 1 Mar 2023 11:24:57 +1300 Subject: [PATCH] MDL-76722 user: Add new update_user_device_public_key webservice --- lib/db/services.php | 6 + user/classes/devicekey.php | 52 ++++++++ .../update_user_device_public_key.php | 101 ++++++++++++++ user/lib.php | 25 ++++ user/tests/devicekey_test.php | 70 ++++++++++ .../update_user_device_public_key_test.php | 125 ++++++++++++++++++ user/upgrade.txt | 2 + 7 files changed, 381 insertions(+) create mode 100644 user/classes/devicekey.php create mode 100644 user/classes/external/update_user_device_public_key.php create mode 100644 user/tests/devicekey_test.php create mode 100644 user/tests/external/update_user_device_public_key_test.php diff --git a/lib/db/services.php b/lib/db/services.php index be5f79db0e4..ca5d6d04f58 100644 --- a/lib/db/services.php +++ b/lib/db/services.php @@ -1746,6 +1746,12 @@ $functions = array( 'type' => 'write', 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE), ), + 'core_user_update_user_device_public_key' => array( + 'classname' => '\core_user\external\update_user_device_public_key', + 'description' => 'Store mobile user public key.', + 'type' => 'write', + 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE), + ), 'core_user_add_user_private_files' => array( 'classname' => 'core_user_external', 'methodname' => 'add_user_private_files', diff --git a/user/classes/devicekey.php b/user/classes/devicekey.php new file mode 100644 index 00000000000..80a3f6890df --- /dev/null +++ b/user/classes/devicekey.php @@ -0,0 +1,52 @@ +. + +namespace core_user; + +/** + * Update public key against registered user device. + * + * @package core + * @copyright Alex Morris + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @since Moodle 4.2 + */ +class devicekey { + /** + * Update the users public key for the specified device and app. + * + * @param string $uuid The device UUID. + * @param string $appid The app id, usually something like com.moodle.moodlemobile. + * @param string $publickey The app generated public key. + * @return bool + * @since Moodle 4.2 + */ + public static function update_device_public_key(string $uuid, string $appid, string $publickey): bool { + global $DB, $USER; + + $params = [ + 'uuid' => $uuid, + 'appid' => $appid, + 'userid' => $USER->id, + ]; + + if ($DB->record_exists('user_devices', $params)) { + $DB->set_field('user_devices', 'publickey', $publickey, $params); + return true; + } + return false; + } +} diff --git a/user/classes/external/update_user_device_public_key.php b/user/classes/external/update_user_device_public_key.php new file mode 100644 index 00000000000..77b83e1eb50 --- /dev/null +++ b/user/classes/external/update_user_device_public_key.php @@ -0,0 +1,101 @@ +. + +namespace core_user\external; + +use context_system; +use core_external\external_api; +use core_external\external_function_parameters; +use core_external\external_single_structure; +use core_external\external_value; +use core_external\external_warnings; +use core_user\devicekey; + +/** + * Update public key against registered user device. + * + * @package core + * @copyright Alex Morris + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @since Moodle 4.2 + */ +class update_user_device_public_key extends external_api { + + /** + * Returns description of method parameters. + * + * @return external_function_parameters + */ + public static function execute_parameters(): external_function_parameters { + return new external_function_parameters([ + 'uuid' => new external_value(PARAM_RAW, 'the device UUID'), + 'appid' => new external_value(PARAM_NOTAGS, 'The app id, something like com.moodle.moodlemobile'), + 'publickey' => new external_value(PARAM_RAW, 'the app generated public key'), + ]); + } + + /** + * Update public key against registered user device. + * + * @param string $uuid The device UUID. + * @param string $appid The app id, usually something like com.moodle.moodlemobile. + * @param string $publickey The app generated public key. + * @return array Status and list of possible warnings + */ + public static function execute($uuid, $appid, $publickey): array { + [ + 'uuid' => $uuid, + 'appid' => $appid, + 'publickey' => $publickey + ] = self::validate_parameters(self::execute_parameters(), [ + 'uuid' => $uuid, + 'appid' => $appid, + 'publickey' => $publickey + ]); + + $context = context_system::instance(); + self::validate_context($context); + + $warnings = []; + + $status = devicekey::update_device_public_key($uuid, $appid, $publickey); + if (!$status) { + $warnings[] = [ + 'item' => $uuid, + 'warningcode' => 'devicedoesnotexist', + 'message' => 'Could not find a device with the specified device UUID and app ID for this user' + ]; + } + + return [ + 'status' => $status, + 'warnings' => $warnings, + ]; + } + + /** + * Returns description of method result value. + * + * @return external_single_structure + * @since Moodle 4.2 + */ + public static function execute_returns(): external_single_structure { + return new external_single_structure([ + 'status' => new external_value(PARAM_BOOL, 'Whether the request was successful'), + 'warnings' => new external_warnings() + ]); + } +} diff --git a/user/lib.php b/user/lib.php index 2ab18a227cd..9a5611a9fdb 100644 --- a/user/lib.php +++ b/user/lib.php @@ -1363,3 +1363,28 @@ function user_edit_map_field_purpose($userid, $fieldname) { return $purpose; } + +/** + * Update the users public key for the specified device and app. + * + * @param string $uuid The device UUID. + * @param string $appid The app id, usually something like com.moodle.moodlemobile. + * @param string $publickey The app generated public key. + * @return bool + * @since Moodle 4.2 + */ +function user_update_device_public_key(string $uuid, string $appid, string $publickey): bool { + global $USER, $DB; + + if (!$DB->get_record('user_devices', + ['uuid' => $uuid, 'appid' => $appid, 'userid' => $USER->id] + )) { + return false; + } + + $DB->set_field('user_devices', 'publickey', $publickey, + ['uuid' => $uuid, 'appid' => $appid, 'userid' => $USER->id] + ); + + return true; +} diff --git a/user/tests/devicekey_test.php b/user/tests/devicekey_test.php new file mode 100644 index 00000000000..337a01280f8 --- /dev/null +++ b/user/tests/devicekey_test.php @@ -0,0 +1,70 @@ +. + +namespace core_user; + +use stdClass; + +/** + * Tests for the devicekey class. + * + * @package core_user + * @covers \core_user\devicekey + */ +class devicekey_test extends \advanced_testcase { + /** + * Helper to create a device record. + * + * @return stdClass + */ + protected function create_device_record(): stdClass { + global $USER, $DB; + + $device = (object) [ + 'appid' => 'com.moodle.moodlemobile', + 'name' => 'occam', + 'model' => 'Nexus 4', + 'platform' => 'Android', + 'version' => '4.2.2', + 'pushid' => 'apushdkasdfj4835', + 'uuid' => 'ABCDE3723ksdfhasfaasef859', + 'userid' => $USER->id, + 'timecreated' => time(), + 'timemodified' => time(), + ]; + $device->id = $DB->insert_record('user_devices', $device); + + return $device; + } + + public function test_update_device_public_key_no_device(): void { + global $DB; + + $this->resetAfterTest(); + $this->setAdminUser(); + + $device = $this->create_device_record(); + + $devicekeypair = sodium_crypto_box_keypair(); + $publickey = sodium_bin2base64( + sodium_crypto_box_publickey($devicekeypair), + SODIUM_BASE64_VARIANT_ORIGINAL + ); + + $this->assertTrue(devicekey::update_device_public_key($device->uuid, $device->appid, $publickey)); + $this->assertEquals($publickey, $DB->get_field('user_devices', 'publickey', ['id' => $device->id])); + } +} diff --git a/user/tests/external/update_user_device_public_key_test.php b/user/tests/external/update_user_device_public_key_test.php new file mode 100644 index 00000000000..b4badbcb0e3 --- /dev/null +++ b/user/tests/external/update_user_device_public_key_test.php @@ -0,0 +1,125 @@ +. + +namespace core_user\external; + +use core_external\external_api; +use stdClass; + +/** + * Tests for the devicekey class. + * + * @package core_user + * @covers \core_user\external\update_user_device_public_key + */ +class update_user_device_public_key_test extends \advanced_testcase { + /** + * Helper to create a device record. + * + * @return stdClass + */ + protected function create_device_record(): stdClass { + global $USER, $DB; + + $device = (object) [ + 'appid' => 'com.moodle.moodlemobile', + 'name' => 'occam', + 'model' => 'Nexus 4', + 'platform' => 'Android', + 'version' => '4.2.2', + 'pushid' => 'apushdkasdfj4835', + 'uuid' => 'ABCDE3723ksdfhasfaasef859', + 'userid' => $USER->id, + 'timecreated' => time(), + 'timemodified' => time(), + ]; + $device->id = $DB->insert_record('user_devices', $device); + + return $device; + } + + public function test_execute(): void { + $this->resetAfterTest(); + $this->setAdminUser(); + + $device = $this->create_device_record(); + + $devicekeypair = sodium_crypto_box_keypair(); + $publickey = sodium_bin2base64( + sodium_crypto_box_publickey($devicekeypair), + SODIUM_BASE64_VARIANT_ORIGINAL + ); + + // Test sending a key to a valid device. + $result = update_user_device_public_key::execute( + $device->uuid, + $device->appid, + $publickey, + ); + + $result = external_api::clean_returnvalue(update_user_device_public_key::execute_returns(), $result); + $this->assertTrue($result['status']); + $this->assertEmpty($result['warnings']); + } + + public function test_execute_with_invalid_device_appid(): void { + $this->resetAfterTest(); + $this->setAdminUser(); + + $device = $this->create_device_record(); + + $devicekeypair = sodium_crypto_box_keypair(); + $publickey = sodium_bin2base64( + sodium_crypto_box_publickey($devicekeypair), + SODIUM_BASE64_VARIANT_ORIGINAL + ); + + // Invalid appid. + $result = update_user_device_public_key::execute( + $device->uuid, + 'invalidappid', + $publickey, + ); + + $result = external_api::clean_returnvalue(update_user_device_public_key::execute_returns(), $result); + $this->assertFalse($result['status']); + $this->assertNotEmpty($result['warnings']); + } + + public function test_execute_with_invalid_device_uuid(): void { + $this->resetAfterTest(); + $this->setAdminUser(); + + $device = $this->create_device_record(); + + $devicekeypair = sodium_crypto_box_keypair(); + $publickey = sodium_bin2base64( + sodium_crypto_box_publickey($devicekeypair), + SODIUM_BASE64_VARIANT_ORIGINAL + ); + + // Invalid appid. + $result = update_user_device_public_key::execute( + 'invaliduuid', + $device->appid, + $publickey, + ); + + $result = external_api::clean_returnvalue(update_user_device_public_key::execute_returns(), $result); + $this->assertFalse($result['status']); + $this->assertNotEmpty($result['warnings']); + } +} diff --git a/user/upgrade.txt b/user/upgrade.txt index b113d41bdfa..333c0bd5218 100644 --- a/user/upgrade.txt +++ b/user/upgrade.txt @@ -19,6 +19,8 @@ This files describes API changes for code that uses the user API. * Return in the field `value` the value of the custom field (as stored in the database) * Return in the field `displayvalue` the value of the custom field for display External systems displaying user information should always use `displayvalue`. +* New method `user_update_device_public_key()`` and accompanying external function core_user_external::update_device_public_key to + update a user's app generated public key by device uuid and app id. === 4.1 ===