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

Public Member Functions
	__construct (protected readonly IconFactory $iconFactory, protected readonly UriBuilder $uriBuilder, protected readonly ModuleTemplateFactory $moduleTemplateFactory,)

	handleRequest (ServerRequestInterface $request)

‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\Controller\AbstractMfaController
	injectMfaProviderRegistry (MfaProviderRegistry $mfaProviderRegistry)

Protected Member Functions
	overviewAction (ServerRequestInterface $request)

	setupAction (ServerRequestInterface $request, MfaProviderManifestInterface $mfaProvider)

	activateAction (ServerRequestInterface $request, MfaProviderManifestInterface $mfaProvider)

	deactivateAction (ServerRequestInterface $request, MfaProviderManifestInterface $mfaProvider)

	unlockAction (ServerRequestInterface $request, MfaProviderManifestInterface $mfaProvider)

	editAction (ServerRequestInterface $request, MfaProviderManifestInterface $mfaProvider)

	saveAction (ServerRequestInterface $request, MfaProviderManifestInterface $mfaProvider)

	getActionUri (string $action, array $additionalParameters=[])

	hasSuitableDefaultProviders (array $excludedProviders=[])

	getDefaultProviderIdentifier ()

	getRecommendedProviderIdentifier ()

	isDefaultProvider (MfaProviderManifestInterface $mfaProvider)

	setDefaultProvider (MfaProviderManifestInterface $mfaProvider)

	removeDefaultProvider ()

	addFlashMessage (string $message, string $title='', ContextualFeedbackSeverity $severity=ContextualFeedbackSeverity::INFO)

	addOverviewButtons (ServerRequestInterface $request)

	addFormButtons ()

	getReturnUrl (ServerRequestInterface $request)

‪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
array	$allowedActions = ['overview', 'setup', 'activate', 'deactivate', 'unlock', 'edit', 'save']

ModuleTemplate	$view

‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\Controller\AbstractMfaController
MfaProviderRegistry	$mfaProviderRegistry

array	$mfaTsConfig

bool	$mfaRequired

array	$allowedProviders

array	$allowedActions = []

Private Attributes
array	$providerActionsWhenInactive = ['setup', 'activate']

array	$providerActionsWhenActive = ['deactivate', 'unlock', 'edit', 'save']

Detailed Description

Controller to configure MFA providers in the backend

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

Definition at line 47 of file MfaConfigurationController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Controller\MfaConfigurationController::__construct	(	protected readonly IconFactory	$iconFactory,
		protected readonly UriBuilder	$uriBuilder,
		protected readonly ModuleTemplateFactory	$moduleTemplateFactory
	)

Definition at line 54 of file MfaConfigurationController.php.

Member Function Documentation

◆ activateAction()

TYPO3\CMS\Backend\Controller\MfaConfigurationController::activateAction	(	ServerRequestInterface	$request,
		MfaProviderManifestInterface	$mfaProvider
	)

protected

Handle activate request, receiving from the setup view by forwarding the request to the appropriate provider. Furthermore, add the provider as default provider in case it is the recommended provider for this user, or no default provider is yet defined the newly activated provider is allowed to be a default provider and there are no other providers which would suite as default provider.

