ConsumeAssertionService::consumeAssertion() - Code Metrics - Inspection of "Add gateway endpoint tests" - OpenConext/Stepup-Gateway - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/refactor-gateway-contr... ( 48680d...09b176 )

unknown

created 2018-08-27 12:56 UTC

ConsumeAssertionService::consumeAssertion() B

↳ Parent: ConsumeAssertionService

Complexity

Conditions	7
Paths	10

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	74
rs	7.6339
c	0
b	0
f	0
cc	7
nc	10
nop	3

How to fix Long Method

<?php

namespace Surfnet\StepupGateway\SamlStepupProviderBundle\Service\Gateway;

use Exception;
use Psr\Log\LoggerInterface;
use Surfnet\SamlBundle\Http\PostBinding;
use Surfnet\SamlBundle\Monolog\SamlAuthenticationLogger;
use Surfnet\StepupGateway\GatewayBundle\Entity\ServiceProvider;
use Surfnet\StepupGateway\GatewayBundle\Exception\ResponseFailureException;
use Surfnet\StepupGateway\GatewayBundle\Saml\AssertionAdapter;
use Surfnet\StepupGateway\GatewayBundle\Saml\Exception\UnknownInResponseToException;
use Surfnet\StepupGateway\SamlStepupProviderBundle\Exception\InvalidSubjectException;
use Surfnet\StepupGateway\SamlStepupProviderBundle\Exception\SecondfactorVerfificationRequiredException;
use Surfnet\StepupGateway\SamlStepupProviderBundle\Provider\ConnectedServiceProviders;
use Surfnet\StepupGateway\SamlStepupProviderBundle\Provider\Provider;
use Surfnet\StepupGateway\SamlStepupProviderBundle\Saml\ProxyResponseFactory;
use Symfony\Component\HttpFoundation\Request;

/**
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 */
class ConsumeAssertionService
{
    /** @var LoggerInterface */
    private $logger;

    /** @var SamlAuthenticationLogger */
    private $samlLogger;

    /** @var PostBinding */
    private $postBinding;

    /** @var ConnectedServiceProviders */
    private $connectedServiceProviders;

    /**
     * ConsumeAssertionService constructor.
     * @param LoggerInterface $logger
     * @param SamlAuthenticationLogger $samlLogger
     * @param PostBinding $postBinding
     * @param ConnectedServiceProviders $connectedServiceProviders
     */
    public function __construct(
        LoggerInterface $logger,
        SamlAuthenticationLogger $samlLogger,
        PostBinding $postBinding,
        ConnectedServiceProviders $connectedServiceProviders
    ) {
        $this->logger = $logger;
        $this->samlLogger = $samlLogger;
        $this->postBinding = $postBinding;
        $this->connectedServiceProviders = $connectedServiceProviders;
    }

    /**
     * Process an assertion received from a remote GSSP application.
     *
     * There are two possible outcomes for a valid flow:
     *
     *  1. in case of registration: a SAMLResponse is returned
     *  2. in case of verification: a SecondfactorVerfificationRequiredException exception is thrown
     *
     * @param Provider $provider
     * @param Request $httpRequest
     * @param ProxyResponseFactory $proxyResponseFactory
     * @return \SAML2\Response
     * @throws Exception
     */
    public function consumeAssertion(Provider $provider, Request $httpRequest, ProxyResponseFactory $proxyResponseFactory)

