Surfnet\StepupMiddleware\MiddlewareBundle\Console\Command\BootstrapGsspSecondFactorCommand

Complexity

Total Complexity

10

Size/Duplication

Total Lines	140
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	execute()	0	103	8
A	configure()	0	22	1
A	__construct()	0	5	1

<?php

/**
 * Copyright 2020 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.
 */

Missing @link tag in file comment

namespace Surfnet\StepupMiddleware\MiddlewareBundle\Console\Command;

use Exception;
use Ramsey\Uuid\Uuid;
use Surfnet\Stepup\Identity\Value\Institution;
use Surfnet\Stepup\Identity\Value\NameId;
use Surfnet\StepupMiddleware\MiddlewareBundle\Service\BootstrapCommandService;
use Surfnet\StepupMiddleware\MiddlewareBundle\Service\TransactionHelper;

The type Surfnet\StepupMiddleware\MiddlewareBundle\Service\TransactionHelper was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

final class BootstrapGsspSecondFactorCommand extends Command

Missing doc comment for class BootstrapGsspSecondFactorCommand

{
    public function __construct(
        private readonly BootstrapCommandService $bootstrapService,
        private readonly TransactionHelper $transactionHelper,
    ) {
        parent::__construct();
    }

    protected function configure(): void
    {
        $this
            ->setDescription('Creates a Generic SAML Second Factor (GSSF) second factor for a specified user')
            ->addArgument('name-id', InputArgument::REQUIRED, 'The NameID of the identity to create')
            ->addArgument('institution', InputArgument::REQUIRED, 'The institution of the identity to create')
            ->addArgument(
                'gssp-token-type',
                InputArgument::REQUIRED,
                'The GSSP token type as defined in the GSSP config, for example tiqr or webauthn',
            )
            ->addArgument(
                'gssp-token-identifier',
                InputArgument::REQUIRED,
                'The identifier of the token as registered at the GSSP',
            )
            ->addArgument(
                'registration-status',
                InputArgument::REQUIRED,
                'Valid arguments: unverified, verified, vetted',
            )
            ->addArgument('actor-id', InputArgument::REQUIRED, 'The id of the vetting actor');
    }

    /**

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

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

     * @SuppressWarnings(PHPMD.ExcessiveMethodLength) Method length could be reduced by deconstructing the bootstrapping
     * of the required data and the vetting of the GSSP
     */

Missing @return tag in function comment

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $registrationStatus = $input->getArgument('registration-status');
        $this->bootstrapService->validRegistrationStatus($registrationStatus);

        $nameId = new NameId($input->getArgument('name-id'));
        $institutionText = $input->getArgument('institution');
        $institution = new Institution($institutionText);
        $mailVerificationRequired = $this->bootstrapService->requiresMailVerification($institutionText);
        $tokenType = $input->getArgument('gssp-token-type');
        $tokenIdentifier = $input->getArgument('gssp-token-identifier');
        $actorId = $input->getArgument('actor-id');
        $this->bootstrapService->enrichEventMetadata($actorId);
        if (!$this->bootstrapService->identityExists($nameId, $institution)) {
            $output->writeln(
                sprintf(
                    '<error>An identity with name ID "%s" from institution "%s" does not exist, create it first.</error>',
                    $nameId->getNameId(),
                    $institution->getInstitution(),
                ),
            );

            return 1;
        }
        $identity = $this->bootstrapService->getIdentity($nameId, $institution);
        $output->writeln(
            sprintf(
                '<comment>Adding a %s %s GSSP token for %s</comment>',
                $registrationStatus,
                $tokenType,
                $identity->commonName,
            ),
        );
        $this->transactionHelper->beginTransaction();
        $secondFactorId = Uuid::uuid4()->toString();

        try {
            switch ($registrationStatus) {
                case "unverified":

Line indented incorrectly; expected 12 spaces, found 16

                    $output->writeln(sprintf('<comment>Creating an unverified %s token</comment>', $tokenType));
                    $this->bootstrapService->proveGsspPossession(
                        $secondFactorId,
                        $identity,
                        $tokenType,
                        $tokenIdentifier,
                    );
                    break;
                case "verified":

Line indented incorrectly; expected 12 spaces, found 16

                    $output->writeln(sprintf('<comment>Creating an unverified %s token</comment>', $tokenType));
                    $this->bootstrapService->proveGsspPossession(
                        $secondFactorId,
                        $identity,
                        $tokenType,
                        $tokenIdentifier,
                    );
                    if ($mailVerificationRequired) {

Line indented incorrectly; expected 12 spaces, found 20

                        $output->writeln(sprintf('<comment>Creating an verified %s token</comment>', $tokenType));
                        $this->bootstrapService->verifyEmail($identity, $tokenType);
                    }

Line indented incorrectly; expected 12 spaces, found 20

                    break;
                case "vetted":

Line indented incorrectly; expected 12 spaces, found 16

                    $output->writeln(sprintf('<comment>Creating an unverified %s token</comment>', $tokenType));
                    $this->bootstrapService->proveGsspPossession(
                        $secondFactorId,
                        $identity,
                        $tokenType,
                        $tokenIdentifier,
                    );
                    if ($mailVerificationRequired) {

Line indented incorrectly; expected 12 spaces, found 20

                        $output->writeln(sprintf('<comment>Creating an verified %s token</comment>', $tokenType));
                        $this->bootstrapService->verifyEmail($identity, $tokenType);
                    }

Line indented incorrectly; expected 12 spaces, found 20

                    $output->writeln(sprintf('<comment>Vetting the verified %s token</comment>', $tokenType));
                    $this->bootstrapService->vetSecondFactor(
                        $tokenType,
                        $actorId,
                        $identity,
                        $secondFactorId,
                        $tokenIdentifier,
                    );
                    break;
            }
            $this->transactionHelper->finishTransaction();
        } catch (Exception $e) {
            $output->writeln(
                sprintf(
                    '<error>An Error occurred when trying to bootstrap the %s token: "%s"</error>',
                    $tokenType,
                    $e->getMessage(),
                ),
            );
            $this->transactionHelper->rollback();
            return 1;
        }
        $output->writeln(
            sprintf(
                '<info>Successfully %s %s second factor with UUID %s</info>',
                $registrationStatus,
                $tokenType,
                $secondFactorId,
            ),
        );
        return 0;
    }
}