GatewayController::ssoAction() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/feature/refac..." - OpenConext/Stepup-Gateway - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/tests-and-symfony-34 ( d06f89 )

by Michiel

created 2018-08-28 10:20 UTC

GatewayController::ssoAction() A

↳ Parent: GatewayController

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	20
rs	9.6
c	0
b	0
f	0
cc	2
nc	2
nop	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\Controller;

use SAML2\Response as SAMLResponse;
use Surfnet\StepupGateway\GatewayBundle\Exception\RequesterFailureException;
use Surfnet\StepupGateway\GatewayBundle\Exception\ResponseFailureException;
use Surfnet\StepupGateway\GatewayBundle\Service\Gateway\ConsumeAssertionService;
use Surfnet\StepupGateway\GatewayBundle\Service\Gateway\FailedResponseService;
use Surfnet\StepupGateway\GatewayBundle\Service\Gateway\LoginService;
use Surfnet\StepupGateway\GatewayBundle\Service\Gateway\RespondService;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\HttpException;

/**
 * Entry point for the Stepup login flow.
 *
 * See docs/GatewayState.md for a high-level diagram on how this controller
 * interacts with outside actors and other parts of Stepup.
 */
class GatewayController extends Controller
{
    const RESPONSE_CONTEXT_SERVICE_ID = 'gateway.proxy.response_context';

