Surfnet\StepupGateway\GatewayBundle\Saml\Proxy\ProxyStateHandler

Complexity

Total Complexity

53

Size/Duplication

Total Lines	310
Duplicated Lines	0 %

Importance

Changes

0

49 Methods

Rating	Name	Duplication	Size	Complexity
A	getGatewayRequestId()	0	3	1
A	setRequiredLoaIdentifier()	0	5	1
A	markAuthenticationModeForRequest()	0	3	1
A	getSchacHomeOrganization()	0	3	1
A	setAuthenticatingIdp()	0	5	1
A	getRequestServiceProvider()	0	3	1
A	getIdentityNameId()	0	13	3
A	setSchacHomeOrganization()	0	4	1
A	getPreferredLocale()	0	3	1
A	setRequestAssertionConsumerServiceUrl()	0	5	1
A	isSecondFactorFallback()	0	3	1
A	setResponseContextServiceId()	0	4	1
A	saveAssertion()	0	5	1
A	getGsspUserAttributeInstitution()	0	3	1
A	getResponseAction()	0	3	1
A	setVerifiedBySsoOn2faCookie()	0	5	1
A	setSecondFactorVerified()	0	5	1
A	setRequestId()	0	5	1
A	setGatewayRequestId()	0	5	1
A	setRequestServiceProvider()	0	5	1
A	getResponseContextServiceId()	0	3	1
A	getGsspUserAttributeSubject()	0	3	1
A	set()	0	3	1
A	getSsoOn2faCookieFingerprint()	0	3	1
A	getRequestId()	0	3	1
A	saveIdentityNameId()	0	5	1
A	clear()	0	7	3
A	getRequiredLoaIdentifier()	0	3	1
A	setPreferredLocale()	0	4	1
A	setSelectedSecondFactorId()	0	5	1
A	isSecondFactorVerified()	0	3	1
A	setRelayState()	0	5	1
A	setResponseAction()	0	4	1
A	isVerifiedBySsoOn2faCookie()	0	3	1
A	getAuthenticationModeForRequestId()	0	3	1
A	setSecondFactorIsFallback()	0	5	1
A	get()	0	3	1
A	getRelayState()	0	3	1
A	getAuthenticatingIdp()	0	3	1
A	getSelectedSecondFactorId()	0	3	1
A	unsetVerifiedBySsoOn2faCookie()	0	3	1
A	isForceAuthn()	0	3	1
A	unsetSelectedSecondFactorId()	0	3	1
A	setGsspUserAttributes()	0	6	1
A	__construct()	0	4	1
A	setIsForceAuthn()	0	4	1
A	getAssertion()	0	3	1
A	setSsoOn2faCookieFingerprint()	0	5	1
A	getRequestAssertionConsumerServiceUrl()	0	3	1

<?php

/**
 * Copyright 2014 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.
 */

namespace Surfnet\StepupGateway\GatewayBundle\Saml\Proxy;

use Surfnet\StepupGateway\GatewayBundle\Saml\Exception\RuntimeException;
use Symfony\Component\HttpFoundation\RequestStack;

/**
 * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
 * @SuppressWarnings(PHPMD.ExcessivePublicCount)
 */
class ProxyStateHandler
{
    public function __construct(
        private readonly RequestStack $requestStack,
        private $sessionPath,
    ) {
    }

    /**
     * Clear the complete state, leaving other states intact.
     */
    public function clear(): void
    {
        $all = $this->requestStack->getSession()->all();

        foreach (array_keys($all) as $key) {
            if (str_starts_with($key, $this->sessionPath)) {
                $this->requestStack->getSession()->remove($key);
            }
        }
    }

    public function setRequestId(string $originalRequestId): ProxyStateHandler
    {
        $this->set('request_id', $originalRequestId);

        return $this;
    }

    public function getRequestId(): ?string
    {
        return $this->get('request_id');
    }

    public function setRequestServiceProvider(string $serviceProvider): ProxyStateHandler
    {
        $this->set('service_provider', $serviceProvider);

        return $this;
    }

    public function getRequestServiceProvider(): ?string
    {
        return $this->get('service_provider');
    }

    public function setRequestAssertionConsumerServiceUrl(string $url): ProxyStateHandler
    {
        $this->set('assertion_consumer_service_url', $url);

        return $this;
    }

    public function getRequestAssertionConsumerServiceUrl(): ?string
    {
        return $this->get('assertion_consumer_service_url');
    }

    public function setRelayState(string $relayState): ProxyStateHandler
    {
        $this->set('relay_state', $relayState);

        return $this;
    }

    public function getRelayState(): ?string
    {
        return $this->get('relay_state');
    }

    public function setRequiredLoaIdentifier(?string $loaIdentifier): ProxyStateHandler
    {
        $this->set('loa_identifier', $loaIdentifier);

        return $this;
    }

    public function getRequiredLoaIdentifier(): ?string
    {
        return $this->get('loa_identifier');
    }

    public function setGatewayRequestId(string $requestId): ProxyStateHandler
    {
        $this->set('gateway_request_id', $requestId);

        return $this;
    }

    public function getGatewayRequestId(): ?string
    {
        return $this->get('gateway_request_id');
    }

    public function saveAssertion(string $assertionAsXmlString): ProxyStateHandler
    {
        $this->set('response_assertion', $assertionAsXmlString);

        return $this;
    }

