Surfnet\StepupSelfService\SelfServiceBundle\Controller\Registration\GssfController

Complexity

Total Complexity

14

Size/Duplication

Total Lines	237
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	16	1
A	status()	0	16	1
A	metadata()	0	15	1
A	redirectToStatusReportForm()	0	6	1
A	authenticate()	0	32	1
A	renderStatusForm()	0	27	1
B	consumeAssertion()	0	78	6
A	getProvider()	0	9	2

<?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.
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

namespace Surfnet\StepupSelfService\SelfServiceBundle\Controller\Registration;

use Exception;
use Psr\Log\LoggerInterface;
use Surfnet\SamlBundle\Http\XMLResponse;
use Surfnet\SamlBundle\Metadata\MetadataFactory;
use Surfnet\SamlBundle\SAML2\Attribute\AttributeDictionary;
use Surfnet\SamlBundle\SAML2\AuthnRequestFactory;
use Surfnet\SamlBundle\SAML2\Response\Assertion\InResponseTo;
use Surfnet\StepupSelfService\SamlStepupProviderBundle\Provider\Provider;
use Surfnet\StepupSelfService\SamlStepupProviderBundle\Provider\ProviderRepository;
use Surfnet\StepupSelfService\SamlStepupProviderBundle\Provider\ViewConfig;
use Surfnet\StepupSelfService\SelfServiceBundle\Controller\Controller;
use Surfnet\StepupSelfService\SelfServiceBundle\Form\Type\StatusGssfType;
use Surfnet\StepupSelfService\SelfServiceBundle\Service\GssfService;

The type Surfnet\StepupSelfService\SelfServiceBundle\Service\GssfService was not found. Maybe you did not declare it correctly or list all dependencies?

use Surfnet\StepupSelfService\SelfServiceBundle\Service\GsspUserAttributeService;

The type Surfnet\StepupSelfService\SelfServiceBundle\Service\GsspUserAttributeService was not found. Maybe you did not declare it correctly or list all dependencies?

use Surfnet\StepupSelfService\SelfServiceBundle\Service\InstitutionConfigurationOptionsService;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\Routing\Annotation\Route;
use Surfnet\SamlBundle\Http\RedirectBinding;
use \Surfnet\SamlBundle\Http\PostBinding;

The type \Surfnet\SamlBundle\Http\PostBinding was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;


/**
 * Controls registration with Generic SAML Stepup Providers (GSSPs), yielding Generic SAML Second Factors (GSSFs).
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

final class GssfController extends Controller
{
    public function __construct(

Missing doc comment for function __construct()

        private readonly LoggerInterface       $logger,
        InstitutionConfigurationOptionsService $configurationOptionsService,
        private readonly ProviderRepository    $providerRepository,
        private readonly RedirectBinding       $redirectBinding,
        private readonly PostBinding           $postBinding,
        private GsspUserAttributeService      $gsspUserAttributeService,
        private TokenStorageInterface                $tokenStorage,
        private GssfService                   $gssfService,
        private AttributeDictionary $attributeDictionary,

Blank lines are not allowed in a multi-line function declaration

Blank lines are not allowed in a multi-line function declaration

Blank lines are not allowed in a multi-line function declaration

    )
    {

The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line

        parent::__construct($logger, $configurationOptionsService);
    }

    /**

Parameter $request should have a doc-comment as per coding-style.

Parameter $provider should have a doc-comment as per coding-style.

     * Render the status form.
     *
     * This action has two parameters:
     *
     * - authenticationFailed (default false), will trigger an error message
     *   and is used when a SAML failure response was received, for example
     *   when the users cancelled the registration
     *
     * - proofOfPossessionFailed (default false), will trigger an error message
     *   when possession was not proven, but the SAML response was successful
     *
     * @return array|Response
     */

There must be no blank lines after the function comment

    #[Route(
        path: '/registration/gssf/{provider}/status',
        name: 'ss_registration_gssf_status_report',
        defaults: ['authenticationFailed' => false, 'proofOfPossessionFailed'=> false ],
        methods: ['GET'],
    )]

    public function status(Request $request, string $provider): \Symfony\Component\HttpFoundation\Response
    {
        $this->assertSecondFactorEnabled($provider);

        return $this->renderStatusForm(
            $provider,
            [
                'authenticationFailed' => (bool) $request->query->get('authenticationFailed'),
                'proofOfPossessionFailed' => (bool) $request->query->get('proofOfPossessionFailed'),
            ]
        );
    }

    #[Route(
        path: '/registration/gssf/{provider}/authenticate',
        name: 'ss_registration_gssf_authenticate',
        methods: ['POST'],
    )]
    public function authenticate(string $provider): array|Response

Missing doc comment for function authenticate()

    {
        $this->assertSecondFactorEnabled($provider);

        $provider = $this->getProvider($provider);

        $authnRequest = AuthnRequestFactory::createNewRequest(
            $provider->getServiceProvider(),
            $provider->getRemoteIdentityProvider()
        );

        $this->gsspUserAttributeService->addGsspUserAttributes(
            $authnRequest,
            $provider,
            $this->getIdentity()
        );
        $stateHandler = $provider->getStateHandler();
        $stateHandler->setRequestId($authnRequest->getRequestId());

        $this->logger->notice(sprintf(

The opening parenthesis of a multi-line function call should be the last content on the line.

            'Sending AuthnRequest with request ID: "%s" to GSSP "%s" at "%s"',
            $authnRequest->getRequestId(),
            $provider->getName(),
            $provider->getRemoteIdentityProvider()->getSsoUrl()
        ));

For multi-line function calls, the closing parenthesis should be on a new line.

        return $this->redirectBinding->createResponseFor($authnRequest);
    }

    #[Route(
        path: '/registration/gssf/{provider}/consume-assertion',
        name: 'ss_registration_gssf_consume_assertion',
        methods: ['POST'],
    )]
    public function consumeAssertion(Request $httpRequest, string $provider): array|Response

