GatewayController::respondAction() - Code Metrics - Inspection of "Feature/second factor only" - OpenConext/Stepup-Gateway - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#91)

by Boy

created 2016-05-26 11:50 UTC

GatewayController::respondAction() B

↳ Parent: GatewayController

Complexity

Conditions	2
Paths	2

Size

Total Lines	37
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	0	Features	1

Metric	Value
c	4
b	0
f	1
dl	0
loc	37
rs	8.8571
cc	2
eloc	23
nc	2
nop	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\Controller;

use Exception;
use Psr\Log\LoggerInterface;
use SAML2_Assertion;
use SAML2_Const;
use SAML2_Response;
use Surfnet\SamlBundle\Http\XMLResponse;
use Surfnet\SamlBundle\Monolog\SamlAuthenticationLogger;
use Surfnet\SamlBundle\SAML2\AuthnRequest;
use Surfnet\SamlBundle\SAML2\AuthnRequestFactory;
use Surfnet\StepupBundle\Value\AuthnContextClass;
use Surfnet\StepupGateway\GatewayBundle\Saml\AssertionAdapter;
use Surfnet\StepupGateway\GatewayBundle\Service\ProxyResponseService;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\HttpException;

class GatewayController extends Controller
{
    const RESPONSE_CONTEXT_SERVICE_ID = 'gateway.proxy.response_context';

    public function metadataAction()
    {
        return new XMLResponse(
          $this->get('surfnet_saml.metadata_factory')->generate()
        );
    }

    public function ssoAction(Request $httpRequest)
    {
        /** @var \Psr\Log\LoggerInterface $logger */
        $logger = $this->get('logger');
        $logger->notice('Received AuthnRequest, started processing');

        /** @var \Surfnet\SamlBundle\Http\RedirectBinding $redirectBinding */
        $redirectBinding = $this->get('surfnet_saml.http.redirect_binding');

        try {
            $originalRequest = $redirectBinding->processRequest($httpRequest);
        } catch (Exception $e) {
            $logger->critical(sprintf('Could not process Request, error: "%s"', $e->getMessage()));

            return $this->render(
              'SurfnetStepupGatewayGatewayBundle:Gateway:unrecoverableError.html.twig'
            );
        }

        $originalRequestId = $originalRequest->getRequestId();
        $logger = $this->get('surfnet_saml.logger')->forAuthentication($originalRequestId);
        $logger->notice(sprintf(
            'AuthnRequest processing complete, received AuthnRequest from "%s", request ID: "%s"',
            $originalRequest->getServiceProvider(),
            $originalRequest->getRequestId()
        ));

        /** @var \Surfnet\StepupGateway\GatewayBundle\Saml\Proxy\ProxyStateHandler $stateHandler */
        $stateHandler = $this->get('gateway.proxy.state_handler');
        $stateHandler
            ->setRequestId($originalRequestId)
            ->setRequestServiceProvider($originalRequest->getServiceProvider())
            ->setRelayState($httpRequest->get(AuthnRequest::PARAMETER_RELAY_STATE, ''))
            ->setResponseAction('SurfnetStepupGatewayGatewayBundle:Gateway:respond')
            ->setResponseContextServiceId(static::RESPONSE_CONTEXT_SERVICE_ID);

        // check if the requested Loa is supported
        $authnContextClassRef = $originalRequest->getAuthenticationContextClassRef();
        $failureResponse = $this->verifyAuthnContextClassRef(
          $authnContextClassRef,
          $logger
        );

        if ($failureResponse) {
            return $failureResponse;
        }

        $stateHandler->setRequestAuthnContextClassRef($authnContextClassRef);

        $proxyRequest = AuthnRequestFactory::createNewRequest(
            $this->get('surfnet_saml.hosted.service_provider'),
            $this->get('surfnet_saml.remote.idp')
        );

        $proxyRequest->setScoping([$originalRequest->getServiceProvider()]);
        $stateHandler->setGatewayRequestId($proxyRequest->getRequestId());

        $logger->notice(sprintf(
            'Sending Proxy AuthnRequest with request ID: "%s" for original AuthnRequest "%s"',
            $proxyRequest->getRequestId(),
            $originalRequest->getRequestId()
        ));

        return $redirectBinding->createRedirectResponseFor($proxyRequest);
    }

