Maintenance.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\Install\Middleware;
 
use Psr\Container\ContainerInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use TYPO3\CMS\Core\Configuration\ConfigurationManager;
use ‪TYPO3\CMS\Core\Configuration\Features;
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Crypto\PasswordHashing\PasswordHashFactory;
use ‪TYPO3\CMS\Core\FormProtection\FormProtectionFactory;
use ‪TYPO3\CMS\Core\Http\HtmlResponse;
use ‪TYPO3\CMS\Core\Http\JsonResponse;
use ‪TYPO3\CMS\Core\Http\Security\ReferrerEnforcer;
use ‪TYPO3\CMS\Core\Messaging\FlashMessage;
use ‪TYPO3\CMS\Core\Messaging\FlashMessageQueue;
use ‪TYPO3\CMS\Core\Package\FailsafePackageManager;
use ‪TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
use ‪TYPO3\CMS\Install\Authentication\AuthenticationService;
use ‪TYPO3\CMS\Install\Controller\AbstractController;
use ‪TYPO3\CMS\Install\Controller\EnvironmentController;
use ‪TYPO3\CMS\Install\Controller\IconController;
use ‪TYPO3\CMS\Install\Controller\LayoutController;
use ‪TYPO3\CMS\Install\Controller\LoginController;
use ‪TYPO3\CMS\Install\Controller\MaintenanceController;
use ‪TYPO3\CMS\Install\Controller\SettingsController;
use ‪TYPO3\CMS\Install\Controller\UpgradeController;
use ‪TYPO3\CMS\Install\Service\EnableFileService;
use TYPO3\CMS\Install\Service\SessionService;
 
class ‪Maintenance implements MiddlewareInterface
{
    protected array ‪$controllers = [
        'icon' => IconController::class,
        'layout' => LayoutController::class,
        'login' => LoginController::class,
        'maintenance' => MaintenanceController::class,
        'settings' => SettingsController::class,
        'upgrade' => UpgradeController::class,
        'environment' => EnvironmentController::class,
    ];
 
    public function ‪__construct(
        protected readonly ‪FailsafePackageManager $packageManager,
        protected readonly ConfigurationManager $configurationManager,
        protected readonly ‪PasswordHashFactory $passwordHashFactory,
        protected readonly ContainerInterface $container,
        protected readonly ‪FormProtectionFactory $formProtectionFactory
    ) {
    }
 
    public function ‪process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
    {
        if (!$this->‪canHandleRequest($request)) {
            return $handler->handle($request);
        }
 
        $controllerName = $request->getQueryParams()['install']['controller'] ?? 'layout';
        $actionName = $request->getParsedBody()['install']['action'] ?? $request->getQueryParams()['install']['action'] ?? 'init';
 
        if ($actionName === 'showEnableInstallToolFile' && ‪EnableFileService::isInstallToolEnableFilePermanent()) {
            $actionName = 'showLogin';
        }
 
        $action = $actionName . 'Action';
 
        // not session related actions
        if ($actionName === 'init') {
            $controller = $this->container->get(LayoutController::class);
            return $controller->initAction($request);
        }
        if ($actionName === 'checkEnableInstallToolFile') {
            return new ‪JsonResponse([
                'success' => $this->‪checkEnableInstallToolFile(),
            ]);
        }
        if ($actionName === 'showEnableInstallToolFile') {
            $controller = $this->container->get(LoginController::class);
            return $controller->showEnableInstallToolFileAction($request);
        }
        if ($actionName === 'showLogin') {
            if (!$this->‪checkEnableInstallToolFile()) {
                throw new \RuntimeException('Not authorized', 1505564888);
            }
            $controller = $this->container->get(LoginController::class);
            return $controller->showLoginAction($request);
        }
 
        // session related actions
        $session = new SessionService();
 
        // the backend user has an active session but the admin / maintainer
        // rights have been revoked or the user was disabled or deleted in the meantime
        if ($session->isAuthorizedBackendUserSession($request) && !$session->hasActiveBackendUserRoleAndSession()) {
            // log out the user and destroy the session
            $session->resetSession();
            $session->destroySession($request);
            $formProtection = $this->formProtectionFactory->createFromRequest($request);
            $formProtection->clean();
 
            return new ‪HtmlResponse('', 403);
        }
 
        if ($actionName === 'preAccessCheck') {
            $response = new ‪JsonResponse([
                'installToolLocked' => !$this->‪checkEnableInstallToolFile(),
                'isAuthorized' => $session->isAuthorized($request),
            ]);
        } elseif ($actionName === 'checkLogin') {
            if (!$this->‪checkEnableInstallToolFile() && !$session->isAuthorizedBackendUserSession($request)) {
                throw new \RuntimeException('Not authorized', 1505563556);
            }
            if ($session->isAuthorized($request)) {
                $session->refreshSession();
                $response = new ‪JsonResponse([
                    'success' => true,
                ]);
            } else {
                // Session expired, log out user, start new session
                $session->resetSession();
                $session->startSession();
                $response = new ‪JsonResponse([
                    'success' => false,
                ]);
            }
        } elseif ($actionName === 'login') {
            $session->initializeSession();
            if (!$this->‪checkEnableInstallToolFile()) {
                throw new \RuntimeException('Not authorized', 1505567462);
            }
            $this->‪checkSessionToken($request, $session);
            $this->‪checkSessionLifetime($request, $session);
            $password = $request->getParsedBody()['install']['password'] ?? null;
            $authService = $this->container->get(AuthenticationService::class);
            if ($authService->loginWithPassword($password, $request, $session)) {
                $response = new ‪JsonResponse([
                    'success' => true,
                ]);
            } else {
                if ($password === null || empty($password)) {
                    $messageQueue = new ‪FlashMessageQueue('install');
                    $messageQueue->enqueue(
                        new ‪FlashMessage('Please enter the install tool password', '', ContextualFeedbackSeverity::ERROR)
                    );
                } else {
                    $hashInstance = $this->passwordHashFactory->getDefaultHashInstance('BE');
                    $hashedPassword = $hashInstance->getHashedPassword($password);
                    $messageQueue = new ‪FlashMessageQueue('install');
                    $messageQueue->enqueue(
                        new ‪FlashMessage(
                            'Given password does not match the install tool login password. Calculated hash: ' . $hashedPassword,
                            '',
                            ContextualFeedbackSeverity::ERROR
                        )
                    );
                }
                $response = new ‪JsonResponse([
                    'success' => false,
                    'status' => $messageQueue,
                ]);
            }
        } elseif ($actionName === 'logout') {
            if (‪EnableFileService::installToolEnableFileExists() && !‪EnableFileService::isInstallToolEnableFilePermanent()) {
                ‪EnableFileService::removeInstallToolEnableFile();
            }
            $formProtection = $this->formProtectionFactory->createFromRequest($request);
            $formProtection->clean();
            $session->destroySession($request);
            $response = new ‪JsonResponse([
                'success' => true,
            ]);
        } else {
            $enforceReferrerResponse = $this->‪enforceReferrer($request);
            if ($enforceReferrerResponse instanceof ResponseInterface) {
                return $enforceReferrerResponse;
            }
            $session->initializeSession();
            if (
                !$this->‪checkSessionToken($request, $session)
                || !$this->‪checkSessionLifetime($request, $session)
                || !$session->isAuthorized($request)
            ) {
                return new ‪HtmlResponse('', 403);
            }
            $session->refreshSession();
            if (!array_key_exists($controllerName, $this->controllers)) {
                throw new \RuntimeException(
                    'Unknown controller ' . $controllerName,
                    1505215756
                );
            }
            $this->packageManager->recreatePackageStatesFileIfMissing();
            $className = $this->controllers[$controllerName];
            $controller = $this->container->get($className);
            if (!method_exists($controller, $action)) {
                throw new \RuntimeException(
                    'Unknown action method ' . $action . ' in controller ' . $controllerName,
                    1505216027
                );
            }
            $response = $controller->$action($request);
        }
 
        return $response;
    }
 
