PasswordResetTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Backend\Tests\Functional\Authentication;
 
use PHPUnit\Framework\Attributes\Test;
use Psr\Log\LoggerInterface;
use Psr\Log\LoggerTrait;
use ‪TYPO3\CMS\Backend\Authentication\PasswordReset;
use ‪TYPO3\CMS\Core\Context\Context;
use ‪TYPO3\CMS\Core\Core\SystemEnvironmentBuilder;
use ‪TYPO3\CMS\Core\Crypto\HashService;
use ‪TYPO3\CMS\Core\Http\ServerRequest;
use ‪TYPO3\CMS\Core\Http\Uri;
use ‪TYPO3\CMS\Core\Mail\MailerInterface;
use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;
 
final class ‪PasswordResetTest extends FunctionalTestCase
{
    protected object ‪$logger;
 
    public function ‪setUp(): void
    {
        parent::setUp();
        $this->logger = new class () implements LoggerInterface {
            use LoggerTrait;
            public array $records = [];
            public function log($level, string|\Stringable $message, array $context = []): void
            {
                $this->records[] = [
                    'level' => $level,
                    'message' => $message,
                    'context' => $context,
                ];
            }
        };
    }
 
    #[Test]
    public function ‪isNotEnabledWorks(): void
    {
        $mailerMock = $this->createStub(MailerInterface::class);
        $subject = new ‪PasswordReset($mailerMock, new ‪HashService());
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordReset'] = false;
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordResetForAdmins'] = false;
        self::assertFalse($subject->isEnabled());
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordResetForAdmins'] = true;
        self::assertFalse($subject->isEnabled());
    }
 
    #[Test]
    public function ‪isNotEnabledWithNoUsers(): void
    {
        $mailerMock = $this->createStub(MailerInterface::class);
        $subject = new ‪PasswordReset($mailerMock, new ‪HashService());
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordReset'] = true;
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordResetForAdmins'] = false;
        self::assertFalse($subject->isEnabled());
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordReset'] = true;
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordResetForAdmins'] = true;
        self::assertFalse($subject->isEnabled());
    }
 
    #[Test]
    public function ‪isEnabledExcludesAdministrators(): void
    {
        $this->importCSVDataSet(__DIR__ . '/Fixtures/be_users_only_admins.csv');
        $mailerMock = $this->createStub(MailerInterface::class);
        $subject = new ‪PasswordReset($mailerMock, new ‪HashService());
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordReset'] = false;
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordResetForAdmins'] = false;
        self::assertFalse($subject->isEnabled());
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordReset'] = true;
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordResetForAdmins'] = false;
        self::assertFalse($subject->isEnabled());
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordReset'] = true;
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordResetForAdmins'] = true;
        self::assertTrue($subject->isEnabled());
    }
 
    #[Test]
    public function ‪isEnabledForUserTest(): void
    {
        $mailerMock = $this->createStub(MailerInterface::class);
        $subject = new ‪PasswordReset($mailerMock, new ‪HashService());
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordResetForAdmins'] = false;
 
        // False since no users exist
        self::assertFalse($subject->isEnabledForUser(3));
 
        $this->importCSVDataSet(__DIR__ . '/Fixtures/be_users.csv');
 
        // False since reset for admins is not enabled
        self::assertFalse($subject->isEnabledForUser(1));
        // False since user has no email set
        self::assertFalse($subject->isEnabledForUser(2));
        // False since user has no password set
        self::assertFalse($subject->isEnabledForUser(4));
        // False since user is disabled
        self::assertFalse($subject->isEnabledForUser(7));
 
        // Now true since user with email+password exist
        self::assertTrue($subject->isEnabledForUser(3));
 
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordResetForAdmins'] = true;
        // True since "passwordResetForAdmins" is now set
        self::assertTrue($subject->isEnabledForUser(1));
    }
 
