TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager Class Reference

Inheritance diagram for TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager:

Public Member Functions
	__construct (protected readonly AbstractUserAuthentication $user, protected readonly string $providerIdentifier)
	hasProviderEntry ()
	hasProperty (string $key)
	getProperty (string $key, mixed $default=null)
	getProperties ()
	updateProperties (array $properties)
	createProviderEntry (array $properties)
	deleteProviderEntry ()
	getUser ()
	getIdentifier ()

Static Public Member Functions
static	create (MfaProviderManifestInterface $provider, AbstractUserAuthentication $user)

Protected Member Functions
	storeProperties ()

Protected Attributes
array	$mfa
array	$providerProperties
const	DATABASE_FIELD_NAME = 'mfa'

Detailed Description

Basic manager for MFA providers to access and update their properties (information) from the mfa column in the user array.

Definition at line 32 of file MfaProviderPropertyManager.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager::__construct	(	protected readonly AbstractUserAuthentication	$user,
		protected readonly string	$providerIdentifier
	)

Definition at line 40 of file MfaProviderPropertyManager.php.

Member Function Documentation

create()

static TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager::create ( MfaProviderManifestInterface  $provider, AbstractUserAuthentication  $user  )

static

Create property manager for the user with the given provider

Definition at line 193 of file MfaProviderPropertyManager.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface\getIdentifier().

