mirror of
https://github.com/moodle/moodle.git
synced 2025-01-17 21:49:15 +01:00
MDL-81924 factor_sms: Remove leftover AWS implementation
Originally implemented as MDL-80962.
This commit is contained in:
Safat
Huong Nguyen
parent
b5ac3257b5
commit
cceed874fd
9
.upgradenotes/MDL-80962-2024071606510000.yml
Normal file
9
.upgradenotes/MDL-80962-2024071606510000.yml
Normal file
@ -0,0 +1,9 @@
|
||||
issueNumber: MDL-80962
|
||||
notes:
|
||||
factor_sms:
|
||||
- message: >
|
||||
The following classes are removed as the SMS feature now takes advantage of core_sms API:
|
||||
- sms_sent (admin/tool/mfa/factor/sms/classes/event/sms_sent.php)
|
||||
- aws_sns (admin/tool/mfa/factor/sms/classes/local/smsgateway/aws_sns.php)
|
||||
- gateway_interface (admin/tool/mfa/factor/sms/classes/local/smsgateway/gateway_interface.php)
|
||||
type: removed
|
||||
@ -1,62 +0,0 @@
|
||||
<?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/>.
|
||||
|
||||
namespace factor_sms\event;
|
||||
|
||||
/**
|
||||
* Event for a sent SMS
|
||||
*
|
||||
* @package factor_sms
|
||||
* @author Alex Morris <alex.morris@catalyst.net.nz>
|
||||
* @copyright Catalyst IT
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class sms_sent extends \core\event\base {
|
||||
|
||||
/**
|
||||
* Init sms sent event
|
||||
*/
|
||||
protected function init() {
|
||||
$this->data['crud'] = 'r';
|
||||
$this->data['edulevel'] = self::LEVEL_OTHER;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns non-localised event description with id's for admin use only.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function get_description(): string {
|
||||
|
||||
$content = [
|
||||
'userid' => $this->other['userid'],
|
||||
'debuginfo' => is_array($this->other['debug']) ? json_encode($this->other['debug']) : $this->other['debug'],
|
||||
];
|
||||
|
||||
return get_string('event:smssentdescription', 'factor_sms', $content);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns localised general event name.
|
||||
*
|
||||
* Override in subclass, we can not make it static and abstract at the same time.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function get_name(): string {
|
||||
return get_string('event:smssent', 'factor_sms');
|
||||
}
|
||||
}
|
||||
@ -19,6 +19,7 @@ namespace factor_sms;
|
||||
use moodle_url;
|
||||
use stdClass;
|
||||
use tool_mfa\local\factor\object_factor_base;
|
||||
use tool_mfa\local\secret_manager;
|
||||
|
||||
/**
|
||||
* SMS Factor implementation.
|
||||
@ -231,7 +232,7 @@ class factor extends object_factor_base {
|
||||
unset($SESSION->tool_mfa_sms_number);
|
||||
}
|
||||
// Clean temp secrets code.
|
||||
$secretmanager = new \tool_mfa\local\secret_manager('sms');
|
||||
$secretmanager = new secret_manager('sms');
|
||||
$secretmanager->cleanup_temp_secrets();
|
||||
}
|
||||
|
||||
@ -424,7 +425,7 @@ class factor extends object_factor_base {
|
||||
* @return bool
|
||||
*/
|
||||
private function check_verification_code(string $enteredcode): bool {
|
||||
return ($this->secretmanager->validate_secret($enteredcode) === \tool_mfa\local\secret_manager::VALID) ? true : false;
|
||||
return $this->secretmanager->validate_secret($enteredcode) === secret_manager::VALID;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -453,8 +454,8 @@ class factor extends object_factor_base {
|
||||
|
||||
if (empty($phonenumber)) {
|
||||
return get_string('errorsmssent', 'factor_sms');
|
||||
} else {
|
||||
return get_string('logindesc', 'factor_' . $this->name, $phonenumber);
|
||||
}
|
||||
|
||||
return get_string('logindesc', 'factor_' . $this->name, $phonenumber);
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,151 +0,0 @@
|
||||
<?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/>.
|
||||
|
||||
namespace factor_sms\local\smsgateway;
|
||||
|
||||
use core\aws\admin_settings_aws_region;
|
||||
use core\aws\aws_helper;
|
||||
use factor_sms\event\sms_sent;
|
||||
|
||||
/**
|
||||
* AWS SNS SMS Gateway class
|
||||
*
|
||||
* @package factor_sms
|
||||
* @author Peter Burnett <peterburnett@catalyst-au.net>
|
||||
* @copyright Catalyst IT
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class aws_sns implements gateway_interface {
|
||||
|
||||
/**
|
||||
* Create an instance of this class.
|
||||
*/
|
||||
public function __construct() {
|
||||
global $CFG;
|
||||
require_once($CFG->libdir . '/aws-sdk/src/functions.php');
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a message using the AWS SNS API
|
||||
*
|
||||
* @param string $messagecontent the content to send in the SMS message.
|
||||
* @param string $phonenumber the destination for the message.
|
||||
* @return bool true on message send success
|
||||
*/
|
||||
public function send_sms_message(string $messagecontent, string $phonenumber): bool {
|
||||
global $SITE, $USER;
|
||||
|
||||
$config = get_config('factor_sms');
|
||||
|
||||
// Setup client params and instantiate client.
|
||||
$params = [
|
||||
'version' => 'latest',
|
||||
'region' => $config->api_region,
|
||||
'http' => ['proxy' => aws_helper::get_proxy_string()],
|
||||
];
|
||||
if (!$config->usecredchain) {
|
||||
$params['credentials'] = [
|
||||
'key' => $config->api_key,
|
||||
'secret' => $config->api_secret,
|
||||
];
|
||||
}
|
||||
$client = new \Aws\Sns\SnsClient($params);
|
||||
|
||||
// Transform the phone number to international standard.
|
||||
$phonenumber = \factor_sms\helper::format_number($phonenumber);
|
||||
|
||||
// Setup the sender information.
|
||||
$senderid = $SITE->shortname;
|
||||
// Remove spaces and non-alphanumeric characters from ID.
|
||||
$senderid = preg_replace("/[^A-Za-z0-9]/", '', trim($senderid));
|
||||
// We have to truncate the senderID to 11 chars.
|
||||
$senderid = substr($senderid, 0, 11);
|
||||
|
||||
if (defined('BEHAT_SITE_RUNNING')) {
|
||||
// Fake SMS sending in behat.
|
||||
return true;
|
||||
}
|
||||
|
||||
try {
|
||||
// These messages need to be transactional.
|
||||
$client->SetSMSAttributes([
|
||||
'attributes' => [
|
||||
'DefaultSMSType' => 'Transactional',
|
||||
'DefaultSenderID' => $senderid,
|
||||
],
|
||||
]);
|
||||
|
||||
// Actually send the message.
|
||||
$result = $client->publish([
|
||||
'Message' => $messagecontent,
|
||||
'PhoneNumber' => $phonenumber,
|
||||
]);
|
||||
|
||||
$data = [
|
||||
'relateduserid' => null,
|
||||
'context' => \context_user::instance($USER->id),
|
||||
'other' => [
|
||||
'userid' => $USER->id,
|
||||
'debug' => [
|
||||
'messageid' => $result->get('MessageId'),
|
||||
],
|
||||
],
|
||||
];
|
||||
$event = sms_sent::create($data);
|
||||
$event->trigger();
|
||||
|
||||
return true;
|
||||
} catch (\Aws\Exception\AwsException $e) {
|
||||
throw new \moodle_exception('errorawsconection', 'factor_sms', '', $e->getAwsErrorMessage());
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Add gateway specific settings to the SMS factor settings page.
|
||||
*
|
||||
* @param \admin_settingpage $settings
|
||||
* @return void
|
||||
*/
|
||||
public static function add_settings(\admin_settingpage $settings): void {
|
||||
$settings->add(new \admin_setting_configcheckbox('factor_sms/usecredchain',
|
||||
get_string('settings:aws:usecredchain', 'factor_sms'), '', 0));
|
||||
|
||||
if (!get_config('factor_sms', 'usecredchain')) {
|
||||
// AWS Settings.
|
||||
$settings->add(new \admin_setting_configtext('factor_sms/api_key',
|
||||
get_string('settings:aws:key', 'factor_sms'),
|
||||
get_string('settings:aws:key_help', 'factor_sms'), ''));
|
||||
|
||||
$settings->add(new \admin_setting_configpasswordunmask('factor_sms/api_secret',
|
||||
get_string('settings:aws:secret', 'factor_sms'),
|
||||
get_string('settings:aws:secret_help', 'factor_sms'), ''));
|
||||
}
|
||||
|
||||
$settings->add(new admin_settings_aws_region('factor_sms/api_region',
|
||||
get_string('settings:aws:region', 'factor_sms'),
|
||||
get_string('settings:aws:region_help', 'factor_sms'),
|
||||
'ap-southeast-2'));
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether or not the gateway is enabled
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public static function is_gateway_enabled(): bool {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
@ -1,53 +0,0 @@
|
||||
<?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/>.
|
||||
|
||||
/**
|
||||
* SMS Gateway interface
|
||||
*
|
||||
* @package factor_sms
|
||||
* @author Peter Burnett <peterburnett@catalyst-au.net>
|
||||
* @copyright Catalyst IT
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
namespace factor_sms\local\smsgateway;
|
||||
|
||||
interface gateway_interface {
|
||||
|
||||
/**
|
||||
* Sends an SMS message
|
||||
*
|
||||
* @param string $messagecontent the content to send in the SMS message.
|
||||
* @param string $phonenumber the destination for the message.
|
||||
* @return bool true on message send success
|
||||
*/
|
||||
public function send_sms_message(string $messagecontent, string $phonenumber): bool;
|
||||
|
||||
/**
|
||||
* Add gateway specific settings to the SMS factor settings page.
|
||||
*
|
||||
* @param \admin_settingpage $settings
|
||||
* @return void
|
||||
*/
|
||||
public static function add_settings(\admin_settingpage $settings): void;
|
||||
|
||||
/**
|
||||
* Returns whether or not the gateway is enabled
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public static function is_gateway_enabled(): bool;
|
||||
}
|
||||
@ -60,5 +60,18 @@ function xmldb_factor_sms_upgrade(int $oldversion): bool {
|
||||
upgrade_plugin_savepoint(true, 2024082200, 'factor', 'sms');
|
||||
}
|
||||
|
||||
if ($oldversion < 2024082201) {
|
||||
// Unset the removed admin settings.
|
||||
unset_config('countrycode', 'factor_sms');
|
||||
unset_config('gateway', 'factor_sms');
|
||||
unset_config('usecredchain', 'factor_sms');
|
||||
unset_config('api_key', 'factor_sms');
|
||||
unset_config('api_secret', 'factor_sms');
|
||||
unset_config('api_region', 'factor_sms');
|
||||
|
||||
// MFA savepoint reached.
|
||||
upgrade_plugin_savepoint(true, 2024082201, 'factor', 'sms');
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
15
admin/tool/mfa/factor/sms/lang/en/deprecated.txt
Normal file
15
admin/tool/mfa/factor/sms/lang/en/deprecated.txt
Normal file
@ -0,0 +1,15 @@
|
||||
settings:countrycode,factor_sms
|
||||
settings:countrycode_help,factor_sms
|
||||
settings:aws,factor_sms
|
||||
settings:aws:key,factor_sms
|
||||
settings:aws:key_help,factor_sms
|
||||
settings:aws:region,factor_sms
|
||||
settings:aws:region_help,factor_sms
|
||||
settings:aws:secret,factor_sms
|
||||
settings:aws:secret_help,factor_sms
|
||||
settings:aws:usecredchain,factor_sms
|
||||
settings:gateway,factor_sms
|
||||
settings:gateway_help,factor_sms
|
||||
errorawsconection,factor_sms
|
||||
event:smssentdescription,factor_sms
|
||||
event:smssent,factor_sms
|
||||
@ -29,13 +29,10 @@ $string['addnumber'] = 'Mobile number';
|
||||
$string['clientnotfound'] = 'AWS service client not found. Client must be fully qualified classname e.g. \Aws\S3\S3Client.';
|
||||
$string['editphonenumber'] = 'Edit phone number';
|
||||
$string['editphonenumberinfo'] = 'If you didn\'t receive the code or entered the wrong number, please edit the number and try again.';
|
||||
$string['errorawsconection'] = 'Error connecting to AWS server: {$a}';
|
||||
$string['errorsmssent'] = 'Error sending a SMS message containing your verification code.';
|
||||
$string['error:emptyverification'] = 'Empty code. Try again.';
|
||||
$string['error:wrongphonenumber'] = 'The phone number you provided is not in a valid format.';
|
||||
$string['error:wrongverification'] = 'Wrong code. Try again.';
|
||||
$string['event:smssent'] = 'SMS message sent.';
|
||||
$string['event:smssentdescription'] = 'The user with ID {$a->userid} was sent a verification code via SMS. Information: {$a->debuginfo}';
|
||||
$string['info'] = 'Have a verification code sent to the mobile number you choose.';
|
||||
$string['logindesc'] = 'SMS message containing a 6-digit code sent to mobile number {$a}';
|
||||
$string['loginoption'] = 'Have a code sent to your mobile phone';
|
||||
@ -51,18 +48,6 @@ $string['phonehelp'] = 'Enter your mobile number (including country code) to rec
|
||||
$string['pluginname'] = 'SMS mobile phone';
|
||||
$string['privacy:metadata'] = 'The SMS mobile phone factor plugin does not store any personal data.';
|
||||
$string['revokefactorconfirmation'] = 'Remove \'{$a}\' SMS?';
|
||||
$string['settings:aws'] = 'AWS SNS';
|
||||
$string['settings:aws:key'] = 'Key';
|
||||
$string['settings:aws:key_help'] = 'Amazon API key credential.';
|
||||
$string['settings:aws:region'] = 'Region';
|
||||
$string['settings:aws:region_help'] = 'Amazon API gateway region.';
|
||||
$string['settings:aws:secret'] = 'Secret';
|
||||
$string['settings:aws:secret_help'] = 'Amazon API secret credential.';
|
||||
$string['settings:aws:usecredchain'] = 'Find AWS credentials using the default credential provider chain';
|
||||
$string['settings:countrycode'] = 'Country number code';
|
||||
$string['settings:countrycode_help'] = 'The calling code without the leading + as a default if users do not enter an international number with a + prefix.
|
||||
|
||||
See this link for a list of calling codes: {$a}';
|
||||
$string['settings:duration'] = 'Validity duration';
|
||||
$string['settings:duration_help'] = 'The period of time that the code is valid.';
|
||||
$string['settings:gateway'] = 'SMS gateway';
|
||||
@ -81,3 +66,22 @@ $string['smsstring'] = '{$a->code} is your {$a->fullname} one-time security code
|
||||
|
||||
@{$a->url} #{$a->code}';
|
||||
$string['summarycondition'] = 'Using an SMS one-time security code';
|
||||
|
||||
// Deprecated since Moodle 4.5.
|
||||
$string['settings:countrycode'] = 'Country number code';
|
||||
$string['settings:countrycode_help'] = 'The calling code without the leading + as a default if users do not enter an international number with a + prefix.
|
||||
|
||||
See this link for a list of calling codes: {$a}';
|
||||
$string['settings:aws'] = 'AWS SNS';
|
||||
$string['settings:aws:key'] = 'Key';
|
||||
$string['settings:aws:key_help'] = 'Amazon API key credential.';
|
||||
$string['settings:aws:region'] = 'Region';
|
||||
$string['settings:aws:region_help'] = 'Amazon API gateway region.';
|
||||
$string['settings:aws:secret'] = 'Secret';
|
||||
$string['settings:aws:secret_help'] = 'Amazon API secret credential.';
|
||||
$string['settings:aws:usecredchain'] = 'Find AWS credentials using the default credential provider chain';
|
||||
$string['settings:gateway'] = 'SMS Gateway';
|
||||
$string['settings:gateway_help'] = 'The SMS provider you wish to send messages via';
|
||||
$string['errorawsconection'] = 'Error connecting to AWS server: {$a}';
|
||||
$string['event:smssentdescription'] = 'The user with ID {$a->userid} was sent a verification code via SMS. Information: {$a->debuginfo}';
|
||||
$string['event:smssent'] = 'SMS message sent.';
|
||||
|
||||
@ -117,30 +117,3 @@ if (count($gatewayrecords) > 0) {
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
// TODO MDL-80962 Remove these settings, strings and associated codes (if any).
|
||||
/*
|
||||
$codeslink = 'https://en.wikipedia.org/wiki/List_of_country_calling_codes';
|
||||
$link = \html_writer::link($codeslink, $codeslink);
|
||||
|
||||
$settings->add(new admin_setting_configtext('factor_sms/countrycode',
|
||||
get_string('settings:countrycode', 'factor_sms'),
|
||||
get_string('settings:countrycode_help', 'factor_sms', $link), '', PARAM_INT));
|
||||
|
||||
$gateways = [
|
||||
'aws_sns' => get_string('settings:aws', 'factor_sms'),
|
||||
];
|
||||
|
||||
$settings->add(new admin_setting_configselect('factor_sms/gateway',
|
||||
get_string('settings:gateway', 'factor_sms'),
|
||||
get_string('settings:gateway_help', 'factor_sms'),
|
||||
'aws_sns', $gateways));
|
||||
|
||||
if (empty(get_config('factor_sms', 'gateway'))) {
|
||||
return;
|
||||
}
|
||||
|
||||
$class = '\factor_sms\local\smsgateway\\' . get_config('factor_sms', 'gateway');
|
||||
call_user_func($class . '::add_settings', $settings);
|
||||
*/
|
||||
|
||||
@ -26,7 +26,7 @@
|
||||
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
$plugin->version = 2024082200; // The current plugin version (Date: YYYYMMDDXX).
|
||||
$plugin->version = 2024082201; // The current plugin version (Date: YYYYMMDDXX).
|
||||
$plugin->requires = 2024041600; // Requires this Moodle version.
|
||||
$plugin->component = 'factor_sms'; // Full name of the plugin (used for diagnostics).
|
||||
$plugin->maturity = MATURITY_STABLE;
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user