mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-01-18 22:08:20 +01:00
Code Issues Projects Releases Wiki Activity

MDL-58716 login: API changes to accommodate web services

Browse Source
This commit is contained in:
Juan Leyva 2017-06-14 14:17:33 +01:00
parent 5a651b43fb
commit cca01ddace
3 changed files with 407 additions and 140 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
login/forgot_password_form.php
View File

@ -67,42 +67,9 @@ class login_forgot_password_form extends moodleform {
* @return array errors occuring during validation.
*/
function validation($data, $files) {
global $CFG, $DB;
$errors = parent::validation($data, $files);
if ((!empty($data['username']) and !empty($data['email'])) or (empty($data['username']) and empty($data['email']))) {
$errors['username'] = get_string('usernameoremail');
$errors['email'] = get_string('usernameoremail');
} else if (!empty($data['email'])) {
if (!validate_email($data['email'])) {
$errors['email'] = get_string('invalidemail');
} else if ($DB->count_records('user', array('email'=>$data['email'])) > 1) {
$errors['email'] = get_string('forgottenduplicate');
} else {
if ($user = get_complete_user_data('email', $data['email'])) {
if (empty($user->confirmed)) {
$errors['email'] = get_string('confirmednot');
}
}
if (!$user and empty($CFG->protectusernames)) {
$errors['email'] = get_string('emailnotfound');
}
}
} else {
if ($user = get_complete_user_data('username', $data['username'])) {
if (empty($user->confirmed)) {
$errors['email'] = get_string('confirmednot');
}
}
if (!$user and empty($CFG->protectusernames)) {
$errors['username'] = get_string('usernamenotfound');
}
}
$errors += core_login_validate_forgot_password_data($data);
return $errors;
}

287
login/lib.php
View File

@ -35,125 +35,26 @@ define('PWRESET_STATUS_ALREADYSENT', 4);
* Where they have supplied identifier, the function will check their status, and send email as appropriate.
*/
function core_login_process_password_reset_request() {
global $DB, $OUTPUT, $CFG, $PAGE;
$systemcontext = context_system::instance();
global $OUTPUT, $PAGE;
$mform = new login_forgot_password_form();
if ($mform->is_cancelled()) {
redirect(get_login_url());
} else if ($data = $mform->get_data()) {
// Requesting user has submitted form data.
// Next find the user account in the database which the requesting user claims to own.
$username = $email = '';
if (!empty($data->username)) {
// Username has been specified - load the user record based on that.
$username = core_text::strtolower($data->username); // Mimic the login page process.
$userparams = array('username' => $username, 'mnethostid' => $CFG->mnet_localhost_id, 'deleted' => 0, 'suspended' => 0);
$user = $DB->get_record('user', $userparams);
$username = $data->username;
} else {
// Try to load the user record based on email address.
// this is tricky because
// 1/ the email is not guaranteed to be unique - TODO: send email with all usernames to select the account for pw reset
// 2/ mailbox may be case sensitive, the email domain is case insensitive - let's pretend it is all case-insensitive.
$select = $DB->sql_like('email', ':email', false, true, false, '|') .
" AND mnethostid = :mnethostid AND deleted=0 AND suspended=0";
$params = array('email' => $DB->sql_like_escape($data->email, '|'), 'mnethostid' => $CFG->mnet_localhost_id);
$user = $DB->get_record_select('user', $select, $params, '*', IGNORE_MULTIPLE);
}
// Target user details have now been identified, or we know that there is no such account.
// Send email address to account's email address if appropriate.
$pwresetstatus = PWRESET_STATUS_NOEMAILSENT;
if ($user and !empty($user->confirmed)) {
$userauth = get_auth_plugin($user->auth);
if (!$userauth->can_reset_password() or !is_enabled_auth($user->auth)
or !has_capability('moodle/user:changeownpassword', $systemcontext, $user->id)) {
if (send_password_change_info($user)) {
$pwresetstatus = PWRESET_STATUS_OTHEREMAILSENT;
} else {
print_error('cannotmailconfirm');
}
} else {
// The account the requesting user claims to be is entitled to change their password.
// Next, check if they have an existing password reset in progress.
$resetinprogress = $DB->get_record('user_password_resets', array('userid' => $user->id));
if (empty($resetinprogress)) {
// Completely new reset request - common case.
$resetrecord = core_login_generate_password_reset($user);
$sendemail = true;
} else if ($resetinprogress->timerequested < (time() - $CFG->pwresettime)) {
// Preexisting, but expired request - delete old record & create new one.
// Uncommon case - expired requests are cleaned up by cron.
$DB->delete_records('user_password_resets', array('id' => $resetinprogress->id));
$resetrecord = core_login_generate_password_reset($user);
$sendemail = true;
} else if (empty($resetinprogress->timererequested)) {
// Preexisting, valid request. This is the first time user has re-requested the reset.
// Re-sending the same email once can actually help in certain circumstances
// eg by reducing the delay caused by greylisting.
$resetinprogress->timererequested = time();
$DB->update_record('user_password_resets', $resetinprogress);
$resetrecord = $resetinprogress;
$sendemail = true;
} else {
// Preexisting, valid request. User has already re-requested email.
$pwresetstatus = PWRESET_STATUS_ALREADYSENT;
$sendemail = false;
}
if ($sendemail) {
$sendresult = send_password_change_confirmation_email($user, $resetrecord);
if ($sendresult) {
$pwresetstatus = PWRESET_STATUS_TOKENSENT;
} else {
print_error('cannotmailconfirm');
}
}
}
$email = $data->email;
}
list($status, $notice, $url) = core_login_process_password_reset($username, $email);
// Any email has now been sent.
// Next display results to requesting user if settings permit.
echo $OUTPUT->header();
if (!empty($CFG->protectusernames)) {
// Neither confirm, nor deny existance of any username or email address in database.
// Print general (non-commital) message.
notice(get_string('emailpasswordconfirmmaybesent'), $CFG->wwwroot.'/index.php');
die; // Never reached.
} else if (empty($user)) {
// Protect usernames is off, and we couldn't find the user with details specified.
// Print failure advice.
notice(get_string('emailpasswordconfirmnotsent'), $CFG->wwwroot.'/forgot_password.php');
die; // Never reached.
} else if (empty($user->email)) {
// User doesn't have an email set - can't send a password change confimation email.
notice(get_string('emailpasswordconfirmnoemail'), $CFG->wwwroot.'/index.php');
die; // Never reached.
} else if ($pwresetstatus == PWRESET_STATUS_ALREADYSENT) {
// User found, protectusernames is off, but user has already (re) requested a reset.
// Don't send a 3rd reset email.
$stremailalreadysent = get_string('emailalreadysent');
notice($stremailalreadysent, $CFG->wwwroot.'/index.php');
die; // Never reached.
} else if ($pwresetstatus == PWRESET_STATUS_NOEMAILSENT) {
// User found, protectusernames is off, but user is not confirmed.
// Pretend we sent them an email.
// This is a big usability problem - need to tell users why we didn't send them an email.
// Obfuscate email address to protect privacy.
$protectedemail = preg_replace('/([^@]*)@(.*)/', '******@$2', $user->email);
$stremailpasswordconfirmsent = get_string('emailpasswordconfirmsent', '', $protectedemail);
notice($stremailpasswordconfirmsent, $CFG->wwwroot.'/index.php');
die; // Never reached.
} else {
// Confirm email sent. (Obfuscate email address to protect privacy).
$protectedemail = preg_replace('/([^@]*)@(.*)/', '******@$2', $user->email);
// This is a small usability problem - may be obfuscating the email address which the user has just supplied.
$stremailresetconfirmsent = get_string('emailresetconfirmsent', '', $protectedemail);
notice($stremailresetconfirmsent, $CFG->wwwroot.'/index.php');
die; // Never reached.
}
notice($notice, $url);
die; // Never reached.
}
@ -169,6 +70,131 @@ function core_login_process_password_reset_request() {
echo $OUTPUT->footer();
}
/**
* Process the password reset for the given user (via username or email).
*
* @param string $username the user name
* @param string $email the user email
* @return array an array containing fields indicating the reset status, a info notice and redirect URL.
* @since Moodle 3.4
*/
function core_login_process_password_reset($username, $email) {
global $CFG, $DB;
if (empty($username) && empty($email)) {
print_error('cannotmailconfirm');
}
// Next find the user account in the database which the requesting user claims to own.
if (!empty($username)) {
// Username has been specified - load the user record based on that.
$username = core_text::strtolower($username); // Mimic the login page process.
$userparams = array('username' => $username, 'mnethostid' => $CFG->mnet_localhost_id, 'deleted' => 0, 'suspended' => 0);
$user = $DB->get_record('user', $userparams);
} else {
// Try to load the user record based on email address.
// this is tricky because
// 1/ the email is not guaranteed to be unique - TODO: send email with all usernames to select the account for pw reset
// 2/ mailbox may be case sensitive, the email domain is case insensitive - let's pretend it is all case-insensitive.
$select = $DB->sql_like('email', ':email', false, true, false, '|') .
" AND mnethostid = :mnethostid AND deleted=0 AND suspended=0";
$params = array('email' => $DB->sql_like_escape($email, '|'), 'mnethostid' => $CFG->mnet_localhost_id);
$user = $DB->get_record_select('user', $select, $params, '*', IGNORE_MULTIPLE);
}
// Target user details have now been identified, or we know that there is no such account.
// Send email address to account's email address if appropriate.
$pwresetstatus = PWRESET_STATUS_NOEMAILSENT;
if ($user and !empty($user->confirmed)) {
$systemcontext = context_system::instance();
$userauth = get_auth_plugin($user->auth);
if (!$userauth->can_reset_password() or !is_enabled_auth($user->auth)
or !has_capability('moodle/user:changeownpassword', $systemcontext, $user->id)) {
if (send_password_change_info($user)) {
$pwresetstatus = PWRESET_STATUS_OTHEREMAILSENT;
} else {
print_error('cannotmailconfirm');
}
} else {
// The account the requesting user claims to be is entitled to change their password.
// Next, check if they have an existing password reset in progress.
$resetinprogress = $DB->get_record('user_password_resets', array('userid' => $user->id));
if (empty($resetinprogress)) {
// Completely new reset request - common case.
$resetrecord = core_login_generate_password_reset($user);
$sendemail = true;
} else if ($resetinprogress->timerequested < (time() - $CFG->pwresettime)) {
// Preexisting, but expired request - delete old record & create new one.
// Uncommon case - expired requests are cleaned up by cron.
$DB->delete_records('user_password_resets', array('id' => $resetinprogress->id));
$resetrecord = core_login_generate_password_reset($user);
$sendemail = true;
} else if (empty($resetinprogress->timererequested)) {
// Preexisting, valid request. This is the first time user has re-requested the reset.
// Re-sending the same email once can actually help in certain circumstances
// eg by reducing the delay caused by greylisting.
$resetinprogress->timererequested = time();
$DB->update_record('user_password_resets', $resetinprogress);
$resetrecord = $resetinprogress;
$sendemail = true;
} else {
// Preexisting, valid request. User has already re-requested email.
$pwresetstatus = PWRESET_STATUS_ALREADYSENT;
$sendemail = false;
}
if ($sendemail) {
$sendresult = send_password_change_confirmation_email($user, $resetrecord);
if ($sendresult) {
$pwresetstatus = PWRESET_STATUS_TOKENSENT;
} else {
print_error('cannotmailconfirm');
}
}
}
}
$url = $CFG->wwwroot.'/index.php';
if (!empty($CFG->protectusernames)) {
// Neither confirm, nor deny existance of any username or email address in database.
// Print general (non-commital) message.
$status = 'emailpasswordconfirmmaybesent';
$notice = get_string($status);
} else if (empty($user)) {
// Protect usernames is off, and we couldn't find the user with details specified.
// Print failure advice.
$status = 'emailpasswordconfirmnotsent';
$notice = get_string($status);
$url = $CFG->wwwroot.'/forgot_password.php';
} else if (empty($user->email)) {
// User doesn't have an email set - can't send a password change confimation email.
$status = 'emailpasswordconfirmnoemail';
$notice = get_string($status);
} else if ($pwresetstatus == PWRESET_STATUS_ALREADYSENT) {
// User found, protectusernames is off, but user has already (re) requested a reset.
// Don't send a 3rd reset email.
$status = 'emailalreadysent';
$notice = get_string($status);
} else if ($pwresetstatus == PWRESET_STATUS_NOEMAILSENT) {
// User found, protectusernames is off, but user is not confirmed.
// Pretend we sent them an email.
// This is a big usability problem - need to tell users why we didn't send them an email.
// Obfuscate email address to protect privacy.
$protectedemail = preg_replace('/([^@]*)@(.*)/', '******@$2', $user->email);
$status = 'emailpasswordconfirmsent';
$notice = get_string($status, '', $protectedemail);
} else {
// Confirm email sent. (Obfuscate email address to protect privacy).
$protectedemail = preg_replace('/([^@]*)@(.*)/', '******@$2', $user->email);
// This is a small usability problem - may be obfuscating the email address which the user has just supplied.
$status = 'emailresetconfirmsent';
$notice = get_string($status, '', $protectedemail);
}
return array($status, $notice, $url);
}
/**
* This function processes a user's submitted token to validate the request to set a new password.
* If the user's token is validated, they are prompted to set a new password.
@ -311,3 +337,52 @@ function core_login_get_return_url() {
}
return $urltogo;
}
/**
* Validates the forgot password form data.
*
* This is used by the forgot_password_form and by the core_auth_request_password_rest WS.
* @param array $data array containing the data to be validated (email and username)
* @return array array of errors compatible with mform
* @since Moodle 3.4
*/
function core_login_validate_forgot_password_data($data) {
global $CFG, $DB;
$errors = array();
if ((!empty($data['username']) and !empty($data['email'])) or (empty($data['username']) and empty($data['email']))) {
$errors['username'] = get_string('usernameoremail');
$errors['email'] = get_string('usernameoremail');
} else if (!empty($data['email'])) {
if (!validate_email($data['email'])) {
$errors['email'] = get_string('invalidemail');
} else if ($DB->count_records('user', array('email' => $data['email'])) > 1) {
$errors['email'] = get_string('forgottenduplicate');
} else {
if ($user = get_complete_user_data('email', $data['email'])) {
if (empty($user->confirmed)) {
$errors['email'] = get_string('confirmednot');
}
}
if (!$user and empty($CFG->protectusernames)) {
$errors['email'] = get_string('emailnotfound');
}
}
} else {
if ($user = get_complete_user_data('username', $data['username'])) {
if (empty($user->confirmed)) {
$errors['email'] = get_string('confirmednot');
}
}
if (!$user and empty($CFG->protectusernames)) {
$errors['username'] = get_string('usernamenotfound');
}
}
return $errors;
}

225
login/tests/lib_test.php Normal file
View File

@ -0,0 +1,225 @@
<?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/>.
/**
* Unit tests for login lib.
*
* @package core
* @copyright 2017 Juan Leyva
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
global $CFG;
require_once($CFG->dirroot . '/login/lib.php');
/**
* Login lib testcase.
*
* @package core
* @copyright 2017 Juan Leyva
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class core_login_lib_testcase extends advanced_testcase {
public function test_core_login_process_password_reset_one_time_without_username_protection() {
global $CFG;
$this->resetAfterTest();
$CFG->protectusernames = 0;
$user = $this->getDataGenerator()->create_user(array('auth' => 'manual'));
$sink = $this->redirectEmails();
list($status, $notice, $url) = core_login_process_password_reset($user->username, null);
$this->assertSame('emailresetconfirmsent', $status);
$emails = $sink->get_messages();
$this->assertCount(1, $emails);
$email = reset($emails);
$this->assertSame($user->email, $email->to);
$this->assertNotEmpty($email->header);
$this->assertNotEmpty($email->body);
$this->assertRegExp('/A password reset was requested for your account/', $email->body);
$sink->clear();
}
public function test_core_login_process_password_reset_two_consecutive_times_without_username_protection() {
global $CFG;
$this->resetAfterTest();
$CFG->protectusernames = 0;
$user = $this->getDataGenerator()->create_user(array('auth' => 'manual'));
$sink = $this->redirectEmails();
list($status, $notice, $url) = core_login_process_password_reset($user->username, null);
$this->assertSame('emailresetconfirmsent', $status);
// Request for a second time.
list($status, $notice, $url) = core_login_process_password_reset($user->username, null);
$this->assertSame('emailresetconfirmsent', $status);
$emails = $sink->get_messages();
$this->assertCount(2, $emails); // Two emails sent (one per each request).
$email = array_pop($emails);
$this->assertSame($user->email, $email->to);
$this->assertNotEmpty($email->header);
$this->assertNotEmpty($email->body);
$this->assertRegExp('/A password reset was requested for your account/', $email->body);
$sink->clear();
}
public function test_core_login_process_password_reset_three_consecutive_times_without_username_protection() {
global $CFG;
$this->resetAfterTest();
$CFG->protectusernames = 0;
$user = $this->getDataGenerator()->create_user(array('auth' => 'manual'));
$sink = $this->redirectEmails();
list($status, $notice, $url) = core_login_process_password_reset($user->username, null);
$this->assertSame('emailresetconfirmsent', $status);
// Request for a second time.
list($status, $notice, $url) = core_login_process_password_reset($user->username, null);
$this->assertSame('emailresetconfirmsent', $status);
// Third time.
list($status, $notice, $url) = core_login_process_password_reset($user->username, null);
$this->assertSame('emailalreadysent', $status);
$emails = $sink->get_messages();
$this->assertCount(2, $emails); // Third time email is not sent.
}
public function test_core_login_process_password_reset_one_time_with_username_protection() {
global $CFG;
$this->resetAfterTest();
$CFG->protectusernames = 1;
$user = $this->getDataGenerator()->create_user(array('auth' => 'manual'));
$sink = $this->redirectEmails();
list($status, $notice, $url) = core_login_process_password_reset($user->username, null);
$this->assertSame('emailpasswordconfirmmaybesent', $status); // Generic message not giving clues.
$emails = $sink->get_messages();
$this->assertCount(1, $emails);
$email = reset($emails);
$this->assertSame($user->email, $email->to);
$this->assertNotEmpty($email->header);
$this->assertNotEmpty($email->body);
$this->assertRegExp('/A password reset was requested for your account/', $email->body);
$sink->clear();
}
public function test_core_login_process_password_reset_with_preexisting_expired_request_without_username_protection() {
global $CFG, $DB;
$this->resetAfterTest();
$CFG->protectusernames = 0;
$user = $this->getDataGenerator()->create_user(array('auth' => 'manual'));
$sink = $this->redirectEmails();
list($status, $notice, $url) = core_login_process_password_reset($user->username, null);
$this->assertSame('emailresetconfirmsent', $status);
// Request again.
list($status, $notice, $url) = core_login_process_password_reset($user->username, null);
$this->assertSame('emailresetconfirmsent', $status);
$resetrequests = $DB->get_records('user_password_resets');
$request = reset($resetrequests);
$request->timerequested = time() - YEARSECS;
$DB->update_record('user_password_resets', $request);
// Request again - third time - but it shuld be expired so we should get an email.
list($status, $notice, $url) = core_login_process_password_reset($user->username, null);
$this->assertSame('emailresetconfirmsent', $status);
$emails = $sink->get_messages();
$this->assertCount(3, $emails); // Normal process, the previous request was deleted.
$email = reset($emails);
$this->assertSame($user->email, $email->to);
$this->assertNotEmpty($email->header);
$this->assertNotEmpty($email->body);
$this->assertRegExp('/A password reset was requested for your account/', $email->body);
$sink->clear();
}
public function test_core_login_process_password_reset_disabled_auth() {
$this->resetAfterTest();
$user = $this->getDataGenerator()->create_user(array('auth' => 'oauth2'));
$sink = $this->redirectEmails();
core_login_process_password_reset($user->username, null);
$emails = $sink->get_messages();
$this->assertCount(1, $emails);
$email = reset($emails);
$this->assertSame($user->email, $email->to);
$this->assertNotEmpty($email->header);
$this->assertNotEmpty($email->body);
$this->assertRegExp('/Unfortunately your account on this site is disabled/', $email->body);
$sink->clear();
}
public function test_core_login_process_password_reset_auth_not_supporting_email_reset() {
global $CFG;
$this->resetAfterTest();
$CFG->auth = $CFG->auth . ',mnet';
$user = $this->getDataGenerator()->create_user(array('auth' => 'mnet'));
$sink = $this->redirectEmails();
core_login_process_password_reset($user->username, null);
$emails = $sink->get_messages();
$this->assertCount(1, $emails);
$email = reset($emails);
$this->assertSame($user->email, $email->to);
$this->assertNotEmpty($email->header);
$this->assertNotEmpty($email->body);
$this->assertRegExp('/Unfortunately passwords cannot be reset on this site/', $email->body);
$sink->clear();
}
public function test_core_login_process_password_reset_missing_parameters() {
$this->expectException('moodle_exception');
$this->expectExceptionMessage(get_string('cannotmailconfirm', 'error'));
core_login_process_password_reset(null, null);
}
public function test_core_login_process_password_reset_invalid_username_with_username_protection() {
global $CFG;
$this->resetAfterTest();
$CFG->protectusernames = 1;
list($status, $notice, $url) = core_login_process_password_reset('72347234nasdfasdf/Ds', null);
$this->assertEquals('emailpasswordconfirmmaybesent', $status);
}
public function test_core_login_process_password_reset_invalid_username_without_username_protection() {
global $CFG;
$this->resetAfterTest();
$CFG->protectusernames = 0;
list($status, $notice, $url) = core_login_process_password_reset('72347234nasdfasdf/Ds', null);
$this->assertEquals('emailpasswordconfirmnotsent', $status);
}
public function test_core_login_process_password_reset_invalid_email_without_username_protection() {
global $CFG;
$this->resetAfterTest();
$CFG->protectusernames = 0;
list($status, $notice, $url) = core_login_process_password_reset(null, 'fakeemail@nofd.zdy');
$this->assertEquals('emailpasswordconfirmnotsent', $status);
}
}