MockRemoteVetController::parseAttributes() - Code Metrics - Inspection of "Add remote vetting POC" - OpenConext/Stepup-SelfService - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#225)

unknown

created 2021-03-02 14:19 UTC

MockRemoteVetController::parseAttributes() B

↳ Parent: MockRemoteVetController

Complexity

Conditions	8
Paths	8

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	48
c	0
b	0
f	0
rs	7.8901
cc	8
nc	8
nop	1

<?php
/**
 * Copyright 2019 SURFnet B.V.
 *
 * 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\StepupSelfService\SelfServiceBundle\Mock\RemoteVetting;

use Exception;
use SAML2\Constants;
use SAML2\Response as SamlResponse;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
use Twig\Environment;

class MockRemoteVetController extends Controller

{
    /**
     * @var MockGateway
     */
    private $mockGateway;
    /**
     * @var Environment
     */
    private $twig;

    public function __construct(MockGateway $mockGateway, Environment $twig)
    {
        $this->mockGateway = $mockGateway;
        $this->twig = $twig;
    }

    /**
     * This is the sso action used to mock a RV IdP callout
     *
     * @param Request $request
     * @return string|Response
     */
    public function ssoAction(Request $request)
    {
        if (!in_array($this->getParameter('kernel.environment'), ['test', 'dev'])) {
            throw new Exception('Invalid environment encountered.');
        }

        try {
            $status = $request->get('status');

            // Check binding
            if (!$request->isMethod(Request::METHOD_GET) &&  !$status) {
                throw new BadRequestHttpException(sprintf(
                    'Could not receive AuthnRequest from HTTP Request: expected a GET method, got %s',
                    $request->getMethod()
                ));
            }

            // show possible saml response status to return
            if (!$status) {
                // Present response
                $body = $this->twig->render(
                    'dev/mock-acs.html.twig',
                    [
                        'action' => $request->getUri(),
                        'responses' => [
                            'success',
                            'user-cancelled',
                            'unknown',
                        ],
                    ]
                );
                return new Response($body);
            }

            // Parse available responses
            $response = $this->getSelectedResponse($request, $status);

            // Present response
            $body = $this->twig->render(
                'dev/mock-acs-post.html.twig',
                [
                    'response' => $response,
                ]
            );

            return new Response($body);
        } catch (BadRequestHttpException $e) {
            return new Response($e->getMessage(), $e->getStatusCode());
        } catch (Exception $e) {
            return new Response($e->getMessage(), 500);
        }
    }

    /**
     * @param Request $request
     * @param string $status
     * @return array
     */
    private function getSelectedResponse(Request $request, $status)
    {
        switch (true) {
            case ($status == 'success'):
                // Parse successful
                $rawAttributes = $request->get('attributes');
                $attributes = $this->parseAttributes($rawAttributes);

                $samlResponse = $this->mockGateway->handleSsoSuccess($request, $this->getFullRequestUri($request), $attributes);
                return $this->getResponseData($request, $samlResponse);

            case ($status == 'user-cancelled'):

                // Parse user cancelled
                $samlResponse = $this->mockGateway->handleSsoFailure(
                    $request,
                    $this->getFullRequestUri($request),
                    Constants::STATUS_RESPONDER,
                    Constants::STATUS_AUTHN_FAILED,
                    'Authentication cancelled by user'
                );
                return $this->getResponseData($request, $samlResponse);

            case ($status == 'unknown'):

                // Parse unknown
                $samlResponse = $this->mockGateway->handleSsoFailure(
                    $request,
                    $this->getFullRequestUri($request),
                    Constants::STATUS_RESPONDER,
                    Constants::STATUS_AUTHN_FAILED
                );
                return $this->getResponseData($request, $samlResponse);
            default:
                throw new BadRequestHttpException(sprintf(
                    'Could not create a response for status %s',
                    $status
                ));
        }
    }

    /**
     * @param Request $request
     * @param SamlResponse $samlResponse
     * @return array
     */
    private function getResponseData(Request $request, SamlResponse $samlResponse)
    {
        $rawResponse = $this->mockGateway->parsePostResponse($samlResponse);

        return [
            'acu' => $samlResponse->getDestination(),
            'rawResponse' => $rawResponse,
            'encodedResponse' => base64_encode($rawResponse),
            'relayState' => $request->request->get(MockGateway::PARAMETER_RELAY_STATE),
        ];
    }

    /**
     * @param Request $request
     * @return string
     */
    private function getFullRequestUri(Request $request)
    {
        return $request->getSchemeAndHttpHost() . $request->getBasePath() . $request->getPathInfo();
    }

    /**
     * @param string $data
     * @return array
     */
    private function parseAttributes($data)
    {
        json_decode($data);
        if (json_last_error() !== JSON_ERROR_NONE) {
            throw new BadRequestHttpException(sprintf(
                'Could not parse the attributes because no valid json was given %s',
                $data
            ));
        }

        $data = json_decode($data, true);

        $result = [];
        foreach ($data as $attr) {
            if (!array_key_exists('name', $attr)) {
                throw new BadRequestHttpException(sprintf(
                    'Could not parse the attributes because no valid name was given %s',
                    json_encode($data)
                ));
            }
            if (!array_key_exists('value', $attr)) {
                throw new BadRequestHttpException(sprintf(
                    'Could not parse the attributes because no valid value was given %s',
                    json_encode($data)
                ));
            }

            if (!is_array($attr['value'])) {
                throw new BadRequestHttpException(sprintf(
                    'Could not parse the attributes because a value should be an array with strings %s',
                    json_encode($data)
                ));
            }

            foreach ($attr['value'] as $value) {
                if (!is_string($value)) {
                    throw new BadRequestHttpException(sprintf(
                        'Could not parse the attributes because if a value is an array it should consist of strings %s',
                        json_encode($data)
                    ));
                }
            }

            $result[$attr['name']] = $attr['value'];
        }

        return $result;
    }
}


