‪TYPO3CMS  11.5
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Backend\Controller\AbstractMfaController Class Reference
Inheritance diagram for TYPO3\CMS\Backend\Controller\AbstractMfaController:
TYPO3\CMS\Backend\Controller\MfaConfigurationController TYPO3\CMS\Backend\Controller\MfaController TYPO3\CMS\Backend\Controller\MfaSetupController

Public Member Functions

 __construct (UriBuilder $uriBuilder, MfaProviderRegistry $mfaProviderRegistry, ModuleTemplateFactory $moduleTemplateFactory)
 
ResponseInterface handleRequest (ServerRequestInterface $request)
 

Protected Member Functions

 isActionAllowed (string $action)
 
 isProviderAllowed (string $identifier)
 
 isValidIdentifier (string $identifier)
 
 initializeMfaConfiguration ()
 
 getRecommendedProvider ()
 
 getBackendUser ()
 
 getLanguageService ()
 

Protected Attributes

UriBuilder $uriBuilder
 
MfaProviderRegistry $mfaProviderRegistry
 
ModuleTemplateFactory $moduleTemplateFactory
 
ModuleTemplate $moduleTemplate
 
array $mfaTsConfig
 
bool $mfaRequired
 
array $allowedProviders
 
array $allowedActions = []
 

Detailed Description

Abstract class for mfa controllers (configuration and authentication)

This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.

Definition at line 36 of file AbstractMfaController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Controller\AbstractMfaController::__construct ( UriBuilder  $uriBuilder,
MfaProviderRegistry  $mfaProviderRegistry,
ModuleTemplateFactory  $moduleTemplateFactory 
)

Definition at line 47 of file AbstractMfaController.php.

References TYPO3\CMS\Backend\Controller\AbstractMfaController\$mfaProviderRegistry, TYPO3\CMS\Backend\Controller\AbstractMfaController\$moduleTemplateFactory, TYPO3\CMS\Backend\Controller\AbstractMfaController\$uriBuilder, and TYPO3\CMS\Backend\Controller\AbstractMfaController\initializeMfaConfiguration().

Member Function Documentation

◆ getBackendUser()

TYPO3\CMS\Backend\Controller\AbstractMfaController::getBackendUser ( )
protected

