Surfnet\StepupSelfService\SelfServiceBundle\Security\Authentication\Session\SessionStorage

Complexity

Total Complexity

21

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	setRequestId()	0	3	1
A	getCurrentRequestUri()	0	6	1
A	getLastInteractionMoment()	0	7	2
A	migrate()	0	3	1
A	hasRequestId()	0	3	1
A	logAuthenticationMoment()	0	10	2
A	isAuthenticationMomentLogged()	0	3	1
A	__construct()	0	2	1
A	invalidate()	0	3	1
A	getAuthenticationMoment()	0	7	2
A	updateLastInteractionMoment()	0	3	1
A	getRequestedActivationFlowPreference()	0	8	2
A	setCurrentRequestUri()	0	3	1
A	hasSeenInteraction()	0	3	1
A	clearRequestId()	0	3	1
A	getRequestId()	0	3	1
A	setRequestedActivationFlowPreference()	0	3	1

<?php

declare(strict_types = 1);

/**
 * Copyright 2016 SURFnet bv
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

namespace Surfnet\StepupSelfService\SelfServiceBundle\Security\Authentication\Session;

use Surfnet\StepupSelfService\SelfServiceBundle\Exception\LogicException;
use Surfnet\StepupSelfService\SelfServiceBundle\Security\Authentication\SamlAuthenticationStateHandler;
use Surfnet\StepupSelfService\SelfServiceBundle\Security\Authentication\AuthenticatedSessionStateHandler;
use Surfnet\StepupSelfService\SelfServiceBundle\Value\ActivationFlowPreference;
use Surfnet\StepupSelfService\SelfServiceBundle\Value\ActivationFlowPreferenceInterface;
use Surfnet\StepupSelfService\SelfServiceBundle\Value\ActivationFlowPreferenceNotExpressed;
use Surfnet\StepupSelfService\SelfServiceBundle\Value\DateTime;
use Symfony\Component\HttpFoundation\RequestStack;

class SessionStorage implements AuthenticatedSessionStateHandler, SamlAuthenticationStateHandler

Missing doc comment for class SessionStorage

{
    /**
     * Session keys
     */
    final public const AUTH_SESSION_KEY = '__auth/';
    final public const SAML_SESSION_KEY = '__saml/';

    public function __construct(private readonly RequestStack $requestStack)

Missing doc comment for function __construct()

    {
    }

    public function logAuthenticationMoment(): void

Missing doc comment for function logAuthenticationMoment()

    {
        if ($this->isAuthenticationMomentLogged()) {
            throw new LogicException('Cannot log authentication moment as an authentication moment is already logged');
        }

        $this->requestStack
            ->getSession()
            ->set(self::AUTH_SESSION_KEY . 'authenticated_at', DateTime::now()->format(DateTime::FORMAT));
        $this->updateLastInteractionMoment();
    }

    public function isAuthenticationMomentLogged(): bool

Missing doc comment for function isAuthenticationMomentLogged()

    {
        return $this->requestStack->getSession()->get(self::AUTH_SESSION_KEY . 'authenticated_at', null) !== null;
    }

    public function getAuthenticationMoment(): DateTime

Missing doc comment for function getAuthenticationMoment()

    {
        if (!$this->isAuthenticationMomentLogged()) {
            throw new LogicException('Cannot get last authentication moment as no authentication has been set');
        }

        return DateTime::fromString($this->requestStack->getSession()->get(self::AUTH_SESSION_KEY . 'authenticated_at'));
    }

    public function updateLastInteractionMoment(): void

Missing doc comment for function updateLastInteractionMoment()

    {
        $this->requestStack->getSession()->set(self::AUTH_SESSION_KEY . 'last_interaction', DateTime::now()->format(DateTime::FORMAT));
    }

    public function hasSeenInteraction(): bool

Missing doc comment for function hasSeenInteraction()

    {
        return $this->requestStack->getSession()->get(self::AUTH_SESSION_KEY . 'last_interaction', null) !== null;
    }

    public function getLastInteractionMoment(): DateTime

Missing doc comment for function getLastInteractionMoment()

    {
        if (!$this->hasSeenInteraction()) {
            throw new LogicException('Cannot get last interaction moment as we have not seen any interaction');
        }

        return DateTime::fromString($this->requestStack->getSession()->get(self::AUTH_SESSION_KEY . 'last_interaction'));
    }

    public function setCurrentRequestUri(string $uri): void

Missing doc comment for function setCurrentRequestUri()

    {
        $this->requestStack->getSession()->set(self::AUTH_SESSION_KEY . 'current_uri', $uri);
    }

    public function getCurrentRequestUri(): string

Missing doc comment for function getCurrentRequestUri()

    {
        $uri = $this->requestStack->getSession()->get(self::AUTH_SESSION_KEY . 'current_uri', '');
        $this->requestStack->getSession()->remove(self::AUTH_SESSION_KEY . 'current_uri');

        return $uri;
    }

    public function getRequestId(): ?string

Missing doc comment for function getRequestId()

    {
        return $this->requestStack->getSession()->get(self::SAML_SESSION_KEY . 'request_id');
    }

    public function setRequestId($requestId): void

Missing doc comment for function setRequestId()

    {
        $this->requestStack->getSession()->set(self::SAML_SESSION_KEY . 'request_id', $requestId);
    }

    public function hasRequestId(): bool

Missing doc comment for function hasRequestId()

    {
        return $this->requestStack->getSession()->has(self::SAML_SESSION_KEY. 'request_id');
    }

    public function clearRequestId(): void

Missing doc comment for function clearRequestId()

    {
        $this->requestStack->getSession()->remove(self::SAML_SESSION_KEY . 'request_id');
    }

    public function setRequestedActivationFlowPreference(ActivationFlowPreferenceInterface $preference): void

Missing doc comment for function setRequestedActivationFlowPreference()

    {
        $this->requestStack->getSession()->set(self::SAML_SESSION_KEY . 'activation_preference', $preference->__toString());
    }

    public function getRequestedActivationFlowPreference(): ActivationFlowPreferenceInterface

Missing doc comment for function getRequestedActivationFlowPreference()

    {
        if ($this->requestStack->getSession()->has(self::SAML_SESSION_KEY . 'activation_preference')) {
            /** @var string $preference */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

            $preference = $this->requestStack->getSession()->get(self::SAML_SESSION_KEY . 'activation_preference');
            return ActivationFlowPreference::fromString($preference);
        }
        return new ActivationFlowPreferenceNotExpressed();
    }

    public function invalidate(): void

Missing doc comment for function invalidate()

    {
        $this->requestStack->getSession()->invalidate();
    }

    public function migrate(): void

Missing doc comment for function migrate()

    {
        $this->requestStack->getSession()->migrate();
    }
}