AbstractFormProtection.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\FormProtection;

abstract class AbstractFormProtection {

    protected $sessionToken;

    protected function getSessionToken() {
        if ($this->sessionToken === NULL) {
            $this->sessionToken = $this->retrieveSessionToken();
        }
        return $this->sessionToken;
    }

    public function __destruct() {
        unset($this->sessionToken);
    }

    public function clean() {
        unset($this->sessionToken);
        $this->persistSessionToken();
    }

    public function generateToken($formName, $action = '', $formInstanceName = '') {
        if ($formName == '') {
            throw new \InvalidArgumentException('$formName must not be empty.', 1294586643);
        }
        $tokenId = \TYPO3\CMS\Core\Utility\GeneralUtility::hmac($formName . $action . $formInstanceName . $this->getSessionToken());
        return $tokenId;
    }

    public function validateToken($tokenId, $formName, $action = '', $formInstanceName = '') {
        $validTokenId = \TYPO3\CMS\Core\Utility\GeneralUtility::hmac(((string) $formName . (string) $action) . (string) $formInstanceName . $this->getSessionToken());
        if ((string) $tokenId === $validTokenId) {
            $isValid = TRUE;
        } else {
            $isValid = FALSE;
        }
        if (!$isValid) {
            $this->createValidationErrorMessage();
        }
        return $isValid;
    }

    protected function generateSessionToken() {
        return bin2hex(\TYPO3\CMS\Core\Utility\GeneralUtility::generateRandomBytes(32));
    }

    abstract protected function createValidationErrorMessage();

    abstract protected function retrieveSessionToken();

    abstract public function persistSessionToken();

}