Surfnet\StepupSelfService\SelfServiceBundle\Controller\SecondFactorController

Complexity

Total Complexity

11

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	revoke()	0	58	6
A	__construct()	0	10	1
A	list()	0	45	4

<?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;

use Surfnet\StepupBundle\DateTime\RegistrationExpirationHelper;
use Psr\Log\LoggerInterface;
use Surfnet\StepupBundle\Service\SecondFactorTypeService;
use Surfnet\StepupSelfService\SelfServiceBundle\Command\RevokeCommand;
use Surfnet\StepupSelfService\SelfServiceBundle\Form\Type\RevokeSecondFactorType;
use Surfnet\StepupSelfService\SelfServiceBundle\Service\AuthorizationService;
use Surfnet\StepupSelfService\SelfServiceBundle\Service\InstitutionConfigurationOptionsService;
use Surfnet\StepupSelfService\SelfServiceBundle\Service\SecondFactorService;
use Surfnet\StepupSelfService\SelfServiceBundle\Service\SelfAssertedTokens\RecoveryTokenService;
use Symfony\Bridge\Twig\Attribute\Template;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\Routing\Annotation\Route;

class SecondFactorController extends Controller

Missing doc comment for class SecondFactorController

{
    public function __construct(

Missing doc comment for function __construct()

        LoggerInterface $logger,
        private readonly InstitutionConfigurationOptionsService $configurationOptionsService,
        private readonly RecoveryTokenService    $recoveryTokenService,
        private readonly AuthorizationService    $authorizationService,
        private readonly SecondFactorTypeService $secondFactorTypeService,
        private readonly SecondFactorService $secondFactorService,
        private readonly RegistrationExpirationHelper $registrationExpirationHelper,
    ) {
        parent::__construct($logger, $configurationOptionsService);
    }
    #[Template('second_factor/list.html.twig')]
    #[Route(path: '/overview', name: 'ss_second_factor_list', methods:  ['GET'])]
    public function list(): array

Missing doc comment for function list()

    {
        $identity = $this->getIdentity();
        $institution = $this->getIdentity()->institution;
        $options = $this->configurationOptionsService
            ->getInstitutionConfigurationOptionsFor($institution);

        // Get all available second factors from the config.
        $allSecondFactors = $this->getParameter('ss.enabled_second_factors');

        $secondFactors = $this->secondFactorService->getSecondFactorsForIdentity(
            $identity,
            $allSecondFactors,
            $options->allowedSecondFactors,
            $options->numberOfTokensPerIdentity
        );

        /** @var RecoveryTokenService $recoveryTokenService */

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

        $recoveryTokenService = $this->recoveryTokenService;
        /** @var AuthorizationService $authorizationService */

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

        $authorizationService = $this->authorizationService;
        $recoveryTokensAllowed = $authorizationService->mayRegisterRecoveryTokens($identity);
        $selfAssertedTokenRegistration = $options->allowSelfAssertedTokens === true && $recoveryTokensAllowed;
        $hasRemainingTokenTypes = $recoveryTokenService->getRemainingTokenTypes($identity) !== [];
        $recoveryTokens = [];
        if ($selfAssertedTokenRegistration && $recoveryTokensAllowed) {
            $recoveryTokens = $recoveryTokenService->getRecoveryTokensForIdentity($identity);
        }
        $loaService = $this->secondFactorTypeService;

        return [
            'loaService' => $loaService,
            'email' => $identity->email,
            'maxNumberOfTokens' => $secondFactors->getMaximumNumberOfRegistrations(),
            'registrationsLeft' => $secondFactors->getRegistrationsLeft(),
            'unverifiedSecondFactors' => $secondFactors->unverified,
            'verifiedSecondFactors' => $secondFactors->verified,
            'vettedSecondFactors' => $secondFactors->vetted,
            'availableSecondFactors' => $secondFactors->available,
            'expirationHelper' => $this->registrationExpirationHelper,
            'selfAssertedTokenRegistration' => $selfAssertedTokenRegistration,
            'recoveryTokens' => $recoveryTokens,
            'hasRemainingRecoveryTokens' => $hasRemainingTokenTypes,
        ];
    }

    #[Template('second_factor/revoke.html.twig')]
    #[Route(
        path: '/second-factor/{state}/{secondFactorId}/revoke',
        name: 'ss_second_factor_revoke',
        requirements: ['state' => '^(unverified|verified|vetted)$'],
        methods: ['GET','POST']
    )]
    public function revoke(Request $request, string $state, string $secondFactorId): array|Response

Missing doc comment for function revoke()

    {
        $identity = $this->getIdentity();

        /** @var SecondFactorService $service */

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

        $service = $this->container->get('surfnet_stepup_self_service_self_service.service.second_factor');
        if (!$service->identityHasSecondFactorOfStateWithId($identity->id, $state, $secondFactorId)) {

It seems like $identity->id can also be of type null; however, parameter $identityId of Surfnet\StepupSelfService\SelfServiceBundle\Service\SecondFactorService::identityHasSecondFactorOfStateWithId() does only seem to accept string, maybe add an additional type check?

            $this->container->get('logger')->error(sprintf(

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

                'Identity "%s" tried to revoke "%s" second factor "%s", but does not own that second factor',
                $identity->id,
                $state,
                $secondFactorId
            ));

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

            throw new NotFoundHttpException();
        }

        $secondFactor = match ($state) {
            'unverified' => $service->findOneUnverified($secondFactorId),
            'verified' => $service->findOneVerified($secondFactorId),
            'vetted' => $service->findOneVetted($secondFactorId),
            default => throw new LogicException('There are no other types of second factor.'),

The type Surfnet\StepupSelfService\SelfServiceBundle\Controller\LogicException was not found. Did you mean LogicException? If so, make sure to prefix the type with \.

        };

        if ($secondFactor === null) {
            throw new NotFoundHttpException(
                sprintf("No %s second factor with id '%s' exists.", $state, $secondFactorId)
            );
        }

        $command = new RevokeCommand();
        $command->identity = $identity;
        $command->secondFactor = $secondFactor;

        $form = $this->createForm(RevokeSecondFactorType::class, $command)->handleRequest($request);

        if ($form->isSubmitted() && $form->isValid()) {
            /** @var FlashBagInterface $flashBag */

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

            $flashBag = $this->container->get('session')->getFlashBag();

            if ($service->revoke($command)) {
                $flashBag->add('success', 'ss.second_factor.revoke.alert.revocation_successful');
            } else {
                $flashBag->add('error', 'ss.second_factor.revoke.alert.revocation_failed');
            }

            return $this->redirectToRoute('ss_second_factor_list');
        }

        return [
            'form'         => $form->createView(),
            'secondFactor' => $secondFactor,
        ];
    }
}