‪TYPO3CMS  11.5
TYPO3\CMS\Backend\Controller\MfaController Class Reference
Inheritance diagram for TYPO3\CMS\Backend\Controller\MfaController:
TYPO3\CMS\Backend\Controller\AbstractMfaController

Public Member Functions

 __construct (UriBuilder $uriBuilder, MfaProviderRegistry $mfaProviderRegistry, ModuleTemplateFactory $moduleTemplateFactory, AuthenticationStyleInformation $authenticationStyleInformation, PageRenderer $pageRenderer)
 
 handleRequest (ServerRequestInterface $request)
 
 authAction (ServerRequestInterface $request, MfaProviderManifestInterface $mfaProvider)
 
 verifyAction (ServerRequestInterface $request, MfaProviderManifestInterface $mfaProvider)
 
 cancelAction (ServerRequestInterface $request)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\Controller\AbstractMfaController
 __construct (UriBuilder $uriBuilder, MfaProviderRegistry $mfaProviderRegistry, ModuleTemplateFactory $moduleTemplateFactory)
 

Protected Member Functions

ProviderInterface[] getAlternativeProviders (MfaProviderManifestInterface $mfaProvider)
 
 log (string $message, array $additionalData=[], ?MfaProviderManifestInterface $mfaProvider=null)
 
 getMfaProviderFromRequest (ServerRequestInterface $request)
 
 addCustomAuthenticationFormStyles ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\Controller\AbstractMfaController
 isActionAllowed (string $action)
 
 isProviderAllowed (string $identifier)
 
 isValidIdentifier (string $identifier)
 
 initializeMfaConfiguration ()
 
 getRecommendedProvider ()
 
 getBackendUser ()
 
 getLanguageService ()
 

Protected Attributes

AuthenticationStyleInformation $authenticationStyleInformation
 
PageRenderer $pageRenderer
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\Controller\AbstractMfaController
UriBuilder $uriBuilder
 
MfaProviderRegistry $mfaProviderRegistry
 
ModuleTemplateFactory $moduleTemplateFactory
 
ModuleTemplate $moduleTemplate
 
array $mfaTsConfig
 
bool $mfaRequired
 
array $allowedProviders
 
array $allowedActions = []
 

Detailed Description

Controller to provide a multi-factor authentication endpoint

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

Definition at line 45 of file MfaController.php.

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCustomAuthenticationFormStyles()

TYPO3\CMS\Backend\Controller\MfaController::addCustomAuthenticationFormStyles ( )
protected

◆ authAction()

◆ cancelAction()

TYPO3\CMS\Backend\Controller\MfaController::cancelAction ( ServerRequestInterface  $request)

Allow the user to cancel the multi-factor authentication by calling logoff on the user object, to destroy the session and other already gathered information and finally initiate a redirect back to the login.

Definition at line 163 of file MfaController.php.

References TYPO3\CMS\Backend\Routing\RouteRedirect\createFromRequest(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getBackendUser(), and TYPO3\CMS\Backend\Controller\MfaController\log().

Referenced by TYPO3\CMS\Backend\Controller\MfaController\handleRequest(), and TYPO3\CMS\Backend\Controller\MfaController\verifyAction().

◆ getAlternativeProviders()

ProviderInterface [] TYPO3\CMS\Backend\Controller\MfaController::getAlternativeProviders ( MfaProviderManifestInterface  $mfaProvider)
protected

◆ getMfaProviderFromRequest()

TYPO3\CMS\Backend\Controller\MfaController::getMfaProviderFromRequest ( ServerRequestInterface  $request)
protected

◆ handleRequest()

TYPO3\CMS\Backend\Controller\MfaController::handleRequest ( ServerRequestInterface  $request)

Main entry point, checking prerequisite, initializing and setting up the view and finally dispatching to the requested action.

Reimplemented from TYPO3\CMS\Backend\Controller\AbstractMfaController.

Definition at line 68 of file MfaController.php.

References TYPO3\CMS\Backend\Controller\MfaController\cancelAction(), and TYPO3\CMS\Backend\Controller\MfaController\getMfaProviderFromRequest().

◆ log()

TYPO3\CMS\Backend\Controller\MfaController::log ( string  $message,
array  $additionalData = [],
?MfaProviderManifestInterface  $mfaProvider = null 
)
protected

◆ verifyAction()

Member Data Documentation

◆ $authenticationStyleInformation

AuthenticationStyleInformation TYPO3\CMS\Backend\Controller\MfaController::$authenticationStyleInformation
protected

◆ $pageRenderer

PageRenderer TYPO3\CMS\Backend\Controller\MfaController::$pageRenderer
protected