ProxyStateHandler::setSsoOn2faCookieFingerprint() - Code Metrics - Inspection of "Add GSSP fallback implementation" - OpenConext/Stepup-Gateway - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#447)

unknown

created 2025-05-26 15:08 UTC

ProxyStateHandler::setSsoOn2faCookieFingerprint() A

↳ Parent: ProxyStateHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	5
rs	10
c	0
b	0
f	0

<?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);
    }
}


1			<?php
2
3			/**
4			* Copyright 2014 SURFnet bv
5			*
6			* Licensed under the Apache License, Version 2.0 (the "License");
7			* you may not use this file except in compliance with the License.
8			* You may obtain a copy of the License at
9			*
10			* http://www.apache.org/licenses/LICENSE-2.0
11			*
12			* Unless required by applicable law or agreed to in writing, software
13			* distributed under the License is distributed on an "AS IS" BASIS,
14			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15			* See the License for the specific language governing permissions and
16			* limitations under the License.
17			*/
18
19			namespace Surfnet\StepupGateway\GatewayBundle\Saml\Proxy;
20
21			use Surfnet\StepupGateway\GatewayBundle\Saml\Exception\RuntimeException;
22			use Symfony\Component\HttpFoundation\RequestStack;
23
24			/**
25			* @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
26			* @SuppressWarnings(PHPMD.ExcessivePublicCount)
27			*/
28			class ProxyStateHandler
29			{
30			public function __construct(
31			private readonly RequestStack $requestStack,
32			private $sessionPath,
33			) {
34			}
35
36			/**
37			* Clear the complete state, leaving other states intact.
38			*/
39			public function clear(): void
40			{
41			$all = $this->requestStack->getSession()->all();
42
43			foreach (array_keys($all) as $key) {
44			if (str_starts_with($key, $this->sessionPath)) {
45			$this->requestStack->getSession()->remove($key);
46			}
47			}
48			}
49
50			public function setRequestId(string $originalRequestId): ProxyStateHandler
51			{
52			$this->set('request_id', $originalRequestId);
53
54			return $this;
55			}
56
57			public function getRequestId(): ?string
58			{
59			return $this->get('request_id');
60			}
61
62			public function setRequestServiceProvider(string $serviceProvider): ProxyStateHandler
63			{
64			$this->set('service_provider', $serviceProvider);
65
66			return $this;
67			}
68
69			public function getRequestServiceProvider(): ?string
70			{
71			return $this->get('service_provider');
72			}
73
74			public function setRequestAssertionConsumerServiceUrl(string $url): ProxyStateHandler
75			{
76			$this->set('assertion_consumer_service_url', $url);
77
78			return $this;
79			}
80
81			public function getRequestAssertionConsumerServiceUrl(): ?string
82			{
83			return $this->get('assertion_consumer_service_url');
84			}
85
86			public function setRelayState(string $relayState): ProxyStateHandler
87			{
88			$this->set('relay_state', $relayState);
89
90			return $this;
91			}
92
93			public function getRelayState(): ?string
94			{
95			return $this->get('relay_state');
96			}
97
98			public function setRequiredLoaIdentifier(?string $loaIdentifier): ProxyStateHandler
99			{
100			$this->set('loa_identifier', $loaIdentifier);
101
102			return $this;
103			}
104
105			public function getRequiredLoaIdentifier(): ?string
106			{
107			return $this->get('loa_identifier');
108			}
109
110			public function setGatewayRequestId(string $requestId): ProxyStateHandler
111			{
112			$this->set('gateway_request_id', $requestId);
113
114			return $this;
115			}
116
117			public function getGatewayRequestId(): ?string
118			{
119			return $this->get('gateway_request_id');
120			}
121
122			public function saveAssertion(string $assertionAsXmlString): ProxyStateHandler
123			{
124			$this->set('response_assertion', $assertionAsXmlString);
125
126			return $this;
127			}
128
129			public function getAssertion(): ?string
130			{
131			return $this->get('response_assertion');
132			}
133
134			public function saveIdentityNameId(string $nameId): ProxyStateHandler
135			{
136			$this->set('name_id', $nameId);
137
138			return $this;
139			}
140
141			public function getIdentityNameId(): string
142			{
143			$nameId = $this->get('name_id');
144			if (!$nameId) {
145			throw new RuntimeException('Unable to retrieve NameId, it was not set on the state handler');
146			}
147
148			if (!is_string($nameId)) {
149			throw new RuntimeException(
150			sprintf('Unable to retrieve NameId, must be a string, but a %s was set', gettype($nameId))
151			);
152			}
153			return $nameId;
154			}
155
156			public function setAuthenticatingIdp(string $idpEntityId): ProxyStateHandler
157			{
158			$this->set('authenticating_idp', $idpEntityId);
159
160			return $this;
161			}
162
163			public function getAuthenticatingIdp(): ?string
164			{
165			return $this->get('authenticating_idp');
166			}
167
168			public function setSelectedSecondFactorId(string $secondFactorId): ProxyStateHandler
169			{
170			$this->set('selected_second_factor', $secondFactorId);
171
172			return $this;
173			}
174
175			public function unsetSelectedSecondFactorId(): void
176			{
177			$this->set('selected_second_factor', null);
178			}
179
180			public function getSelectedSecondFactorId(): ?string
181			{
182			return $this->get('selected_second_factor');
183			}
184
185			public function setSecondFactorVerified(bool $verified): ProxyStateHandler
186			{
187			$this->set('selected_second_factor_verified', $verified);
188
189			return $this;
190			}
191
192			public function isSecondFactorVerified(): bool
193			{
194			return $this->get('selected_second_factor_verified') === true;
195			}
196
197
198			public function setSecondFactorIsFallback(bool $fallback): ProxyStateHandler
199			{
200			$this->set('selected_second_factor_fallback', $fallback);
201
202			return $this;
203			}
204
205			public function isSecondFactorFallback(): bool
206			{
207			return (bool)$this->get('selected_second_factor_fallback');
208			}
209
210			public function setGsspUserAttributes(string $subject, string $institution): ProxyStateHandler
211			{
212			$this->set('user_attribute_subject', $subject);
213			$this->set('user_attribute_institution', $institution);
214
215			return $this;
216			}
217
218			public function getGsspUserAttributeSubject(): string
219			{
220			return (string)$this->get('user_attribute_subject');
221			}
222
223			public function getGsspUserAttributeInstitution(): string
224			{
225			return (string)$this->get('user_attribute_institution');
226			}
227
228			public function setVerifiedBySsoOn2faCookie(bool $isVerifiedByCookie): ProxyStateHandler
229			{
230			$this->set('verified_by_sso_on_2fa_cookie', $isVerifiedByCookie);
231
232			return $this;
233			}
234
235			public function unsetVerifiedBySsoOn2faCookie(): void
236			{
237			$this->set('verified_by_sso_on_2fa_cookie', null);
238			}
239
240			public function isVerifiedBySsoOn2faCookie(): bool
241			{
242			return $this->get('verified_by_sso_on_2fa_cookie') === true;
243			}
244
245			public function setSsoOn2faCookieFingerprint(string $fingerprint): ProxyStateHandler
246			{
247			$this->set('sso_on_2fa_cookie_fingerprint', $fingerprint);
248
249			return $this;
250			}
251
252			public function getSsoOn2faCookieFingerprint()
253			{
254			return $this->get('sso_on_2fa_cookie_fingerprint');
255			}
256
257			public function setResponseAction(string $controllerName): ProxyStateHandler
258			{
259			$this->set('response_controller', $controllerName);
260			return $this;
261			}
262
263			public function getResponseAction(): ?string
264			{
265			return $this->get('response_controller');
266			}
267
268			public function setResponseContextServiceId(string $serviceId): ProxyStateHandler
269			{
270			$this->set('response_context_service_id', $serviceId);
271			return $this;
272			}
273
274			public function getResponseContextServiceId(): ?string
275			{
276			return $this->get('response_context_service_id');
277			}
278
279			public function setSchacHomeOrganization($organization): ProxyStateHandler
280			{
281			$this->set('schac_home_organization', $organization);
282			return $this;
283			}
284
285			public function setIsForceAuthn(bool $forceAuthn): ProxyStateHandler
286			{
287			$this->set('force_authn', $forceAuthn);
288			return $this;
289			}
290
291			public function isForceAuthn(): bool
292			{
293			return $this->get('force_authn') === true;
294			}
295
296			public function getSchacHomeOrganization(): ?string
297			{
298			return $this->get('schac_home_organization');
299			}
300
301
302			public function setPreferredLocale($locale): ProxyStateHandler
303			{
304			$this->set('locale', $locale);
305			return $this;
306			}
307
308			public function getPreferredLocale(): ?string
309			{
310			return $this->get('locale');
311			}
312
313			/**
314			* note that the authentication mode is stored outside the session path, to enable other state handlers
315			* to retrieve the Authentication state for a given authentication request id.
316			*
317			* @param $requestId
318			* @param $authenticationMode
319			*/
320			public function markAuthenticationModeForRequest($requestId, $authenticationMode): void
321			{
322			$this->requestStack->getSession()->set('surfnet/gateway/auth_mode/' . $requestId, $authenticationMode);
323			}
324
325			public function getAuthenticationModeForRequestId($requestId)
326			{
327			return $this->requestStack->getSession()->get('surfnet/gateway/auth_mode/' . $requestId);
328			}
329
330			protected function set($key, $value): void
331			{
332			$this->requestStack->getSession()->set($this->sessionPath . $key, $value);
333			}
334
335			protected function get(string $key): mixed
336			{
337			return $this->requestStack->getSession()->get($this->sessionPath . $key);
338			}
339			}
340

OpenConext / Stepup-Gateway

Pull Request — main (#447)

ProxyStateHandler::setSsoOn2faCookieFingerprint() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like