    /**
     * Receive an AuthnRequest from a service provider.
     *
     * The service provider is either a Stepup component (SelfService, RA) or
     * an external service provider.
     *
     * This single sign-on action will start a new SAML request to the remote
     * IDP configured in Stepup (most likely to be an instance of OpenConext
     * EngineBlock).
     *
     * @param Request $httpRequest
     * @return \Symfony\Component\HttpFoundation\RedirectResponse|Response
     */
    public function ssoAction(Request $httpRequest)
    {
        /** @var \Psr\Log\LoggerInterface $logger */
        $logger = $this->get('logger');

        $redirectBinding = $this->get('surfnet_saml.http.redirect_binding');
        $gatewayLoginService = $this->getGatewayLoginService();

        $logger->notice('Received AuthnRequest, started processing');

        try {
            $proxyRequest = $gatewayLoginService->singleSignOn($httpRequest);
        } catch (RequesterFailureException $e) {
            $response = $this->getGatewayFailedResponseService()->createRequesterFailureResponse($this->getResponseContext());


            return $this->renderSamlResponse('consumeAssertion', $response);
        }

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

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

    /**
     * Receive an AuthnResponse from an identity provider.
     *
     * The AuthnRequest started in ssoAction() resulted in an AuthnResponse
     * from the IDP. This method handles the assertion and forwards the user
     * using an internal redirect to the SecondFactorController to start the
     * actual second factor verification.
     *
     * @param Request $request
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function consumeAssertionAction(Request $request)
    {
        $responseContext = $this->getResponseContext();
        $gatewayLoginService = $this->getGatewayConsumeAssertionService();

        try {
            $gatewayLoginService->consumeAssertion($request, $responseContext);
        } catch (ResponseFailureException $e) {
            $response = $this->getGatewayFailedResponseService()->createResponseFailureResponse($responseContext);

            return $this->renderSamlResponse('unprocessableResponse', $response);
        }

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

    /**
     * Send a SAML response back to the service provider.
     *
     * Second factor verification handled by SecondFactorController is
     * finished. The user was forwarded back to this action with an internal
     * redirect. This method sends a AuthnResponse back to the service
     * provider in response to the AuthnRequest received in ssoAction().
     */
    public function respondAction()
    {
        $responseContext = $this->getResponseContext();
        $gatewayLoginService = $this->getGatewayRespondService();

        $response = $gatewayLoginService->respond($responseContext);
        $gatewayLoginService->resetRespondState($responseContext);

        return $this->renderSamlResponse('consumeAssertion', $response);
    }

    /**
     * @return Response
     */
    public function sendLoaCannotBeGivenAction()

    {
        $responseContext = $this->getResponseContext();
        $gatewayLoginService = $this->getGatewayFailedResponseService();

        $response = $gatewayLoginService->sendLoaCannotBeGiven($responseContext);

        return $this->renderSamlResponse('consumeAssertion', $response);
    }

    /**
     * @return Response
     */
    public function sendAuthenticationCancelledByUserAction()

    {
        $responseContext = $this->getResponseContext();
        $gatewayLoginService = $this->getGatewayFailedResponseService();

        $response = $gatewayLoginService->sendAuthenticationCancelledByUser($responseContext);

        return $this->renderSamlResponse('consumeAssertion', $response);
    }

    /**
     * @param string         $view
     * @param SAMLResponse $response
     * @return Response
     */
    public function renderSamlResponse($view, SAMLResponse $response)

    {
        $responseContext = $this->getResponseContext();

        return $this->render($view, [
            'acu'        => $responseContext->getDestination(),
            'response'   => $this->getResponseAsXML($response),
            'relayState' => $responseContext->getRelayState()
        ]);
    }

    /**
     * @param string   $view
     * @param array    $parameters
     * @param Response $response

     * @return Response
     */
    public function render($view, array $parameters = array(), Response $response = null)
    {
        return parent::render(
            'SurfnetStepupGatewayGatewayBundle:Gateway:' . $view . '.html.twig',
            $parameters,
            $response
        );
    }

    /**
     * @return \Surfnet\StepupGateway\GatewayBundle\Saml\ResponseContext
     */
    public function getResponseContext()
    {
        $stateHandler = $this->get('gateway.proxy.state_handler');

        $responseContextServiceId = $stateHandler->getResponseContextServiceId();

        if (!$responseContextServiceId) {
            return $this->get(static::RESPONSE_CONTEXT_SERVICE_ID);
        }

        return $this->get($responseContextServiceId);
    }

    /**
     * @param SAMLResponse $response
     * @return string
     */
    private function getResponseAsXML(SAMLResponse $response)
    {
        return base64_encode($response->toUnsignedXML()->ownerDocument->saveXML());
    }

    /**
     * @return LoginService
     */
    private function getGatewayLoginService()
    {
        return $this->get('gateway.service.gateway.login');
    }

    /**
     * @return ConsumeAssertionService
     */
    private function getGatewayConsumeAssertionService()
    {
        return $this->get('gateway.service.gateway.consume_assertion');
    }

    /**
     * @return RespondService
     */
    private function getGatewayRespondService()
    {
        return $this->get('gateway.service.gateway.respond');
    }

    /**
     * @return FailedResponseService
     */
    private function getGatewayFailedResponseService()
    {
        return $this->get('gateway.service.gateway.failed_response');
    }
}


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 SAML2\Response as SAMLResponse;
22		use Surfnet\StepupGateway\GatewayBundle\Exception\RequesterFailureException;
23		use Surfnet\StepupGateway\GatewayBundle\Exception\ResponseFailureException;
24		use Surfnet\StepupGateway\GatewayBundle\Service\Gateway\ConsumeAssertionService;
25		use Surfnet\StepupGateway\GatewayBundle\Service\Gateway\FailedResponseService;
26		use Surfnet\StepupGateway\GatewayBundle\Service\Gateway\LoginService;
27		use Surfnet\StepupGateway\GatewayBundle\Service\Gateway\RespondService;
28		use Symfony\Bundle\FrameworkBundle\Controller\Controller;
29		use Symfony\Component\HttpFoundation\Request;
30		use Symfony\Component\HttpFoundation\Response;
31		use Symfony\Component\HttpKernel\Exception\HttpException;
32
33		/**
34		* Entry point for the Stepup login flow.
35		*
36		* See docs/GatewayState.md for a high-level diagram on how this controller
37		* interacts with outside actors and other parts of Stepup.
38		*/
39		class GatewayController extends Controller
40		{
41		const RESPONSE_CONTEXT_SERVICE_ID = 'gateway.proxy.response_context';
42
43		/**
44		* Receive an AuthnRequest from a service provider.
45		*
46		* The service provider is either a Stepup component (SelfService, RA) or
47		* an external service provider.
48		*
49		* This single sign-on action will start a new SAML request to the remote
50		* IDP configured in Stepup (most likely to be an instance of OpenConext
51		* EngineBlock).
52		*
53		* @param Request $httpRequest
54		* @return \Symfony\Component\HttpFoundation\RedirectResponse\|Response
55		*/
56		public function ssoAction(Request $httpRequest)
57		{
58		/** @var \Psr\Log\LoggerInterface $logger */
59		$logger = $this->get('logger');
60
61		$redirectBinding = $this->get('surfnet_saml.http.redirect_binding');
62		$gatewayLoginService = $this->getGatewayLoginService();
63
64		$logger->notice('Received AuthnRequest, started processing');
65
66		try {
67		$proxyRequest = $gatewayLoginService->singleSignOn($httpRequest);
68		} catch (RequesterFailureException $e) {
69		$response = $this->getGatewayFailedResponseService()->createRequesterFailureResponse($this->getResponseContext());
		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 126 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...
70
71		return $this->renderSamlResponse('consumeAssertion', $response);
72		}
73
74		return $redirectBinding->createResponseFor($proxyRequest);
75		}
76
77		/**
78		*
79		*/
80		public function proxySsoAction()
81		{
82		throw new HttpException(418, 'Not Yet Implemented');
83		}
84
85		/**
86		* Receive an AuthnResponse from an identity provider.
87		*
88		* The AuthnRequest started in ssoAction() resulted in an AuthnResponse
89		* from the IDP. This method handles the assertion and forwards the user
90		* using an internal redirect to the SecondFactorController to start the
91		* actual second factor verification.
92		*
93		* @param Request $request
94		* @return \Symfony\Component\HttpFoundation\Response
95		*/
96		public function consumeAssertionAction(Request $request)
97		{
98		$responseContext = $this->getResponseContext();
99		$gatewayLoginService = $this->getGatewayConsumeAssertionService();
100
101		try {
102		$gatewayLoginService->consumeAssertion($request, $responseContext);
103		} catch (ResponseFailureException $e) {
104		$response = $this->getGatewayFailedResponseService()->createResponseFailureResponse($responseContext);
105
106		return $this->renderSamlResponse('unprocessableResponse', $response);
107		}
108
109		return $this->forward('SurfnetStepupGatewayGatewayBundle:SecondFactor:selectSecondFactorForVerification');
110		}
111
112		/**
113		* Send a SAML response back to the service provider.
114		*
115		* Second factor verification handled by SecondFactorController is
116		* finished. The user was forwarded back to this action with an internal
117		* redirect. This method sends a AuthnResponse back to the service
118		* provider in response to the AuthnRequest received in ssoAction().
119		*/
120		public function respondAction()
121		{
122		$responseContext = $this->getResponseContext();
123		$gatewayLoginService = $this->getGatewayRespondService();
124
125		$response = $gatewayLoginService->respond($responseContext);
126		$gatewayLoginService->resetRespondState($responseContext);
127
128		return $this->renderSamlResponse('consumeAssertion', $response);
129		}
130
131		/**
132		* @return Response
133		*/
134	View Code Duplication	public function sendLoaCannotBeGivenAction()
		0 ignored issues – show Duplication introduced 2018-08-20 10:08 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
135		{
136		$responseContext = $this->getResponseContext();
137		$gatewayLoginService = $this->getGatewayFailedResponseService();
138
139		$response = $gatewayLoginService->sendLoaCannotBeGiven($responseContext);
140
141		return $this->renderSamlResponse('consumeAssertion', $response);
142		}
143
144		/**
145		* @return Response
146		*/
147	View Code Duplication	public function sendAuthenticationCancelledByUserAction()
		0 ignored issues – show Duplication introduced 2017-08-01 06:56 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
148		{
149		$responseContext = $this->getResponseContext();
150		$gatewayLoginService = $this->getGatewayFailedResponseService();
151
152		$response = $gatewayLoginService->sendAuthenticationCancelledByUser($responseContext);
153
154		return $this->renderSamlResponse('consumeAssertion', $response);
155		}
156
157		/**
158		* @param string $view
159		* @param SAMLResponse $response
160		* @return Response
161		*/
162	View Code Duplication	public function renderSamlResponse($view, SAMLResponse $response)
		0 ignored issues – show Duplication introduced 2017-08-01 06:56 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
163		{
164		$responseContext = $this->getResponseContext();
165
166		return $this->render($view, [
167		'acu' => $responseContext->getDestination(),
168		'response' => $this->getResponseAsXML($response),
169		'relayState' => $responseContext->getRelayState()
170		]);
171		}
172
173		/**
174		* @param string $view
175		* @param array $parameters
176		* @param Response $response
		0 ignored issues – show Documentation introduced 2015-12-15 13:35 UTC by Report Bug Copy Issue Report Should the type for parameter `$response` not be `null\|Response`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
177		* @return Response
178		*/
179		public function render($view, array $parameters = array(), Response $response = null)
180		{
181		return parent::render(
182		'SurfnetStepupGatewayGatewayBundle:Gateway:' . $view . '.html.twig',
183		$parameters,
184		$response
185		);
186		}
187
188		/**
189		* @return \Surfnet\StepupGateway\GatewayBundle\Saml\ResponseContext
190		*/
191		public function getResponseContext()
192		{
193		$stateHandler = $this->get('gateway.proxy.state_handler');
194
195		$responseContextServiceId = $stateHandler->getResponseContextServiceId();
196
197		if (!$responseContextServiceId) {
198		return $this->get(static::RESPONSE_CONTEXT_SERVICE_ID);
199		}
200
201		return $this->get($responseContextServiceId);
202		}
203
204		/**
205		* @param SAMLResponse $response
206		* @return string
207		*/
208		private function getResponseAsXML(SAMLResponse $response)
209		{
210		return base64_encode($response->toUnsignedXML()->ownerDocument->saveXML());
211		}
212
213		/**
214		* @return LoginService
215		*/
216		private function getGatewayLoginService()
217		{
218		return $this->get('gateway.service.gateway.login');
219		}
220
221		/**
222		* @return ConsumeAssertionService
223		*/
224		private function getGatewayConsumeAssertionService()
225		{
226		return $this->get('gateway.service.gateway.consume_assertion');
227		}
228
229		/**
230		* @return RespondService
231		*/
232		private function getGatewayRespondService()
233		{
234		return $this->get('gateway.service.gateway.respond');
235		}
236
237		/**
238		* @return FailedResponseService
239		*/
240		private function getGatewayFailedResponseService()
241		{
242		return $this->get('gateway.service.gateway.failed_response');
243		}
244		}
245

OpenConext / Stepup-Gateway

Push — feature/tests-and-symfony-34 ( d06f89 )

GatewayController::ssoAction() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like