MfaController extends AbstractMfaController implements LoggerAwareInterface uses LoggerAwareTrait

Controller to provide a multi-factor authentication endpoint

Internal

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

Table of Contents

Interfaces

LoggerAwareInterface

Properties

$allowedActions  : array<string|int, mixed>
$allowedProviders  : array<string|int, mixed>
$authenticationStyleInformation  : AuthenticationStyleInformation
$mfaProviderRegistry  : MfaProviderRegistry
$mfaRequired  : bool
$mfaTsConfig  : array<string|int, mixed>
$moduleTemplate  : ModuleTemplate|null
$moduleTemplateFactory  : ModuleTemplateFactory
$pageRenderer  : PageRenderer
$uriBuilder  : UriBuilder

Methods

__construct()  : mixed
authAction()  : ResponseInterface
Setup the authentication view for the provider by using provider specific content
cancelAction()  : ResponseInterface
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.
handleRequest()  : ResponseInterface
Main entry point, checking prerequisite, initializing and setting up the view and finally dispatching to the requested action.
verifyAction()  : ResponseInterface
Handle verification request, receiving from the auth view by forwarding the request to the appropriate provider.
addCustomAuthenticationFormStyles()  : void
getAlternativeProviders()  : array<string|int, ProviderInterface>
Fetch alternative (activated and allowed) providers for the user to chose from
getBackendUser()  : BackendUserAuthentication
getLanguageService()  : LanguageService
getMfaProviderFromRequest()  : MfaProviderManifestInterface|null
getRecommendedProvider()  : MfaProviderManifestInterface|null
Get the recommended provider
initializeMfaConfiguration()  : void
Initialize MFA configuration based on TSconfig and global configuration
isActionAllowed()  : bool
isProviderAllowed()  : bool
isValidIdentifier()  : bool
log()  : void
Log debug information for MFA events

Properties

$allowedActions

protected array<string|int, mixed> $allowedActions = []

$allowedProviders

protected array<string|int, mixed> $allowedProviders

$mfaTsConfig

protected array<string|int, mixed> $mfaTsConfig

Methods

authAction()

Setup the authentication view for the provider by using provider specific content

public authAction(ServerRequestInterface $request, MfaProviderManifestInterface $mfaProvider) : ResponseInterface
Parameters
$request : ServerRequestInterface
$mfaProvider : MfaProviderManifestInterface
Return values
ResponseInterface

cancelAction()

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.

public cancelAction(ServerRequestInterface $request) : ResponseInterface
Parameters
$request : ServerRequestInterface
Return values
ResponseInterface

handleRequest()

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

public handleRequest(ServerRequestInterface $request) : ResponseInterface
Parameters
$request : ServerRequestInterface
Return values
ResponseInterface

verifyAction()

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

public verifyAction(ServerRequestInterface $request, MfaProviderManifestInterface $mfaProvider) : ResponseInterface
Parameters
$request : ServerRequestInterface
$mfaProvider : MfaProviderManifestInterface
Return values
ResponseInterface

addCustomAuthenticationFormStyles()

protected addCustomAuthenticationFormStyles() : void

initializeMfaConfiguration()

Initialize MFA configuration based on TSconfig and global configuration

protected initializeMfaConfiguration() : void

isActionAllowed()

protected isActionAllowed(string $action) : bool
Parameters
$action : string
Return values
bool

isProviderAllowed()

protected isProviderAllowed(string $identifier) : bool
Parameters
$identifier : string
Return values
bool

isValidIdentifier()

protected isValidIdentifier(string $identifier) : bool
Parameters
$identifier : string
Return values
bool

log()

Log debug information for MFA events

protected log(string $message[, array<string|int, mixed> $additionalData = [] ][, MfaProviderManifestInterface|null $mfaProvider = null ]) : void
Parameters
$message : string
$additionalData : array<string|int, mixed> = []
$mfaProvider : MfaProviderManifestInterface|null = null 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results