BackendFormProtectionTest.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\Core\Tests\Unit\FormProtection;
 
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\FormProtection\BackendFormProtection;
use ‪TYPO3\CMS\Core\Registry;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪BackendFormProtectionTest extends UnitTestCase
{
    protected ‪$subject;
 
    protected ‪$backendUserMock;
 
    protected ‪$registryMock;
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        $this->backendUserMock = $this->createMock(BackendUserAuthentication::class);
        $this->backendUserMock->user['uid'] = 1;
        $this->registryMock = $this->createMock(Registry::class);
        $this->subject = new ‪BackendFormProtection(
            $this->backendUserMock,
            $this->registryMock,
            static function () {
                throw new \Exception('Closure called', 1442592030);
            }
        );
        ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] = '';
    }
 
    public function ‪generateTokenReadsTokenFromSessionData(): void
    {
        $this->backendUserMock
            ->expects(self::once())
            ->method('getSessionData')
            ->with('formProtectionSessionToken')
            ->willReturn([]);
        $this->subject->generateToken('foo');
    }
 
    public function ‪tokenFromSessionDataIsAvailableForValidateToken(): void
    {
        $sessionToken = '881ffea2159ac72182557b79dc0c723f5a8d20136f9fab56cdd4f8b3a1dbcfcd';
        $formName = 'foo';
        $action = 'edit';
        $formInstanceName = '42';
 
        $tokenId = GeneralUtility::hmac(
            $formName . $action . $formInstanceName . $sessionToken
        );
 
        $this->backendUserMock
            ->expects(self::atLeastOnce())
            ->method('getSessionData')
            ->with('formProtectionSessionToken')
            ->willReturn($sessionToken);
 
        self::assertTrue(
            $this->subject->validateToken($tokenId, $formName, $action, $formInstanceName)
        );
    }
 
    public function ‪restoreSessionTokenFromRegistryThrowsExceptionIfSessionTokenIsEmpty(): void
    {
        $this->expectException(\UnexpectedValueException::class);
        $this->expectExceptionCode(1301827270);
 
        $this->subject->setSessionTokenFromRegistry();
    }
 
    public function ‪persistSessionTokenWritesTokenToSession(): void
    {
        $this->backendUserMock
            ->expects(self::once())
            ->method('setAndSaveSessionData');
        $this->subject->persistSessionToken();
    }
 
    public function ‪failingTokenValidationInvokesFailingTokenClosure(): void
    {
        $this->expectException(\Exception::class);
        $this->expectExceptionCode(1442592030);
 
        $this->subject->validateToken('foo', 'bar');
    }
}