‪TYPO3CMS  11.5
Public Member Functions | Private Member Functions | Private Attributes | List of all members
TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest Class Reference
Inheritance diagram for TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest:
TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface

Public Member Functions

 __construct (string $identifier, string $title, string $description, string $setupInstructions, string $iconIdentifier, bool $isDefaultProviderAllowed, string $serviceName, ContainerInterface $container)
 
 getIdentifier ()
 
 getTitle ()
 
 getDescription ()
 
 getIconIdentifier ()
 
 getSetupInstructions ()
 
 isDefaultProviderAllowed ()
 
 canProcess (ServerRequestInterface $request)
 
 isActive (MfaProviderPropertyManager $propertyManager)
 
 isLocked (MfaProviderPropertyManager $propertyManager)
 
 verify (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager)
 
 handleRequest (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager, string $type)
 
 activate (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager)
 
 deactivate (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager)
 
 unlock (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager)
 
 update (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager)
 

Private Member Functions

 getInstance ()
 
 createInstance ()
 

Private Attributes

string $identifier
 
string $title
 
string $description
 
string $setupInstructions
 
string $iconIdentifier
 
bool $isDefaultProviderAllowed
 
string $serviceName
 
ContainerInterface $container
 
MfaProviderInterface $instance = null
 

Detailed Description

Adapter for MFA providers

should only be used by the TYPO3 Core

Definition at line 29 of file MfaProviderManifest.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::__construct ( string  $identifier,
string  $title,
string  $description,
string  $setupInstructions,
string  $iconIdentifier,
bool  $isDefaultProviderAllowed,
string  $serviceName,
ContainerInterface  $container 
)

Definition at line 41 of file MfaProviderManifest.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\$container, TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\$description, TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\$iconIdentifier, TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\$identifier, TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\$isDefaultProviderAllowed, TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\$serviceName, TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\$setupInstructions, TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\$title, and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\isDefaultProviderAllowed().

Member Function Documentation

◆ activate()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::activate ( ServerRequestInterface  $request,
MfaProviderPropertyManager  $propertyManager 
)

Activate / register this provider for the user

Parameters
ServerRequestInterface$request
MfaProviderPropertyManager$propertyManager
Returns
‪bool TRUE in case operation was successful, FALSE otherwise

Implements TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface.

Definition at line 119 of file MfaProviderManifest.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\getInstance().

◆ canProcess()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::canProcess ( ServerRequestInterface  $request)

Check if the current request can be handled by this provider (e.g. necessary query arguments are set).

Parameters
ServerRequestInterface$request
Returns
‪bool

Implements TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface.

Definition at line 91 of file MfaProviderManifest.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\getInstance().

◆ createInstance()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::createInstance ( )
private

Definition at line 144 of file MfaProviderManifest.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\$instance.

Referenced by TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\getInstance().

◆ deactivate()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::deactivate ( ServerRequestInterface  $request,
MfaProviderPropertyManager  $propertyManager 
)

Deactivate this provider for the user

Parameters
ServerRequestInterface$request
MfaProviderPropertyManager$propertyManager
Returns
‪bool TRUE in case operation was successful, FALSE otherwise

Implements TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface.

Definition at line 124 of file MfaProviderManifest.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\getInstance().

◆ getDescription()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::getDescription ( )

A short description about the provider

Returns
‪string

Implements TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface.

Definition at line 71 of file MfaProviderManifest.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\$description.

◆ getIconIdentifier()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::getIconIdentifier ( )

The icon identifier for this provider

Returns
‪string

Implements TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface.

Definition at line 76 of file MfaProviderManifest.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\$iconIdentifier.

◆ getIdentifier()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::getIdentifier ( )

Unique provider identifier

Returns
‪string

Implements TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface.

Definition at line 61 of file MfaProviderManifest.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\$identifier.

◆ getInstance()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::getInstance ( )
private

Definition at line 139 of file MfaProviderManifest.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\createInstance().

