Surfnet\StepupSelfService\SelfServiceBundle\Controller\Registration\SmsController

Complexity

Total Complexity

15

Size/Duplication

Total Lines	111
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	sendChallenge()	0	42	5
A	__construct()	0	6	1
B	provePossession()	0	57	9

<?php

declare(strict_types = 1);

/**
 * 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 Psr\Log\LoggerInterface;
use Surfnet\StepupSelfService\SelfServiceBundle\Service\InstitutionConfigurationOptionsService;
use Symfony\Bridge\Twig\Attribute\Template;
use Surfnet\StepupSelfService\SelfServiceBundle\Command\SendSmsChallengeCommand;
use Surfnet\StepupSelfService\SelfServiceBundle\Command\VerifySmsChallengeCommand;
use Surfnet\StepupSelfService\SelfServiceBundle\Controller\Controller;
use Surfnet\StepupSelfService\SelfServiceBundle\Form\Type\SendSmsChallengeType;
use Surfnet\StepupSelfService\SelfServiceBundle\Form\Type\VerifySmsChallengeType;
use Surfnet\StepupSelfService\SelfServiceBundle\Service\SmsSecondFactorService;
use Surfnet\StepupSelfService\SelfServiceBundle\Service\SmsSecondFactorServiceInterface;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Annotation\Route;

class SmsController extends Controller

Missing doc comment for class SmsController

{
    public function __construct(

Missing doc comment for function __construct()

        LoggerInterface                         $logger,
        InstitutionConfigurationOptionsService  $configurationOptionsService,
        private readonly SmsSecondFactorService $smsSecondFactorService,
    ) {
        parent::__construct($logger, $configurationOptionsService);
    }

    #[Template('registration/sms/send_challenge.html.twig')]
    #[Route(
        path: '/registration/sms/send-challenge',
        name: 'ss_registration_sms_send_challenge',
        methods: ['GET','POST'],
    )]
    public function sendChallenge(Request $request): array|RedirectResponse

Missing doc comment for function sendChallenge()

    {
        $this->assertSecondFactorEnabled('sms');

        $identity = $this->getIdentity();

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

        $otpRequestsRemaining = $this->smsSecondFactorService->getOtpRequestsRemainingCount(
            SmsSecondFactorServiceInterface::REGISTRATION_SECOND_FACTOR_ID
        );
        $maximumOtpRequests = $this->smsSecondFactorService->getMaximumOtpRequestsCount();
        $viewVariables = [
            'otpRequestsRemaining' => $otpRequestsRemaining,
            'maximumOtpRequests' => $maximumOtpRequests,
            'verifyEmail' => $this->emailVerificationIsRequired(),
        ];

        if ($form->isSubmitted() && $form->isValid()) {
            $command->identity = $identity->id;
            $command->institution = $identity->institution;

            if ($otpRequestsRemaining === 0) {
                $this->addFlash('error', 'ss.prove_phone_possession.challenge_request_limit_reached');
                return ['form' => $form->createView(), ...$viewVariables];
            }

            if ($this->smsSecondFactorService->sendChallenge($command)) {
                return $this->redirect($this->generateUrl('ss_registration_sms_prove_possession'));
            } else {
                $this->addFlash('error', 'ss.prove_phone_possession.send_sms_challenge_failed');
            }
        }

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

    #[Template('registration/sms/prove_possession.html.twig')]
    #[Route(
        path: '/registration/sms/prove-possession',
        name: 'ss_registration_sms_prove_possession',
        methods: ['GET','POST'],
    )]
    public function provePossession(Request $request): RedirectResponse|array

Missing doc comment for function provePossession()

    {
        $this->assertSecondFactorEnabled('sms');

        /** @var SmsSecondFactorService $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->get('surfnet_stepup_self_service_self_service.service.sms_second_factor');

The method get() does not exist on Surfnet\StepupSelfService\SelfServiceBundle\Controller\Registration\SmsController.

        if (!$service->hasSmsVerificationState(SmsSecondFactorServiceInterface::REGISTRATION_SECOND_FACTOR_ID)) {
            $this->get('session')->getFlashBag()->add('notice', 'ss.registration.sms.alert.no_verification_state');

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

        $identity = $this->getIdentity();

        $command = new VerifySmsChallengeCommand();
        $command->identity = $identity->id;

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

        if ($form->isSubmitted() && $form->isValid()) {
            $result = $service->provePossession($command);

            if ($result->isSuccessful()) {
                $service->clearSmsVerificationState(SmsSecondFactorServiceInterface::REGISTRATION_SECOND_FACTOR_ID);

                if ($this->emailVerificationIsRequired()) {
                    return $this->redirectToRoute(
                        'ss_registration_email_verification_email_sent',
                        ['secondFactorId' => $result->getSecondFactorId()]
                    );
                } else {
                    return $this->redirectToRoute(
                        'ss_second_factor_vetting_types',
                        ['secondFactorId' => $result->getSecondFactorId()]
                    );
                }
            } elseif ($result->wasIncorrectChallengeResponseGiven()) {
                $this->addFlash('error', 'ss.prove_phone_possession.incorrect_challenge_response');
            } elseif ($result->hasChallengeExpired()) {
                $this->addFlash('error', 'ss.prove_phone_possession.challenge_expired');
            } elseif ($result->wereTooManyAttemptsMade()) {
                $this->addFlash('error', 'ss.prove_phone_possession.too_many_attempts');
            } else {
                $this->addFlash('error', 'ss.prove_phone_possession.proof_of_possession_failed');
            }
        }

        return [
            'form' => $form->createView(),
            'verifyEmail' => $this->emailVerificationIsRequired(),
        ];
    }
}