Missing doc comment for function consumeAssertion()

    {
        $this->assertSecondFactorEnabled($provider);

        $provider = $this->getProvider($provider);

        $this->logger->notice(
            sprintf('Received GSSP "%s" SAMLResponse through Gateway, attempting to process', $provider->getName())
        );

        try {
            $assertion = $this->postBinding->processResponse(
                $httpRequest,
                $provider->getRemoteIdentityProvider(),
                $provider->getServiceProvider()
            );
        } catch (Exception $exception) {
            $provider->getStateHandler()->clear();

            $this->logger->error(
                sprintf('Could not process received Response, error: "%s"', $exception->getMessage())
            );

            return $this->redirectToStatusReportForm(
                $provider,
                ['authenticationFailed' => true]
            );
        }

        $expectedResponseTo = $provider->getStateHandler()->getRequestId();
        $provider->getStateHandler()->clear();

        if (!InResponseTo::assertEquals($assertion, $expectedResponseTo)) {
            $this->logger->critical(sprintf(

The opening parenthesis of a multi-line function call should be the last content on the line.

                'Received Response with unexpected InResponseTo, %s',
                ($expectedResponseTo ? 'expected "' . $expectedResponseTo . '"' : ' no response expected')
            ));

For multi-line function calls, the closing parenthesis should be on a new line.

            return $this->redirectToStatusReportForm(
                $provider,
                ['authenticationFailed' => true]
            );
        }

        $this->logger->notice(
            sprintf('Processed GSSP "%s" SAMLResponse received through Gateway successfully', $provider->getName())
        );

        $gssfId = $this->attributeDictionary->translate($assertion)->getNameID();

        $secondFactorId = $this->gssfService->provePossession($this->getIdentity()->id, $provider->getName(), $gssfId);

        if ($secondFactorId) {
            $this->logger->notice('GSSF possession has been proven successfully');

            if ($this->emailVerificationIsRequired()) {
                return $this->redirectToRoute(
                    'ss_registration_email_verification_email_sent',
                    ['secondFactorId' => $secondFactorId]
                );
            } else {
                return $this->redirectToRoute(
                    'ss_second_factor_vetting_types',
                    ['secondFactorId' => $secondFactorId]
                );
            }
        }

        $this->logger->error('Unable to prove GSSF possession');

        return $this->redirectToStatusReportForm(
            $provider,
            ['proofOfPossessionFailed' => true]
        );
    }

    private function redirectToStatusReportForm(Provider $provider, array $options): RedirectResponse

Missing doc comment for function redirectToStatusReportForm()

Private method name "GssfController::redirectToStatusReportForm" must be prefixed with an underscore

    {
        return $this->redirectToRoute(
            'ss_registration_gssf_status_report',
            $options + [
                'provider' => $provider->getName(),
            ]
        );
    }

    #[Route(
        path: '/registration/gssf/{provider}/metadata',
        name: 'ss_registration_gssf_saml_metadata',
        methods: ['GET'],
    )]
    public function metadata(string $provider): XMLResponse

Missing doc comment for function metadata()

    {
        $this->assertSecondFactorEnabled($provider);

        $provider = $this->getProvider($provider);

        /** @var MetadataFactory $factory */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $factory = $this->container->get('gssp.provider.' . $provider->getName() . '.metadata.factory');

        return new XMLResponse($factory->generate());
    }

    /**

Missing short description in doc comment

Parameter $provider should have a doc-comment as per coding-style.

     * @throws NotFoundHttpException
     */

Missing @return tag in function comment

    private function getProvider(string $provider): Provider

Private method name "GssfController::getProvider" must be prefixed with an underscore

    {
        if (!$this->providerRepository->has($provider)) {
            $this->logger->info(sprintf('Requested GSSP "%s" does not exist or is not registered', $provider));

            throw new NotFoundHttpException('Requested provider does not exist');
        }

        return $this->providerRepository->get($provider);
    }

    private function renderStatusForm(string $provider, array $parameters = []): Response

Missing doc comment for function renderStatusForm()

Private method name "GssfController::renderStatusForm" must be prefixed with an underscore

    {
        /** @var ViewConfig $secondFactorConfig */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $secondFactorConfig = $this->container->get("gssp.view_config.{$provider}");

        $form = $this->createForm(
            StatusGssfType::class,
            null,
            [
                'provider' => $provider,
                /** @Ignore from translation message extraction */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                'label' => $secondFactorConfig->getInitiateButton()
            ]
        );
        /** @var ViewConfig $secondFactorConfig */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $templateParameters = array_merge(
            $parameters,
            [
                'form' => $form->createView(),
                'provider' => $provider,
                'secondFactorConfig' => $secondFactorConfig,
                'verifyEmail' => $this->emailVerificationIsRequired(),
            ]
        );
        return $this->render(
            'registration/gssf/status.html.twig',
            $templateParameters
        );
    }
}