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

Public Member Functions
	__construct (UriBuilder $uriBuilder, MfaProviderRegistry $mfaProviderRegistry, ModuleTemplateFactory $moduleTemplateFactory, AuthenticationStyleInformation $authenticationStyleInformation, PageRenderer $pageRenderer, LoggerInterface $logger)

	handleRequest (ServerRequestInterface $request)

	setupAction (ServerRequestInterface $request)

	activateAction (ServerRequestInterface $request)

	cancelAction (ServerRequestInterface $request)

‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\Controller\AbstractMfaController
	__construct (UriBuilder $uriBuilder, MfaProviderRegistry $mfaProviderRegistry, ModuleTemplateFactory $moduleTemplateFactory)

Protected Member Functions
	renderSelectionView (ServerRequestInterface $request)

	renderSetupView (ServerRequestInterface $request, MfaProviderManifestInterface $mfaProvider)

	initializeView (ServerRequestInterface $request, string $templateName)

	addCustomAuthenticationFormStyles ()

	isValidIdentifier (string $identifier)

	addSuccessMessage (string $mfaProviderTitle)

	log (string $message, ?MfaProviderManifestInterface $mfaProvider=null)

‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\Controller\AbstractMfaController
	isActionAllowed (string $action)

	isProviderAllowed (string $identifier)

	initializeMfaConfiguration ()

	getRecommendedProvider ()

	getBackendUser ()

	getLanguageService ()

Protected Attributes
const	ACTION_METHOD_MAP

AuthenticationStyleInformation	$authenticationStyleInformation

PageRenderer	$pageRenderer

LoggerInterface	$logger

‪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 the standalone setup endpoint for multi-factor authentication

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

Definition at line 45 of file MfaSetupController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Controller\MfaSetupController::__construct	(	UriBuilder	$uriBuilder,
		MfaProviderRegistry	$mfaProviderRegistry,
		ModuleTemplateFactory	$moduleTemplateFactory,
		AuthenticationStyleInformation	$authenticationStyleInformation,
		PageRenderer	$pageRenderer,
		LoggerInterface	$logger
	)

Definition at line 57 of file MfaSetupController.php.

References TYPO3\CMS\Backend\Controller\MfaSetupController\$authenticationStyleInformation, TYPO3\CMS\Backend\Controller\MfaSetupController\$logger, TYPO3\CMS\Backend\Controller\AbstractMfaController\$mfaProviderRegistry, TYPO3\CMS\Backend\Controller\AbstractMfaController\$moduleTemplateFactory, TYPO3\CMS\Backend\Controller\MfaSetupController\$pageRenderer, and TYPO3\CMS\Backend\Controller\AbstractMfaController\$uriBuilder.

Member Function Documentation

◆ activateAction()

TYPO3\CMS\Backend\Controller\MfaSetupController::activateAction ( ServerRequestInterface $request )

Handle activate request, receiving from the setup view by forwarding the request to the appropriate provider.

Definition at line 116 of file MfaSetupController.php.