    #[Test]
    public function ‪noEmailIsFound(): void
    {
        $this->importCSVDataSet(__DIR__ . '/Fixtures/be_users.csv');
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordReset'] = true;
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordResetForAdmins'] = true;
        ‪$GLOBALS['TYPO3_CONF_VARS']['MAIL']['transport'] = 'null';
        $emailAddress = 'does-not-exist@example.com';
        $mailerMock = $this->createStub(MailerInterface::class);
        $subject = new ‪PasswordReset($mailerMock, new ‪HashService());
        $loggerMock = $this->createMock(LoggerInterface::class);
        $loggerMock->expects(self::atLeastOnce())->method('warning')->with('Password reset requested for email but no valid users');
        $subject->setLogger($loggerMock);
        $context = new ‪Context();
        $request = new ‪ServerRequest();
        $subject->initiateReset($request, $context, $emailAddress);
    }
 
    #[Test]
    public function ‪ambiguousEmailIsTriggeredForMultipleValidUsers(): void
    {
        $this->importCSVDataSet(__DIR__ . '/Fixtures/be_users.csv');
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordReset'] = true;
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordResetForAdmins'] = true;
        ‪$GLOBALS['TYPO3_CONF_VARS']['MAIL']['transport'] = 'null';
        $emailAddress = 'duplicate@example.com';
        $mailerMock = $this->createStub(MailerInterface::class);
        $subject = new ‪PasswordReset($mailerMock, new ‪HashService());
        $subject->setLogger($this->logger);
        $context = new ‪Context();
        $request = new ‪ServerRequest();
        $subject->initiateReset($request, $context, $emailAddress);
        self::assertEquals('warning', $this->logger->records[0]['level']);
        self::assertEquals($emailAddress, $this->logger->records[0]['context']['email']);
    }
 
    #[Test]
    public function ‪passwordResetEmailIsTriggeredForValidUser(): void
    {
        $this->importCSVDataSet(__DIR__ . '/Fixtures/be_users.csv');
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordReset'] = true;
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordResetForAdmins'] = true;
        ‪$GLOBALS['TYPO3_CONF_VARS']['MAIL']['transport'] = 'null';
        $emailAddress = 'editor-with-email@example.com';
        $username = 'editor-with-email';
        $mailerMock = $this->createStub(MailerInterface::class);
        $subject = new ‪PasswordReset($mailerMock, new ‪HashService());
        $subject->setLogger($this->logger);
        $context = new ‪Context();
        $uri = new ‪Uri('https://localhost/typo3/');
        $request = new ‪ServerRequest($uri);
        $request = $request->withAttribute('applicationType', ‪SystemEnvironmentBuilder::REQUESTTYPE_BE);
        ‪$GLOBALS['TYPO3_REQUEST'] = $request;
        $subject->initiateReset($request, $context, $emailAddress);
        self::assertEquals('info', $this->logger->records[0]['level']);
        self::assertEquals($emailAddress, $this->logger->records[0]['context']['email']);
        self::assertEquals($username, $this->logger->records[0]['context']['username']);
    }
 
    #[Test]
    public function ‪invalidTokenCannotResetPassword(): void
    {
        $this->importCSVDataSet(__DIR__ . '/Fixtures/be_users.csv');
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordReset'] = true;
        ‪$GLOBALS['TYPO3_CONF_VARS']['BE']['passwordResetForAdmins'] = true;
        ‪$GLOBALS['TYPO3_CONF_VARS']['MAIL']['transport'] = 'null';
        $mailerMock = $this->createStub(MailerInterface::class);
        $subject = new ‪PasswordReset($mailerMock, new ‪HashService());
        $loggerMock = $this->createMock(LoggerInterface::class);
        $loggerMock->expects(self::exactly(2))->method('warning')->with('Password reset not possible. Valid user for token not found.');
        $subject->setLogger($loggerMock);
 
        $context = new ‪Context();
        $request = new ‪ServerRequest();
        $request = $request->withQueryParams(['t' => 'token', 'i' => 'identity', 'e' => 13465444]);
        $subject->resetPassword($request, $context);
 
        // Now with a password
        $request = $request->withParsedBody(['password' => 'str0NGpassw0RD!', 'passwordrepeat' => 'str0NGpassw0RD!']);
        $subject->resetPassword($request, $context);
    }
}