1		<?php
2		/**
3		* Copyright 2019 SURFnet B.V.
4		*
5		* Licensed under the Apache License, Version 2.0 (the "License");
6		* you may not use this file except in compliance with the License.
7		* You may obtain a copy of the License at
8		*
9		* http://www.apache.org/licenses/LICENSE-2.0
10		*
11		* Unless required by applicable law or agreed to in writing, software
12		* distributed under the License is distributed on an "AS IS" BASIS,
13		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14		* See the License for the specific language governing permissions and
15		* limitations under the License.
16		*/
17
18		namespace Surfnet\StepupSelfService\SelfServiceBundle\Mock\RemoteVetting;
19
20		use Exception;
21		use SAML2\Constants;
22		use SAML2\Response as SamlResponse;
23		use Symfony\Bundle\FrameworkBundle\Controller\Controller;
24		use Symfony\Component\HttpFoundation\Request;
25		use Symfony\Component\HttpFoundation\Response;
26		use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
27		use Twig\Environment;
28
29		class MockRemoteVetController extends Controller
		0 ignored issues – show Deprecated Code introduced 2021-02-16 18:23 UTC by Report Bug Copy Issue Report The class `Symfony\Bundle\Framework...e\Controller\Controller` has been deprecated with message: since Symfony 4.2, use "Symfony\Bundle\FrameworkBundle\Controller\AbstractController" instead. This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