Referenced by TYPO3\CMS\Backend\Controller\MfaSetupController\activateAction(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\activateAction(), TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\Provider\RecoveryCodesProviderTest\activateTest(), TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\Provider\TotpProviderTest\activateTest(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\activeProvidersExist(), TYPO3\CMS\Backend\Controller\MfaController\authAction(), TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\Provider\RecoveryCodesProviderTest\authViewTest(), TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\Provider\TotpProviderTest\authViewTest(), TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\MfaProviderPropertyManagerTest\createPropertyManager(), TYPO3\CMS\Backend\Controller\MfaAjaxController\deactivateAction(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\deactivateAction(), TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\Provider\RecoveryCodesProviderTest\deactivateTest(), TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\Provider\TotpProviderTest\deactivateTest(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\editAction(), TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\Provider\RecoveryCodesProviderTest\editViewTest(), TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\Provider\TotpProviderTest\editViewTest(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderRegistry\getActiveProviders(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\getDefaultProviderIdentifier(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderRegistry\getLockedProviders(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\getRecommendedProviderIdentifier(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\handleRequest(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\hasSuitableDefaultProviders(), TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\Provider\TotpProviderTest\isActiveTest(), TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\Provider\RecoveryCodesProviderTest\isActiveTest(), TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\Provider\TotpProviderTest\isLockedTest(), TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\Provider\RecoveryCodesProviderTest\isLockedTest(), TYPO3\CMS\Backend\Form\Element\MfaInfoElement\render(), TYPO3\CMS\Backend\Controller\MfaSetupController\renderSetupView(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\saveAction(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\setupAction(), TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\Provider\RecoveryCodesProviderTest\setupFailsIfNoOtherMfaProviderIsActive(), TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\Provider\RecoveryCodesProviderTest\setupReturnsHtmlWithRecoveryCodes(), TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\Provider\TotpProviderTest\setupViewTest(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\unlockAction(), TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\Provider\RecoveryCodesProviderTest\unlockTest(), TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\Provider\TotpProviderTest\unlockTest(), TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\Provider\RecoveryCodesProviderTest\updateTest(), TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\Provider\TotpProviderTest\updateTest(), TYPO3\CMS\Backend\ViewHelpers\Mfa\IfHasStateViewHelper\verdict(), TYPO3\CMS\Backend\Controller\MfaController\verifyAction(), TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\Provider\TotpProviderTest\verifyTest(), and TYPO3\CMS\Core\Tests\Functional\Authentication\Mfa\Provider\RecoveryCodesProviderTest\verifyTest().

createProviderEntry()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager::createProviderEntry

(

array

$properties

)

Create a new provider entry for the current user Note: If an entry already exists, use updateProperties() instead. This can be checked with hasProviderEntry().

Definition at line 108 of file MfaProviderPropertyManager.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\$providerProperties, TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\hasProviderEntry(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\storeProperties().

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

deleteProviderEntry()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager::deleteProviderEntry

(

)

Delete a provider entry for the current user

Exceptions

Definition at line 136 of file MfaProviderPropertyManager.php.

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

Referenced by TYPO3\CMS\Core\Authentication\Mfa\Provider\TotpProvider\deactivate(), and TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\deactivate().

getIdentifier()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager::getIdentifier

(

)

Return the current providers identifier

Definition at line 185 of file MfaProviderPropertyManager.php.

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

getProperties()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager::getProperties

(

)

Get provider specific properties

Definition at line 74 of file MfaProviderPropertyManager.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\$providerProperties.

getProperty()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager::getProperty	(	string	$key,
		mixed	$default = null
	)

Get a provider specific property value or the defined default value if the requested property was not found.

Definition at line 66 of file MfaProviderPropertyManager.php.

Referenced by TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\deactivate(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\handleRequest(), TYPO3\CMS\Core\Authentication\Mfa\Provider\TotpProvider\isActive(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\isActive(), TYPO3\CMS\Core\Authentication\Mfa\Provider\TotpProvider\isLocked(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\isLocked(), TYPO3\CMS\Core\Authentication\Mfa\Provider\TotpProvider\prepareEditView(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\unlock(), TYPO3\CMS\Core\Authentication\Mfa\Provider\TotpProvider\verify(), and TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\verify().

getUser()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager::getUser

(

)

Return the current user

Definition at line 177 of file MfaProviderPropertyManager.php.

Referenced by TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\activeProvidersExist(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\getMode(), and TYPO3\CMS\Core\Authentication\Mfa\Provider\TotpProvider\prepareSetupView().

hasProperty()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager::hasProperty

(

string

$key

)

Check if a provider property exists

Definition at line 57 of file MfaProviderPropertyManager.php.

hasProviderEntry()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager::hasProviderEntry

(

)

Check if a provider entry exists for the current user

Definition at line 49 of file MfaProviderPropertyManager.php.

Referenced by TYPO3\CMS\Core\Authentication\Mfa\Provider\TotpProvider\activate(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\activate(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\createProviderEntry(), TYPO3\CMS\Core\Authentication\Mfa\Provider\TotpProvider\isLocked(), TYPO3\CMS\Core\Authentication\Mfa\Provider\RecoveryCodesProvider\isLocked(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\updateProperties().

storeProperties()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager::storeProperties ( )

protected

Stores the updated properties in the user array and the database

Exceptions

Definition at line 148 of file MfaProviderPropertyManager.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\$mfa, TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\DATABASE_FIELD_NAME, and TYPO3\CMS\Core\Database\Connection\PARAM_LOB.

Referenced by TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\createProviderEntry(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\deleteProviderEntry(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\updateProperties().

updateProperties()

TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager::updateProperties

(

array

$properties

)

Update the provider properties Note: If no entry exists yet, use createProviderEntry() instead. This can be checked with hasProviderEntry().

Definition at line 84 of file MfaProviderPropertyManager.php.

References TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\$providerProperties, TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\hasProviderEntry(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\storeProperties().

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

Member Data Documentation

$mfa

array TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager::$mfa

protected

Definition at line 36 of file MfaProviderPropertyManager.php.

Referenced by TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\storeProperties().

$providerProperties

array TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager::$providerProperties

protected

Definition at line 37 of file MfaProviderPropertyManager.php.

Referenced by TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\createProviderEntry(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\getProperties(), and TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\updateProperties().

DATABASE_FIELD_NAME

const TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager::DATABASE_FIELD_NAME = 'mfa'

protected

Definition at line 38 of file MfaProviderPropertyManager.php.

Referenced by TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\storeProperties().