    {
        $stateHandler = $provider->getStateHandler();
        $originalRequestId = $stateHandler->getRequestId();

        $logger = $this->samlLogger->forAuthentication($originalRequestId);

        $action = $stateHandler->hasSubject() ? 'Second Factor Verification' : 'Proxy Response';
        $logger->notice(
            sprintf('Received SAMLResponse, attempting to process for %s', $action)
        );

        try {
            $assertion = $this->postBinding->processResponse(
                $httpRequest,
                $provider->getRemoteIdentityProvider(),
                $provider->getServiceProvider()
            );
        } catch (Exception $exception) {
            $message = sprintf('Could not process received Response, error: "%s"', $exception->getMessage());
            $logger->error($message);

            throw new ResponseFailureException($message);
        }

        $adaptedAssertion = new AssertionAdapter($assertion);
        $expectedResponse = $stateHandler->getGatewayRequestId();
        if (!$adaptedAssertion->inResponseToMatches($expectedResponse)) {
            throw new UnknownInResponseToException(
                $adaptedAssertion->getInResponseTo(),
                $expectedResponse
            );
        }

        $authenticatedNameId = $assertion->getNameId();
        $isSubjectRequested = $stateHandler->hasSubject();
        if ($isSubjectRequested && ($stateHandler->getSubject() !== $authenticatedNameId->value)) {
            $message = sprintf(
                'Requested Subject NameID "%s" and Response NameID "%s" do not match',
                $stateHandler->getSubject(),
                $authenticatedNameId->value
            );
            $logger->critical($message);

            throw new InvalidSubjectException($message);
        }

        $logger->notice('Successfully processed SAMLResponse');

        if ($stateHandler->secondFactorVerificationRequested()) {
            $message = 'Second Factor verification was requested and was successful, forwarding to SecondFactor handling';

            $logger->notice($message);

            throw new SecondfactorVerfificationRequiredException($message);
        }

        $targetServiceProvider = $this->getServiceProvider($stateHandler->getRequestServiceProvider());

        $response = $proxyResponseFactory->createProxyResponse(
            $assertion,
            $targetServiceProvider->determineAcsLocation(
                $stateHandler->getRequestAssertionConsumerServiceUrl(),
                $this->logger
            )
        );

        $logger->notice(sprintf(
            'Responding to request "%s" with response based on response from the remote IdP with response "%s"',
            $stateHandler->getRequestId(),
            $response->getId()
        ));

        return $response;
    }

    /**
     * @param string $serviceProvider
     * @return ServiceProvider
     */
    private function getServiceProvider($serviceProvider)
    {
        return $this->connectedServiceProviders->getConfigurationOf($serviceProvider);
    }
}


