TYPO3\CMS\Backend\Controller\MfaController Class Reference

Inheritance diagram for TYPO3\CMS\Backend\Controller\MfaController:

Public Member Functions
	__construct (protected readonly UriBuilder $uriBuilder, protected readonly AuthenticationStyleInformation $authenticationStyleInformation, protected readonly PageRenderer $pageRenderer, protected readonly ExtensionConfiguration $extensionConfiguration, protected readonly LoggerInterface $logger, protected readonly BackendViewFactory $backendViewFactory, protected readonly EventDispatcherInterface $eventDispatcher,)
	handleRequest (ServerRequestInterface $request)
‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\Controller\AbstractMfaController
	injectMfaProviderRegistry (MfaProviderRegistry $mfaProviderRegistry)

Protected Member Functions
	authAction (ServerRequestInterface $request, MfaProviderManifestInterface $mfaProvider)
	verifyAction (ServerRequestInterface $request, MfaProviderManifestInterface $mfaProvider)
	cancelAction (ServerRequestInterface $request)
ProviderInterface[]	getAlternativeProviders (MfaProviderManifestInterface $mfaProvider)
	log (string $message, array $additionalData=[], ?MfaProviderManifestInterface $mfaProvider=null, int $action=Login::LOGIN, int $error=SystemLogErrorClassification::MESSAGE)
	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 Member Functions inherited from ‪TYPO3\CMS\Backend\Template\PageRendererBackendSetupTrait
	setUpBasicPageRendererForBackend (PageRenderer $pageRenderer, ExtensionConfiguration $extensionConfiguration, ServerRequestInterface $request, LanguageService $languageService,)
	loadStylesheets (PageRenderer $pageRenderer)
	getBackendFavicon (ExtensionConfiguration $extensionConfiguration, ServerRequestInterface $request)
string	getUriForFileName (ServerRequestInterface $request, string $filename)
	getNormalizedParams (ServerRequestInterface $request)

Additional Inherited Members
‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\Controller\AbstractMfaController
MfaProviderRegistry	$mfaProviderRegistry
array	$mfaTsConfig
bool	$mfaRequired
array	$allowedProviders
array	$allowedActions = []

Detailed Description

Controller to provide a multi-factor authentication endpoint. This is the backend login related view to authenticate against chosen MFA provider.

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

Definition at line 49 of file MfaController.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Controller\MfaController::__construct	(	protected readonly UriBuilder	$uriBuilder,
		protected readonly AuthenticationStyleInformation	$authenticationStyleInformation,
		protected readonly PageRenderer	$pageRenderer,
		protected readonly ExtensionConfiguration	$extensionConfiguration,
		protected readonly LoggerInterface	$logger,
		protected readonly BackendViewFactory	$backendViewFactory,
		protected readonly EventDispatcherInterface	$eventDispatcher
	)

Definition at line 52 of file MfaController.php.

Member Function Documentation

addCustomAuthenticationFormStyles()

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

protected

Definition at line 232 of file MfaController.php.

Referenced by TYPO3\CMS\Backend\Controller\MfaController\authAction().

authAction()

TYPO3\CMS\Backend\Controller\MfaController::authAction ( ServerRequestInterface  $request, MfaProviderManifestInterface  $mfaProvider  )

protected

Set up the authentication view for the provider by using provider specific content.

Definition at line 91 of file MfaController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\MfaController\addCustomAuthenticationFormStyles(), TYPO3\CMS\Core\Authentication\Mfa\AUTH, TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\create(), TYPO3\CMS\Backend\Routing\RouteRedirect\createFromRequest(), TYPO3\CMS\Backend\Controller\MfaController\getAlternativeProviders(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getBackendUser(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getLanguageService(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface\handleRequest(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface\isLocked(), and TYPO3\CMS\Backend\Template\PageRendererBackendSetupTrait\setUpBasicPageRendererForBackend().

cancelAction()

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

protected

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 165 of file MfaController.php.

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

Fetch alternative (activated and allowed) providers for the user to chose from

Returns

‪ProviderInterface[]

Definition at line 177 of file MfaController.php.

Referenced by TYPO3\CMS\Backend\Controller\MfaController\authAction().

getMfaProviderFromRequest()

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

protected

Definition at line 218 of file MfaController.php.

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

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 66 of file MfaController.php.

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

log()

TYPO3\CMS\Backend\Controller\MfaController::log ( string  $message, array  $additionalData = [], ?MfaProviderManifestInterface  $mfaProvider = null, int  $action = Login::LOGIN, int  $error = SystemLogErrorClassification::MESSAGE  )

protected

Log debug information for MFA events

Definition at line 188 of file MfaController.php.

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

verifyAction()

TYPO3\CMS\Backend\Controller\MfaController::verifyAction ( ServerRequestInterface  $request, MfaProviderManifestInterface  $mfaProvider  )

protected

Handle verification request, receiving from the auth view by forwarding the request to the appropriate provider.

Definition at line 119 of file MfaController.php.

References TYPO3\CMS\Backend\Controller\MfaController\cancelAction(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface\canProcess(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\create(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getBackendUser(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface\getIdentifier(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface\isLocked(), TYPO3\CMS\Backend\Controller\MfaController\log(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface\verify().