MfaAjaxController::deactivateAction() - Code Metrics - Inspection of "[FEATURE] Introduce MFA in Core" - TYPO3/TYPO3.CMS - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 25a926...39145a )

unknown
created 2021-02-19 14:39 UTC
MfaAjaxController::deactivateAction() B

↳ Parent: MfaAjaxController
Complexity

Conditions	7
Paths	7
Size

Total Lines	33
Code Lines	19
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	19
c	1
b	0
f	0
dl	0
loc	33
rs	8.8333
cc	7
nc	7
nop	1
<?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\Controller;

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use TYPO3\CMS\Core\Authentication\AbstractUserAuthentication;
use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager;
use TYPO3\CMS\Core\Authentication\Mfa\MfaProviderRegistry;
use TYPO3\CMS\Core\Http\JsonResponse;
use TYPO3\CMS\Core\Localization\LanguageService;
use TYPO3\CMS\Core\Messaging\FlashMessage;
use TYPO3\CMS\Core\Messaging\FlashMessageQueue;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication;

/**
 * Controller to manipulate MFA providers via AJAX in the backend
 *
 * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
 */
class MfaAjaxController
{
    private const ALLOWED_ACTIONS = ['deactivate'];

    protected MfaProviderRegistry $mfaProviderRegistry;
    protected ?AbstractUserAuthentication $user = null;

    public function __construct(MfaProviderRegistry $mfaProviderRegistry)
    {
        $this->mfaProviderRegistry = $mfaProviderRegistry;
    }

    /**
     * Main entry point, checking prerequisite and dispatching to the requested action
     *
     * @param ServerRequestInterface $request
     * @return ResponseInterface
     */
    public function handleRequest(ServerRequestInterface $request): ResponseInterface
    {
        $action = (string)($request->getQueryParams()['action'] ?? $request->getParsedBody()['action'] ?? '');

        if (!in_array($action, self::ALLOWED_ACTIONS, true)) {
            return new JsonResponse($this->getResponseData(false, $this->getLanguageService()->sL('LLL:EXT:backend/Resources/Private/Language/locallang_mfa.xlf:ajax.invalidRequest')));
        }

        $userId = (int)($request->getParsedBody()['userId'] ?? 0);
        $tableName = (string)($request->getParsedBody()['tableName'] ?? '');

        if (!$userId || !in_array($tableName, ['be_users', 'fe_users'], true)) {
            return new JsonResponse($this->getResponseData(false, $this->getLanguageService()->sL('LLL:EXT:backend/Resources/Private/Language/locallang_mfa.xlf:ajax.invalidRequest')));
        }

        $this->user = $this->initializeUser($userId, $tableName);

        if (!$this->isAllowedToPerformAction($action)) {
            return new JsonResponse($this->getResponseData(false, $this->getLanguageService()->sL('LLL:EXT:backend/Resources/Private/Language/locallang_mfa.xlf:ajax.insufficientPermissions')));
        }

        return new JsonResponse($this->{$action . 'Action'}($request));
    }