30		{
31		/**
32		* @var MockGateway
33		*/
34		private $mockGateway;
35		/**
36		* @var Environment
37		*/
38		private $twig;
39
40		public function __construct(MockGateway $mockGateway, Environment $twig)
41		{
42		$this->mockGateway = $mockGateway;
43		$this->twig = $twig;
44		}
45
46		/**
47		* This is the sso action used to mock a RV IdP callout
48		*
49		* @param Request $request
50		* @return string\|Response
51		*/
52		public function ssoAction(Request $request)
53		{
54		if (!in_array($this->getParameter('kernel.environment'), ['test', 'dev'])) {
55		throw new Exception('Invalid environment encountered.');
56		}
57
58		try {
59		$status = $request->get('status');
60
61		// Check binding
62		if (!$request->isMethod(Request::METHOD_GET) && !$status) {
63		throw new BadRequestHttpException(sprintf(
64		'Could not receive AuthnRequest from HTTP Request: expected a GET method, got %s',
65		$request->getMethod()
66		));
67		}
68
69		// show possible saml response status to return
70		if (!$status) {
71		// Present response
72		$body = $this->twig->render(
73		'dev/mock-acs.html.twig',
74		[
75		'action' => $request->getUri(),
76		'responses' => [
77		'success',
78		'user-cancelled',
79		'unknown',
80		],
81		]
82		);
83		return new Response($body);
84		}
85
86		// Parse available responses
87		$response = $this->getSelectedResponse($request, $status);
88
89		// Present response
90		$body = $this->twig->render(
91		'dev/mock-acs-post.html.twig',
92		[
93		'response' => $response,
94		]
95		);
96
97		return new Response($body);
98		} catch (BadRequestHttpException $e) {
99		return new Response($e->getMessage(), $e->getStatusCode());
100		} catch (Exception $e) {
101		return new Response($e->getMessage(), 500);
102		}
103		}
104
105		/**
106		* @param Request $request
107		* @param string $status
108		* @return array
109		*/
110		private function getSelectedResponse(Request $request, $status)
111		{
112		switch (true) {
113		case ($status == 'success'):
114		// Parse successful
115		$rawAttributes = $request->get('attributes');
116		$attributes = $this->parseAttributes($rawAttributes);
117
118		$samlResponse = $this->mockGateway->handleSsoSuccess($request, $this->getFullRequestUri($request), $attributes);
119		return $this->getResponseData($request, $samlResponse);
120
121	View Code Duplication	case ($status == 'user-cancelled'):
		0 ignored issues – show Duplication introduced 2020-02-25 13:13 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...
122		// Parse user cancelled
123		$samlResponse = $this->mockGateway->handleSsoFailure(
124		$request,
125		$this->getFullRequestUri($request),
126		Constants::STATUS_RESPONDER,
127		Constants::STATUS_AUTHN_FAILED,
128		'Authentication cancelled by user'
129		);
130		return $this->getResponseData($request, $samlResponse);
131
132	View Code Duplication	case ($status == 'unknown'):
		0 ignored issues – show Duplication introduced 2020-02-25 13:13 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...
133		// Parse unknown
134		$samlResponse = $this->mockGateway->handleSsoFailure(
135		$request,
136		$this->getFullRequestUri($request),
137		Constants::STATUS_RESPONDER,
138		Constants::STATUS_AUTHN_FAILED
139		);
140		return $this->getResponseData($request, $samlResponse);
141		default:
142		throw new BadRequestHttpException(sprintf(
143		'Could not create a response for status %s',
144		$status
145		));
146		}
147		}
148
149		/**
150		* @param Request $request
151		* @param SamlResponse $samlResponse
152		* @return array
153		*/
154		private function getResponseData(Request $request, SamlResponse $samlResponse)
155		{
156		$rawResponse = $this->mockGateway->parsePostResponse($samlResponse);
157
158		return [
159		'acu' => $samlResponse->getDestination(),
160		'rawResponse' => $rawResponse,
161		'encodedResponse' => base64_encode($rawResponse),
162		'relayState' => $request->request->get(MockGateway::PARAMETER_RELAY_STATE),
163		];
164		}
165
166		/**
167		* @param Request $request
168		* @return string
169		*/
170		private function getFullRequestUri(Request $request)
171		{
172		return $request->getSchemeAndHttpHost() . $request->getBasePath() . $request->getPathInfo();
173		}
174
175		/**
176		* @param string $data
177		* @return array
178		*/
179		private function parseAttributes($data)
180		{
181		json_decode($data);
182		if (json_last_error() !== JSON_ERROR_NONE) {
183		throw new BadRequestHttpException(sprintf(
184		'Could not parse the attributes because no valid json was given %s',
185		$data
186		));
187		}
188
189		$data = json_decode($data, true);
190
191		$result = [];
192		foreach ($data as $attr) {
193		if (!array_key_exists('name', $attr)) {
194		throw new BadRequestHttpException(sprintf(
195		'Could not parse the attributes because no valid name was given %s',
196		json_encode($data)
197		));
198		}
199		if (!array_key_exists('value', $attr)) {
200		throw new BadRequestHttpException(sprintf(
201		'Could not parse the attributes because no valid value was given %s',
202		json_encode($data)
203		));
204		}
205
206		if (!is_array($attr['value'])) {
207		throw new BadRequestHttpException(sprintf(
208		'Could not parse the attributes because a value should be an array with strings %s',
209		json_encode($data)
210		));
211		}
212
213		foreach ($attr['value'] as $value) {
214		if (!is_string($value)) {
215		throw new BadRequestHttpException(sprintf(
216		'Could not parse the attributes because if a value is an array it should consist of strings %s',
217		json_encode($data)
218		));
219		}
220		}
221
222		$result[$attr['name']] = $attr['value'];
223		}
224
225		return $result;
226		}
227		}
228

OpenConext / Stepup-SelfService

Pull Request — develop (#225)

MockRemoteVetController::parseAttributes() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like