    protected function ‪canHandleRequest(ServerRequestInterface $request): bool
    {
        $basicIntegrity = $this->‪checkIfEssentialConfigurationExists()
            && !empty(‪$GLOBALS['TYPO3_CONF_VARS']['BE']['installToolPassword'])
            && !‪EnableFileService::isFirstInstallAllowed();
        if (!$basicIntegrity) {
            return false;
        }
        return true;
    }
 
    protected function ‪checkEnableInstallToolFile()
    {
        return ‪EnableFileService::checkInstallToolEnableFile();
    }
 
    protected function ‪checkSessionToken(ServerRequestInterface $request, SessionService $session): bool
    {
        $postValues = $request->getParsedBody()['install'] ?? null;
        // no post data is there, so no token check necessary
        if (empty($postValues)) {
            return true;
        }
        $tokenOk = false;
        // A token must be given as soon as there is POST data
        if (isset($postValues['token'])) {
            $formProtection = $this->formProtectionFactory->createFromRequest($request);
            $action = (string)$postValues['action'];
            if ($action === '') {
                throw new \RuntimeException(
                    'No POST action given for token check',
                    1369326593
                );
            }
            $tokenOk = $formProtection->validateToken($postValues['token'], 'installTool', $action);
        }
        if (!$tokenOk) {
            $session->resetSession();
            $session->startSession();
        }
        return $tokenOk;
    }
 
    protected function ‪checkSessionLifetime(ServerRequestInterface $request, SessionService $session): bool
    {
        $isExpired = $session->isExpired($request);
        if ($isExpired) {
            // Session expired, log out user, start new session
            $session->resetSession();
            $session->startSession();
        }
        return !$isExpired;
    }
 
    protected function ‪checkIfEssentialConfigurationExists(): bool
    {
        if (file_exists($this->configurationManager->getSystemConfigurationFileLocation())) {
            return true;
        }
        // Check can be removed with TYPO3 v14.0
        if (file_exists($this->configurationManager->getLocalConfigurationFileLocation())) {
            mkdir(dirname($this->configurationManager->getSystemConfigurationFileLocation()), 02775, true);
            rename($this->configurationManager->getLocalConfigurationFileLocation(), $this->configurationManager->getSystemConfigurationFileLocation());
            if (file_exists(‪Environment::getLegacyConfigPath() . '/AdditionalConfiguration.php')) {
                rename(‪Environment::getLegacyConfigPath() . '/AdditionalConfiguration.php', $this->configurationManager->getAdditionalConfigurationFileLocation());
            }
 
            return file_exists($this->configurationManager->getSystemConfigurationFileLocation());
        }
        return false;
    }
 
    protected function ‪enforceReferrer(ServerRequestInterface $request): ?ResponseInterface
    {
        if (!(new ‪Features())->isFeatureEnabled('security.backend.enforceReferrer')) {
            return null;
        }
        return (new ‪ReferrerEnforcer($request))->handle([
            'flags' => ['refresh-always'],
            'subject' => 'Install Tool',
        ]);
    }
}