    /**
     * Deactivate MFA providers
     * If the request contains a provider, it will be deactivated.
     * Otherwise all active providers are deactivated.
     *
     * @param ServerRequestInterface $request
     * @return array
     */
    protected function deactivateAction(ServerRequestInterface $request): array
    {
        $lang = $this->getLanguageService();
        $userName = (string)($this->user->user[$this->user->username_column] ?? '');
        $providerToDeactivate = (string)($request->getParsedBody()['provider'] ?? '');

        if ($providerToDeactivate === '') {
            // In case no provider is given, try to deactivate all active providers
            $providersToDeactivate = $this->mfaProviderRegistry->getActiveProviders($this->user);
            $providersToDeactivate = $this->mfaProviderRegistry->getActiveProviders(/** @scrutinizer ignore-type */ $this->user);
            if ($providersToDeactivate === []) {
                return $this->getResponseData(false, $lang->sL('LLL:EXT:backend/Resources/Private/Language/locallang_mfa.xlf:ajax.deactivate.providersNotDeactivated'));
            }
            foreach ($providersToDeactivate as $identifier => $provider) {
                $propertyManager = MfaProviderPropertyManager::create($provider, $this->user);
                $propertyManager = MfaProviderPropertyManager::create($provider, /** @scrutinizer ignore-type */ $this->user);
                if (!$provider->deactivate($request, $propertyManager)) {
                    return $this->getResponseData(false, sprintf($lang->sL('LLL:EXT:backend/Resources/Private/Language/locallang_mfa.xlf:ajax.deactivate.providerNotDeactivated'), $lang->sL($provider->getTitle())));
                }
            }
            return $this->getResponseData(true, sprintf($lang->sL('LLL:EXT:backend/Resources/Private/Language/locallang_mfa.xlf:ajax.deactivate.providersDeactivated'), $userName));
        }

        if (!$this->mfaProviderRegistry->hasProvider($providerToDeactivate)) {
            return $this->getResponseData(false, sprintf($lang->sL('LLL:EXT:backend/Resources/Private/Language/locallang_mfa.xlf:ajax.deactivate.providerNotFound'), $providerToDeactivate));
        }

        $provider = $this->mfaProviderRegistry->getProvider($providerToDeactivate);
        $propertyManager = MfaProviderPropertyManager::create($provider, $this->user);

        if (!$provider->deactivate($request, $propertyManager)) {
            return $this->getResponseData(false, sprintf($lang->sL('LLL:EXT:backend/Resources/Private/Language/locallang_mfa.xlf:ajax.deactivate.providerNotDeactivated'), $lang->sL($provider->getTitle())));
        }

        return $this->getResponseData(true, sprintf($lang->sL('LLL:EXT:backend/Resources/Private/Language/locallang_mfa.xlf:ajax.deactivate.providerDeactivated'), $lang->sL($provider->getTitle()), $userName));
    }

    /**
     * Initialize a user based on the table name
     *
     * @param int $userId
     * @param string $tableName
     * @return AbstractUserAuthentication
     */
    protected function initializeUser(int $userId, string $tableName): AbstractUserAuthentication
    {
        $user = $tableName === 'be_users'
            ? GeneralUtility::makeInstance(BackendUserAuthentication::class)
            : GeneralUtility::makeInstance(FrontendUserAuthentication::class);

        $user->enablecolumns = ['deleted' => true];
        $user->setBeUserByUid($userId);

        return $user;
    }

    /**
     * Prepare response data for a JSON response
     *
     * @param bool $success
     * @param string $message
     * @return array
     */
    protected function getResponseData(bool $success, string $message): array
    {
        return [
            'success' => $success,
            'status' => (new FlashMessageQueue('backend'))->enqueue(
                new FlashMessage(
                    $message,
                    $this->getLanguageService()->sL('LLL:EXT:backend/Resources/Private/Language/locallang_mfa.xlf:ajax.' . ($success ? 'success' : 'error'))
                )
            ),
            'remaining' => count($this->mfaProviderRegistry->getActiveProviders($this->user))
            'remaining' => count($this->mfaProviderRegistry->getActiveProviders(/** @scrutinizer ignore-type */ $this->user))
        ];
    }

    /**
     * Check if the current logged in user is allowed to perform
     * the requested action on the selected user.
     *
     * @param string $action
     * @return bool
     */
    protected function isAllowedToPerformAction(string $action): bool
    {
        if ($action === 'deactivate') {
            $currentBackendUser = $this->getBackendUser();
            // Only admins are allowed to deactivate providers
            if (!$currentBackendUser->isAdmin()) {
                return false;
            }
            // System maintainer checks are only required for backend users
            if ($this->user instanceof BackendUserAuthentication) {
                $systemMaintainer = array_map('intval', $GLOBALS['TYPO3_CONF_VARS']['SYS']['systemMaintainers'] ?? []);
                $isCurrentBackendUserSystemMaintainer = in_array((int)$currentBackendUser->user[$currentBackendUser->userid_column], $systemMaintainer, true);
                $isTargetUserSystemMaintainer = in_array((int)$this->user->user[$this->user->userid_column], $systemMaintainer, true);
                // Providers from system maintainers can only be deactivated by system maintainers
                if ($isTargetUserSystemMaintainer && !$isCurrentBackendUserSystemMaintainer) {
                    return false;
                }
            }
            return true;
        }

        return false;
    }

    protected function getBackendUser(): BackendUserAuthentication
    {
        return $GLOBALS['BE_USER'];
    }

    protected function getLanguageService(): LanguageService
    {
        return $GLOBALS['LANG'];
    }
}

TYPO3 / TYPO3.CMS

Push — master ( 25a926...39145a )

MfaAjaxController::deactivateAction() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