    public function proxySsoAction()
    {
        throw new HttpException(418, 'Not Yet Implemented');
    }

    /**
     * @param Request $request
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function consumeAssertionAction(Request $request)
    {
        $responseContext = $this->get(static::RESPONSE_CONTEXT_SERVICE_ID);
        $originalRequestId = $responseContext->getInResponseTo();

        /** @var \Surfnet\SamlBundle\Monolog\SamlAuthenticationLogger $logger */
        $logger = $this->get('surfnet_saml.logger')->forAuthentication($originalRequestId);
        $logger->notice('Received SAMLResponse, attempting to process for Proxy Response');

        try {
            $assertion = $this->get('surfnet_saml.http.post_binding')->processResponse(
                $request,
                $this->get('surfnet_saml.remote.idp'),
                $this->get('surfnet_saml.hosted.service_provider')
            );
        } catch (Exception $exception) {
            $logger->error(
              sprintf(
                'Could not process received Response, error: "%s"',
                $exception->getMessage()
              )
            );
            $responseRendering = $this->get('gateway.service.saml_response');
            return $responseRendering->renderUnprocessableResponse(
              $this->get(static::RESPONSE_CONTEXT_SERVICE_ID)
            );
        }

        $adaptedAssertion = new AssertionAdapter($assertion);
        $expectedInResponseTo = $responseContext->getExpectedInResponseTo();
        if (!$adaptedAssertion->inResponseToMatches($expectedInResponseTo)) {

            $logger->critical(sprintf(
                'Received Response with unexpected InResponseTo: "%s", %s',
                $adaptedAssertion->getInResponseTo(),
                ($expectedInResponseTo ? 'expected "' . $expectedInResponseTo . '"' : ' no response expected')
            ));

            return $this->render(
              'SurfnetStepupGatewayGatewayBundle:Gateway:unrecoverableError.html.twig'
            );
        }

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

        $responseContext->saveAssertion($assertion);

        $logger->notice(sprintf('Forwarding to second factor controller for loa determination and handling'));