Referenced by TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\activate(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\canProcess(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\deactivate(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\handleRequest(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\isActive(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\isLocked(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\unlock(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\update(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\verify().

◆ getSetupInstructions()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::getSetupInstructions ( )

Instructions to be displayed in the setup view

Returns
‪string

Implements TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface.

Definition at line 81 of file MfaProviderManifest.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\$setupInstructions.

◆ getTitle()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::getTitle ( )

The title of the provider

Returns
‪string

Implements TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface.

Definition at line 66 of file MfaProviderManifest.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\$title.

◆ handleRequest()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::handleRequest ( ServerRequestInterface  $request,
MfaProviderPropertyManager  $propertyManager,
string  $type 
)

Generate the provider specific response for the given view type. Note: Currently the calling controller only evaluates the response body and directly injects it into the corresponding view. It's however planned to also take further information like headers into account.

Parameters
ServerRequestInterface$request
MfaProviderPropertyManager$propertyManager
string$type
Returns
‪ResponseInterface
See also
‪MfaViewType

Implements TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface.

Definition at line 111 of file MfaProviderManifest.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\getInstance().

◆ isActive()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::isActive ( MfaProviderPropertyManager  $propertyManager)

Check if provider is active for the user by e.g. checking the user record for some provider specific active state.

Parameters
MfaProviderPropertyManager$propertyManager
Returns
‪bool

Implements TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface.

Definition at line 96 of file MfaProviderManifest.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\getInstance().

◆ isDefaultProviderAllowed()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::isDefaultProviderAllowed ( )

Whether the provider is allowed to be set as default

Returns
‪bool

Implements TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface.

Definition at line 86 of file MfaProviderManifest.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\$isDefaultProviderAllowed.

Referenced by TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\__construct().

◆ isLocked()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::isLocked ( MfaProviderPropertyManager  $propertyManager)

Check if provider is temporarily locked for the user, because of e.g. to much false authentication attempts. This differs from the "isActive" state on purpose, so please DO NOT use the "isActive" state for such check internally. This will allow attackers to easily circumvent MFA!

Parameters
MfaProviderPropertyManager$propertyManager
Returns
‪bool

Implements TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface.

Definition at line 101 of file MfaProviderManifest.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\getInstance().

◆ unlock()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::unlock ( ServerRequestInterface  $request,
MfaProviderPropertyManager  $propertyManager 
)

Unlock this provider for the user

Parameters
ServerRequestInterface$request
MfaProviderPropertyManager$propertyManager
Returns
‪bool TRUE in case operation was successful, FALSE otherwise

Implements TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface.

Definition at line 129 of file MfaProviderManifest.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\getInstance().

◆ update()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::update ( ServerRequestInterface  $request,
MfaProviderPropertyManager  $propertyManager 
)

Handle changes of the provider by the user

Parameters
ServerRequestInterface$request
MfaProviderPropertyManager$propertyManager
Returns
‪bool TRUE in case operation was successful, FALSE otherwise

Implements TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface.

Definition at line 134 of file MfaProviderManifest.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\getInstance().

◆ verify()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::verify ( ServerRequestInterface  $request,
MfaProviderPropertyManager  $propertyManager 
)

Verifies the MFA request

Parameters
ServerRequestInterface$request
MfaProviderPropertyManager$propertyManager
Returns
‪bool

Implements TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface.

Definition at line 106 of file MfaProviderManifest.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\getInstance().

Member Data Documentation

◆ $container

ContainerInterface TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::$container
private

Definition at line 38 of file MfaProviderManifest.php.

Referenced by TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\__construct().

◆ $description

string TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::$description
private

Definition at line 33 of file MfaProviderManifest.php.

Referenced by TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\__construct(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\getDescription().

◆ $iconIdentifier

string TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::$iconIdentifier
private

Definition at line 35 of file MfaProviderManifest.php.

Referenced by TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\__construct(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\getIconIdentifier().

◆ $identifier

string TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::$identifier
private

Definition at line 31 of file MfaProviderManifest.php.

Referenced by TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\__construct(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\getIdentifier().

◆ $instance

MfaProviderInterface TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::$instance = null
private

Definition at line 39 of file MfaProviderManifest.php.

Referenced by TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\createInstance().

◆ $isDefaultProviderAllowed

bool TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::$isDefaultProviderAllowed
private

Definition at line 36 of file MfaProviderManifest.php.

Referenced by TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\__construct(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\isDefaultProviderAllowed().

◆ $serviceName

string TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::$serviceName
private

Definition at line 37 of file MfaProviderManifest.php.

Referenced by TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\__construct().

◆ $setupInstructions

string TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::$setupInstructions
private

Definition at line 34 of file MfaProviderManifest.php.

Referenced by TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\__construct(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\getSetupInstructions().

◆ $title

string TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest::$title
private

Definition at line 32 of file MfaProviderManifest.php.

Referenced by TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\__construct(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest\getTitle().