References TYPO3\CMS\Backend\Controller\MfaSetupController\addSuccessMessage(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\create(), TYPO3\CMS\Backend\Routing\RouteRedirect\createFromRequest(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getBackendUser(), TYPO3\CMS\Backend\Controller\MfaSetupController\isValidIdentifier(), and TYPO3\CMS\Backend\Controller\MfaSetupController\log().

◆ addCustomAuthenticationFormStyles()

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

protected

Definition at line 222 of file MfaSetupController.php.

Referenced by TYPO3\CMS\Backend\Controller\MfaSetupController\initializeView().

◆ addSuccessMessage()

TYPO3\CMS\Backend\Controller\MfaSetupController::addSuccessMessage ( string $mfaProviderTitle )

protected

Add a flash message to inform the user about the successful activation of MFA and store this in the session, so it will be shown in the backend after the redirect.

Definition at line 246 of file MfaSetupController.php.

References TYPO3\CMS\Backend\Controller\AbstractMfaController\getLanguageService(), and TYPO3\CMS\Core\Messaging\AbstractMessage\OK.

Referenced by TYPO3\CMS\Backend\Controller\MfaSetupController\activateAction().

◆ cancelAction()

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

Allow the user to cancel the multi-factor authentication setup process 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 156 of file MfaSetupController.php.

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

◆ handleRequest()

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

Main action for handling the request and returning the response

Parameters

ServerRequestInterface $request

Returns: ‪ResponseInterface

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

Definition at line 71 of file MfaSetupController.php.

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

◆ initializeView()

TYPO3\CMS\Backend\Controller\MfaSetupController::initializeView	(	ServerRequestInterface	$request,
		string	$templateName
	)

protected

Initialize the standalone view by setting the paths and assigning view variables

Definition at line 205 of file MfaSetupController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\MfaSetupController\addCustomAuthenticationFormStyles(), and TYPO3\CMS\Fluid\View\AbstractTemplateView\setTemplateRootPaths().

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

◆ isValidIdentifier()

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

protected

Extend base identifier check to further evaluate whether the provider is allowed to be a default provider.

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

Definition at line 236 of file MfaSetupController.php.

Referenced by TYPO3\CMS\Backend\Controller\MfaSetupController\activateAction(), and TYPO3\CMS\Backend\Controller\MfaSetupController\setupAction().

◆ log()

TYPO3\CMS\Backend\Controller\MfaSetupController::log	(	string	$message,
		?MfaProviderManifestInterface	$mfaProvider = `null`
	)

protected

Log debug information for MFA setup events

Definition at line 263 of file MfaSetupController.php.

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

Referenced by TYPO3\CMS\Backend\Controller\MfaSetupController\activateAction(), TYPO3\CMS\Backend\Controller\MfaSetupController\cancelAction(), and TYPO3\CMS\Backend\Controller\MfaSetupController\setupAction().

◆ renderSelectionView()

TYPO3\CMS\Backend\Controller\MfaSetupController::renderSelectionView ( ServerRequestInterface $request )

protected

Allow the user - required to set up MFA - to select between all available providers

Definition at line 166 of file MfaSetupController.php.

References TYPO3\CMS\Backend\Controller\AbstractMfaController\getRecommendedProvider(), and TYPO3\CMS\Backend\Controller\MfaSetupController\initializeView().

Referenced by TYPO3\CMS\Backend\Controller\MfaSetupController\setupAction().

◆ renderSetupView()

TYPO3\CMS\Backend\Controller\MfaSetupController::renderSetupView	(	ServerRequestInterface	$request,
		MfaProviderManifestInterface	$mfaProvider
	)

protected

Render form to setup a provider by using provider specific content

Definition at line 186 of file MfaSetupController.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\create(), TYPO3\CMS\Backend\Controller\AbstractMfaController\getBackendUser(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface\handleRequest(), TYPO3\CMS\Backend\Controller\MfaSetupController\initializeView(), and TYPO3\CMS\Core\Authentication\Mfa\MfaViewType\SETUP.

Referenced by TYPO3\CMS\Backend\Controller\MfaSetupController\setupAction().

◆ setupAction()

TYPO3\CMS\Backend\Controller\MfaSetupController::setupAction ( ServerRequestInterface $request )

Render form to setup a provider by using provider specific content. Fall back to provider selection view, in case no valid provider was yet selected.

Definition at line 99 of file MfaSetupController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\MfaSetupController\isValidIdentifier(), TYPO3\CMS\Backend\Controller\MfaSetupController\log(), TYPO3\CMS\Backend\Controller\MfaSetupController\renderSelectionView(), and TYPO3\CMS\Backend\Controller\MfaSetupController\renderSetupView().

Member Data Documentation

◆ $authenticationStyleInformation

AuthenticationStyleInformation TYPO3\CMS\Backend\Controller\MfaSetupController::$authenticationStyleInformation

protected

Definition at line 53 of file MfaSetupController.php.

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

◆ $logger

LoggerInterface TYPO3\CMS\Backend\Controller\MfaSetupController::$logger

protected

Definition at line 55 of file MfaSetupController.php.

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

◆ $pageRenderer

PageRenderer TYPO3\CMS\Backend\Controller\MfaSetupController::$pageRenderer

protected

Definition at line 54 of file MfaSetupController.php.

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

◆ ACTION_METHOD_MAP

const TYPO3\CMS\Backend\Controller\MfaSetupController::ACTION_METHOD_MAP

protected

Initial value:

= [
        'setup' => 'GET',
        'activate' => 'POST',
        'cancel' => 'GET',
    ]

Definition at line 47 of file MfaSetupController.php.

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activateAction()

◆ addCustomAuthenticationFormStyles()

◆ addSuccessMessage()

◆ cancelAction()

◆ handleRequest()

◆ initializeView()

◆ isValidIdentifier()

◆ log()

◆ renderSelectionView()

◆ renderSetupView()

◆ setupAction()

Member Data Documentation

◆ $authenticationStyleInformation

◆ $logger

◆ $pageRenderer

◆ ACTION_METHOD_MAP