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

Public Member Functions

 __construct (MfaProviderRegistry $mfaProviderRegistry, Context $context, UriBuilder $uriBuilder, FlashMessageService $flashMessageService)
 
bool canProcess (ServerRequestInterface $request)
 
bool isActive (MfaProviderPropertyManager $propertyManager)
 
bool isLocked (MfaProviderPropertyManager $propertyManager)
 
bool verify (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager)
 
ResponseInterface handleRequest (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager, string $type)
 
bool activate (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager)
 
bool deactivate (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager)
 
bool unlock (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager)
 
 update (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager)
 

Protected Member Functions

bool activeProvidersExist (MfaProviderPropertyManager $currentPropertyManager)
 
string getRecoveryCode (ServerRequestInterface $request)
 
string getMode (MfaProviderPropertyManager $propertyManager)
 
 addFlashMessage (string $message, string $title='', int $severity=FlashMessage::INFO)
 
string getDateTime (int $timestamp)
 
 getLanguageService ()
 

Protected Attributes

MfaProviderRegistry $mfaProviderRegistry
 
Context $context
 
UriBuilder $uriBuilder
 
FlashMessageService $flashMessageService
 

Private Attributes

const MAX_ATTEMPTS = 3
 

Detailed Description

MFA provider for authentication with recovery codes

should only be used by the TYPO3 Core

Definition at line 42 of file RecoveryCodesProvider.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider::__construct ( MfaProviderRegistry  $mfaProviderRegistry,
Context  $context,
UriBuilder  $uriBuilder,
FlashMessageService  $flashMessageService 
)

Definition at line 49 of file RecoveryCodesProvider.php.

References TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\$context, TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\$flashMessageService, TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\$mfaProviderRegistry, and TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\$uriBuilder.

Member Function Documentation

◆ activate()

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

Activate the provider by hashing and storing the given recovery codes

Parameters
ServerRequestInterface$request
MfaProviderPropertyManager$propertyManager
Returns
‪bool

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

Definition at line 208 of file RecoveryCodesProvider.php.

References TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\activeProvidersExist(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\createProviderEntry(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\getMode(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\hasProviderEntry(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\isActive(), TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\updateProperties().

◆ activeProvidersExist()

bool TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider::activeProvidersExist ( MfaProviderPropertyManager  $currentPropertyManager)
protected

Check if the current user has other active providers

Parameters
MfaProviderPropertyManager$currentPropertyManager
Returns
‪bool

Definition at line 351 of file RecoveryCodesProvider.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\create(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\getIdentifier(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\getUser().

Referenced by TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\activate(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\handleRequest(), and TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\isActive().

◆ addFlashMessage()

TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider::addFlashMessage ( string  $message,
string  $title = '',
int  $severity = FlashMessage::INFO 
)
protected

Add a custom flash message for this provider Note: The flash messages added by the main controller are still shown to the user.

Parameters
string$message
string$title
int$severity

Definition at line 393 of file RecoveryCodesProvider.php.

Referenced by TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\handleRequest(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\unlock(), and TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\update().

◆ canProcess()

bool TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider::canProcess ( ServerRequestInterface  $request)

Check if a recovery code is given in the current request

Parameters
ServerRequestInterface$request
Returns
‪bool

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

Definition at line 69 of file RecoveryCodesProvider.php.

References TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\getRecoveryCode().

◆ deactivate()

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

Handle the deactivate action by removing the provider entry

Parameters
ServerRequestInterface$request
MfaProviderPropertyManager$propertyManager
Returns
‪bool

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

Definition at line 250 of file RecoveryCodesProvider.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\deleteProviderEntry(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\getProperty().

◆ getDateTime()

string TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider::getDateTime ( int  $timestamp)
protected

Return the timestamp as local time (date string) by applying the globally configured format

Parameters
int$timestamp
Returns
‪string

Definition at line 406 of file RecoveryCodesProvider.php.

References $GLOBALS.

◆ getLanguageService()

TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider::getLanguageService ( )
protected

Definition at line 418 of file RecoveryCodesProvider.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\handleRequest(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\unlock(), and TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\update().

◆ getMode()

string TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider::getMode ( MfaProviderPropertyManager  $propertyManager)
protected

Determine the mode (used for the hash instance) based on the current users table

Parameters
MfaProviderPropertyManager$propertyManager
Returns
‪string

Definition at line 380 of file RecoveryCodesProvider.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\getUser().

Referenced by TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\activate(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\handleRequest(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\unlock(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\update(), and TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\verify().

◆ getRecoveryCode()

string TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider::getRecoveryCode ( ServerRequestInterface  $request)
protected

Internal helper method for fetching the recovery code from the request

Parameters
ServerRequestInterface$request
Returns
‪string

Definition at line 369 of file RecoveryCodesProvider.php.

Referenced by TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\canProcess(), and TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\verify().

◆ handleRequest()

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

Render the provider specific response for the given content type

Parameters
ServerRequestInterface$request
MfaProviderPropertyManager$propertyManager
string$type
Returns
‪ResponseInterface
Exceptions
PropagateResponseException

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

Definition at line 151 of file RecoveryCodesProvider.php.

References TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\activeProvidersExist(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\addFlashMessage(), TYPO3\CMS\Core\Authentication\Mfa\MfaViewType\AUTH, TYPO3\CMS\Core\Authentication\Mfa\MfaViewType\EDIT, TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\getIdentifier(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\getLanguageService(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\getMode(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\getProperty(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\isLocked(), TYPO3\CMS\Core\Authentication\Mfa\MfaViewType\SETUP, and TYPO3\CMS\Core\Messaging\AbstractMessage\WARNING.

◆ isActive()

bool TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider::isActive ( MfaProviderPropertyManager  $propertyManager)

Evaluate if the provider is activated by checking the active state from the provider properties. This provider furthermore has a mannerism that it only works if at least one other MFA provider is activated for the user.

Parameters
MfaProviderPropertyManager$propertyManager
Returns
‪bool

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

Definition at line 83 of file RecoveryCodesProvider.php.

References TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\activeProvidersExist(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\getProperty().

Referenced by TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\activate(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\unlock(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\update(), and TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\verify().

◆ isLocked()

bool TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider::isLocked ( MfaProviderPropertyManager  $propertyManager)

Evaluate if the provider is temporarily locked by checking the current attempts state from the provider properties and if there are still recovery codes left.

Parameters
MfaProviderPropertyManager$propertyManager
Returns
‪bool

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

Definition at line 97 of file RecoveryCodesProvider.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\getProperty(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\hasProviderEntry().

Referenced by TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\handleRequest(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\unlock(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\update(), and TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\verify().

◆ unlock()

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

Handle the unlock action by resetting the attempts provider property and issuing new codes.

Parameters
ServerRequestInterface$request
MfaProviderPropertyManager$propertyManager
Returns
‪bool

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

Definition at line 272 of file RecoveryCodesProvider.php.

References TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\addFlashMessage(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\getLanguageService(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\getMode(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\getProperty(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\isActive(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\isLocked(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\updateProperties(), and TYPO3\CMS\Core\Messaging\AbstractMessage\WARNING.

◆ update()

TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider::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 310 of file RecoveryCodesProvider.php.

References TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\addFlashMessage(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\getLanguageService(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\getMode(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\isActive(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\isLocked(), TYPO3\CMS\Core\Messaging\AbstractMessage\OK, and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\updateProperties().

◆ verify()

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

Verify the given recovery code and remove it from the provider properties if valid.

Parameters
ServerRequestInterface$request
MfaProviderPropertyManager$propertyManager
Returns
‪bool

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

Definition at line 116 of file RecoveryCodesProvider.php.

References TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\getMode(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\getProperty(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\getRecoveryCode(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\isActive(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\isLocked(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\updateProperties().

Member Data Documentation

◆ $context

Context TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider::$context
protected

Definition at line 45 of file RecoveryCodesProvider.php.

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

◆ $flashMessageService

FlashMessageService TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider::$flashMessageService
protected

Definition at line 47 of file RecoveryCodesProvider.php.

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

◆ $mfaProviderRegistry

MfaProviderRegistry TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider::$mfaProviderRegistry
protected

Definition at line 44 of file RecoveryCodesProvider.php.

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

◆ $uriBuilder

UriBuilder TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider::$uriBuilder
protected

Definition at line 46 of file RecoveryCodesProvider.php.

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

◆ MAX_ATTEMPTS

const TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider::MAX_ATTEMPTS = 3
private

Definition at line 61 of file RecoveryCodesProvider.php.