TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider Class Reference

Inheritance diagram for TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider:

Public Member Functions
	__construct (protected readonly MfaProviderRegistry $mfaProviderRegistry, protected readonly Context $context, protected readonly UriBuilder $uriBuilder, protected readonly FlashMessageService $flashMessageService, protected readonly HashService $hashService,)
	canProcess (ServerRequestInterface $request)
	isActive (MfaProviderPropertyManager $propertyManager)
	isLocked (MfaProviderPropertyManager $propertyManager)
	verify (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager)
	handleRequest (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager, MfaViewType $type)
	activate (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager)
	deactivate (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager)
	unlock (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager)
	update (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager)
‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface
	handleRequest (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager, MfaViewType $type)

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

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 44 of file RecoveryCodesProvider.php.

Constructor & Destructor Documentation

__construct()

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

Definition at line 46 of file RecoveryCodesProvider.php.

Member Function Documentation

activate()

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

Activate the provider by hashing and storing the given recovery codes

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

Definition at line 179 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()

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

protected

Check if the current user has other active providers

Definition at line 311 of file RecoveryCodesProvider.php.

References TYPO3\CMS\Webhooks\Message\$identifier, 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 = '', ContextualFeedbackSeverity  $severity = ContextualFeedbackSeverity::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.

Definition at line 343 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()

TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider::canProcess

(

ServerRequestInterface

$request

)

Check if a recovery code is given in the current request

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

Definition at line 59 of file RecoveryCodesProvider.php.

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

deactivate()

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

Handle the deactivate action by removing the provider entry

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

Definition at line 217 of file RecoveryCodesProvider.php.

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

getDateTime()

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

Definition at line 353 of file RecoveryCodesProvider.php.

References $GLOBALS.

getLanguageService()

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

protected

Definition at line 365 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()

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

Definition at line 334 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()

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

protected

Internal helper method for fetching the recovery code from the request

Definition at line 326 of file RecoveryCodesProvider.php.

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

handleRequest()

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

Render the provider specific response for the given content type

Exceptions

PropagateResponseException

Definition at line 126 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\AUTH, 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(), and TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\isLocked().

isActive()

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.

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

Definition at line 70 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()

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.

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

Definition at line 81 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()

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.

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

Definition at line 235 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(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\updateProperties().

update()

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

Handle changes of the provider by the user

Returns

‪bool TRUE in case operation was successful, FALSE otherwise

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

Definition at line 273 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(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\updateProperties().

verify()

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.

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

Definition at line 95 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

MAX_ATTEMPTS

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

private

Definition at line 54 of file RecoveryCodesProvider.php.