Definition at line 122 of file AbstractMfaController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\MfaSetupController\activateAction(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\activateAction(), TYPO3\CMS\Backend\Controller\MfaController\authAction(), TYPO3\CMS\Backend\Controller\MfaSetupController\cancelAction(), TYPO3\CMS\Backend\Controller\MfaController\cancelAction(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\deactivateAction(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\editAction(), TYPO3\CMS\Backend\Controller\MfaController\getAlternativeProviders(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\getDefaultProviderIdentifier(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\getRecommendedProviderIdentifier(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\handleRequest(), TYPO3\CMS\Backend\Controller\MfaSetupController\handleRequest(), TYPO3\CMS\Backend\Controller\AbstractMfaController\initializeMfaConfiguration(), TYPO3\CMS\Backend\Controller\MfaController\log(), TYPO3\CMS\Backend\Controller\MfaSetupController\log(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\removeDefaultProvider(), TYPO3\CMS\Backend\Controller\MfaSetupController\renderSetupView(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\saveAction(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\setDefaultProvider(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\setupAction(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\unlockAction(), and TYPO3\CMS\Backend\Controller\MfaController\verifyAction().

◆ getLanguageService()

TYPO3\CMS\Backend\Controller\AbstractMfaController::getLanguageService ( )
protected

Definition at line 127 of file AbstractMfaController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\MfaConfigurationController\activateAction(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\addFormButtons(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\addOverviewButtons(), TYPO3\CMS\Backend\Controller\MfaSetupController\addSuccessMessage(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\deactivateAction(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\editAction(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\handleRequest(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\saveAction(), and TYPO3\CMS\Backend\Controller\MfaConfigurationController\unlockAction().

◆ getRecommendedProvider()

TYPO3\CMS\Backend\Controller\AbstractMfaController::getRecommendedProvider ( )
protected

Get the recommended provider

Definition at line 102 of file AbstractMfaController.php.

References $GLOBALS, and TYPO3\CMS\Backend\Controller\AbstractMfaController\isValidIdentifier().

Referenced by TYPO3\CMS\Backend\Controller\MfaConfigurationController\getRecommendedProviderIdentifier(), and TYPO3\CMS\Backend\Controller\MfaSetupController\renderSelectionView().

◆ handleRequest()

ResponseInterface TYPO3\CMS\Backend\Controller\AbstractMfaController::handleRequest ( ServerRequestInterface  $request)
abstract

Main action for handling the request and returning the response

Parameters
ServerRequestInterface$request
Returns
‪ResponseInterface

Reimplemented in TYPO3\CMS\Backend\Controller\MfaSetupController, TYPO3\CMS\Backend\Controller\MfaController, and TYPO3\CMS\Backend\Controller\MfaConfigurationController.

◆ initializeMfaConfiguration()

TYPO3\CMS\Backend\Controller\AbstractMfaController::initializeMfaConfiguration ( )
protected

Initialize MFA configuration based on TSconfig and global configuration

Definition at line 86 of file AbstractMfaController.php.

References TYPO3\CMS\Backend\function, and TYPO3\CMS\Backend\Controller\AbstractMfaController\getBackendUser().

Referenced by TYPO3\CMS\Backend\Controller\AbstractMfaController\__construct().

◆ isActionAllowed()

TYPO3\CMS\Backend\Controller\AbstractMfaController::isActionAllowed ( string  $action)
protected

Definition at line 66 of file AbstractMfaController.php.

Referenced by TYPO3\CMS\Backend\Controller\MfaConfigurationController\getActionUri(), and TYPO3\CMS\Backend\Controller\MfaConfigurationController\handleRequest().

◆ isProviderAllowed()

TYPO3\CMS\Backend\Controller\AbstractMfaController::isProviderAllowed ( string  $identifier)
protected

Definition at line 71 of file AbstractMfaController.php.

Referenced by TYPO3\CMS\Backend\Controller\AbstractMfaController\isValidIdentifier().

◆ isValidIdentifier()

TYPO3\CMS\Backend\Controller\AbstractMfaController::isValidIdentifier ( string  $identifier)
protected

Reimplemented in TYPO3\CMS\Backend\Controller\MfaSetupController.

Definition at line 76 of file AbstractMfaController.php.

References TYPO3\CMS\Backend\Controller\AbstractMfaController\isProviderAllowed().

Referenced by TYPO3\CMS\Backend\Controller\MfaConfigurationController\getDefaultProviderIdentifier(), TYPO3\CMS\Backend\Controller\MfaController\getMfaProviderFromRequest(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getRecommendedProvider(), and TYPO3\CMS\Backend\Controller\MfaConfigurationController\handleRequest().

Member Data Documentation

◆ $allowedActions

array TYPO3\CMS\Backend\Controller\AbstractMfaController::$allowedActions = []
protected

Definition at line 45 of file AbstractMfaController.php.

◆ $allowedProviders

array TYPO3\CMS\Backend\Controller\AbstractMfaController::$allowedProviders
protected

Definition at line 44 of file AbstractMfaController.php.

◆ $mfaProviderRegistry

MfaProviderRegistry TYPO3\CMS\Backend\Controller\AbstractMfaController::$mfaProviderRegistry
protected

Definition at line 39 of file AbstractMfaController.php.

Referenced by TYPO3\CMS\Backend\Controller\AbstractMfaController\__construct(), TYPO3\CMS\Backend\Controller\MfaController\__construct(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\__construct(), and TYPO3\CMS\Backend\Controller\MfaSetupController\__construct().

◆ $mfaRequired

bool TYPO3\CMS\Backend\Controller\AbstractMfaController::$mfaRequired
protected

Definition at line 43 of file AbstractMfaController.php.

◆ $mfaTsConfig

array TYPO3\CMS\Backend\Controller\AbstractMfaController::$mfaTsConfig
protected

Definition at line 42 of file AbstractMfaController.php.

◆ $moduleTemplate

ModuleTemplate TYPO3\CMS\Backend\Controller\AbstractMfaController::$moduleTemplate
protected

Definition at line 41 of file AbstractMfaController.php.

◆ $moduleTemplateFactory

ModuleTemplateFactory TYPO3\CMS\Backend\Controller\AbstractMfaController::$moduleTemplateFactory
protected

Definition at line 40 of file AbstractMfaController.php.

Referenced by TYPO3\CMS\Backend\Controller\AbstractMfaController\__construct(), TYPO3\CMS\Backend\Controller\MfaController\__construct(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\__construct(), and TYPO3\CMS\Backend\Controller\MfaSetupController\__construct().

◆ $uriBuilder

UriBuilder TYPO3\CMS\Backend\Controller\AbstractMfaController::$uriBuilder
protected

Definition at line 38 of file AbstractMfaController.php.

Referenced by TYPO3\CMS\Backend\Controller\AbstractMfaController\__construct(), TYPO3\CMS\Backend\Controller\MfaController\__construct(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\__construct(), and TYPO3\CMS\Backend\Controller\MfaSetupController\__construct().