SilverStripe\MFA\SessionStore

Complexity

Total Complexity

16

Size/Duplication

Total Lines	142
Duplicated Lines	0 %

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	15	3
A	save()	0	5	1
A	clear()	0	3	1
A	getMember()	0	3	1
A	build()	0	6	2
A	setState()	0	5	1
A	setMember()	0	13	3
A	getMethod()	0	3	1
A	getState()	0	3	1
A	resetMethod()	0	3	1
A	setMethod()	0	5	1

<?php
namespace SilverStripe\MFA;

use SilverStripe\Control\HTTPRequest;
use SilverStripe\MFA\Extensions\MemberExtension;
use SilverStripe\Security\Member;

/**
 * This class provides an interface to store data in session during an MFA process. This is implemented as a measure to
 * prevent bleeding state between individual MFA auth types
 *
 * @package SilverStripe\MFA
 */
class SessionStore
{
    const SESSION_KEY = 'thing';

    /**
     * The member that is currently going through the MFA process
     *
     * @var Member
     */
    protected $member;

    /**
     * A string representing the current authentication method that is underway
     *
     * @var string
     */
    protected $method;

    /**
     * Any state that the current authentication method needs to retain while it is underway
     *
     * @var array
     */
    protected $state = [];

    /**
     * Create a store from the given request getting any initial state from the session of the request
     *
     * @param HTTPRequest $request
     * @return SessionStore
     */
    public static function create(HTTPRequest $request)
    {
        $state = $request->getSession()->get(static::SESSION_KEY);

        $new = new static;

        if ($state) {
            $new->setMethod($state['method']);
            $new->setState($state['state']);
            if ($state['member']) {
                $new->setMember(Member::get_by_id($state['member']));
            }
        }

        return $new;
    }

    /**
     * @return Member|MemberExtension
     */
    public function getMember()
    {
        return $this->member;
    }

    /**
     * @param Member $member
     * @return $this
     */
    public function setMember(Member $member)
    {
        // Early return if there's no change
        if ($this->member && $this->member->ID === $member->ID) {
            return $this;
        }

        // If the member has changed we should null out the method that's underway and the state of it
        $this->resetMethod();

        $this->member = $member;

        return $this;
    }

    /**
     * @return string
     */
    public function getMethod()
    {
        return $this->method;
    }

    /**
     * @param string $method
     * @return $this
     */
    public function setMethod($method)
    {
        $this->method = $method;

        return $this;
    }

    /**
     * @return array
     */
    public function getState()
    {
        return $this->state;
    }

    /**
     * @param array $state
     * @return $this
     */
    public function setState(array $state)
    {
        $this->state = $state;

        return $this;
    }

    /**
     * Save this store into the session of the given request
     *
     * @param HTTPRequest $request
     * @return $this
     */
    public function save(HTTPRequest $request)
    {
        $request->getSession()->set(static::SESSION_KEY, $this->build());

        return $this;
    }

    public static function clear(HTTPRequest $request)
    {
        $request->getSession()->clear(static::SESSION_KEY);
    }

    protected function resetMethod()
    {
        $this->setMethod(null)->setState([]);
    }

    protected function build()
    {
        return [
            'member' => $this->getMember() ? $this->getMember()->ID : null,
            'method' => $this->getMethod(),
            'state' => $this->getState(),
        ];
    }
}