    public function getAssertion(): ?string
    {
        return $this->get('response_assertion');
    }

    public function saveIdentityNameId(string $nameId): ProxyStateHandler
    {
        $this->set('name_id', $nameId);

        return $this;
    }

    public function getIdentityNameId(): string
    {
        $nameId = $this->get('name_id');
        if (!$nameId) {
            throw new RuntimeException('Unable to retrieve NameId, it was not set on the state handler');
        }

        if (!is_string($nameId)) {
            throw new RuntimeException(
                sprintf('Unable to retrieve NameId, must be a string, but a %s was set', gettype($nameId))
            );
        }
        return $nameId;
    }

    public function setAuthenticatingIdp(string $idpEntityId): ProxyStateHandler
    {
        $this->set('authenticating_idp', $idpEntityId);

        return $this;
    }

    public function getAuthenticatingIdp(): ?string
    {
        return $this->get('authenticating_idp');
    }

    public function setSelectedSecondFactorId(string $secondFactorId): ProxyStateHandler
    {
        $this->set('selected_second_factor', $secondFactorId);

        return $this;
    }

    public function unsetSelectedSecondFactorId(): void
    {
        $this->set('selected_second_factor', null);
    }

    public function getSelectedSecondFactorId(): ?string
    {
        return $this->get('selected_second_factor');
    }

    public function setSecondFactorVerified(bool $verified): ProxyStateHandler
    {
        $this->set('selected_second_factor_verified', $verified);

        return $this;
    }

    public function isSecondFactorVerified(): bool
    {
        return $this->get('selected_second_factor_verified') === true;
    }


    public function setSecondFactorIsFallback(bool $fallback): ProxyStateHandler
    {
        $this->set('selected_second_factor_fallback', $fallback);

        return $this;
    }

    public function isSecondFactorFallback(): bool
    {
        return (bool)$this->get('selected_second_factor_fallback');
    }

    public function setGsspUserAttributes(string $subject, string $institution): ProxyStateHandler
    {
        $this->set('user_attribute_subject', $subject);
        $this->set('user_attribute_institution', $institution);

        return $this;
    }

    public function getGsspUserAttributeSubject(): string
    {
        return (string)$this->get('user_attribute_subject');
    }

    public function getGsspUserAttributeInstitution(): string
    {
        return (string)$this->get('user_attribute_institution');
    }

    public function setVerifiedBySsoOn2faCookie(bool $isVerifiedByCookie): ProxyStateHandler
    {
        $this->set('verified_by_sso_on_2fa_cookie', $isVerifiedByCookie);

        return $this;
    }

    public function unsetVerifiedBySsoOn2faCookie(): void
    {
        $this->set('verified_by_sso_on_2fa_cookie', null);
    }

    public function isVerifiedBySsoOn2faCookie(): bool
    {
        return $this->get('verified_by_sso_on_2fa_cookie') === true;
    }

    public function setSsoOn2faCookieFingerprint(string $fingerprint): ProxyStateHandler
    {
        $this->set('sso_on_2fa_cookie_fingerprint', $fingerprint);

        return $this;
    }

    public function getSsoOn2faCookieFingerprint()
    {
        return $this->get('sso_on_2fa_cookie_fingerprint');
    }

    public function setResponseAction(string $controllerName): ProxyStateHandler
    {
        $this->set('response_controller', $controllerName);
        return $this;
    }

    public function getResponseAction(): ?string
    {
        return $this->get('response_controller');
    }

    public function setResponseContextServiceId(string $serviceId): ProxyStateHandler
    {
        $this->set('response_context_service_id', $serviceId);
        return $this;
    }

    public function getResponseContextServiceId(): ?string
    {
        return $this->get('response_context_service_id');
    }

    public function setSchacHomeOrganization($organization): ProxyStateHandler
    {
        $this->set('schac_home_organization', $organization);
        return $this;
    }

    public function setIsForceAuthn(bool $forceAuthn): ProxyStateHandler
    {
        $this->set('force_authn', $forceAuthn);
        return $this;
    }

    public function isForceAuthn(): bool
    {
        return $this->get('force_authn') === true;
    }

    public function getSchacHomeOrganization(): ?string
    {
        return $this->get('schac_home_organization');
    }


    public function setPreferredLocale($locale): ProxyStateHandler
    {
        $this->set('locale', $locale);
        return $this;
    }

    public function getPreferredLocale(): ?string
    {
        return $this->get('locale');
    }

    /**
     * note that the authentication mode is stored outside the session path, to enable other state handlers
     * to retrieve the Authentication state for a given authentication request id.
     *
     * @param $requestId
     * @param $authenticationMode
     */
    public function markAuthenticationModeForRequest($requestId, $authenticationMode): void
    {
        $this->requestStack->getSession()->set('surfnet/gateway/auth_mode/' . $requestId, $authenticationMode);
    }

    public function getAuthenticationModeForRequestId($requestId)
    {
        return $this->requestStack->getSession()->get('surfnet/gateway/auth_mode/' . $requestId);
    }

    protected function set($key, $value): void
    {
        $this->requestStack->getSession()->set($this->sessionPath . $key, $value);
    }

    protected function get(string $key): mixed
    {
        return $this->requestStack->getSession()->get($this->sessionPath . $key);
    }
}