        return $this->forward(
          'SurfnetStepupGatewayGatewayBundle:Selection:selectSecondFactorForVerification'
        );
    }

    public function respondAction()

    {
        $responseContext = $this->get(static::RESPONSE_CONTEXT_SERVICE_ID);
        $originalRequestId = $responseContext->getInResponseTo();

        $logger = $this->get('surfnet_saml.logger')->forAuthentication($originalRequestId);
        $logger->notice('Creating Response');

        $grantedLoa = null;
        if ($responseContext->isSecondFactorVerified()) {
            $secondFactor = $this->get('gateway.service.second_factor_service')->findByUuid(
                $responseContext->getSelectedSecondFactor()
            );

            $grantedLoa = $this->get('surfnet_stepup.service.loa_resolution')->getLoaByLevel(
                $secondFactor->getLoaLevel()
            );
        }

        $proxyResponseService = $this->get('gateway.service.response_proxy');
        $response             = $proxyResponseService->createProxyResponse(
            $responseContext->reconstituteAssertion(),
            $responseContext->getServiceProvider(),
            (string) $grantedLoa
        );

        $responseContext->responseSent();

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

        $responseRendering = $this->get('gateway.service.saml_response');
        return $responseRendering->renderResponse($responseContext, $response);
    }

    /**
     * @param $authnContextClassRef
     * @param LoggerInterface $logger
     * @return null|Response
     */
    private function verifyAuthnContextClassRef(
      $authnContextClassRef,
      LoggerInterface $logger
    ) {
        if (!$authnContextClassRef) {
            return null;
        }

        $loaResolution = $this->get('surfnet_stepup.service.loa_resolution');
        if (!$loaResolution->hasLoa($authnContextClassRef)) {

            $logger->info(
              sprintf(
                'Requested required Loa "%s" does not exist, sending response with status Requester Error',
                $authnContextClassRef
              )
            );
            $responseRendering = $this->get(
              'gateway.service.saml_response'
            );

            return $responseRendering->renderRequesterFailureResponse(
              $this->get(self::RESPONSE_CONTEXT_SERVICE_ID)
            );
        }

        $loa = $loaResolution->getLoa($authnContextClassRef);
        $authContextClass = $loa->fetchAuthnContextClassOfType(
          AuthnContextClass::TYPE_GATEWAY
        );

        if (!$authContextClass->isIdentifiedBy($authnContextClassRef)) {

            $logger->info(
              sprintf(
                'Requested required Loa "%s" is of the wrong type, sending response with status Requester Error',
                $authnContextClassRef
              )
            );
            $responseRendering = $this->get(
              'gateway.service.saml_response'
            );

            return $responseRendering->renderRequesterFailureResponse(
              $this->get(self::RESPONSE_CONTEXT_SERVICE_ID)
            );
        }

        return null;
    }
}


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\Controller;
20
21		use Exception;
22		use Psr\Log\LoggerInterface;
23		use SAML2_Assertion;
24		use SAML2_Const;
25		use SAML2_Response;
26		use Surfnet\SamlBundle\Http\XMLResponse;
27		use Surfnet\SamlBundle\Monolog\SamlAuthenticationLogger;
28		use Surfnet\SamlBundle\SAML2\AuthnRequest;
29		use Surfnet\SamlBundle\SAML2\AuthnRequestFactory;
30		use Surfnet\StepupBundle\Value\AuthnContextClass;
31		use Surfnet\StepupGateway\GatewayBundle\Saml\AssertionAdapter;
32		use Surfnet\StepupGateway\GatewayBundle\Service\ProxyResponseService;
33		use Symfony\Bundle\FrameworkBundle\Controller\Controller;
34		use Symfony\Component\HttpFoundation\Request;
35		use Symfony\Component\HttpFoundation\Response;
36		use Symfony\Component\HttpKernel\Exception\HttpException;
37
38		class GatewayController extends Controller
39		{
40		const RESPONSE_CONTEXT_SERVICE_ID = 'gateway.proxy.response_context';
41
42		public function metadataAction()
43		{
44		return new XMLResponse(
45		$this->get('surfnet_saml.metadata_factory')->generate()
46		);
47		}
48
49		public function ssoAction(Request $httpRequest)
50		{
51		/** @var \Psr\Log\LoggerInterface $logger */
52		$logger = $this->get('logger');
53		$logger->notice('Received AuthnRequest, started processing');
54
55		/** @var \Surfnet\SamlBundle\Http\RedirectBinding $redirectBinding */
56		$redirectBinding = $this->get('surfnet_saml.http.redirect_binding');
57
58		try {
59		$originalRequest = $redirectBinding->processRequest($httpRequest);
60		} catch (Exception $e) {
61		$logger->critical(sprintf('Could not process Request, error: "%s"', $e->getMessage()));
62
63		return $this->render(
64		'SurfnetStepupGatewayGatewayBundle:Gateway:unrecoverableError.html.twig'
65		);
66		}
67
68		$originalRequestId = $originalRequest->getRequestId();
69		$logger = $this->get('surfnet_saml.logger')->forAuthentication($originalRequestId);
70		$logger->notice(sprintf(
71		'AuthnRequest processing complete, received AuthnRequest from "%s", request ID: "%s"',
72		$originalRequest->getServiceProvider(),
73		$originalRequest->getRequestId()
74		));
75
76		/** @var \Surfnet\StepupGateway\GatewayBundle\Saml\Proxy\ProxyStateHandler $stateHandler */
77		$stateHandler = $this->get('gateway.proxy.state_handler');
78		$stateHandler
79		->setRequestId($originalRequestId)
80		->setRequestServiceProvider($originalRequest->getServiceProvider())
81		->setRelayState($httpRequest->get(AuthnRequest::PARAMETER_RELAY_STATE, ''))
82		->setResponseAction('SurfnetStepupGatewayGatewayBundle:Gateway:respond')
83		->setResponseContextServiceId(static::RESPONSE_CONTEXT_SERVICE_ID);
84
85		// check if the requested Loa is supported
86		$authnContextClassRef = $originalRequest->getAuthenticationContextClassRef();
87		$failureResponse = $this->verifyAuthnContextClassRef(
88		$authnContextClassRef,
89		$logger
90		);
91
92		if ($failureResponse) {
93		return $failureResponse;
94		}
95
96		$stateHandler->setRequestAuthnContextClassRef($authnContextClassRef);
97
98		$proxyRequest = AuthnRequestFactory::createNewRequest(
99		$this->get('surfnet_saml.hosted.service_provider'),
100		$this->get('surfnet_saml.remote.idp')
101		);
102
103		$proxyRequest->setScoping([$originalRequest->getServiceProvider()]);
104		$stateHandler->setGatewayRequestId($proxyRequest->getRequestId());
105
106		$logger->notice(sprintf(
107		'Sending Proxy AuthnRequest with request ID: "%s" for original AuthnRequest "%s"',
108		$proxyRequest->getRequestId(),
109		$originalRequest->getRequestId()
110		));
111
112		return $redirectBinding->createRedirectResponseFor($proxyRequest);
113		}
114
115		public function proxySsoAction()
116		{
117		throw new HttpException(418, 'Not Yet Implemented');
118		}
119
120		/**
121		* @param Request $request
122		* @return \Symfony\Component\HttpFoundation\Response
123		*/
124		public function consumeAssertionAction(Request $request)
125		{
126		$responseContext = $this->get(static::RESPONSE_CONTEXT_SERVICE_ID);
127		$originalRequestId = $responseContext->getInResponseTo();
128
129		/** @var \Surfnet\SamlBundle\Monolog\SamlAuthenticationLogger $logger */
130		$logger = $this->get('surfnet_saml.logger')->forAuthentication($originalRequestId);
131		$logger->notice('Received SAMLResponse, attempting to process for Proxy Response');
132
133		try {
134		$assertion = $this->get('surfnet_saml.http.post_binding')->processResponse(
135		$request,
136		$this->get('surfnet_saml.remote.idp'),
137		$this->get('surfnet_saml.hosted.service_provider')
138		);
139		} catch (Exception $exception) {
140		$logger->error(
141		sprintf(
142		'Could not process received Response, error: "%s"',
143		$exception->getMessage()
144		)
145		);
146		$responseRendering = $this->get('gateway.service.saml_response');
147		return $responseRendering->renderUnprocessableResponse(
148		$this->get(static::RESPONSE_CONTEXT_SERVICE_ID)
149		);
150		}
151
152		$adaptedAssertion = new AssertionAdapter($assertion);
153		$expectedInResponseTo = $responseContext->getExpectedInResponseTo();
154	View Code Duplication	if (!$adaptedAssertion->inResponseToMatches($expectedInResponseTo)) {
		0 ignored issues – show Duplication introduced 2015-12-15 13:35 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
155		$logger->critical(sprintf(
156		'Received Response with unexpected InResponseTo: "%s", %s',
157		$adaptedAssertion->getInResponseTo(),
158		($expectedInResponseTo ? 'expected "' . $expectedInResponseTo . '"' : ' no response expected')
159		));
160
161		return $this->render(
162		'SurfnetStepupGatewayGatewayBundle:Gateway:unrecoverableError.html.twig'
163		);
164		}
165
166		$logger->notice('Successfully processed SAMLResponse');
167
168		$responseContext->saveAssertion($assertion);
169
170		$logger->notice(sprintf('Forwarding to second factor controller for loa determination and handling'));
171
172		return $this->forward(
173		'SurfnetStepupGatewayGatewayBundle:Selection:selectSecondFactorForVerification'
174		);
175		}
176
177		public function respondAction()
		0 ignored issues – show Documentation introduced 2016-05-25 10:22 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
178		{
179		$responseContext = $this->get(static::RESPONSE_CONTEXT_SERVICE_ID);
180		$originalRequestId = $responseContext->getInResponseTo();
181
182		$logger = $this->get('surfnet_saml.logger')->forAuthentication($originalRequestId);
183		$logger->notice('Creating Response');
184
185		$grantedLoa = null;
186		if ($responseContext->isSecondFactorVerified()) {
187		$secondFactor = $this->get('gateway.service.second_factor_service')->findByUuid(
188		$responseContext->getSelectedSecondFactor()
189		);
190
191		$grantedLoa = $this->get('surfnet_stepup.service.loa_resolution')->getLoaByLevel(
192		$secondFactor->getLoaLevel()
193		);
194		}
195
196		$proxyResponseService = $this->get('gateway.service.response_proxy');
197		$response = $proxyResponseService->createProxyResponse(
198		$responseContext->reconstituteAssertion(),
199		$responseContext->getServiceProvider(),
200		(string) $grantedLoa
201		);
202
203		$responseContext->responseSent();
204
205		$logger->notice(sprintf(
206		'Responding to request "%s" with response based on response from the remote IdP with response "%s"',
207		$responseContext->getInResponseTo(),
208		$response->getId()
209		));
210
211		$responseRendering = $this->get('gateway.service.saml_response');
212		return $responseRendering->renderResponse($responseContext, $response);
213		}
214
215		/**
216		* @param $authnContextClassRef
217		* @param LoggerInterface $logger
218		* @return null\|Response
219		*/
220		private function verifyAuthnContextClassRef(
221		$authnContextClassRef,
222		LoggerInterface $logger
223		) {
224		if (!$authnContextClassRef) {
225		return null;
226		}
227
228		$loaResolution = $this->get('surfnet_stepup.service.loa_resolution');
229	View Code Duplication	if (!$loaResolution->hasLoa($authnContextClassRef)) {
		0 ignored issues – show Duplication introduced 2016-05-26 10:20 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
230		$logger->info(
231		sprintf(
232		'Requested required Loa "%s" does not exist, sending response with status Requester Error',
233		$authnContextClassRef
234		)
235		);
236		$responseRendering = $this->get(
237		'gateway.service.saml_response'
238		);
239
240		return $responseRendering->renderRequesterFailureResponse(
241		$this->get(self::RESPONSE_CONTEXT_SERVICE_ID)
242		);
243		}
244
245		$loa = $loaResolution->getLoa($authnContextClassRef);
246		$authContextClass = $loa->fetchAuthnContextClassOfType(
247		AuthnContextClass::TYPE_GATEWAY
248		);
249
250	View Code Duplication	if (!$authContextClass->isIdentifiedBy($authnContextClassRef)) {
		0 ignored issues – show Duplication introduced 2016-05-26 10:20 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
251		$logger->info(
252		sprintf(
253		'Requested required Loa "%s" is of the wrong type, sending response with status Requester Error',
254		$authnContextClassRef
255		)
256		);
257		$responseRendering = $this->get(
258		'gateway.service.saml_response'
259		);
260
261		return $responseRendering->renderRequesterFailureResponse(
262		$this->get(self::RESPONSE_CONTEXT_SERVICE_ID)
263		);
264		}
265
266		return null;
267		}
268		}
269

OpenConext / Stepup-Gateway

Pull Request — develop (#91)

GatewayController::respondAction() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like