SecurityManager Class Reference

Public Member Functions
	__construct (ConfigInterface $securityConfig, \Magento\Security\Model\PasswordResetRequestEventFactory $passwordResetRequestEventFactory, ResourceModel\PasswordResetRequestEvent\CollectionFactory $passwordResetRequestEventCollectionFactory, \Magento\Framework\Event\ManagerInterface $eventManager, \Magento\Framework\Stdlib\DateTime\DateTime $dateTime, RemoteAddress $remoteAddress, $securityCheckers=[])
	performSecurityCheck ($requestType, $accountReference=null, $longIp=null)
	cleanExpiredRecords ()

Data Fields
const	SECURITY_CONTROL_RECORDS_LIFE_TIME = 86400

Protected Attributes
	$securityConfig
	$passwordResetRequestEventFactory
	$passwordResetRequestEventCollectionFactory
	$securityCheckers

Detailed Description

Manager for password reset actions

@api

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since

100.1.0

Definition at line 20 of file SecurityManager.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ConfigInterface	$securityConfig,
		\Magento\Security\Model\PasswordResetRequestEventFactory	$passwordResetRequestEventFactory,
		ResourceModel\PasswordResetRequestEvent\CollectionFactory	$passwordResetRequestEventCollectionFactory,
		\Magento\Framework\Event\ManagerInterface	$eventManager,
		\Magento\Framework\Stdlib\DateTime\DateTime	$dateTime,
		RemoteAddress	$remoteAddress,
			$securityCheckers = []
	)

SecurityManager constructor.

Parameters

ConfigInterface	$securityConfig
\Magento\Security\Model\PasswordResetRequestEventFactory	$passwordResetRequestEventFactory
ResourceModel\PasswordResetRequestEvent\CollectionFactory	$passwordResetRequestEventCollectionFactory
\Magento\Framework\Event\ManagerInterface	$eventManager
\Magento\Framework\Stdlib\DateTime\DateTime	$dateTime
RemoteAddress	$remoteAddress
array	$securityCheckers

Exceptions

Definition at line 78 of file SecurityManager.php.

      {
        $this->securityConfig = $securityConfig;
        $this->passwordResetRequestEventFactory = $passwordResetRequestEventFactory;
        $this->passwordResetRequestEventCollectionFactory = $passwordResetRequestEventCollectionFactory;
        $this->securityCheckers = $securityCheckers;
        $this->eventManager = $eventManager;
        $this->dateTime = $dateTime;
        $this->remoteAddress = $remoteAddress;

        foreach ($this->securityCheckers as $checker) {
            if (!($checker instanceof SecurityCheckerInterface)) {
                throw new \Magento\Framework\Exception\LocalizedException(
                    __('Incorrect Security Checker class. It has to implement SecurityCheckerInterface')
                );
            }
        }
    }

Member Function Documentation

cleanExpiredRecords()

cleanExpiredRecords

(

)

Clean expired Admin Sessions

Returns

$this

Since

100.1.0

Definition at line 134 of file SecurityManager.php.

    {
        $this->passwordResetRequestEventCollectionFactory->create()->deleteRecordsOlderThen(
            $this->dateTime->gmtTimestamp() - self::SECURITY_CONTROL_RECORDS_LIFE_TIME
        );

        return $this;
    }

performSecurityCheck()

performSecurityCheck	(		$requestType,
			$accountReference = null,
			$longIp = null
	)

Perform security check

Parameters

int	$requestType
string | null	$accountReference
int | null	$longIp

Returns

$this

Exceptions

SecurityViolationException

Since

100.1.0

Definition at line 114 of file SecurityManager.php.

    {
        if (null === $longIp) {
            $longIp = $this->remoteAddress->getRemoteAddress();
        }
        foreach ($this->securityCheckers as $checker) {
            $checker->check($requestType, $accountReference, $longIp);
        }

        $this->createNewPasswordResetRequestEventRecord($requestType, $accountReference, $longIp);

        return $this;
    }

Field Documentation

$passwordResetRequestEventCollectionFactory

$passwordResetRequestEventCollectionFactory

protected

Definition at line 43 of file SecurityManager.php.

$passwordResetRequestEventFactory

$passwordResetRequestEventFactory

protected

Definition at line 37 of file SecurityManager.php.

$securityCheckers

$securityCheckers

protected

Definition at line 49 of file SecurityManager.php.

$securityConfig

$securityConfig

protected

Definition at line 31 of file SecurityManager.php.

SECURITY_CONTROL_RECORDS_LIFE_TIME

const SECURITY_CONTROL_RECORDS_LIFE_TIME = 86400

Security control records time life

Definition at line 25 of file SecurityManager.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-security/Model/SecurityManager.php