1			<?php
2
3			namespace Surfnet\StepupGateway\SamlStepupProviderBundle\Service\Gateway;
4
5			use Exception;
6			use Psr\Log\LoggerInterface;
7			use Surfnet\SamlBundle\Http\PostBinding;
8			use Surfnet\SamlBundle\Monolog\SamlAuthenticationLogger;
9			use Surfnet\StepupGateway\GatewayBundle\Entity\ServiceProvider;
10			use Surfnet\StepupGateway\GatewayBundle\Exception\ResponseFailureException;
11			use Surfnet\StepupGateway\GatewayBundle\Saml\AssertionAdapter;
12			use Surfnet\StepupGateway\GatewayBundle\Saml\Exception\UnknownInResponseToException;
13			use Surfnet\StepupGateway\SamlStepupProviderBundle\Exception\InvalidSubjectException;
14			use Surfnet\StepupGateway\SamlStepupProviderBundle\Exception\SecondfactorVerfificationRequiredException;
15			use Surfnet\StepupGateway\SamlStepupProviderBundle\Provider\ConnectedServiceProviders;
16			use Surfnet\StepupGateway\SamlStepupProviderBundle\Provider\Provider;
17			use Surfnet\StepupGateway\SamlStepupProviderBundle\Saml\ProxyResponseFactory;
18			use Symfony\Component\HttpFoundation\Request;
19
20			/**
21			* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
22			*/
23			class ConsumeAssertionService
24			{
25			/** @var LoggerInterface */
26			private $logger;
27
28			/** @var SamlAuthenticationLogger */
29			private $samlLogger;
30
31			/** @var PostBinding */
32			private $postBinding;
33
34			/** @var ConnectedServiceProviders */
35			private $connectedServiceProviders;
36
37			/**
38			* ConsumeAssertionService constructor.
39			* @param LoggerInterface $logger
40			* @param SamlAuthenticationLogger $samlLogger
41			* @param PostBinding $postBinding
42			* @param ConnectedServiceProviders $connectedServiceProviders
43			*/
44			public function __construct(
45			LoggerInterface $logger,
46			SamlAuthenticationLogger $samlLogger,
47			PostBinding $postBinding,
48			ConnectedServiceProviders $connectedServiceProviders
49			) {
50			$this->logger = $logger;
51			$this->samlLogger = $samlLogger;
52			$this->postBinding = $postBinding;
53			$this->connectedServiceProviders = $connectedServiceProviders;
54			}
55
56			/**
57			* Process an assertion received from a remote GSSP application.
58			*
59			* There are two possible outcomes for a valid flow:
60			*
61			* 1. in case of registration: a SAMLResponse is returned
62			* 2. in case of verification: a SecondfactorVerfificationRequiredException exception is thrown
63			*
64			* @param Provider $provider
65			* @param Request $httpRequest
66			* @param ProxyResponseFactory $proxyResponseFactory
67			* @return \SAML2\Response
68			* @throws Exception
69			*/
70			public function consumeAssertion(Provider $provider, Request $httpRequest, ProxyResponseFactory $proxyResponseFactory)
			0 ignored issues – show Coding Style introduced 2018-08-23 15:38 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 122 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
71			{
72			$stateHandler = $provider->getStateHandler();
73			$originalRequestId = $stateHandler->getRequestId();
74
75			$logger = $this->samlLogger->forAuthentication($originalRequestId);
76
77			$action = $stateHandler->hasSubject() ? 'Second Factor Verification' : 'Proxy Response';
78			$logger->notice(
79			sprintf('Received SAMLResponse, attempting to process for %s', $action)
80			);
81
82			try {
83			$assertion = $this->postBinding->processResponse(
84			$httpRequest,
85			$provider->getRemoteIdentityProvider(),
86			$provider->getServiceProvider()
87			);
88			} catch (Exception $exception) {
89			$message = sprintf('Could not process received Response, error: "%s"', $exception->getMessage());
90			$logger->error($message);
91
92			throw new ResponseFailureException($message);
93			}
94
95			$adaptedAssertion = new AssertionAdapter($assertion);
96			$expectedResponse = $stateHandler->getGatewayRequestId();
97			if (!$adaptedAssertion->inResponseToMatches($expectedResponse)) {
98			throw new UnknownInResponseToException(
99			$adaptedAssertion->getInResponseTo(),
100			$expectedResponse
101			);
102			}
103
104			$authenticatedNameId = $assertion->getNameId();
105			$isSubjectRequested = $stateHandler->hasSubject();
106			if ($isSubjectRequested && ($stateHandler->getSubject() !== $authenticatedNameId->value)) {
107			$message = sprintf(
108			'Requested Subject NameID "%s" and Response NameID "%s" do not match',
109			$stateHandler->getSubject(),
110			$authenticatedNameId->value
111			);
112			$logger->critical($message);
113
114			throw new InvalidSubjectException($message);
115			}
116
117			$logger->notice('Successfully processed SAMLResponse');
118
119			if ($stateHandler->secondFactorVerificationRequested()) {
120			$message = 'Second Factor verification was requested and was successful, forwarding to SecondFactor handling';
			0 ignored issues – show Coding Style introduced 2018-08-23 15:38 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 122 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
121			$logger->notice($message);
122
123			throw new SecondfactorVerfificationRequiredException($message);
124			}
125
126			$targetServiceProvider = $this->getServiceProvider($stateHandler->getRequestServiceProvider());
127
128			$response = $proxyResponseFactory->createProxyResponse(
129			$assertion,
130			$targetServiceProvider->determineAcsLocation(
131			$stateHandler->getRequestAssertionConsumerServiceUrl(),
132			$this->logger
133			)
134			);
135
136			$logger->notice(sprintf(
137			'Responding to request "%s" with response based on response from the remote IdP with response "%s"',
138			$stateHandler->getRequestId(),
139			$response->getId()
140			));
141
142			return $response;
143			}
144
145			/**
146			* @param string $serviceProvider
147			* @return ServiceProvider
148			*/
149			private function getServiceProvider($serviceProvider)
150			{
151			return $this->connectedServiceProviders->getConfigurationOf($serviceProvider);
152			}
153			}
154

OpenConext / Stepup-Gateway

Push — feature/refactor-gateway-contr... ( 48680d...09b176 )

ConsumeAssertionService::consumeAssertion() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like