Definition at line 157 of file MfaConfigurationController.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface\activate(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\addFlashMessage(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\create(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\getActionUri(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getBackendUser(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\getDefaultProviderIdentifier(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface\getIdentifier(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getLanguageService(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\getRecommendedProviderIdentifier(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface\getTitle(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface\isActive(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface\isDefaultProviderAllowed(), and TYPO3\CMS\Backend\Controller\MfaConfigurationController\setDefaultProvider().

◆ addFlashMessage()

TYPO3\CMS\Backend\Controller\MfaConfigurationController::addFlashMessage	(	string	$message,
		string	$title = `''`,
		ContextualFeedbackSeverity	$severity = `ContextualFeedbackSeverity::INFO`
	)

protected

Definition at line 348 of file MfaConfigurationController.php.

Referenced by TYPO3\CMS\Backend\Controller\MfaConfigurationController\activateAction(), 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().

◆ addFormButtons()

TYPO3\CMS\Backend\Controller\MfaConfigurationController::addFormButtons ( )

protected

Definition at line 378 of file MfaConfigurationController.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_LEFT, and TYPO3\CMS\Backend\Controller\AbstractMfaController\getLanguageService().

Referenced by TYPO3\CMS\Backend\Controller\MfaConfigurationController\editAction(), and TYPO3\CMS\Backend\Controller\MfaConfigurationController\setupAction().

◆ addOverviewButtons()

TYPO3\CMS\Backend\Controller\MfaConfigurationController::addOverviewButtons ( ServerRequestInterface $request )

protected

Definition at line 356 of file MfaConfigurationController.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_RIGHT, TYPO3\CMS\Backend\Controller\AbstractMfaController\getLanguageService(), and TYPO3\CMS\Backend\Controller\MfaConfigurationController\getReturnUrl().

Referenced by TYPO3\CMS\Backend\Controller\MfaConfigurationController\overviewAction().

◆ deactivateAction()

TYPO3\CMS\Backend\Controller\MfaConfigurationController::deactivateAction	(	ServerRequestInterface	$request,
		MfaProviderManifestInterface	$mfaProvider
	)

protected

Handle deactivate request by forwarding the request to the appropriate provider. Also remove the provider as default provider from user UC, if set.

Definition at line 192 of file MfaConfigurationController.php.

References TYPO3\CMS\Backend\Controller\MfaConfigurationController\addFlashMessage(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\create(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface\deactivate(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\getActionUri(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getBackendUser(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getLanguageService(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface\getTitle(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\isDefaultProvider(), and TYPO3\CMS\Backend\Controller\MfaConfigurationController\removeDefaultProvider().

◆ editAction()

TYPO3\CMS\Backend\Controller\MfaConfigurationController::editAction	(	ServerRequestInterface	$request,
		MfaProviderManifestInterface	$mfaProvider
	)

protected

Render form to edit a provider by using provider specific content

Definition at line 225 of file MfaConfigurationController.php.

References TYPO3\CMS\Backend\Controller\MfaConfigurationController\addFlashMessage(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\addFormButtons(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\create(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\getActionUri(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getBackendUser(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getLanguageService(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface\handleRequest(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface\isLocked().

◆ getActionUri()

TYPO3\CMS\Backend\Controller\MfaConfigurationController::getActionUri	(	string	$action,
		array	$additionalParameters = `[]`
	)

protected

Build a uri for the current controller based on the given action, respecting additional parameters.

Definition at line 271 of file MfaConfigurationController.php.

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

Referenced by TYPO3\CMS\Backend\Controller\MfaConfigurationController\activateAction(), 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().

◆ getDefaultProviderIdentifier()

TYPO3\CMS\Backend\Controller\MfaConfigurationController::getDefaultProviderIdentifier ( )

protected

Get the default provider

Definition at line 298 of file MfaConfigurationController.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\create(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getBackendUser(), TYPO3\CMS\Backend\Controller\AbstractMfaController\isValidIdentifier(), and TYPO3\CMS\Backend\Controller\MfaConfigurationController\removeDefaultProvider().

Referenced by TYPO3\CMS\Backend\Controller\MfaConfigurationController\activateAction(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\isDefaultProvider(), and TYPO3\CMS\Backend\Controller\MfaConfigurationController\overviewAction().

◆ getRecommendedProviderIdentifier()

TYPO3\CMS\Backend\Controller\MfaConfigurationController::getRecommendedProviderIdentifier ( )

protected

Get the recommended provider

Definition at line 319 of file MfaConfigurationController.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\create(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getBackendUser(), and TYPO3\CMS\Backend\Controller\AbstractMfaController\getRecommendedProvider().

Referenced by TYPO3\CMS\Backend\Controller\MfaConfigurationController\activateAction(), and TYPO3\CMS\Backend\Controller\MfaConfigurationController\overviewAction().

◆ getReturnUrl()

TYPO3\CMS\Backend\Controller\MfaConfigurationController::getReturnUrl ( ServerRequestInterface $request )

protected

Definition at line 403 of file MfaConfigurationController.php.

References TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded().

Referenced by TYPO3\CMS\Backend\Controller\MfaConfigurationController\addOverviewButtons().

◆ handleRequest()

TYPO3\CMS\Backend\Controller\MfaConfigurationController::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 64 of file MfaConfigurationController.php.

References TYPO3\CMS\Webhooks\Message\$identifier, TYPO3\CMS\Backend\Controller\MfaConfigurationController\addFlashMessage(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\create(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\getActionUri(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getBackendUser(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getLanguageService(), TYPO3\CMS\Backend\Controller\AbstractMfaController\initializeMfaConfiguration(), TYPO3\CMS\Backend\Controller\AbstractMfaController\isActionAllowed(), TYPO3\CMS\Backend\Controller\AbstractMfaController\isValidIdentifier(), and TYPO3\CMS\Backend\Controller\MfaConfigurationController\overviewAction().

◆ hasSuitableDefaultProviders()

TYPO3\CMS\Backend\Controller\MfaConfigurationController::hasSuitableDefaultProviders ( array $excludedProviders = [] )

protected

Check if there are more suitable default providers for the current user

Definition at line 282 of file MfaConfigurationController.php.

References TYPO3\CMS\Webhooks\Message\$identifier, and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\create().

◆ isDefaultProvider()

TYPO3\CMS\Backend\Controller\MfaConfigurationController::isDefaultProvider ( MfaProviderManifestInterface $mfaProvider )

protected

Definition at line 331 of file MfaConfigurationController.php.

References TYPO3\CMS\Backend\Controller\MfaConfigurationController\getDefaultProviderIdentifier(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface\getIdentifier().

Referenced by TYPO3\CMS\Backend\Controller\MfaConfigurationController\deactivateAction(), and TYPO3\CMS\Backend\Controller\MfaConfigurationController\saveAction().

◆ overviewAction()

TYPO3\CMS\Backend\Controller\MfaConfigurationController::overviewAction ( ServerRequestInterface $request )

protected

Setup the overview with all available MFA providers

Definition at line 121 of file MfaConfigurationController.php.

References TYPO3\CMS\Backend\Controller\MfaConfigurationController\addOverviewButtons(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\getDefaultProviderIdentifier(), and TYPO3\CMS\Backend\Controller\MfaConfigurationController\getRecommendedProviderIdentifier().

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

◆ removeDefaultProvider()

TYPO3\CMS\Backend\Controller\MfaConfigurationController::removeDefaultProvider ( )

protected

Definition at line 342 of file MfaConfigurationController.php.

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

Referenced by TYPO3\CMS\Backend\Controller\MfaConfigurationController\deactivateAction(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\getDefaultProviderIdentifier(), and TYPO3\CMS\Backend\Controller\MfaConfigurationController\saveAction().

◆ saveAction()

TYPO3\CMS\Backend\Controller\MfaConfigurationController::saveAction	(	ServerRequestInterface	$request,
		MfaProviderManifestInterface	$mfaProvider
	)

protected

Handle save request, receiving from the edit view by forwarding the request to the appropriate provider.

Definition at line 247 of file MfaConfigurationController.php.

References TYPO3\CMS\Backend\Controller\MfaConfigurationController\addFlashMessage(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\create(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\getActionUri(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getBackendUser(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface\getIdentifier(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getLanguageService(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface\getTitle(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface\isActive(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\isDefaultProvider(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\removeDefaultProvider(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\setDefaultProvider(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface\update().

◆ setDefaultProvider()

TYPO3\CMS\Backend\Controller\MfaConfigurationController::setDefaultProvider ( MfaProviderManifestInterface $mfaProvider )

protected

Definition at line 336 of file MfaConfigurationController.php.

References TYPO3\CMS\Backend\Controller\AbstractMfaController\getBackendUser(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface\getIdentifier().

Referenced by TYPO3\CMS\Backend\Controller\MfaConfigurationController\activateAction(), and TYPO3\CMS\Backend\Controller\MfaConfigurationController\saveAction().

◆ setupAction()

TYPO3\CMS\Backend\Controller\MfaConfigurationController::setupAction	(	ServerRequestInterface	$request,
		MfaProviderManifestInterface	$mfaProvider
	)

protected

Render form to setup a provider by using provider specific content

Definition at line 136 of file MfaConfigurationController.php.

References TYPO3\CMS\Backend\Controller\MfaConfigurationController\addFormButtons(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\create(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getBackendUser(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface\handleRequest().

◆ unlockAction()

TYPO3\CMS\Backend\Controller\MfaConfigurationController::unlockAction	(	ServerRequestInterface	$request,
		MfaProviderManifestInterface	$mfaProvider
	)

protected

Handle unlock request by forwarding the request to the appropriate provider

Definition at line 210 of file MfaConfigurationController.php.

References TYPO3\CMS\Backend\Controller\MfaConfigurationController\addFlashMessage(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\create(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\getActionUri(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getBackendUser(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getLanguageService(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface\getTitle(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface\unlock().

Member Data Documentation

◆ $allowedActions

array TYPO3\CMS\Backend\Controller\MfaConfigurationController::$allowedActions = ['overview', 'setup', 'activate', 'deactivate', 'unlock', 'edit', 'save']

protected

Definition at line 49 of file MfaConfigurationController.php.

◆ $providerActionsWhenActive

array TYPO3\CMS\Backend\Controller\MfaConfigurationController::$providerActionsWhenActive = ['deactivate', 'unlock', 'edit', 'save']

private

Definition at line 51 of file MfaConfigurationController.php.

◆ $providerActionsWhenInactive

array TYPO3\CMS\Backend\Controller\MfaConfigurationController::$providerActionsWhenInactive = ['setup', 'activate']

private

Definition at line 50 of file MfaConfigurationController.php.

◆ $view

ModuleTemplate TYPO3\CMS\Backend\Controller\MfaConfigurationController::$view

protected

Definition at line 52 of file MfaConfigurationController.php.

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activateAction()

◆ addFlashMessage()

◆ addFormButtons()

◆ addOverviewButtons()

◆ deactivateAction()

◆ editAction()

◆ getActionUri()

◆ getDefaultProviderIdentifier()

◆ getRecommendedProviderIdentifier()

◆ getReturnUrl()

◆ handleRequest()

◆ hasSuitableDefaultProviders()

◆ isDefaultProvider()

◆ overviewAction()

◆ removeDefaultProvider()

◆ saveAction()

◆ setDefaultProvider()

◆ setupAction()

◆ unlockAction()

Member Data Documentation

◆ $allowedActions

◆ $providerActionsWhenActive

◆ $providerActionsWhenInactive

◆ $view